An instance of a Layout engine that can layout and flow text into one or more frames, resulting in DOM that describes the final laid-out text.
More...
#include <layout.h>
|
virtual void | addFrame (const ILayoutFramePtr &frame)=0 |
| Add a frame to the list of frames into which the engine will flow text. Text will be laid out into the first frame, and any that does not fit will flow into the second, and so forth.
|
|
virtual IDOMNodePtr | layout (const CLayoutParagraphVect ¶graphs)=0 |
| Lay out the given paragraphs into the frames, returning a DOM representation of the result.
|
|
virtual void | addRef () const =0 |
| Increases the reference count of the actual object pointed to. This would take place during an assignment or copying.
|
|
virtual bool | decRef () const =0 |
| Decreases the reference count of the actual object pointed to. When the reference count falls to Zero, it deletes the actual object pointed to.
|
|
virtual int32 | getRefCount () const =0 |
| Retrieve the current reference count of the actual object pointed to.
|
|
|
static JAWSMAKO_API ILayoutPtr | create (const IJawsMakoPtr &jawsMako) |
| Create an instance of the layout engine.
|
|
|
virtual | ~IRCObject () |
| Virtual destructor.
|
|
An instance of a Layout engine that can layout and flow text into one or more frames, resulting in DOM that describes the final laid-out text.
◆ addFrame()
virtual void JawsMako::ILayout::addFrame |
( |
const ILayoutFramePtr & |
frame | ) |
|
|
pure virtual |
Add a frame to the list of frames into which the engine will flow text. Text will be laid out into the first frame, and any that does not fit will flow into the second, and so forth.
- Parameters
-
◆ create()
static JAWSMAKO_API ILayoutPtr JawsMako::ILayout::create |
( |
const IJawsMakoPtr & |
jawsMako | ) |
|
|
static |
Create an instance of the layout engine.
- Parameters
-
- Returns
- ILayoutPtr The new layout engine object.
◆ layout()
virtual IDOMNodePtr JawsMako::ILayout::layout |
( |
const CLayoutParagraphVect & |
paragraphs | ) |
|
|
pure virtual |
Lay out the given paragraphs into the frames, returning a DOM representation of the result.
- Parameters
-
paragraphs | The paragraphs to lay out. |
- Returns
- IDOMNodePtr The resulting DOM.
The documentation for this class was generated from the following file: