Interface for creating marked-up text output. More...

#include <cutelee/abstractmarkupbuilder.h>

Inheritance diagram for Cutelee::AbstractMarkupBuilder:

[legend]

Public Member Functions
virtual	~AbstractMarkupBuilder ()

virtual void	addNewline ()=0

virtual void	appendLiteralText (const QString &text)=0

virtual void	appendRawText (const QString &text)=0

virtual void	beginAnchor (const QString &href={}, const QString &name={})=0

virtual void	beginBackground (const QBrush &brush)=0

virtual void	beginEmph ()=0

virtual void	beginFontFamily (const QString &family)=0

virtual void	beginFontPointSize (int size)=0

virtual void	beginForeground (const QBrush &brush)=0

virtual void	beginHeader (int level)=0

virtual void	beginList (QTextListFormat::Style style)=0

virtual void	beginListItem ()=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	beginStrikeout ()=0

virtual void	beginStrong ()=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	beginUnderline ()=0

virtual void	endAnchor ()=0

virtual void	endBackground ()=0

virtual void	endEmph ()=0

virtual void	endFontFamily ()=0

virtual void	endFontPointSize ()=0

virtual void	endForeground ()=0

virtual void	endHeader (int level)=0

virtual void	endList ()=0

virtual void	endListItem ()=0

virtual void	endParagraph ()=0

virtual void	endStrikeout ()=0

virtual void	endStrong ()=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	endUnderline ()=0

virtual QString	getResult ()=0

virtual void	insertHorizontalRule (int width=-1)=0

virtual void	insertImage (const QString &url, qreal width, qreal height)=0

Detailed Description

The AbstractMarkupBuilder is used by a MarkupDirector to create marked-up output such as html or markdown.

See PlainTextMarkupBuilder and TextHTMLBuilder for example implementations.

This interface can be extended to handle custom format types in a QTextDocument.

See also: Handling custom QTextObjects

Author: Stephen Kelly steve.nosp@m.ire@.nosp@m.gmail.nosp@m..com

Definition at line 51 of file abstractmarkupbuilder.h.

Constructor & Destructor Documentation

◆ ~AbstractMarkupBuilder()

virtual Cutelee::AbstractMarkupBuilder::~AbstractMarkupBuilder ( )

inlinevirtual

Destructor

Definition at line 55 of file abstractmarkupbuilder.h.

Member Function Documentation

◆ addNewline()

virtual void Cutelee::AbstractMarkupBuilder::addNewline ( )

pure virtual

Add a newline to the markup.

Implemented in Cutelee::TextHTMLBuilder, Cutelee::PlainTextMarkupBuilder, Cutelee::MediaWikiMarkupBuilder, and Cutelee::BBCodeBuilder.

Referenced by Cutelee::MarkupDirector::processBlockContents(), and Cutelee::MarkupDirector::processFragment().

◆ appendLiteralText()

virtual void Cutelee::AbstractMarkupBuilder::appendLiteralText ( const QString & text )

pure virtual

Append the plain text text to the markup

Parameters

text	The text to append.

Implemented in Cutelee::TextHTMLBuilder, Cutelee::PlainTextMarkupBuilder, Cutelee::MediaWikiMarkupBuilder, and Cutelee::BBCodeBuilder.

Referenced by Cutelee::MarkupDirector::processFragment().

◆ appendRawText()

virtual void Cutelee::AbstractMarkupBuilder::appendRawText ( const QString & text )

pure virtual

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

Implemented in Cutelee::TextHTMLBuilder, and Cutelee::PlainTextMarkupBuilder.

◆ beginAnchor()

virtual void Cutelee::AbstractMarkupBuilder::beginAnchor	(	const QString &	href = `{}`,
		const QString &	name = `{}`
	)

pure virtual

Begin a url anchor element in the markup

Parameters

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

Implemented in Cutelee::TextHTMLBuilder, Cutelee::PlainTextMarkupBuilder, Cutelee::MediaWikiMarkupBuilder, and Cutelee::BBCodeBuilder.

Referenced by Cutelee::MarkupDirector::processOpeningElements().

◆ beginBackground()

virtual void Cutelee::AbstractMarkupBuilder::beginBackground ( const QBrush & brush )

pure virtual

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

Implemented in Cutelee::TextHTMLBuilder, and Cutelee::PlainTextMarkupBuilder.

Referenced by Cutelee::MarkupDirector::processOpeningElements().

◆ beginEmph()

virtual void Cutelee::AbstractMarkupBuilder::beginEmph ( )

pure virtual

Begin an emphasised element in the markup

Implemented in Cutelee::TextHTMLBuilder, Cutelee::PlainTextMarkupBuilder, Cutelee::MediaWikiMarkupBuilder, and Cutelee::BBCodeBuilder.

Referenced by Cutelee::MarkupDirector::processOpeningElements().

◆ beginFontFamily()

virtual void Cutelee::AbstractMarkupBuilder::beginFontFamily ( const QString & family )

pure virtual

Begin a new font familiy element in the markup

Parameters

family The name of the font family to begin.

Implemented in Cutelee::TextHTMLBuilder, and Cutelee::PlainTextMarkupBuilder.

Referenced by Cutelee::MarkupDirector::processOpeningElements().

◆ beginFontPointSize()

virtual void Cutelee::AbstractMarkupBuilder::beginFontPointSize ( int size )

pure virtual

Begin a new font point size element in the markup

Parameters

size	The point size to begin.

Implemented in Cutelee::TextHTMLBuilder, Cutelee::PlainTextMarkupBuilder, and Cutelee::BBCodeBuilder.

Referenced by Cutelee::MarkupDirector::processOpeningElements().

◆ beginForeground()

virtual void Cutelee::AbstractMarkupBuilder::beginForeground ( const QBrush & brush )

pure virtual

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

Implemented in Cutelee::TextHTMLBuilder, Cutelee::PlainTextMarkupBuilder, and Cutelee::BBCodeBuilder.

Referenced by Cutelee::MarkupDirector::processOpeningElements().

◆ beginHeader()

virtual void Cutelee::AbstractMarkupBuilder::beginHeader ( int level )

pure virtual

Begin a level level header

Parameters

level An integer between 1 and 6

Implemented in Cutelee::TextHTMLBuilder, Cutelee::PlainTextMarkupBuilder, and Cutelee::MediaWikiMarkupBuilder.

◆ beginList()

virtual void Cutelee::AbstractMarkupBuilder::beginList ( QTextListFormat::Style style )

pure 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.

Implemented in Cutelee::TextHTMLBuilder, Cutelee::MediaWikiMarkupBuilder, Cutelee::BBCodeBuilder, and Cutelee::PlainTextMarkupBuilder.

Referenced by Cutelee::MarkupDirector::processList().

◆ beginListItem()

virtual void Cutelee::AbstractMarkupBuilder::beginListItem ( )

pure virtual

Begin a new list item in the markup

Implemented in Cutelee::TextHTMLBuilder, Cutelee::PlainTextMarkupBuilder, Cutelee::MediaWikiMarkupBuilder, and Cutelee::BBCodeBuilder.

Referenced by Cutelee::MarkupDirector::processList().

◆ beginParagraph()

virtual void Cutelee::AbstractMarkupBuilder::beginParagraph	(	Qt::Alignment	a = `Qt::AlignLeft`,
		qreal	top = `0.0`,
		qreal	bottom = `0.0`,
		qreal	left = `0.0`,
		qreal	right = `0.0`
	)

pure 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.

Implemented in Cutelee::TextHTMLBuilder, Cutelee::PlainTextMarkupBuilder, and Cutelee::BBCodeBuilder.

Referenced by Cutelee::MarkupDirector::processBlockContents(), and Cutelee::MarkupDirector::processFragment().

◆ beginStrikeout()

virtual void Cutelee::AbstractMarkupBuilder::beginStrikeout ( )

pure virtual

Begin a struck out element in the markup

Implemented in Cutelee::TextHTMLBuilder, Cutelee::PlainTextMarkupBuilder, Cutelee::MediaWikiMarkupBuilder, and Cutelee::BBCodeBuilder.

Referenced by Cutelee::MarkupDirector::processOpeningElements().

◆ beginStrong()

virtual void Cutelee::AbstractMarkupBuilder::beginStrong ( )

pure virtual

Begin a bold element in the markup

Implemented in Cutelee::TextHTMLBuilder, Cutelee::PlainTextMarkupBuilder, Cutelee::MediaWikiMarkupBuilder, and Cutelee::BBCodeBuilder.

Referenced by Cutelee::MarkupDirector::processOpeningElements().

◆ beginSubscript()

virtual void Cutelee::AbstractMarkupBuilder::beginSubscript ( )

pure virtual

Begin a subscript element

Implemented in Cutelee::TextHTMLBuilder, Cutelee::PlainTextMarkupBuilder, and Cutelee::BBCodeBuilder.

Referenced by Cutelee::MarkupDirector::processOpeningElements().

◆ beginSuperscript()

virtual void Cutelee::AbstractMarkupBuilder::beginSuperscript ( )

pure virtual

Begin a superscript element

Implemented in Cutelee::TextHTMLBuilder, Cutelee::PlainTextMarkupBuilder, and Cutelee::BBCodeBuilder.

Referenced by Cutelee::MarkupDirector::processOpeningElements().

◆ beginTable()

virtual void Cutelee::AbstractMarkupBuilder::beginTable	(	qreal	cellpadding,
		qreal	cellspacing,
		const QString &	width
	)

pure 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.

Implemented in Cutelee::BBCodeBuilder, Cutelee::TextHTMLBuilder, and Cutelee::PlainTextMarkupBuilder.

Referenced by Cutelee::MarkupDirector::processTable().

◆ beginTableCell()

virtual void Cutelee::AbstractMarkupBuilder::beginTableCell	(	const QString &	width,
		int	colSpan,
		int	rowSpan
	)

pure 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.

Implemented in Cutelee::TextHTMLBuilder, and Cutelee::PlainTextMarkupBuilder.

Referenced by Cutelee::MarkupDirector::processTable().

◆ beginTableHeaderCell()

virtual void Cutelee::AbstractMarkupBuilder::beginTableHeaderCell	(	const QString &	width,
		int	colSpan,
		int	rowSpan
	)

pure 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.

Implemented in Cutelee::TextHTMLBuilder, and Cutelee::PlainTextMarkupBuilder.

Referenced by Cutelee::MarkupDirector::processTable().

◆ beginTableRow()

virtual void Cutelee::AbstractMarkupBuilder::beginTableRow ( )

pure virtual

Begin a new table row

Implemented in Cutelee::TextHTMLBuilder, Cutelee::PlainTextMarkupBuilder, and Cutelee::BBCodeBuilder.

Referenced by Cutelee::MarkupDirector::processTable().

◆ beginUnderline()

virtual void Cutelee::AbstractMarkupBuilder::beginUnderline ( )

pure virtual

Begin an underlined element in the markup

Implemented in Cutelee::TextHTMLBuilder, Cutelee::PlainTextMarkupBuilder, Cutelee::MediaWikiMarkupBuilder, and Cutelee::BBCodeBuilder.

Referenced by Cutelee::MarkupDirector::processOpeningElements().

◆ endAnchor()

virtual void Cutelee::AbstractMarkupBuilder::endAnchor ( )

pure virtual

Close the anchor element

Implemented in Cutelee::TextHTMLBuilder, Cutelee::PlainTextMarkupBuilder, Cutelee::MediaWikiMarkupBuilder, and Cutelee::BBCodeBuilder.

Referenced by Cutelee::MarkupDirector::processClosingElements(), and Cutelee::MarkupDirector::processOpeningElements().

◆ endBackground()

virtual void Cutelee::AbstractMarkupBuilder::endBackground ( )

pure virtual

Close the decorarated background element in the markup

Implemented in Cutelee::TextHTMLBuilder, and Cutelee::PlainTextMarkupBuilder.

Referenced by Cutelee::MarkupDirector::processClosingElements().

◆ endEmph()

virtual void Cutelee::AbstractMarkupBuilder::endEmph ( )

pure virtual

Close the emphasised element in the markup

Implemented in Cutelee::TextHTMLBuilder, Cutelee::PlainTextMarkupBuilder, Cutelee::MediaWikiMarkupBuilder, and Cutelee::BBCodeBuilder.

Referenced by Cutelee::MarkupDirector::processClosingElements().

◆ endFontFamily()

virtual void Cutelee::AbstractMarkupBuilder::endFontFamily ( )

pure virtual

End font family element

Implemented in Cutelee::TextHTMLBuilder, and Cutelee::PlainTextMarkupBuilder.

Referenced by Cutelee::MarkupDirector::processClosingElements().

◆ endFontPointSize()

virtual void Cutelee::AbstractMarkupBuilder::endFontPointSize ( )

pure virtual

End font point size element

Implemented in Cutelee::TextHTMLBuilder, Cutelee::PlainTextMarkupBuilder, and Cutelee::BBCodeBuilder.

Referenced by Cutelee::MarkupDirector::processClosingElements().

◆ endForeground()

virtual void Cutelee::AbstractMarkupBuilder::endForeground ( )

pure virtual

Close the decorarated foreground element in the markup

Implemented in Cutelee::TextHTMLBuilder, Cutelee::PlainTextMarkupBuilder, and Cutelee::BBCodeBuilder.

Referenced by Cutelee::MarkupDirector::processClosingElements().

◆ endHeader()

virtual void Cutelee::AbstractMarkupBuilder::endHeader ( int level )

pure virtual

End a level level header

Parameters

level An integer between 1 and 6

Implemented in Cutelee::TextHTMLBuilder, Cutelee::PlainTextMarkupBuilder, and Cutelee::MediaWikiMarkupBuilder.

◆ endList()

virtual void Cutelee::AbstractMarkupBuilder::endList ( )

pure virtual

Close the list.

Implemented in Cutelee::TextHTMLBuilder, Cutelee::PlainTextMarkupBuilder, Cutelee::MediaWikiMarkupBuilder, and Cutelee::BBCodeBuilder.

Referenced by Cutelee::MarkupDirector::processList().

◆ endListItem()

virtual void Cutelee::AbstractMarkupBuilder::endListItem ( )

pure virtual

End the list item

Implemented in Cutelee::TextHTMLBuilder, Cutelee::PlainTextMarkupBuilder, and Cutelee::MediaWikiMarkupBuilder.

Referenced by Cutelee::MarkupDirector::processList().

◆ endParagraph()

virtual void Cutelee::AbstractMarkupBuilder::endParagraph ( )

pure virtual

Close the paragraph in the markup.

Implemented in Cutelee::TextHTMLBuilder, Cutelee::PlainTextMarkupBuilder, Cutelee::MediaWikiMarkupBuilder, and Cutelee::BBCodeBuilder.

Referenced by Cutelee::MarkupDirector::processBlockContents(), and Cutelee::MarkupDirector::processFragment().

◆ endStrikeout()

virtual void Cutelee::AbstractMarkupBuilder::endStrikeout ( )

pure virtual

Close the struck out element in the markup

Implemented in Cutelee::TextHTMLBuilder, Cutelee::PlainTextMarkupBuilder, Cutelee::MediaWikiMarkupBuilder, and Cutelee::BBCodeBuilder.

Referenced by Cutelee::MarkupDirector::processClosingElements().

◆ endStrong()

virtual void Cutelee::AbstractMarkupBuilder::endStrong ( )

pure virtual

Close the bold element in the markup

Implemented in Cutelee::TextHTMLBuilder, Cutelee::PlainTextMarkupBuilder, Cutelee::MediaWikiMarkupBuilder, and Cutelee::BBCodeBuilder.

Referenced by Cutelee::MarkupDirector::processClosingElements().

◆ endSubscript()

virtual void Cutelee::AbstractMarkupBuilder::endSubscript ( )

pure virtual

End subscript element

Implemented in Cutelee::TextHTMLBuilder, Cutelee::PlainTextMarkupBuilder, and Cutelee::BBCodeBuilder.

Referenced by Cutelee::MarkupDirector::processClosingElements().

◆ endSuperscript()

virtual void Cutelee::AbstractMarkupBuilder::endSuperscript ( )

pure virtual

End superscript element

Implemented in Cutelee::TextHTMLBuilder, Cutelee::PlainTextMarkupBuilder, and Cutelee::BBCodeBuilder.

Referenced by Cutelee::MarkupDirector::processClosingElements().

◆ endTable()

virtual void Cutelee::AbstractMarkupBuilder::endTable ( )

pure virtual

End a table element

Implemented in Cutelee::TextHTMLBuilder, and Cutelee::PlainTextMarkupBuilder.

Referenced by Cutelee::MarkupDirector::processTable().

◆ endTableCell()

virtual void Cutelee::AbstractMarkupBuilder::endTableCell ( )

pure virtual

End a table cell

Implemented in Cutelee::TextHTMLBuilder, and Cutelee::PlainTextMarkupBuilder.

Referenced by Cutelee::MarkupDirector::processTable().

◆ endTableHeaderCell()

virtual void Cutelee::AbstractMarkupBuilder::endTableHeaderCell ( )

pure virtual

End a table header cell

Implemented in Cutelee::TextHTMLBuilder, and Cutelee::PlainTextMarkupBuilder.

Referenced by Cutelee::MarkupDirector::processTable().

◆ endTableRow()

virtual void Cutelee::AbstractMarkupBuilder::endTableRow ( )

pure virtual

End a table row

Implemented in Cutelee::TextHTMLBuilder, and Cutelee::PlainTextMarkupBuilder.

Referenced by Cutelee::MarkupDirector::processTable().

◆ endUnderline()

virtual void Cutelee::AbstractMarkupBuilder::endUnderline ( )

pure virtual

Close the underlined element in the markup

Implemented in Cutelee::TextHTMLBuilder, Cutelee::PlainTextMarkupBuilder, Cutelee::MediaWikiMarkupBuilder, and Cutelee::BBCodeBuilder.

Referenced by Cutelee::MarkupDirector::processClosingElements().

◆ getResult()

virtual QString Cutelee::AbstractMarkupBuilder::getResult ( )

pure 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.

Implemented in Cutelee::TextHTMLBuilder, Cutelee::PlainTextMarkupBuilder, Cutelee::MediaWikiMarkupBuilder, and Cutelee::BBCodeBuilder.

◆ insertHorizontalRule()

virtual void Cutelee::AbstractMarkupBuilder::insertHorizontalRule ( int width = -1 )

pure virtual

Insert a horizontal rule into the markup.

Parameters

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

Implemented in Cutelee::TextHTMLBuilder, and Cutelee::PlainTextMarkupBuilder.

Referenced by Cutelee::MarkupDirector::processBlockContents().

◆ insertImage()

virtual void Cutelee::AbstractMarkupBuilder::insertImage	(	const QString &	url,
		qreal	width,
		qreal	height
	)

pure 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.

Implemented in Cutelee::TextHTMLBuilder, Cutelee::PlainTextMarkupBuilder, and Cutelee::BBCodeBuilder.

Referenced by Cutelee::MarkupDirector::processImage().

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~AbstractMarkupBuilder()

Member Function Documentation

◆ addNewline()

◆ appendLiteralText()

◆ appendRawText()

◆ beginAnchor()

◆ beginBackground()

◆ beginEmph()

◆ beginFontFamily()

◆ beginFontPointSize()

◆ beginForeground()

◆ beginHeader()

◆ beginList()

◆ beginListItem()

◆ beginParagraph()

◆ beginStrikeout()

◆ beginStrong()

◆ beginSubscript()

◆ beginSuperscript()

◆ beginTable()

◆ beginTableCell()

◆ beginTableHeaderCell()

◆ beginTableRow()

◆ beginUnderline()

◆ endAnchor()

◆ endBackground()

◆ endEmph()

◆ endFontFamily()

◆ endFontPointSize()

◆ endForeground()

◆ endHeader()

◆ endList()

◆ endListItem()

◆ endParagraph()

◆ endStrikeout()

◆ endStrong()

◆ endSubscript()

◆ endSuperscript()

◆ endTable()

◆ endTableCell()

◆ endTableHeaderCell()

◆ endTableRow()

◆ endUnderline()

◆ getResult()

◆ insertHorizontalRule()

◆ insertImage()