Grantlee::MediaWikiMarkupBuilder Class Reference

Creates MediaWiki markup from a QTextDocument.

#include <mediawikimarkupbuilder.h>

Inheritance diagram for Grantlee::MediaWikiMarkupBuilder:

List of all members.

Public Member Functions
	MediaWikiMarkupBuilder ()
void	addNewline () override
void	appendLiteralText (const QString &text) override
void	beginAnchor (const QString &href=QString(), const QString &name=QString()) override
void	beginEmph () override
void	beginHeader (int level) override
void	beginList (QTextListFormat::Style type) override
void	beginListItem () override
void	beginStrikeout () override
void	beginStrong () override
void	beginUnderline () override
void	endAnchor () override
void	endEmph () override
void	endHeader (int level) override
void	endList () override
void	endListItem () override
void	endParagraph () override
void	endStrikeout () override
void	endStrong () override
void	endUnderline () override
const QString	escape (const QString &s)
QString	getResult () override

---

Detailed Description

Definition at line 32 of file mediawikimarkupbuilder.h.

---

Constructor & Destructor Documentation

Grantlee::MediaWikiMarkupBuilder::MediaWikiMarkupBuilder

(

)

Creates a new MediaWikiMarkupBuilder

---

Member Function Documentation

void Grantlee::MediaWikiMarkupBuilder::addNewline

(

)

[override, virtual]

Add a newline to the markup.

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::MediaWikiMarkupBuilder::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::MediaWikiMarkupBuilder::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::MediaWikiMarkupBuilder::beginEmph

(

)

[override, virtual]

Begin an emphasised element in the markup

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::MediaWikiMarkupBuilder::beginHeader

(

int

level

)

[override, virtual]

Begin a level level header.

Parameters:

level

An integer between 1 and 6

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::MediaWikiMarkupBuilder::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::MediaWikiMarkupBuilder::beginListItem

(

)

[override, virtual]

Begin a new list item in the markup

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::MediaWikiMarkupBuilder::beginStrikeout

(

)

[override, virtual]

Begin a struck out element in the markup

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::MediaWikiMarkupBuilder::beginStrong

(

)

[override, virtual]

Begin a bold element in the markup

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::MediaWikiMarkupBuilder::beginUnderline

(

)

[override, virtual]

Begin an underlined element in the markup

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::MediaWikiMarkupBuilder::endAnchor

(

)

[override, virtual]

Close the anchor element

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::MediaWikiMarkupBuilder::endEmph

(

)

[override, virtual]

Close the emphasised element in the markup

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::MediaWikiMarkupBuilder::endHeader

(

int

level

)

[override, virtual]

End a level level header.

Parameters:

level

An integer between 1 and 6

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::MediaWikiMarkupBuilder::endList

(

)

[override, virtual]

Close the list.

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::MediaWikiMarkupBuilder::endListItem

(

)

[override, virtual]

End the list item

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::MediaWikiMarkupBuilder::endParagraph

(

)

[override, virtual]

Close the paragraph in the markup.

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::MediaWikiMarkupBuilder::endStrikeout

(

)

[override, virtual]

Close the struck out element in the markup

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::MediaWikiMarkupBuilder::endStrong

(

)

[override, virtual]

Close the bold element in the markup

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::MediaWikiMarkupBuilder::endUnderline

(

)

[override, virtual]

Close the underlined element in the markup

Implements Grantlee::AbstractMarkupBuilder.

const QString Grantlee::MediaWikiMarkupBuilder::escape

(

const QString &

s

)

Escapes text appropriately for MediaWiki.

QString Grantlee::MediaWikiMarkupBuilder::getResult

(

)

[override, 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.