Grantlee  0.2.0
Public Member Functions
Grantlee::MediaWikiMarkupBuilder Class Reference

Creates MediaWiki markup from a QTextDocument.

#include <mediawikimarkupbuilder.h>

Inheritance diagram for Grantlee::MediaWikiMarkupBuilder:
Inheritance graph
[legend]

List of all members.

Public Member Functions

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

Detailed Description

Definition at line 32 of file mediawikimarkupbuilder.h.


Constructor & Destructor Documentation

Creates a new MediaWikiMarkupBuilder


Member Function Documentation

Add a newline to the markup.

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::MediaWikiMarkupBuilder::appendLiteralText ( const QString &  text) [virtual]

Append the plain text text to the markup.

Parameters:
textThe text to append.

Implements Grantlee::AbstractMarkupBuilder.

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

Begin a url anchor element in the markup

Parameters:
hrefThe href of the anchor.
nameThe name of the anchor.

Implements Grantlee::AbstractMarkupBuilder.

Begin an emphasised element in the markup

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::MediaWikiMarkupBuilder::beginHeader ( int  level) [virtual]

Begin a level level header.

Parameters:
levelAn integer between 1 and 6

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::MediaWikiMarkupBuilder::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:
styleThe style of list to create.

Implements Grantlee::AbstractMarkupBuilder.

Begin a new list item in the markup

Implements Grantlee::AbstractMarkupBuilder.

Begin a struck out element in the markup

Implements Grantlee::AbstractMarkupBuilder.

Begin a bold element in the markup

Implements Grantlee::AbstractMarkupBuilder.

Begin an underlined element in the markup

Implements Grantlee::AbstractMarkupBuilder.

Close the anchor element

Implements Grantlee::AbstractMarkupBuilder.

Close the emphasised element in the markup

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::MediaWikiMarkupBuilder::endHeader ( int  level) [virtual]

End a level level header.

Parameters:
levelAn integer between 1 and 6

Implements Grantlee::AbstractMarkupBuilder.

Close the list.

Implements Grantlee::AbstractMarkupBuilder.

End the list item

Implements Grantlee::AbstractMarkupBuilder.

Close the paragraph in the markup.

Implements Grantlee::AbstractMarkupBuilder.

Close the struck out element in the markup

Implements Grantlee::AbstractMarkupBuilder.

Close the bold element in the markup

Implements Grantlee::AbstractMarkupBuilder.

Close the underlined element in the markup

Implements Grantlee::AbstractMarkupBuilder.

const QString Grantlee::MediaWikiMarkupBuilder::escape ( const QString &  s)

Escapes text appropriately for MediaWiki.

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.