The PlainTextHTMLMarkupBuilder creates a simple marked up plain text document. More...

#include <grantlee/plaintextmarkupbuilder.h>

Inheritance diagram for Grantlee::PlainTextMarkupBuilder:

Public Member Functions
	PlainTextMarkupBuilder ()
void	addNewline () override
int	addReference (const QString &reference)
void	appendLiteralText (const QString &text) override
void	appendRawText (const QString &text) override
void	beginAnchor (const QString &href=QString(), const QString &name=QString()) override
void	beginBackground (const QBrush &brush) override
void	beginEmph () override
void	beginFontFamily (const QString &family) override
void	beginFontPointSize (int size) override
void	beginForeground (const QBrush &brush) override
void	beginHeader (int level) override
void	beginList (QTextListFormat::Style style) 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 cellpadding, qreal cellspacing, const QString &width) override
void	beginTableCell (const QString &width, int colSpan, int rowSpan) override
void	beginTableHeaderCell (const QString &width, int colSpan, int rowSpan) override
void	beginTableRow () override
void	beginUnderline () override
void	endAnchor () override
void	endBackground () override
void	endEmph () override
void	endFontFamily () override
void	endFontPointSize () override
void	endForeground () override
void	endHeader (int level) override
void	endList () override
void	endListItem () override
void	endParagraph () override
void	endStrikeout () override
void	endStrong () override
void	endSubscript () override
void	endSuperscript () override
void	endTable () override
void	endTableCell () override
void	endTableHeaderCell () override
void	endTableRow () override
void	endUnderline () override
QString	getResult () override
void	insertHorizontalRule (int width=-1) override
void	insertImage (const QString &src, qreal width, qreal height) override

Detailed Description

This class creates a simple plain text markup.

Text that may be represented as

    A paragraph with <b>bold</b> text, <i>italic</i> text, and <u>underlined</u>
  text.

would be output as

    A paragraph with *bold* text /italic/ text, and _underlined_ text.

The markup is intended to be simple, plain and easily human readable. No markup is created for different font-familiy, font-size, foreground or background colors.

Lists are marked up by preceding the list element with '*' for disc, 'o' for circle, 'X' for square, or a letter or number. Lists are also indented if nested. eg:

    A. One
    B. Two
      o Three
      o Four
        \* Five
        \* Six
    C. Seven

External references such as external urls and images are represented in the body text as a reference, and references are maintained at the bottom of the output.

Eg,

    Here is a link to <a href="http://www.kde.org">KDE</a> and the <a
  href="http://pim.kde.org">KDEPIM project</a>.

becomes:

    Here is a link to KDE[1], and the KDEPIM project[2].

    ---- References ----
    [1] http://www.kde.org
    [2] http://pim.kde.org

Author:: Stephen Kelly <steveire@gmail.com>

Definition at line 104 of file plaintextmarkupbuilder.h.

Constructor & Destructor Documentation

Grantlee::PlainTextMarkupBuilder::PlainTextMarkupBuilder ( )

Construct a new PlainTextHTMLMarkupBuilder.

Member Function Documentation

void Grantlee::PlainTextMarkupBuilder::addNewline ( ) [override, virtual]

Add a newline to the markup.

Implements Grantlee::AbstractMarkupBuilder.

int Grantlee::PlainTextMarkupBuilder::addReference ( const QString & reference )

Adds a reference to reference to the internal list of references in the document.

void Grantlee::PlainTextMarkupBuilder::appendLiteralText ( const QString & text ) [override, virtual]

Append the plain text text to the markup.

Parameters:

text	The text to append.

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::PlainTextMarkupBuilder::appendRawText ( const QString & text ) [override, virtual]

Appends the raw text text to the markup. text is added unescaped.

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::PlainTextMarkupBuilder::beginAnchor	(	const QString &	href = `QString()`,
		const QString &	name = `QString()`
	)		`[override, virtual]`

Begin a url anchor element in the markup

Parameters:

href	The href of the anchor.
name	The name of the anchor.

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::PlainTextMarkupBuilder::beginBackground ( const QBrush & brush ) [override, virtual]

Begin a decorarated background element in the markup (A text background color) using brush

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::PlainTextMarkupBuilder::beginEmph ( ) [override, virtual]

Begin an emphasised element in the markup

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::PlainTextMarkupBuilder::beginFontFamily ( const QString & family ) [override, virtual]

Begin a new font familiy element in the markup

Parameters:

family The name of the font family to begin.

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::PlainTextMarkupBuilder::beginFontPointSize ( int size ) [override, virtual]

Begin a new font point size element in the markup

Parameters:

size	The point size to begin.

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::PlainTextMarkupBuilder::beginForeground ( const QBrush & brush ) [override, virtual]

