Cutelee
6.1.0
|
Builder to create BBCode from a QTextDocument. More...
#include <bbcodebuilder.h>
Public Member Functions | |
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::BBCodeBuilder | ( | ) |
Creates a new BBCodeBuilder.
Definition at line 25 of file bbcodebuilder.cpp.
|
overridevirtual |
Add a newline to the markup.
Implements Cutelee::AbstractMarkupBuilder.
Definition at line 94 of file bbcodebuilder.cpp.
|
overridevirtual |
Append the plain text text
to the markup
text | The text to append. |
Implements Cutelee::AbstractMarkupBuilder.
Definition at line 154 of file bbcodebuilder.cpp.
References escape().
|
overridevirtual |
Begin a url anchor element in the markup
href | The href of the anchor. |
name | The name of the anchor. |
Implements Cutelee::AbstractMarkupBuilder.
Definition at line 48 of file bbcodebuilder.cpp.
|
overridevirtual |
Begin an emphasised element in the markup
Implements Cutelee::AbstractMarkupBuilder.
Definition at line 31 of file bbcodebuilder.cpp.
|
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.
size | The size of font to begin. |
Implements Cutelee::AbstractMarkupBuilder.
Definition at line 57 of file bbcodebuilder.cpp.
|
overridevirtual |
Begin a decorarated foreground element in the markup (A text color) using brush
Implements Cutelee::AbstractMarkupBuilder.
Definition at line 37 of file bbcodebuilder.cpp.
|
overridevirtual |
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. |
Implements Cutelee::AbstractMarkupBuilder.
Definition at line 103 of file bbcodebuilder.cpp.
|
overridevirtual |
Begin a new list item in the markup
Implements Cutelee::AbstractMarkupBuilder.
Definition at line 128 of file bbcodebuilder.cpp.
|
overridevirtual |
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. |
Implements Cutelee::AbstractMarkupBuilder.
Definition at line 66 of file bbcodebuilder.cpp.
|
overridevirtual |
Begin a struck out element in the markup
Implements Cutelee::AbstractMarkupBuilder.
Definition at line 35 of file bbcodebuilder.cpp.
|
overridevirtual |
Begin a bold element in the markup
Implements Cutelee::AbstractMarkupBuilder.
Definition at line 29 of file bbcodebuilder.cpp.
|
overridevirtual |
Begin a subscript element
Implements Cutelee::AbstractMarkupBuilder.
Definition at line 140 of file bbcodebuilder.cpp.
|
overridevirtual |
Begin a superscript element
Implements Cutelee::AbstractMarkupBuilder.
Definition at line 130 of file bbcodebuilder.cpp.
|
overridevirtual |
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. |
Implements Cutelee::AbstractMarkupBuilder.
Definition at line 144 of file bbcodebuilder.cpp.
|
overridevirtual |
Begin a new table row
Implements Cutelee::AbstractMarkupBuilder.
Definition at line 149 of file bbcodebuilder.cpp.
|
overridevirtual |
Begin an underlined element in the markup
Implements Cutelee::AbstractMarkupBuilder.
Definition at line 33 of file bbcodebuilder.cpp.
|
overridevirtual |
Close the anchor element
Implements Cutelee::AbstractMarkupBuilder.
Definition at line 53 of file bbcodebuilder.cpp.
|
overridevirtual |
Close the emphasised element in the markup
Implements Cutelee::AbstractMarkupBuilder.
Definition at line 32 of file bbcodebuilder.cpp.
|
overridevirtual |
End font point size element
Implements Cutelee::AbstractMarkupBuilder.
Definition at line 61 of file bbcodebuilder.cpp.
|
overridevirtual |
Close the decorarated foreground element in the markup
Implements Cutelee::AbstractMarkupBuilder.
Definition at line 41 of file bbcodebuilder.cpp.
|
overridevirtual |
Close the list.
Implements Cutelee::AbstractMarkupBuilder.
Definition at line 126 of file bbcodebuilder.cpp.
|
overridevirtual |
Close the paragraph in the markup.
Implements Cutelee::AbstractMarkupBuilder.
Definition at line 82 of file bbcodebuilder.cpp.
|
overridevirtual |
Close the struck out element in the markup
Implements Cutelee::AbstractMarkupBuilder.
Definition at line 36 of file bbcodebuilder.cpp.
|
overridevirtual |
Close the bold element in the markup
Implements Cutelee::AbstractMarkupBuilder.
Definition at line 30 of file bbcodebuilder.cpp.
|
overridevirtual |
End subscript element
Implements Cutelee::AbstractMarkupBuilder.
Definition at line 142 of file bbcodebuilder.cpp.
|
overridevirtual |
End superscript element
Implements Cutelee::AbstractMarkupBuilder.
Definition at line 135 of file bbcodebuilder.cpp.
|
overridevirtual |
Close the underlined element in the markup
Implements Cutelee::AbstractMarkupBuilder.
Definition at line 34 of file bbcodebuilder.cpp.
Escapes text
appropriately for BBCode.
Definition at line 159 of file bbcodebuilder.cpp.
Referenced by appendLiteralText().
|
overridevirtual |
Return the fully marked up result of the building process.
This may contain metadata etc, such as a head element in html.
Implements Cutelee::AbstractMarkupBuilder.
Definition at line 167 of file bbcodebuilder.cpp.
|
overridevirtual |
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. |
Implements Cutelee::AbstractMarkupBuilder.
Definition at line 96 of file bbcodebuilder.cpp.