Okular::TextDocumentConverter Class Reference

#include <textdocumentgenerator.h>

Inheritance diagram for Okular::TextDocumentConverter:

Signals
void	addAction (Action *link, int cursorBegin, int cursorEnd)
void	addAnnotation (Annotation *annotation, int cursorBegin, int cursorEnd)
void	addMetaData (const QString &key, const QString &value, const QString &title)
void	addMetaData (DocumentInfo::Key key, const QString &value)
void	addTitle (int level, const QString &title, const QTextBlock &position)
void	error (const QString &message, int duration)
void	notice (const QString &message, int duration)
void	warning (const QString &message, int duration)

Public Member Functions
	TextDocumentConverter ()
	~TextDocumentConverter ()
virtual QTextDocument *	convert (const QString &fileName)=0

Protected Member Functions
DocumentViewport	calculateViewport (QTextDocument *document, const QTextBlock &block)
TextDocumentGenerator *	generator () const

Detailed Description

Definition at line 29 of file textdocumentgenerator.h.

Constructor & Destructor Documentation

TextDocumentConverter::TextDocumentConverter

(

)

Creates a new generic converter.

Generic Converter Implementation.

Definition at line 38 of file textdocumentgenerator.cpp.

TextDocumentConverter::~TextDocumentConverter

(

)

Destroys the generic converter.

Definition at line 43 of file textdocumentgenerator.cpp.

Member Function Documentation

void Okular::TextDocumentConverter::addAction ( Action *  link, int  cursorBegin, int  cursorEnd  )

signal

Adds a new link object which is located between cursorBegin and cursorEnd to the generator.

void Okular::TextDocumentConverter::addAnnotation ( Annotation *  annotation, int  cursorBegin, int  cursorEnd  )

signal

Adds a new annotation object which is located between cursorBegin and cursorEnd to the generator.

void Okular::TextDocumentConverter::addMetaData ( const QString &  key, const QString &  value, const QString &  title  )

signal

Adds a set of meta data to the generator.

void Okular::TextDocumentConverter::addMetaData ( DocumentInfo::Key  key, const QString &  value  )

signal

Adds a set of meta data to the generator.

Since

0.7 (KDE 4.1)

void Okular::TextDocumentConverter::addTitle ( int  level, const QString &  title, const QTextBlock &  position  )

signal

Adds a new title at the given level which is located as position to the generator.

DocumentViewport TextDocumentConverter::calculateViewport ( QTextDocument *  document, const QTextBlock &  block  )

protected

This method can be used to calculate the viewport for a given text block.

Note

This method should be called at the end of the convertion, because it triggers QTextDocument to do the layout calculation.

Definition at line 48 of file textdocumentgenerator.cpp.

virtual QTextDocument* Okular::TextDocumentConverter::convert ( const QString &  fileName )

pure virtual

Returns the generated QTextDocument object.

void Okular::TextDocumentConverter::error ( const QString &  message, int  duration  )

signal

This signal should be emitted whenever an error occurred in the converter.

Parameters

message	The message which should be shown to the user.
duration	The time that the message should be shown to the user.

TextDocumentGenerator * TextDocumentConverter::generator ( ) const

protected

Returns the generator that owns this converter.

Note

May be null if the converter was not created for a generator.

Since

0.7 (KDE 4.1)

Definition at line 53 of file textdocumentgenerator.cpp.

void Okular::TextDocumentConverter::notice ( const QString &  message, int  duration  )

signal

This signal should be emitted whenever the user should be noticed.

Parameters

message	The message which should be shown to the user.
duration	The time that the message should be shown to the user.

void Okular::TextDocumentConverter::warning ( const QString &  message, int  duration  )

signal

This signal should be emitted whenever the user should be warned.

Parameters

message	The message which should be shown to the user.
duration	The time that the message should be shown to the user.

---

The documentation for this class was generated from the following files:

• textdocumentgenerator.h
• textdocumentgenerator.cpp