Builder to create BBCode from a QTextDocument.
#include <bbcodebuilder.h>
Public Member Functions |
| BBCodeBuilder () |
void | addNewline () |
void | appendLiteralText (const QString &text) |
void | beginAnchor (const QString &href=QString(), const QString &name=QString()) |
void | beginEmph () |
void | beginFontPointSize (int size) |
void | beginForeground (const QBrush &brush) |
void | beginList (QTextListFormat::Style type) |
void | beginListItem () |
void | beginParagraph (Qt::Alignment a=Qt::AlignLeft, qreal top=0.0, qreal bottom=0.0, qreal left=0.0, qreal right=0.0) |
void | beginStrikeout () |
void | beginStrong () |
void | beginSubscript () |
void | beginSuperscript () |
void | beginTable (qreal, qreal, const QString &) |
void | beginTableRow () |
void | beginUnderline () |
void | endAnchor () |
void | endEmph () |
void | endFontPointSize () |
void | endForeground () |
void | endList () |
void | endParagraph () |
void | endStrikeout () |
void | endStrong () |
void | endSubscript () |
void | endSuperscript () |
void | endUnderline () |
const QString | escape (const QString &text) const |
QString | getResult () |
void | insertImage (const QString &src, qreal width, qreal height) |
virtual | ~AbstractMarkupBuilder () |
virtual void | appendRawText (const QString &text)=0 |
virtual void | beginBackground (const QBrush &brush)=0 |
virtual void | beginFontFamily (const QString &family)=0 |
virtual void | beginHeader (int level)=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 | endBackground ()=0 |
virtual void | endFontFamily ()=0 |
virtual void | endHeader (int level)=0 |
virtual void | endListItem ()=0 |
virtual void | endTable ()=0 |
virtual void | endTableCell ()=0 |
virtual void | endTableHeaderCell ()=0 |
virtual void | endTableRow ()=0 |
virtual void | insertHorizontalRule (int width=-1)=0 |
Detailed Description
Definition at line 32 of file bbcodebuilder.h.
Constructor & Destructor Documentation
Grantlee::BBCodeBuilder::BBCodeBuilder |
( |
| ) |
|
Member Function Documentation
void Grantlee::BBCodeBuilder::addNewline |
( |
| ) |
|
|
virtual |
void Grantlee::BBCodeBuilder::appendLiteralText |
( |
const QString & |
text | ) |
|
|
virtual |
void Grantlee::BBCodeBuilder::beginAnchor |
( |
const QString & |
href = QString() , |
|
|
const QString & |
name = QString() |
|
) |
| |
|
virtual |
void Grantlee::BBCodeBuilder::beginEmph |
( |
| ) |
|
|
virtual |
void Grantlee::BBCodeBuilder::beginFontPointSize |
( |
int |
size | ) |
|
|
virtual |
Begin an element of font size size
. Note that this size is in pixels, and must be converted before it is suitable for use in BBCode.
- Parameters
-
size | The size of font to begin. |
Implements Grantlee::AbstractMarkupBuilder.
void Grantlee::BBCodeBuilder::beginForeground |
( |
const QBrush & |
brush | ) |
|
|
virtual |
void Grantlee::BBCodeBuilder::beginList |
( |
QTextListFormat::Style |
style | ) |
|
|
virtual |
Begin a new list element in the markup. A list element contains list items, and may contain other lists.
- Parameters
-
style | The style of list to create. |
Implements Grantlee::AbstractMarkupBuilder.
void Grantlee::BBCodeBuilder::beginListItem |
( |
| ) |
|
|
virtual |
void Grantlee::BBCodeBuilder::beginParagraph |
( |
Qt::Alignment |
a = Qt::AlignLeft , |
|
|
qreal |
top = 0.0 , |
|
|
qreal |
bottom = 0.0 , |
|
|
qreal |
left = 0.0 , |
|
|
qreal |
right = 0.0 |
|
) |
| |
|
virtual |
Begin a new paragraph in the markup
- Parameters
-
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. |
Implements Grantlee::AbstractMarkupBuilder.
void Grantlee::BBCodeBuilder::beginStrikeout |
( |
| ) |
|
|
virtual |
void Grantlee::BBCodeBuilder::beginStrong |
( |
| ) |
|
|
virtual |
void Grantlee::BBCodeBuilder::beginSubscript |
( |
| ) |
|
|
virtual |
void Grantlee::BBCodeBuilder::beginSuperscript |
( |
| ) |
|
|
virtual |
void Grantlee::BBCodeBuilder::beginTable |
( |
qreal |
cellpadding, |
|
|
qreal |
cellspacing, |
|
|
const QString & |
width |
|
) |
| |
|
virtual |
Begin a table element.
- Parameters
-
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. |
Implements Grantlee::AbstractMarkupBuilder.
void Grantlee::BBCodeBuilder::beginTableRow |
( |
| ) |
|
|
virtual |
void Grantlee::BBCodeBuilder::beginUnderline |
( |
| ) |
|
|
virtual |
void Grantlee::BBCodeBuilder::endAnchor |
( |
| ) |
|
|
virtual |
void Grantlee::BBCodeBuilder::endEmph |
( |
| ) |
|
|
virtual |
void Grantlee::BBCodeBuilder::endFontPointSize |
( |
| ) |
|
|
virtual |
void Grantlee::BBCodeBuilder::endForeground |
( |
| ) |
|
|
virtual |
void Grantlee::BBCodeBuilder::endList |
( |
| ) |
|
|
virtual |
void Grantlee::BBCodeBuilder::endParagraph |
( |
| ) |
|
|
virtual |
void Grantlee::BBCodeBuilder::endStrikeout |
( |
| ) |
|
|
virtual |
void Grantlee::BBCodeBuilder::endStrong |
( |
| ) |
|
|
virtual |
void Grantlee::BBCodeBuilder::endSubscript |
( |
| ) |
|
|
virtual |
void Grantlee::BBCodeBuilder::endSuperscript |
( |
| ) |
|
|
virtual |
void Grantlee::BBCodeBuilder::endUnderline |
( |
| ) |
|
|
virtual |
const QString Grantlee::BBCodeBuilder::escape |
( |
const QString & |
text | ) |
const |
Escapes text
appropriately for BBCode.
QString Grantlee::BBCodeBuilder::getResult |
( |
| ) |
|
|
virtual |
Return the fully marked up result of the building process. This may contain metadata etc, such as a head element in html.
- Returns
- The fully marked up text.
Implements Grantlee::AbstractMarkupBuilder.
void Grantlee::BBCodeBuilder::insertImage |
( |
const QString & |
url, |
|
|
qreal |
width, |
|
|
qreal |
height |
|
) |
| |
|
virtual |
Insert a new image element into the markup.
- Parameters
-
url | The url of the image |
width | The width of the image |
height | The height of the image. |
Implements Grantlee::AbstractMarkupBuilder.