• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.9.5 API Reference
  • KDE Home
  • Contact Us
 

kpimtextedit/richtextbuilders

Public Member Functions | List of all members
MediaWikiMarkupBuilder Class Reference

#include <mediawikimarkupbuilder.h>

Inheritance diagram for MediaWikiMarkupBuilder:
Inheritance graph
[legend]

Public Member Functions

 MediaWikiMarkupBuilder ()
virtual void addNewline ()
virtual void appendLiteralText (const QString &text)
virtual void beginAnchor (const QString &href=QString(), const QString &name=QString())
virtual void beginEmph ()
virtual void beginHeader (int level)
virtual void beginList (QTextListFormat::Style type)
virtual void beginListItem ()
virtual void beginStrikeout ()
virtual void beginStrong ()
virtual void beginUnderline ()
virtual void endAnchor ()
virtual void endEmph ()
virtual void endHeader (int level)
virtual void endList ()
virtual void endListItem ()
virtual void endParagraph ()
virtual void endStrikeout ()
virtual void endStrong ()
virtual void endUnderline ()
const QString escape (const QString &s)
virtual QString & getResult ()
- Public Member Functions inherited from KAbstractMarkupBuilder
virtual ~KAbstractMarkupBuilder ()
virtual void beginBackground (const QBrush &brush)
virtual void beginExtraElement (int type, QVariantList args)
virtual void beginFontFamily (const QString &family)
virtual void beginFontPointSize (int size)
virtual void beginForeground (const QBrush &brush)
virtual void beginParagraph (Qt::Alignment a=Qt::AlignLeft, qreal top=0.0, qreal bottom=0.0, qreal left=0.0, qreal right=0.0)
virtual void beginSubscript ()
virtual void beginSuperscript ()
virtual void beginTable (qreal cellpadding, qreal cellspacing, const QString &width)
virtual void beginTableCell (const QString &width, int colSpan, int rowSpan)
virtual void beginTableHeaderCell (const QString &width, int colSpan, int rowSpan)
virtual void beginTableRow ()
virtual void endBackground ()
virtual void endExtraElement (int type)
virtual void endFontFamily ()
virtual void endFontPointSize ()
virtual void endForeground ()
virtual void endSubscript ()
virtual void endSuperscript ()
virtual void endTable ()
virtual void endTableCell ()
virtual void endTableHeaderCell ()
virtual void endTableRow ()
virtual void insertHorizontalRule (int width=-1)
virtual void insertImage (const QString &url, qreal width, qreal height)

Additional Inherited Members

- Public Types inherited from KAbstractMarkupBuilder
enum  ExtraElement { UserElement = 100 }

Detailed Description

Creates MediaWiki markup from a QTextDocument.

Definition at line 33 of file mediawikimarkupbuilder.h.

Constructor & Destructor Documentation

MediaWikiMarkupBuilder::MediaWikiMarkupBuilder ( )

Creates a new MediaWikiMarkupBuilder.

Definition at line 25 of file mediawikimarkupbuilder.cpp.

Member Function Documentation

void MediaWikiMarkupBuilder::addNewline ( )
virtual

Add a newline to the markup.

Reimplemented from KAbstractMarkupBuilder.

Definition at line 65 of file mediawikimarkupbuilder.cpp.

void MediaWikiMarkupBuilder::appendLiteralText ( const QString &  text)
virtual

Append the plain text text to the markup.

Parameters
Thetext to append.

Implements KAbstractMarkupBuilder.

Definition at line 181 of file mediawikimarkupbuilder.cpp.

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

Reimplemented from KAbstractMarkupBuilder.

Definition at line 70 of file mediawikimarkupbuilder.cpp.

void MediaWikiMarkupBuilder::beginEmph ( )
virtual

Begin an emphasised element in the markup.

Reimplemented from KAbstractMarkupBuilder.

Definition at line 36 of file mediawikimarkupbuilder.cpp.

void MediaWikiMarkupBuilder::beginHeader ( int  level)
virtual

Begin a level level header.

Parameters
levelAn integer between 1 and 6

Reimplemented from KAbstractMarkupBuilder.

Definition at line 80 of file mediawikimarkupbuilder.cpp.

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

Reimplemented from KAbstractMarkupBuilder.

Definition at line 132 of file mediawikimarkupbuilder.cpp.

void MediaWikiMarkupBuilder::beginListItem ( )
virtual

Begin a new list item in the markup.

Reimplemented from KAbstractMarkupBuilder.

Definition at line 158 of file mediawikimarkupbuilder.cpp.

void MediaWikiMarkupBuilder::beginStrikeout ( )
virtual

Begin a struck out element in the markup.

Reimplemented from KAbstractMarkupBuilder.

Definition at line 52 of file mediawikimarkupbuilder.cpp.

void MediaWikiMarkupBuilder::beginStrong ( )
virtual

Begin a bold element in the markup.

Reimplemented from KAbstractMarkupBuilder.

Definition at line 28 of file mediawikimarkupbuilder.cpp.

void MediaWikiMarkupBuilder::beginUnderline ( )
virtual

Begin an underlined element in the markup.

Reimplemented from KAbstractMarkupBuilder.

Definition at line 44 of file mediawikimarkupbuilder.cpp.

void MediaWikiMarkupBuilder::endAnchor ( )
virtual

Close the anchor element.

Reimplemented from KAbstractMarkupBuilder.

Definition at line 75 of file mediawikimarkupbuilder.cpp.

void MediaWikiMarkupBuilder::endEmph ( )
virtual

Close the emphasised element in the markup.

Reimplemented from KAbstractMarkupBuilder.

Definition at line 40 of file mediawikimarkupbuilder.cpp.

void MediaWikiMarkupBuilder::endHeader ( int  level)
virtual

End a level level header.

Parameters
levelAn integer between 1 and 6

Reimplemented from KAbstractMarkupBuilder.

Definition at line 106 of file mediawikimarkupbuilder.cpp.

void MediaWikiMarkupBuilder::endList ( )
virtual

Close the list.

Reimplemented from KAbstractMarkupBuilder.

Definition at line 151 of file mediawikimarkupbuilder.cpp.

void MediaWikiMarkupBuilder::endListItem ( )
virtual

End the list item.

Reimplemented from KAbstractMarkupBuilder.

Definition at line 176 of file mediawikimarkupbuilder.cpp.

void MediaWikiMarkupBuilder::endParagraph ( )
virtual

Close the paragraph in the markup.

Reimplemented from KAbstractMarkupBuilder.

Definition at line 61 of file mediawikimarkupbuilder.cpp.

void MediaWikiMarkupBuilder::endStrikeout ( )
virtual

Close the struck out element in the markup.

Reimplemented from KAbstractMarkupBuilder.

Definition at line 56 of file mediawikimarkupbuilder.cpp.

void MediaWikiMarkupBuilder::endStrong ( )
virtual

Close the bold element in the markup.

Reimplemented from KAbstractMarkupBuilder.

Definition at line 32 of file mediawikimarkupbuilder.cpp.

void MediaWikiMarkupBuilder::endUnderline ( )
virtual

Close the underlined element in the markup.

Reimplemented from KAbstractMarkupBuilder.

Definition at line 48 of file mediawikimarkupbuilder.cpp.

QString & 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 KAbstractMarkupBuilder.

Definition at line 194 of file mediawikimarkupbuilder.cpp.


The documentation for this class was generated from the following files:
  • mediawikimarkupbuilder.h
  • mediawikimarkupbuilder.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2013 The KDE developers.
Generated on Sat Jan 5 2013 19:44:42 by doxygen 1.8.1.2 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

kpimtextedit/richtextbuilders

Skip menu "kpimtextedit/richtextbuilders"
  • Main Page
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Related Pages

kdepimlibs-4.9.5 API Reference

Skip menu "kdepimlibs-4.9.5 API Reference"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal