Builder to create BBCode from a QTextDocument.
More...
#include <bbcodebuilder.h>
|
| | BBCodeBuilder () |
| |
| void | addNewline () override |
| |
| void | appendLiteralText (const QString &text) override |
| |
| void | beginAnchor (const QString &href={}, const QString &name={}) override |
| |
| void | beginEmph () override |
| |
| void | beginFontPointSize (int size) override |
| |
| void | beginForeground (const QBrush &brush) override |
| |
| void | beginList (QTextListFormat::Style type) override |
| |
| void | beginListItem () override |
| |
| void | beginParagraph (Qt::Alignment a=Qt::AlignLeft, qreal top=0.0, qreal bottom=0.0, qreal left=0.0, qreal right=0.0) override |
| |
| void | beginStrikeout () override |
| |
| void | beginStrong () override |
| |
| void | beginSubscript () override |
| |
| void | beginSuperscript () override |
| |
| void | beginTable (qreal, qreal, const QString &) override |
| |
| void | beginTableRow () override |
| |
| void | beginUnderline () override |
| |
| void | endAnchor () override |
| |
| void | endEmph () override |
| |
| void | endFontPointSize () override |
| |
| void | endForeground () override |
| |
| void | endList () override |
| |
| void | endParagraph () override |
| |
| void | endStrikeout () override |
| |
| void | endStrong () override |
| |
| void | endSubscript () override |
| |
| void | endSuperscript () override |
| |
| void | endUnderline () override |
| |
| const QString | escape (const QString &text) const |
| |
| QString | getResult () override |
| |
| void | insertImage (const QString &src, qreal width, qreal height) override |
| |
| 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 |
| |
Definition at line 32 of file bbcodebuilder.h.
◆ BBCodeBuilder()
| Grantlee::BBCodeBuilder::BBCodeBuilder |
( |
| ) |
|
◆ addNewline()
| void Grantlee::BBCodeBuilder::addNewline |
( |
| ) |
|
|
overridevirtual |
◆ appendLiteralText()
| void Grantlee::BBCodeBuilder::appendLiteralText |
( |
const QString & |
text | ) |
|
|
overridevirtual |
◆ beginAnchor()
| void Grantlee::BBCodeBuilder::beginAnchor |
( |
const QString & |
href = {}, |
|
|
const QString & |
name = {} |
|
) |
| |
|
overridevirtual |
◆ beginEmph()
| void Grantlee::BBCodeBuilder::beginEmph |
( |
| ) |
|
|
overridevirtual |
◆ beginFontPointSize()
| void Grantlee::BBCodeBuilder::beginFontPointSize |
( |
int |
size | ) |
|
|
overridevirtual |
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.
◆ beginForeground()
| void Grantlee::BBCodeBuilder::beginForeground |
( |
const QBrush & |
brush | ) |
|
|
overridevirtual |
◆ beginList()
| void Grantlee::BBCodeBuilder::beginList |
( |
QTextListFormat::Style |
style | ) |
|
|
overridevirtual |
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.
◆ beginListItem()
| void Grantlee::BBCodeBuilder::beginListItem |
( |
| ) |
|
|
overridevirtual |
◆ beginParagraph()
| 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 |
|
) |
| |
|
overridevirtual |
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.
◆ beginStrikeout()
| void Grantlee::BBCodeBuilder::beginStrikeout |
( |
| ) |
|
|
overridevirtual |
◆ beginStrong()
| void Grantlee::BBCodeBuilder::beginStrong |
( |
| ) |
|
|
overridevirtual |
◆ beginSubscript()
| void Grantlee::BBCodeBuilder::beginSubscript |
( |
| ) |
|
|
overridevirtual |
◆ beginSuperscript()
| void Grantlee::BBCodeBuilder::beginSuperscript |
( |
| ) |
|
|
overridevirtual |
◆ beginTable()
| void Grantlee::BBCodeBuilder::beginTable |
( |
qreal |
cellpadding, |
|
|
qreal |
cellspacing, |
|
|
const QString & |
width |
|
) |
| |
|
overridevirtual |
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.
◆ beginTableRow()
| void Grantlee::BBCodeBuilder::beginTableRow |
( |
| ) |
|
|
overridevirtual |
◆ beginUnderline()
| void Grantlee::BBCodeBuilder::beginUnderline |
( |
| ) |
|
|
overridevirtual |
◆ endAnchor()
| void Grantlee::BBCodeBuilder::endAnchor |
( |
| ) |
|
|
overridevirtual |
◆ endEmph()
| void Grantlee::BBCodeBuilder::endEmph |
( |
| ) |
|
|
overridevirtual |
◆ endFontPointSize()
| void Grantlee::BBCodeBuilder::endFontPointSize |
( |
| ) |
|
|
overridevirtual |
◆ endForeground()
| void Grantlee::BBCodeBuilder::endForeground |
( |
| ) |
|
|
overridevirtual |
◆ endList()
| void Grantlee::BBCodeBuilder::endList |
( |
| ) |
|
|
overridevirtual |
◆ endParagraph()
| void Grantlee::BBCodeBuilder::endParagraph |
( |
| ) |
|
|
overridevirtual |
◆ endStrikeout()
| void Grantlee::BBCodeBuilder::endStrikeout |
( |
| ) |
|
|
overridevirtual |
◆ endStrong()
| void Grantlee::BBCodeBuilder::endStrong |
( |
| ) |
|
|
overridevirtual |
◆ endSubscript()
| void Grantlee::BBCodeBuilder::endSubscript |
( |
| ) |
|
|
overridevirtual |
◆ endSuperscript()
| void Grantlee::BBCodeBuilder::endSuperscript |
( |
| ) |
|
|
overridevirtual |
◆ endUnderline()
| void Grantlee::BBCodeBuilder::endUnderline |
( |
| ) |
|
|
overridevirtual |
◆ escape()
| const QString Grantlee::BBCodeBuilder::escape |
( |
const QString & |
text | ) |
const |
Escapes text appropriately for BBCode.
◆ getResult()
| QString Grantlee::BBCodeBuilder::getResult |
( |
| ) |
|
|
overridevirtual |
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.
◆ insertImage()
| void Grantlee::BBCodeBuilder::insertImage |
( |
const QString & |
url, |
|
|
qreal |
width, |
|
|
qreal |
height |
|
) |
| |
|
overridevirtual |
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.