Grantlee::MediaWikiMarkupBuilder Class Reference

Creates MediaWiki markup from a QTextDocument. More...

#include <mediawikimarkupbuilder.h>

Inheritance diagram for Grantlee::MediaWikiMarkupBuilder:

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 ()
Public Member Functions inherited from Grantlee::AbstractMarkupBuilder
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	beginFontPointSize (int size)=0
virtual void	beginForeground (const QBrush &brush)=0
virtual void	beginParagraph (Qt::Alignment a=Qt::AlignLeft, qreal top=0.0, qreal bottom=0.0, qreal left=0.0, qreal right=0.0)=0
virtual void	beginSubscript ()=0
virtual void	beginSuperscript ()=0
virtual void	beginTable (qreal cellpadding, qreal cellspacing, const QString &width)=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	beginTableRow ()=0
virtual void	endBackground ()=0
virtual void	endFontFamily ()=0
virtual void	endFontPointSize ()=0
virtual void	endForeground ()=0
virtual void	endSubscript ()=0
virtual void	endSuperscript ()=0
virtual void	endTable ()=0
virtual void	endTableCell ()=0
virtual void	endTableHeaderCell ()=0
virtual void	endTableRow ()=0
virtual void	insertHorizontalRule (int width=-1)=0
virtual void	insertImage (const QString &url, qreal width, qreal height)=0

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 ( )

virtual

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

text	The 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

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

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::MediaWikiMarkupBuilder::beginEmph ( )

virtual

Begin an emphasised element in the markup

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::MediaWikiMarkupBuilder::beginHeader ( int  level )

virtual

Begin a level level header.

Parameters

level

An 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

style

The style of list to create.

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::MediaWikiMarkupBuilder::beginListItem ( )

virtual

Begin a new list item in the markup

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::MediaWikiMarkupBuilder::beginStrikeout ( )

virtual

Begin a struck out element in the markup

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::MediaWikiMarkupBuilder::beginStrong ( )

virtual

Begin a bold element in the markup

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::MediaWikiMarkupBuilder::beginUnderline ( )

virtual

Begin an underlined element in the markup

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::MediaWikiMarkupBuilder::endAnchor ( )

virtual

Close the anchor element

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::MediaWikiMarkupBuilder::endEmph ( )

virtual

Close the emphasised element in the markup

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::MediaWikiMarkupBuilder::endHeader ( int  level )

virtual

End a level level header.

Parameters

level

An integer between 1 and 6

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::MediaWikiMarkupBuilder::endList ( )

virtual

Close the list.

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::MediaWikiMarkupBuilder::endListItem ( )

virtual

End the list item

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::MediaWikiMarkupBuilder::endParagraph ( )

virtual

Close the paragraph in the markup.

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::MediaWikiMarkupBuilder::endStrikeout ( )

virtual

Close the struck out element in the markup

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::MediaWikiMarkupBuilder::endStrong ( )

virtual

Close the bold element in the markup

Implements Grantlee::AbstractMarkupBuilder.

void Grantlee::MediaWikiMarkupBuilder::endUnderline ( )

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 ( )

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.