• Skip to content
  • Skip to link menu
KDE 4.7 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • KDE Home
  • Contact Us
 

kpimtextedit/richtextbuilders

Public Member Functions
MediaWikiMarkupBuilder Class Reference

#include <mediawikimarkupbuilder.h>

Inheritance diagram for MediaWikiMarkupBuilder:
Inheritance graph
[legend]

List of all members.

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

Detailed Description

Creates MediaWiki markup from a QTextDocument.


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

kpimtextedit/richtextbuilders

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

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • 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
Generated for KDE-PIM Libraries by doxygen 1.7.5
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal