Okular::Generator

#include <generator.h>

Inheritance diagram for Okular::Generator:

Public Types

enum  GeneratorFeature {
  Threaded, TextExtraction, ReadRawData, FontInfo,
  PageSizes, PrintNative, PrintPostscript, PrintToFile,
  TiledRendering, SwapBackingFile, SupportsCancelling
}
 
enum  PageSizeMetric { None, Points, Pixels }
 
enum  PrintError {
  NoPrintError, UnknownPrintError, TemporaryFileOpenPrintError, FileConversionPrintError,
  PrintingProcessCrashPrintError, PrintingProcessStartPrintError, PrintToFilePrintError, InvalidPrinterStatePrintError,
  UnableToFindFilePrintError, NoFileToPrintError, NoBinaryToPrintError, InvalidPageSizePrintError
}
 
enum  SwapBackingFileResult { SwapBackingFileError, SwapBackingFileNoOp, SwapBackingFileReloadInternalData }
 

Signals

void error (const QString &message, int duration)
 
void notice (const QString &message, int duration)
 
void warning (const QString &message, int duration)
 

Public Member Functions

 Generator (QObject *parent=nullptr, const QVariantList &args=QVariantList())
 
 ~Generator () override
 
virtual bool canGeneratePixmap () const
 
virtual bool canGenerateTextPage () const
 
bool closeDocument ()
 
virtual const QList< EmbeddedFile * > * embeddedFiles () const
 
virtual ExportFormat::List exportFormats () const
 
virtual bool exportTo (const QString &fileName, const ExportFormat &format)
 
virtual FontInfo::List fontsForPage (int page)
 
virtual DocumentInfo generateDocumentInfo (const QSet< DocumentInfo::Key > &keys) const
 
virtual const DocumentSynopsisgenerateDocumentSynopsis ()
 
virtual void generatePixmap (PixmapRequest *request)
 
void generateTextPage (Page *page)
 
bool hasFeature (GeneratorFeature feature) const
 
virtual bool isAllowed (Permission action) const
 
virtual QAbstractItemModellayersModel () const
 
virtual bool loadDocument (const QString &fileName, QVector< Page * > &pagesVector)
 
virtual bool loadDocumentFromData (const QByteArray &fileData, QVector< Page * > &pagesVector)
 
virtual Document::OpenResult loadDocumentFromDataWithPassword (const QByteArray &fileData, QVector< Page * > &pagesVector, const QString &password)
 
virtual Document::OpenResult loadDocumentWithPassword (const QString &fileName, QVector< Page * > &pagesVector, const QString &password)
 
virtual QVariant metaData (const QString &key, const QVariant &option) const
 
virtual void opaqueAction (const BackendOpaqueAction *action)
 
virtual void pageSizeChanged (const PageSize &pageSize, const PageSize &oldPageSize)
 
virtual PageSize::List pageSizes () const
 
virtual PageSizeMetric pagesSizeMetric () const
 
virtual bool print (QPrinter &printer)
 
virtual void rotationChanged (Rotation orientation, Rotation oldOrientation)
 
void setDPI (const QSizeF &dpi)
 
virtual SwapBackingFileResult swapBackingFile (const QString &newFileName, QVector< Okular::Page * > &newPagesVector)
 
virtual void walletDataForFile (const QString &fileName, QString *walletName, QString *walletFolder, QString *walletKey) const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 

Protected Types

enum  DocumentMetaDataKey { PaperColorMetaData, TextAntialiasMetaData, GraphicsAntialiasMetaData, TextHintingMetaData }
 

Protected Slots

void requestFontData (const Okular::FontInfo &font, QByteArray *data)
 
void signalPartialPixmapRequest (Okular::PixmapRequest *request, const QImage &image)
 

Protected Member Functions

virtual bool doCloseDocument ()=0
 
const Documentdocument () const
 
QVariant documentMetaData (const DocumentMetaDataKey key, const QVariant &option=QVariant()) const
 
OKULARCORE_DEPRECATED QVariant documentMetaData (const QString &key, const QVariant &option=QVariant()) const
 
QSizeF dpi () const
 
virtual QImage image (PixmapRequest *request)
 
Q_INVOKABLE Okular::Generator::PrintError printError () const
 
void setFeature (GeneratorFeature feature, bool on=true)
 
void signalPixmapRequestDone (PixmapRequest *request)
 
void signalTextGenerationDone (Page *page, TextPage *textPage)
 
virtual TextPagetextPage (TextRequest *request)
 
void updatePageBoundingBox (int page, const NormalizedRect &boundingBox)
 
QMutexuserMutex () const
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Additional Inherited Members

- Properties inherited from QObject
 objectName
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QObject
typedef QObjectList
 

Detailed Description

[Abstract Class] The information generator.

Most of class members are virtuals and some of them pure virtual. The pure virtuals provide the minimal functionalities for a Generator, that is being able to generate QPixmap for the Page 's of the Document.

Implementing the other functions will make the Generator able to provide more contents and/or functionalities (like text extraction).

Generation/query is requested by the Document class only, and that class stores the resulting data into Page s. The data will then be displayed by the GUI components (PageView, ThumbnailList, etc..).

See also
PrintInterface, ConfigInterface, GuiInterface

Definition at line 189 of file generator.h.

Member Enumeration Documentation

Internal document setting.

Enumerator
PaperColorMetaData 

Returns (QColor) the paper color if set in Settings or the default color (white) if option is true (otherwise returns a non initialized QColor)

TextAntialiasMetaData 

Returns (bool) text antialias from Settings (option is not used)

GraphicsAntialiasMetaData 

Returns (bool)graphic antialias from Settings (option is not used)

TextHintingMetaData 

Returns (bool)text hinting from Settings (option is not used)

Definition at line 549 of file generator.h.

Describe the possible optional features that a Generator can provide.

Enumerator
Threaded 

Whether the Generator supports asynchronous generation of pictures or text pages.

TextExtraction 

Whether the Generator can extract text from the document in the form of TextPage's.

ReadRawData 

Whether the Generator can read a document directly from its raw data.

FontInfo 

Whether the Generator can provide information about the fonts used in the document.

PageSizes 

Whether the Generator can change the size of the document pages.

PrintNative 

Whether the Generator supports native cross-platform printing (QPainter-based).

PrintPostscript 

Whether the Generator supports postscript-based file printing.

PrintToFile 

Whether the Generator supports export to PDF & PS through the Print Dialog.

TiledRendering 

Whether the Generator can render tiles.

Since
0.16 (KDE 4.10)
SwapBackingFile 

Whether the Generator can hot-swap the file it's reading from.

Since
1.3
SupportsCancelling 

Whether the Generator can cancel requests.

Since
1.4

Definition at line 203 of file generator.h.

This enum identifies the metric of the page size.

Enumerator
None 

The page size is not defined in a physical metric.

Points 

The page size is given in 1/72 inches.

Pixels 

The page size is given in screen pixels.

Since
0.19 (KDE 4.13)

Definition at line 363 of file generator.h.

Possible print errors.

Since
0.11 (KDE 4.5)
Enumerator
NoPrintError 

There was no print error.

InvalidPageSizePrintError 
Since
0.18.2 (KDE 4.12.2)

Definition at line 404 of file generator.h.

Describes the result of an swap file operation.

Since
1.3

Definition at line 280 of file generator.h.

Constructor & Destructor Documentation

Generator::Generator ( QObject parent = nullptr,
const QVariantList &  args = QVariantList() 
)
explicit

Creates a new generator.

Definition at line 169 of file generator.cpp.

Generator::~Generator ( )
override

Destroys the generator.

Definition at line 183 of file generator.cpp.

Member Function Documentation

bool Generator::canGeneratePixmap ( ) const
virtual

This method returns whether the generator is ready to handle a new pixmap request.

Reimplemented in Okular::TextDocumentGenerator.

Definition at line 243 of file generator.cpp.

bool Generator::canGenerateTextPage ( ) const
virtual

This method returns whether the generator is ready to handle a new text page request.

Definition at line 298 of file generator.cpp.

bool Generator::closeDocument ( )

This method is called when the document is closed and not used any longer.

Returns
true on success, false otherwise.

Definition at line 216 of file generator.cpp.

virtual bool Okular::Generator::doCloseDocument ( )
protectedpure virtual

This method is called when the document is closed and not used any longer.

Returns
true on success, false otherwise.

Implemented in Okular::TextDocumentGenerator.

const Document * Generator::document ( ) const
protected

Returns a pointer to the document.

Definition at line 444 of file generator.cpp.

QVariant Generator::documentMetaData ( const DocumentMetaDataKey  key,
const QVariant option = QVariant() 
) const
protected

Request a meta data of the Document, if available, like an internal setting.

Since
1.1

Definition at line 480 of file generator.cpp.

QVariant Generator::documentMetaData ( const QString key,
const QVariant option = QVariant() 
) const
protected

Request a meta data of the Document, if available, like an internal setting.

Definition at line 462 of file generator.cpp.

QSizeF Generator::dpi ( ) const
protected

Returns DPI, previously set via setDPI()

Since
0.19 (KDE 4.13)

Definition at line 512 of file generator.cpp.

const QList< EmbeddedFile * > * Generator::embeddedFiles ( ) const
virtual

Returns the 'list of embedded files' object of the document or 0 if no list of embedded files is available.

Definition at line 340 of file generator.cpp.

void Okular::Generator::error ( const QString message,
int  duration 
)
signal

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

Parameters
messageThe message which should be shown to the user.
durationThe time that the message should be shown to the user.
ExportFormat::List Generator::exportFormats ( ) const
virtual

Returns the list of additional supported export formats.

Reimplemented in Okular::TextDocumentGenerator.

Definition at line 388 of file generator.cpp.

bool Generator::exportTo ( const QString fileName,
const ExportFormat format 
)
virtual

This method is called to export the document in the given format and save it under the given fileName.

The format must be one of the supported export formats.

Reimplemented in Okular::TextDocumentGenerator.

Definition at line 393 of file generator.cpp.

FontInfo::List Generator::fontsForPage ( int  page)
virtual

Returns the 'list of embedded fonts' object of the specified page of the document.

Parameters
pagea page of the document, starting from 0 - -1 indicates all the other fonts

Definition at line 335 of file generator.cpp.

DocumentInfo Generator::generateDocumentInfo ( const QSet< DocumentInfo::Key > &  keys) const
virtual

Returns the general information object of the document.

Changed signature in okular version 0.21

Reimplemented in Okular::TextDocumentGenerator.

Definition at line 323 of file generator.cpp.

const DocumentSynopsis * Generator::generateDocumentSynopsis ( )
virtual

Returns the 'table of content' object of the document or 0 if no table of content is available.

Reimplemented in Okular::TextDocumentGenerator.

Definition at line 330 of file generator.cpp.

void Generator::generatePixmap ( PixmapRequest request)
virtual

This method can be called to trigger the generation of a new pixmap as described by request.

We create the text page for every page that is visible to the user, so he can use the text extraction tools without a delay.

Reimplemented in Okular::TextDocumentGenerator.

Definition at line 249 of file generator.cpp.

void Generator::generateTextPage ( Page page)

This method can be called to trigger the generation of a text page for the given page.

The generation is done in the calling thread.

See also
TextPage

Definition at line 304 of file generator.cpp.

bool Generator::hasFeature ( GeneratorFeature  feature) const

Query for the specified feature.

Definition at line 407 of file generator.cpp.

QImage Generator::image ( PixmapRequest request)
protectedvirtual

Returns the image of the page as specified in the passed pixmap request.

Must return a null image if the request was cancelled and the generator supports cancelling

Warning
this method may be executed in its own separated thread if the Threaded is enabled!

Definition at line 312 of file generator.cpp.

bool Generator::isAllowed ( Permission  action) const
virtual

Returns whether the given action is allowed in the document.

See also
Okular::Permission

Definition at line 350 of file generator.cpp.

QAbstractItemModel * Generator::layersModel ( ) const
virtual

Returns the 'layers model' object of the document or NULL if layers model is not available.

Since
0.24

Definition at line 518 of file generator.cpp.

bool Generator::loadDocument ( const QString fileName,
QVector< Page * > &  pagesVector 
)
virtual

Loads the document with the given fileName and fills the pagesVector with the parsed pages.

Note
If you implement the WithPassword variants you don't need to implement this one
Returns
true on success, false otherwise.

Definition at line 188 of file generator.cpp.

bool Generator::loadDocumentFromData ( const QByteArray fileData,
QVector< Page * > &  pagesVector 
)
virtual

Loads the document from the raw data fileData and fills the pagesVector with the parsed pages.

Note
If you implement the WithPassword variants you don't need to implement this one
the Generator has to have the feature ReadRawData enabled
Returns
true on success, false otherwise.

Definition at line 196 of file generator.cpp.

Document::OpenResult Generator::loadDocumentFromDataWithPassword ( const QByteArray fileData,
QVector< Page * > &  pagesVector,
const QString password 
)
virtual

Loads the document from the raw data fileData and password and fills the pagesVector with the parsed pages.

Note
Do not implement this if your format doesn't support passwords, it'll cleanly call loadDocumentFromData()
the Generator has to have the feature ReadRawData enabled
Since
0.20 (KDE 4.14)
Returns
a LoadResult defining the result of the operation

Definition at line 206 of file generator.cpp.

Document::OpenResult Generator::loadDocumentWithPassword ( const QString fileName,
QVector< Page * > &  pagesVector,
const QString password 
)
virtual

Loads the document with the given fileName and password and fills the pagesVector with the parsed pages.

Note
Do not implement this if your format doesn't support passwords, it'll cleanly call loadDocument()
Since
0.20 (KDE 4.14)
Returns
a LoadResult defining the result of the operation

Reimplemented in Okular::TextDocumentGenerator.

Definition at line 201 of file generator.cpp.

QVariant Generator::metaData ( const QString key,
const QVariant option 
) const
virtual

This method returns the meta data of the given key with the given option of the document.

Definition at line 382 of file generator.cpp.

void Okular::Generator::notice ( const QString message,
int  duration 
)
signal

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

Parameters
messageThe message which should be shown to the user.
durationThe time that the message should be shown to the user.
void Generator::opaqueAction ( const BackendOpaqueAction *  action)
virtual

Calls the backend to execute an BackendOpaqueAction.

Definition at line 378 of file generator.cpp.

void Generator::pageSizeChanged ( const PageSize pageSize,
const PageSize oldPageSize 
)
virtual

This method is called when the page size has been changed by the user.

Definition at line 364 of file generator.cpp.

PageSize::List Generator::pageSizes ( ) const
virtual

Returns the list of supported page sizes.

Definition at line 359 of file generator.cpp.

Generator::PageSizeMetric Generator::pagesSizeMetric ( ) const
virtual

This method returns the metric of the page size.

Default is None.

Definition at line 345 of file generator.cpp.

bool Generator::print ( QPrinter printer)
virtual

This method is called to print the document to the given printer.

Reimplemented in Okular::TextDocumentGenerator.

Definition at line 368 of file generator.cpp.

Generator::PrintError Generator::printError ( ) const
protected

Returns the last print error in case print() failed.

Since
0.11 (KDE 4.5)

Definition at line 373 of file generator.cpp.

void Generator::requestFontData ( const Okular::FontInfo font,
QByteArray data 
)
protectedslot

Gets the font data for the given font.

Since
0.8 (KDE 4.1)

Definition at line 502 of file generator.cpp.

void Generator::rotationChanged ( Rotation  orientation,
Rotation  oldOrientation 
)
virtual

This method is called when the orientation has been changed by the user.

Definition at line 355 of file generator.cpp.

void Generator::setDPI ( const QSizeF dpi)

Update DPI of the generator.

Since
0.19 (KDE 4.13)

Definition at line 506 of file generator.cpp.

void Generator::setFeature ( GeneratorFeature  feature,
bool  on = true 
)
protected

Toggle the feature .

Definition at line 453 of file generator.cpp.

void Generator::signalPartialPixmapRequest ( Okular::PixmapRequest request,
const QImage image 
)
protectedslot

This method can be called to trigger a partial pixmap update for the given request Make sure you call it in a way it's executed in the main thread.

Since
1.3

Definition at line 432 of file generator.cpp.

void Generator::signalPixmapRequestDone ( PixmapRequest request)
protected

This method must be called when the pixmap request triggered by generatePixmap() has been finished.

Definition at line 413 of file generator.cpp.

void Generator::signalTextGenerationDone ( Page page,
TextPage textPage 
)
protected

This method must be called when a text generation has been finished.

Definition at line 423 of file generator.cpp.

Generator::SwapBackingFileResult Generator::swapBackingFile ( const QString newFileName,
QVector< Okular::Page * > &  newPagesVector 
)
virtual

Changes the path of the file we are reading from.

The new path must point to a copy of the same document.

Note
the Generator has to have the feature SwapBackingFile enabled
Since
1.3

Definition at line 211 of file generator.cpp.

TextPage * Generator::textPage ( TextRequest request)
protectedvirtual

Returns the text page for the given request.

Must return a null pointer if the request was cancelled and the generator supports cancelling

Warning
this method may be executed in its own separated thread if the Threaded is enabled!
Since
1.4

Reimplemented in Okular::TextDocumentGenerator.

Definition at line 318 of file generator.cpp.

void Generator::updatePageBoundingBox ( int  page,
const NormalizedRect boundingBox 
)
protected

Set the bounding box of a page after the page has already been handed to the Document.

Call this instead of Page::setBoundingBox() to ensure that all observers are notified.

Since
0.7 (KDE 4.1)

Definition at line 495 of file generator.cpp.

QMutex * Generator::userMutex ( ) const
protected

Return the pointer to a mutex the generator can use freely.

Definition at line 489 of file generator.cpp.

void Generator::walletDataForFile ( const QString fileName,
QString walletName,
QString walletFolder,
QString walletKey 
) const
virtual

This method is called to know which wallet data should be used for the given file name.

Unless you have very special requirements to where wallet data should be stored you don't need to reimplement this method.

Definition at line 398 of file generator.cpp.

void Okular::Generator::warning ( const QString message,
int  duration 
)
signal

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

Parameters
messageThe message which should be shown to the user.
durationThe time that the message should be shown to the user.

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Thu Nov 26 2020 22:34:57 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.