Grantlee
0.4.0
|
The AbstractMarkupBuilder class serves as a base class for creating marked up plain text output. More...
#include <grantlee/abstractmarkupbuilder.h>
Public Member Functions | |
virtual | ~AbstractMarkupBuilder () |
virtual void | addNewline ()=0 |
virtual void | appendLiteralText (const QString &text)=0 |
virtual void | appendRawText (const QString &text)=0 |
virtual void | beginAnchor (const QString &href=QString(), const QString &name=QString())=0 |
virtual void | beginBackground (const QBrush &brush)=0 |
virtual void | beginEmph ()=0 |
virtual void | beginFontFamily (const QString &family)=0 |
virtual void | beginFontPointSize (int size)=0 |
virtual void | beginForeground (const QBrush &brush)=0 |
virtual void | beginHeader (int level)=0 |
virtual void | beginList (QTextListFormat::Style style)=0 |
virtual void | beginListItem ()=0 |
virtual void | beginParagraph (Qt::Alignment a=Qt::AlignLeft, qreal top=0.0, qreal bottom=0.0, qreal left=0.0, qreal right=0.0)=0 |
virtual void | beginStrikeout ()=0 |
virtual void | beginStrong ()=0 |
virtual void | beginSubscript ()=0 |
virtual void | beginSuperscript ()=0 |
virtual void | beginTable (qreal cellpadding, qreal cellspacing, const QString &width)=0 |
virtual void | beginTableCell (const QString &width, int colSpan, int rowSpan)=0 |
virtual void | beginTableHeaderCell (const QString &width, int colSpan, int rowSpan)=0 |
virtual void | beginTableRow ()=0 |
virtual void | beginUnderline ()=0 |
virtual void | endAnchor ()=0 |
virtual void | endBackground ()=0 |
virtual void | endEmph ()=0 |
virtual void | endFontFamily ()=0 |
virtual void | endFontPointSize ()=0 |
virtual void | endForeground ()=0 |
virtual void | endHeader (int level)=0 |
virtual void | endList ()=0 |
virtual void | endListItem ()=0 |
virtual void | endParagraph ()=0 |
virtual void | endStrikeout ()=0 |
virtual void | endStrong ()=0 |
virtual void | endSubscript ()=0 |
virtual void | endSuperscript ()=0 |
virtual void | endTable ()=0 |
virtual void | endTableCell ()=0 |
virtual void | endTableHeaderCell ()=0 |
virtual void | endTableRow ()=0 |
virtual void | endUnderline ()=0 |
virtual QString | getResult ()=0 |
virtual void | insertHorizontalRule (int width=-1)=0 |
virtual void | insertImage (const QString &url, qreal width, qreal height)=0 |
The AbstractMarkupBuilder is used by a MarkupDirector to create marked up output such as html or markdown.
See PlainTextMarkupBuilder and TextHTMLBuilder for example implementations.
This interface can be extended to handle custom format types in a QTextDocument.
Definition at line 49 of file abstractmarkupbuilder.h.
virtual Grantlee::AbstractMarkupBuilder::~AbstractMarkupBuilder | ( | ) | [inline, virtual] |
Destructor
Definition at line 53 of file abstractmarkupbuilder.h.
virtual void Grantlee::AbstractMarkupBuilder::addNewline | ( | ) | [pure virtual] |
Add a newline to the markup.
Implemented in Grantlee::TextHTMLBuilder, Grantlee::PlainTextMarkupBuilder, Grantlee::BBCodeBuilder, and Grantlee::MediaWikiMarkupBuilder.
virtual void Grantlee::AbstractMarkupBuilder::appendLiteralText | ( | const QString & | text | ) | [pure virtual] |
Append the plain text text
to the markup.
text | The text to append. |
Implemented in Grantlee::TextHTMLBuilder, Grantlee::PlainTextMarkupBuilder, Grantlee::BBCodeBuilder, and Grantlee::MediaWikiMarkupBuilder.
virtual void Grantlee::AbstractMarkupBuilder::appendRawText | ( | const QString & | text | ) | [pure virtual] |
Appends the raw text text
to the markup. text
is added unescaped.
Implemented in Grantlee::TextHTMLBuilder, and Grantlee::PlainTextMarkupBuilder.
virtual void Grantlee::AbstractMarkupBuilder::beginAnchor | ( | const QString & | href = QString() , |
const QString & | name = QString() |
||
) | [pure virtual] |
Begin a url anchor element in the markup
href | The href of the anchor. |
name | The name of the anchor. |
Implemented in Grantlee::PlainTextMarkupBuilder, Grantlee::TextHTMLBuilder, Grantlee::BBCodeBuilder, and Grantlee::MediaWikiMarkupBuilder.
virtual void Grantlee::AbstractMarkupBuilder::beginBackground | ( | const QBrush & | brush | ) | [pure virtual] |
Begin a decorarated background element in the markup (A text background color) using brush
Implemented in Grantlee::PlainTextMarkupBuilder, and Grantlee::TextHTMLBuilder.
virtual void Grantlee::AbstractMarkupBuilder::beginEmph | ( | ) | [pure virtual] |
Begin an emphasised element in the markup
Implemented in Grantlee::PlainTextMarkupBuilder, Grantlee::TextHTMLBuilder, Grantlee::BBCodeBuilder, and Grantlee::MediaWikiMarkupBuilder.
virtual void Grantlee::AbstractMarkupBuilder::beginFontFamily | ( | const QString & | family | ) | [pure virtual] |
Begin a new font familiy element in the markup
family | The name of the font family to begin. |
Implemented in Grantlee::PlainTextMarkupBuilder, and Grantlee::TextHTMLBuilder.
virtual void Grantlee::AbstractMarkupBuilder::beginFontPointSize | ( | int | size | ) | [pure virtual] |
Begin a new font point size element in the markup
size | The point size to begin. |
Implemented in Grantlee::PlainTextMarkupBuilder, Grantlee::TextHTMLBuilder, and Grantlee::BBCodeBuilder.
virtual void Grantlee::AbstractMarkupBuilder::beginForeground | ( | const QBrush & | brush | ) | [pure virtual] |
Begin a decorarated foreground element in the markup (A text color) using brush
Implemented in Grantlee::PlainTextMarkupBuilder, Grantlee::TextHTMLBuilder, and Grantlee::BBCodeBuilder.
virtual void Grantlee::AbstractMarkupBuilder::beginHeader | ( | int | level | ) | [pure virtual] |
Begin a level level
header.
level | An integer between 1 and 6 |
Implemented in Grantlee::PlainTextMarkupBuilder, Grantlee::TextHTMLBuilder, and Grantlee::MediaWikiMarkupBuilder.
virtual void Grantlee::AbstractMarkupBuilder::beginList | ( | QTextListFormat::Style | style | ) | [pure virtual] |
Begin a new list element in the markup. A list element contains list items, and may contain other lists.
style | The style of list to create. |
Implemented in Grantlee::TextHTMLBuilder, Grantlee::PlainTextMarkupBuilder, Grantlee::BBCodeBuilder, and Grantlee::MediaWikiMarkupBuilder.
virtual void Grantlee::AbstractMarkupBuilder::beginListItem | ( | ) | [pure virtual] |
Begin a new list item in the markup
Implemented in Grantlee::TextHTMLBuilder, Grantlee::PlainTextMarkupBuilder, Grantlee::BBCodeBuilder, and Grantlee::MediaWikiMarkupBuilder.
virtual void Grantlee::AbstractMarkupBuilder::beginParagraph | ( | Qt::Alignment | a = Qt::AlignLeft , |
qreal | top = 0.0 , |
||
qreal | bottom = 0.0 , |
||
qreal | left = 0.0 , |
||
qreal | right = 0.0 |
||
) | [pure virtual] |
Begin a new paragraph in the markup
a | The alignment of the new paragraph. |
top | The top margin of the new paragraph. |
bottom | The bottom margin of the new paragraph. |
left | The left margin of the new paragraph. |
right | The right margin of the new paragraph. |
Implemented in Grantlee::TextHTMLBuilder, Grantlee::PlainTextMarkupBuilder, and Grantlee::BBCodeBuilder.
virtual void Grantlee::AbstractMarkupBuilder::beginStrikeout | ( | ) | [pure virtual] |
Begin a struck out element in the markup
Implemented in Grantlee::PlainTextMarkupBuilder, Grantlee::TextHTMLBuilder, Grantlee::BBCodeBuilder, and Grantlee::MediaWikiMarkupBuilder.
virtual void Grantlee::AbstractMarkupBuilder::beginStrong | ( | ) | [pure virtual] |
Begin a bold element in the markup
Implemented in Grantlee::PlainTextMarkupBuilder, Grantlee::TextHTMLBuilder, Grantlee::BBCodeBuilder, and Grantlee::MediaWikiMarkupBuilder.
virtual void Grantlee::AbstractMarkupBuilder::beginSubscript | ( | ) | [pure virtual] |
Begin a subscript element
Implemented in Grantlee::TextHTMLBuilder, Grantlee::PlainTextMarkupBuilder, and Grantlee::BBCodeBuilder.
virtual void Grantlee::AbstractMarkupBuilder::beginSuperscript | ( | ) | [pure virtual] |
Begin a superscript element
Implemented in Grantlee::TextHTMLBuilder, Grantlee::PlainTextMarkupBuilder, and Grantlee::BBCodeBuilder.
virtual void Grantlee::AbstractMarkupBuilder::beginTable | ( | qreal | cellpadding, |
qreal | cellspacing, | ||
const QString & | width | ||
) | [pure virtual] |
Begin a table element.
cellpadding | The padding attribute for the table. |
cellspacing | The spacing attribute for the table. |
width | The width of the table. May be either an integer, or a percentage value. |
Implemented in Grantlee::TextHTMLBuilder, Grantlee::PlainTextMarkupBuilder, and Grantlee::BBCodeBuilder.
virtual void Grantlee::AbstractMarkupBuilder::beginTableCell | ( | const QString & | width, |
int | colSpan, | ||
int | rowSpan | ||
) | [pure virtual] |
Begin a new table cell.
width | The width of the cell. |
colSpan | The column span of the cell. |
rowSpan | The row span of the cell. |
Implemented in Grantlee::TextHTMLBuilder, and Grantlee::PlainTextMarkupBuilder.
virtual void Grantlee::AbstractMarkupBuilder::beginTableHeaderCell | ( | const QString & | width, |
int | colSpan, | ||
int | rowSpan | ||
) | [pure virtual] |
Begin a new table header cell.
width | The width of the cell. |
colSpan | The column span of the cell. |
rowSpan | The row span of the cell. |
Implemented in Grantlee::TextHTMLBuilder, and Grantlee::PlainTextMarkupBuilder.
virtual void Grantlee::AbstractMarkupBuilder::beginTableRow | ( | ) | [pure virtual] |
Begins a new table row.
Implemented in Grantlee::TextHTMLBuilder, Grantlee::PlainTextMarkupBuilder, and Grantlee::BBCodeBuilder.
virtual void Grantlee::AbstractMarkupBuilder::beginUnderline | ( | ) | [pure virtual] |
Begin an underlined element in the markup
Implemented in Grantlee::PlainTextMarkupBuilder, Grantlee::TextHTMLBuilder, Grantlee::BBCodeBuilder, and Grantlee::MediaWikiMarkupBuilder.
virtual void Grantlee::AbstractMarkupBuilder::endAnchor | ( | ) | [pure virtual] |
Close the anchor element
Implemented in Grantlee::PlainTextMarkupBuilder, Grantlee::TextHTMLBuilder, Grantlee::BBCodeBuilder, and Grantlee::MediaWikiMarkupBuilder.
virtual void Grantlee::AbstractMarkupBuilder::endBackground | ( | ) | [pure virtual] |
Close the decorarated background element in the markup
Implemented in Grantlee::PlainTextMarkupBuilder, and Grantlee::TextHTMLBuilder.
virtual void Grantlee::AbstractMarkupBuilder::endEmph | ( | ) | [pure virtual] |
Close the emphasised element in the markup
Implemented in Grantlee::PlainTextMarkupBuilder, Grantlee::TextHTMLBuilder, Grantlee::BBCodeBuilder, and Grantlee::MediaWikiMarkupBuilder.
virtual void Grantlee::AbstractMarkupBuilder::endFontFamily | ( | ) | [pure virtual] |
End font family element
Implemented in Grantlee::PlainTextMarkupBuilder, and Grantlee::TextHTMLBuilder.
virtual void Grantlee::AbstractMarkupBuilder::endFontPointSize | ( | ) | [pure virtual] |
End font point size element
Implemented in Grantlee::PlainTextMarkupBuilder, Grantlee::TextHTMLBuilder, and Grantlee::BBCodeBuilder.
virtual void Grantlee::AbstractMarkupBuilder::endForeground | ( | ) | [pure virtual] |
Close the decorarated foreground element in the markup
Implemented in Grantlee::PlainTextMarkupBuilder, Grantlee::TextHTMLBuilder, and Grantlee::BBCodeBuilder.
virtual void Grantlee::AbstractMarkupBuilder::endHeader | ( | int | level | ) | [pure virtual] |
End a level level
header.
level | An integer between 1 and 6 |
Implemented in Grantlee::PlainTextMarkupBuilder, Grantlee::TextHTMLBuilder, and Grantlee::MediaWikiMarkupBuilder.
virtual void Grantlee::AbstractMarkupBuilder::endList | ( | ) | [pure virtual] |
Close the list.
Implemented in Grantlee::TextHTMLBuilder, Grantlee::PlainTextMarkupBuilder, Grantlee::BBCodeBuilder, and Grantlee::MediaWikiMarkupBuilder.
virtual void Grantlee::AbstractMarkupBuilder::endListItem | ( | ) | [pure virtual] |
End the list item
Implemented in Grantlee::TextHTMLBuilder, Grantlee::PlainTextMarkupBuilder, and Grantlee::MediaWikiMarkupBuilder.
virtual void Grantlee::AbstractMarkupBuilder::endParagraph | ( | ) | [pure virtual] |
Close the paragraph in the markup.
Implemented in Grantlee::TextHTMLBuilder, Grantlee::PlainTextMarkupBuilder, Grantlee::BBCodeBuilder, and Grantlee::MediaWikiMarkupBuilder.
virtual void Grantlee::AbstractMarkupBuilder::endStrikeout | ( | ) | [pure virtual] |
Close the struck out element in the markup
Implemented in Grantlee::PlainTextMarkupBuilder, Grantlee::TextHTMLBuilder, Grantlee::BBCodeBuilder, and Grantlee::MediaWikiMarkupBuilder.
virtual void Grantlee::AbstractMarkupBuilder::endStrong | ( | ) | [pure virtual] |
Close the bold element in the markup
Implemented in Grantlee::PlainTextMarkupBuilder, Grantlee::TextHTMLBuilder, Grantlee::BBCodeBuilder, and Grantlee::MediaWikiMarkupBuilder.
virtual void Grantlee::AbstractMarkupBuilder::endSubscript | ( | ) | [pure virtual] |
End subscript element
Implemented in Grantlee::TextHTMLBuilder, Grantlee::PlainTextMarkupBuilder, and Grantlee::BBCodeBuilder.
virtual void Grantlee::AbstractMarkupBuilder::endSuperscript | ( | ) | [pure virtual] |
End superscript element
Implemented in Grantlee::TextHTMLBuilder, Grantlee::PlainTextMarkupBuilder, and Grantlee::BBCodeBuilder.
virtual void Grantlee::AbstractMarkupBuilder::endTable | ( | ) | [pure virtual] |
End a table element
Implemented in Grantlee::TextHTMLBuilder, and Grantlee::PlainTextMarkupBuilder.
virtual void Grantlee::AbstractMarkupBuilder::endTableCell | ( | ) | [pure virtual] |
End a table cell
Implemented in Grantlee::TextHTMLBuilder, and Grantlee::PlainTextMarkupBuilder.
virtual void Grantlee::AbstractMarkupBuilder::endTableHeaderCell | ( | ) | [pure virtual] |
End a table header cell
Implemented in Grantlee::TextHTMLBuilder, and Grantlee::PlainTextMarkupBuilder.
virtual void Grantlee::AbstractMarkupBuilder::endTableRow | ( | ) | [pure virtual] |
End a table row
Implemented in Grantlee::TextHTMLBuilder, and Grantlee::PlainTextMarkupBuilder.
virtual void Grantlee::AbstractMarkupBuilder::endUnderline | ( | ) | [pure virtual] |
Close the underlined element in the markup
Implemented in Grantlee::PlainTextMarkupBuilder, Grantlee::TextHTMLBuilder, Grantlee::BBCodeBuilder, and Grantlee::MediaWikiMarkupBuilder.
virtual QString Grantlee::AbstractMarkupBuilder::getResult | ( | ) | [pure virtual] |
Return the fully marked up result of the building process. This may contain metadata etc, such as a head element in html.
Implemented in Grantlee::TextHTMLBuilder, Grantlee::PlainTextMarkupBuilder, Grantlee::BBCodeBuilder, and Grantlee::MediaWikiMarkupBuilder.
virtual void Grantlee::AbstractMarkupBuilder::insertHorizontalRule | ( | int | width = -1 | ) | [pure virtual] |
Insert a horizontal rule into the markup.
width | The width of the rule. Default is full width. |
Implemented in Grantlee::TextHTMLBuilder, and Grantlee::PlainTextMarkupBuilder.
virtual void Grantlee::AbstractMarkupBuilder::insertImage | ( | const QString & | url, |
qreal | width, | ||
qreal | height | ||
) | [pure virtual] |
Insert a new image element into the markup.
url | The url of the image |
width | The width of the image |
height | The height of the image. |
Implemented in Grantlee::TextHTMLBuilder, Grantlee::PlainTextMarkupBuilder, and Grantlee::BBCodeBuilder.