Cutelee::MediaWikiMarkupBuilder Class Reference

Creates MediaWiki markup from a QTextDocument. More...

#include <mediawikimarkupbuilder.h>

Inheritance diagram for Cutelee::MediaWikiMarkupBuilder:

Public Member Functions
void	addNewline () override
void	appendLiteralText (const QString &text) override
void	beginAnchor (const QString &href={}, const QString &name={}) 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
Public Member Functions inherited from Cutelee::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

MediaWikiMarkupBuilder()

MediaWikiMarkupBuilder::MediaWikiMarkupBuilder

(

)

Definition at line 25 of file mediawikimarkupbuilder.cpp.

~MediaWikiMarkupBuilder()

MediaWikiMarkupBuilder::~MediaWikiMarkupBuilder ( )

override

Definition at line 27 of file mediawikimarkupbuilder.cpp.

Member Function Documentation

addNewline()

void MediaWikiMarkupBuilder::addNewline ( )

overridevirtual

Add a newline to the markup.

Implements Cutelee::AbstractMarkupBuilder.

Definition at line 63 of file mediawikimarkupbuilder.cpp.

appendLiteralText()

void MediaWikiMarkupBuilder::appendLiteralText ( const QString & text )

overridevirtual

Append the plain text text to the markup

Parameters

text	The text to append.

Implements Cutelee::AbstractMarkupBuilder.

Definition at line 169 of file mediawikimarkupbuilder.cpp.

References escape().

beginAnchor()

void MediaWikiMarkupBuilder::beginAnchor ( const QString & href = {}, const QString & name = {} )

overridevirtual

Begin a url anchor element in the markup

Parameters

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

Implements Cutelee::AbstractMarkupBuilder.

Definition at line 65 of file mediawikimarkupbuilder.cpp.

beginEmph()

void MediaWikiMarkupBuilder::beginEmph ( )

overridevirtual

Begin an emphasised element in the markup

Implements Cutelee::AbstractMarkupBuilder.

Definition at line 37 of file mediawikimarkupbuilder.cpp.

beginHeader()

void MediaWikiMarkupBuilder::beginHeader ( int level )

overridevirtual

Begin a level level header

Parameters

level

An integer between 1 and 6

Implements Cutelee::AbstractMarkupBuilder.

Definition at line 73 of file mediawikimarkupbuilder.cpp.

beginList()

void MediaWikiMarkupBuilder::beginList ( QTextListFormat::Style style )

overridevirtual

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 Cutelee::AbstractMarkupBuilder.

Definition at line 125 of file mediawikimarkupbuilder.cpp.

References QTextListFormat::ListCircle, QTextListFormat::ListDecimal, QTextListFormat::ListDisc, QTextListFormat::ListLowerAlpha, QTextListFormat::ListSquare, and QTextListFormat::ListUpperAlpha.

beginListItem()

void MediaWikiMarkupBuilder::beginListItem ( )

overridevirtual

Begin a new list item in the markup

Implements Cutelee::AbstractMarkupBuilder.

Definition at line 148 of file mediawikimarkupbuilder.cpp.

References QTextListFormat::ListCircle, QTextListFormat::ListDecimal, QTextListFormat::ListDisc, QTextListFormat::ListLowerAlpha, QTextListFormat::ListSquare, and QTextListFormat::ListUpperAlpha.

beginStrikeout()

void MediaWikiMarkupBuilder::beginStrikeout ( )

overridevirtual

Begin a struck out element in the markup

Implements Cutelee::AbstractMarkupBuilder.

Definition at line 50 of file mediawikimarkupbuilder.cpp.

beginStrong()

void MediaWikiMarkupBuilder::beginStrong ( )

overridevirtual

Begin a bold element in the markup

Implements Cutelee::AbstractMarkupBuilder.

Definition at line 29 of file mediawikimarkupbuilder.cpp.

beginUnderline()

void MediaWikiMarkupBuilder::beginUnderline ( )

overridevirtual

Begin an underlined element in the markup

Implements Cutelee::AbstractMarkupBuilder.

Definition at line 42 of file mediawikimarkupbuilder.cpp.

endAnchor()

void MediaWikiMarkupBuilder::endAnchor ( )

overridevirtual

Close the anchor element

Implements Cutelee::AbstractMarkupBuilder.

Definition at line 71 of file mediawikimarkupbuilder.cpp.

endEmph()

void MediaWikiMarkupBuilder::endEmph ( )

overridevirtual

Close the emphasised element in the markup

Implements Cutelee::AbstractMarkupBuilder.

Definition at line 41 of file mediawikimarkupbuilder.cpp.

endHeader()

void MediaWikiMarkupBuilder::endHeader ( int level )

overridevirtual

End a level level header

Parameters

level

An integer between 1 and 6

Implements Cutelee::AbstractMarkupBuilder.

Definition at line 99 of file mediawikimarkupbuilder.cpp.

endList()

void MediaWikiMarkupBuilder::endList ( )

overridevirtual

Close the list.

Implements Cutelee::AbstractMarkupBuilder.

Definition at line 142 of file mediawikimarkupbuilder.cpp.

endListItem()

void MediaWikiMarkupBuilder::endListItem ( )

overridevirtual

End the list item

Implements Cutelee::AbstractMarkupBuilder.

Definition at line 167 of file mediawikimarkupbuilder.cpp.

endParagraph()

void MediaWikiMarkupBuilder::endParagraph ( )

overridevirtual

Close the paragraph in the markup.

Implements Cutelee::AbstractMarkupBuilder.

Definition at line 59 of file mediawikimarkupbuilder.cpp.

endStrikeout()

void MediaWikiMarkupBuilder::endStrikeout ( )

overridevirtual

Close the struck out element in the markup

Implements Cutelee::AbstractMarkupBuilder.

Definition at line 54 of file mediawikimarkupbuilder.cpp.

endStrong()

void MediaWikiMarkupBuilder::endStrong ( )

overridevirtual

Close the bold element in the markup

Implements Cutelee::AbstractMarkupBuilder.

Definition at line 33 of file mediawikimarkupbuilder.cpp.

endUnderline()

void MediaWikiMarkupBuilder::endUnderline ( )

overridevirtual

Close the underlined element in the markup

Implements Cutelee::AbstractMarkupBuilder.

Definition at line 46 of file mediawikimarkupbuilder.cpp.

escape()

const QString MediaWikiMarkupBuilder::escape

(

const QString &

s

)

Escapes text appropriately for MediaWiki.

Definition at line 174 of file mediawikimarkupbuilder.cpp.

References QString::contains().

Referenced by appendLiteralText().

getResult()

QString MediaWikiMarkupBuilder::getResult ( )

overridevirtual

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 Cutelee::AbstractMarkupBuilder.

Definition at line 183 of file mediawikimarkupbuilder.cpp.

References QString::clear().