Begin a decorarated foreground element in the markup (A text color) using brush

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::PlainTextMarkupBuilder::beginHeader ( int level ) [override, virtual]

Begin a level level header.

Parameters:

level An integer between 1 and 6

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::PlainTextMarkupBuilder::beginList ( QTextListFormat::Style style ) [override, 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::PlainTextMarkupBuilder::beginListItem ( ) [override, virtual]

Begin a new list item in the markup

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::PlainTextMarkupBuilder::beginParagraph	(	Qt::Alignment	a = `Qt::AlignLeft`,
		qreal	top = `0.0`,
		qreal	bottom = `0.0`,
		qreal	left = `0.0`,
		qreal	right = `0.0`
	)		`[override, 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::PlainTextMarkupBuilder::beginStrikeout ( ) [override, virtual]

Begin a struck out element in the markup

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::PlainTextMarkupBuilder::beginStrong ( ) [override, virtual]

Begin a bold element in the markup

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::PlainTextMarkupBuilder::beginSubscript ( ) [override, virtual]

Begin a subscript element

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::PlainTextMarkupBuilder::beginSuperscript ( ) [override, virtual]

Begin a superscript element

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::PlainTextMarkupBuilder::beginTable	(	qreal	cellpadding,
		qreal	cellspacing,
		const QString &	width
	)		`[override, 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::PlainTextMarkupBuilder::beginTableCell	(	const QString &	width,
		int	colSpan,
		int	rowSpan
	)		`[override, virtual]`

Begin a new table cell.

Parameters:

width	The width of the cell.
colSpan	The column span of the cell.
rowSpan	The row span of the cell.

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::PlainTextMarkupBuilder::beginTableHeaderCell	(	const QString &	width,
		int	colSpan,
		int	rowSpan
	)		`[override, virtual]`

Begin a new table header cell.

Parameters:

width	The width of the cell.
colSpan	The column span of the cell.
rowSpan	The row span of the cell.

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::PlainTextMarkupBuilder::beginTableRow ( ) [override, virtual]

Begins a new table row.

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::PlainTextMarkupBuilder::beginUnderline ( ) [override, virtual]

Begin an underlined element in the markup

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::PlainTextMarkupBuilder::endAnchor ( ) [override, virtual]

Close the anchor element

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::PlainTextMarkupBuilder::endBackground ( ) [override, virtual]

Close the decorarated background element in the markup

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::PlainTextMarkupBuilder::endEmph ( ) [override, virtual]

Close the emphasised element in the markup

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::PlainTextMarkupBuilder::endFontFamily ( ) [override, virtual]

End font family element

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::PlainTextMarkupBuilder::endFontPointSize ( ) [override, virtual]

End font point size element

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::PlainTextMarkupBuilder::endForeground ( ) [override, virtual]

Close the decorarated foreground element in the markup

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::PlainTextMarkupBuilder::endHeader ( int level ) [override, virtual]

End a level level header.

Parameters:

level An integer between 1 and 6

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::PlainTextMarkupBuilder::endList ( ) [override, virtual]

Close the list.

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::PlainTextMarkupBuilder::endListItem ( ) [override, virtual]

End the list item

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::PlainTextMarkupBuilder::endParagraph ( ) [override, virtual]

Close the paragraph in the markup.

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::PlainTextMarkupBuilder::endStrikeout ( ) [override, virtual]

Close the struck out element in the markup

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::PlainTextMarkupBuilder::endStrong ( ) [override, virtual]

Close the bold element in the markup

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::PlainTextMarkupBuilder::endSubscript ( ) [override, virtual]

End subscript element

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::PlainTextMarkupBuilder::endSuperscript ( ) [override, virtual]

End superscript element

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::PlainTextMarkupBuilder::endTable ( ) [override, virtual]

End a table element

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::PlainTextMarkupBuilder::endTableCell ( ) [override, virtual]

End a table cell

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::PlainTextMarkupBuilder::endTableHeaderCell ( ) [override, virtual]

End a table header cell

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::PlainTextMarkupBuilder::endTableRow ( ) [override, virtual]

End a table row

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::PlainTextMarkupBuilder::endUnderline ( ) [override, virtual]

Close the underlined element in the markup

Implements Grantlee::AbstractMarkupBuilder.

QString Grantlee::PlainTextMarkupBuilder::getResult ( ) [override, virtual]

Returns the finalised plain text markup, including references at the end.

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::PlainTextMarkupBuilder::insertHorizontalRule ( int width = -1 ) [override, virtual]

Insert a horizontal rule into the markup.

Parameters:

width The width of the rule. Default is full width.

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::PlainTextMarkupBuilder::insertImage	(	const QString &	url,
		qreal	width,
		qreal	height
	)		`[override, 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.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation