Grantlee
5.2.0
|
Instructs a builder object to create markup output. More...
#include <grantlee/markupdirector.h>
Public Member Functions | |
MarkupDirector (AbstractMarkupBuilder *builder) | |
virtual | ~MarkupDirector () |
virtual QTextFrame::iterator | processBlock (QTextFrame::iterator it, const QTextBlock &block) |
virtual QTextFrame::iterator | processBlockContents (QTextFrame::iterator it, const QTextBlock &block) |
virtual QPair< QTextFrame::iterator, QTextBlock > | processBlockGroup (QTextFrame::iterator it, const QTextBlock &block, QTextBlockGroup *textBlockGroup) |
virtual QTextBlock::iterator | processCharTextObject (QTextBlock::iterator it, const QTextFragment &fragment, QTextObject *textObject) |
virtual void | processCustomFragment (const QTextFragment &fragment, QTextDocument const *doc) |
virtual void | processDocument (QTextDocument *doc) |
virtual QTextBlock::iterator | processFragment (QTextBlock::iterator it, const QTextFragment &fragment, QTextDocument const *doc) |
virtual QTextFrame::iterator | processFrame (QTextFrame::iterator it, QTextFrame *frame) |
virtual QTextBlock::iterator | processImage (QTextBlock::iterator it, const QTextImageFormat &imageFormat, QTextDocument *doc) |
virtual QPair< QTextFrame::iterator, QTextBlock > | processList (QTextFrame::iterator it, const QTextBlock &block, QTextList *textList) |
virtual QTextFrame::iterator | processObject (QTextFrame::iterator it, const QTextBlock &block, QTextObject *textObject) |
virtual QTextFrame::iterator | processTable (QTextFrame::iterator it, QTextTable *table) |
virtual void | processTableCell (const QTextTableCell &tableCell, QTextTable *table) |
Protected Types | |
enum | OpenElementValues { None , SuperScript , SubScript , Anchor , SpanForeground , SpanBackground , SpanFontFamily , SpanFontPointSize , Strong , Emph , Underline , StrikeOut } |
Protected Member Functions | |
virtual QSet< int > | getElementsToClose (QTextBlock::iterator it) const |
virtual QList< int > | getElementsToOpen (QTextBlock::iterator it) |
virtual void | processClosingElements (QTextBlock::iterator it) |
void | processDocumentContents (QTextFrame::iterator begin, QTextFrame::iterator end) |
virtual void | processOpeningElements (QTextBlock::iterator it) |
QPair< QTextFrame::iterator, QTextBlock > | skipBlockGroup (QTextFrame::iterator it, const QTextBlock &_block, QTextBlockGroup *blockGroup) |
QList< int > | sortOpeningOrder (QSet< int > openingTags, QTextBlock::iterator it) const |
Protected Attributes | |
AbstractMarkupBuilder * | m_builder |
The MarkupDirector is used with an implementation of AbstractMarkupBuilder to create a marked up document output.
Usage can be quite simple.
Or with a different builder:
The MarkupDirector also provides API for processing just part of a QTextDocument, such as a QTextFrame or a QTextBlock. The appropriate method may then be called with an invalid iterator as appropriate.
The behaviour of the MarkupDirector can be customized by subclassing. Support for custom types can also be added by implementing the processCustomFragment method.
Definition at line 92 of file markupdirector.h.
|
protected |
Flags for the tags that may be open.
Definition at line 273 of file markupdirector.h.
Grantlee::MarkupDirector::MarkupDirector | ( | AbstractMarkupBuilder * | builder | ) |
Constructor
|
virtual |
Destructor
|
protectedvirtual |
Returns the tags that should be closed at the position of it
.
|
protectedvirtual |
Returns the tags that should be opened at the position of it
.
|
virtual |
Directs the builder to create output for the single block
. If calling this method directly, an invalid QTextFrame::iterator may be used.
This method does not process the contents of the block
, but uses the processBlockContents method to do so.
|
virtual |
Directs the builder to create output for the contents of the single block
. If calling this method directly, an invalid QTextFrame::iterator may be used.
|
virtual |
Directs the builder to create output for the single textBlockGroup
. If calling this method directly, an invalid QTextFrame::iterator may be used.
The block block
is the first block in the textBlockGroup
.
|
virtual |
Directs the builder to create output for the contents of the single textObject
. The textObject
is represented in the QTextDocument with the QTextFragment fragment
.
If calling this method directly, an invalid QTextBlock::iterator may be used.
|
protectedvirtual |
Directs the builder to close the appropriate tags at the position of it
.
|
virtual |
Hook for instructing the builder to create output for the fragemnt
with a custom type. doc
is the document the fragment is in.
|
virtual |
Constructs the output by directing the builder to create the markup.
|
protected |
Processes the document between begin
and end
|
virtual |
Directs the builder to create output for the contents of the single fragment
. If calling this method directly, an invalid QTextBlock::iterator may be used. doc
is the document the fragment is in.
|
virtual |
Directs the builder to create output for the single frame
. If calling this method directly, an invalid QTextFrame::iterator may be used.
|
virtual |
Directs the builder to create output for the image represented by the imageFormat
.
If calling this method directly, an invalid QTextBlock::iterator may be used. doc
is the document the fragment is in.
|
virtual |
Directs the builder to create output for the single textList
. If calling this method directly, an invalid QTextFrame::iterator may be used.
The block block
is the first block in the textList
.
|
virtual |
Directs the builder to create output for the single textObject
. If calling this method directly, an invalid QTextFrame::iterator may be used.
The block block
is the container of the textObject
.
|
protectedvirtual |
Directs the builder to open the appropriate tags at the position of it
.
|
virtual |
Directs the builder to create output for the contents of the single table
.
If calling this method directly, an invalid QTextFrame::iterator may be used.
|
virtual |
Directs the builder to create output for the contents of the single tableCell
. The tableCell is in the table
.
|
protected |
Iterates the iterator it
to the first block after blockGroup
. _block
is any block in the blockGroup
.
The return pair is the iterator pointing after the end of blockGroup
and the first block after blockGroup
.
|
protected |
Returns a list of tags contained in openingTags
sorted so they can be opened in order and will be closed in the correct order.
openingTags
should be a set of tags opened at the fragment pointed to by it
.
|
protected |
The builder this MarkupDirector is operating on. This is available when subclassing to customize behaviour.
Definition at line 297 of file markupdirector.h.