Okular::Document

#include <document.h>

Inheritance diagram for Okular::Document:

Public Types

enum  OpenResult { OpenSuccess, OpenError, OpenNeedsPassword }
 
enum  PixmapRequestFlag { NoOption = 0, RemoveAllPrevious = 1 }
 
typedef QFlags< PixmapRequestFlagPixmapRequestFlags
 
enum  PrintingType { NoPrinting, NativePrinting, PostscriptPrinting }
 
enum  SaveCapability { SaveFormsCapability = 1, SaveAnnotationsCapability = 2 }
 
enum  SearchStatus { MatchFound, NoMatchFound, SearchCancelled, EndOfDocumentReached }
 
enum  SearchType {
  NextMatch, PreviousMatch, AllDocument, GoogleAll,
  GoogleAny
}
 

Signals

void aboutToClose ()
 
void annotationContentsChangedByUndoRedo (Okular::Annotation *annotation, const QString &contents, int cursorPos, int anchorPos)
 
void canRedoChanged (bool redoAvailable)
 
void canUndoChanged (bool undoAvailable)
 
void close ()
 
void error (const QString &text, int duration)
 
void fontReadingEnded ()
 
void fontReadingProgress (int page)
 
void formButtonsChangedByUndoRedo (int page, const QList< Okular::FormFieldButton * > &formButtons)
 
void formComboChangedByUndoRedo (int page, Okular::FormFieldChoice *form, const QString &text, int cursorPos, int anchorPos)
 
void formListChangedByUndoRedo (int page, Okular::FormFieldChoice *form, const QList< int > &choices)
 
void formTextChangedByUndoRedo (int page, Okular::FormFieldText *form, const QString &contents, int cursorPos, int anchorPos)
 
void gotFont (const Okular::FontInfo &font)
 
void linkEndPresentation ()
 
void linkFind ()
 
void linkGoToPage ()
 
void linkPresentation ()
 
void notice (const QString &text, int duration)
 
void openUrl (const QUrl &url)
 
void processMovieAction (const Okular::MovieAction *action)
 
void processRenditionAction (const Okular::RenditionAction *action)
 
void quit ()
 
void refreshFormWidget (Okular::FormField *field)
 
void searchFinished (int searchID, Okular::Document::SearchStatus endStatus)
 
void sourceReferenceActivated (const QString &absFileName, int line, int col, bool *handled)
 
void undoHistoryCleanChanged (bool clean)
 
void warning (const QString &text, int duration)
 

Public Slots

void cancelSearch ()
 
void editFormButtons (int pageNumber, const QList< Okular::FormFieldButton * > &formButtons, const QList< bool > &newButtonStates)
 
void editFormCombo (int pageNumber, Okular::FormFieldChoice *form, const QString &newText, int newCursorPos, int prevCursorPos, int prevAnchorPos)
 
void editFormList (int pageNumber, Okular::FormFieldChoice *form, const QList< int > &newChoices)
 
void editFormText (int pageNumber, Okular::FormFieldText *form, const QString &newContents, int newCursorPos, int prevCursorPos, int prevAnchorPos)
 
void redo ()
 
void refreshPixmaps (int pageNumber)
 
void reloadDocument () const
 
QByteArray requestSignedRevisionData (const Okular::SignatureInfo &info)
 
void setPageSize (const Okular::PageSize &size)
 
void setRotation (int rotation)
 
void undo ()
 

Public Member Functions

 Document (QWidget *widget)
 
 ~Document () override
 
void addObserver (DocumentObserver *observer)
 
void addPageAnnotation (int page, Annotation *annotation)
 
void adjustPageAnnotation (int page, Annotation *annotation, const Okular::NormalizedPoint &delta1, const Okular::NormalizedPoint &delta2)
 
QSizeF allPagesSize () const
 
QList< int > bookmarkedPageList () const
 
QString bookmarkedPageRange () const
 
BookmarkManagerbookmarkManager () const
 
bool canConfigurePrinter () const
 
bool canExportToText () const
 
bool canModifyPageAnnotation (const Annotation *annotation) const
 
bool canProvideFontInformation () const
 
bool canRedo () const
 
bool canRemovePageAnnotation (const Annotation *annotation) const
 
bool canSaveChanges (SaveCapability cap) const
 
bool canSaveChanges () const
 
bool canSwapBackingFile () const
 
bool canUndo () const
 
void closeDocument ()
 
int configurableGenerators () const
 
void continueSearch (int searchID)
 
void continueSearch (int searchID, SearchType type)
 
QUrl currentDocument () const
 
uint currentPage () const
 
void docdataMigrationDone ()
 
DocumentInfo documentInfo () const
 
DocumentInfo documentInfo (const QSet< DocumentInfo::Key > &keys) const
 
const DocumentSynopsisdocumentSynopsis () const
 
const SourceReferencedynamicSourceReference (int pageNr, double absX, double absY)
 
void editPageAnnotationContents (int page, Annotation *annotation, const QString &newContents, int newCursorPos, int prevCursorPos, int prevAnchorPos)
 
const QList< EmbeddedFile * > * embeddedFiles () const
 
QList< ExportFormatexportFormats () const
 
bool exportTo (const QString &fileName, const ExportFormat &format) const
 
bool exportToText (const QString &fileName) const
 
bool extractArchivedFile (const QString &destFileName)
 
void fillConfigDialog (KConfigDialog *dialog)
 
QByteArray fontData (const FontInfo &font) const
 
KPluginMetaData generatorInfo () const
 
KXMLGUIClientguiClient ()
 
bool historyAtBegin () const
 
bool historyAtEnd () const
 
bool isAllowed (Permission action) const
 
bool isDocdataMigrationNeeded () const
 
bool isOpened () const
 
QAbstractItemModellayersModel () const
 
QVariant metaData (const QString &key, const QVariant &option=QVariant()) const
 
void modifyPageAnnotationProperties (int page, Annotation *annotation)
 
OpenResult openDocument (const QString &docFile, const QUrl &url, const QMimeType &mime, const QString &password=QString())
 
OpenResult openDocumentArchive (const QString &docFile, const QUrl &url, const QString &password=QString())
 
QString openError () const
 
QPrinter::Orientation orientation () const
 
const Pagepage (int number) const
 
uint pages () const
 
PageSize::List pageSizes () const
 
QString pageSizeString (int page) const
 
void prepareToModifyAnnotationProperties (Annotation *annotation)
 
bool print (QPrinter &printer)
 
QWidgetprintConfigurationWidget () const
 
QString printError () const
 
PrintingType printingSupport () const
 
void processAction (const Action *action)
 
void processFocusAction (const Action *action, Okular::FormField *field)
 
void processFormatAction (const Action *action, Okular::FormFieldText *fft)
 
void processKeystrokeAction (const Action *action, Okular::FormFieldText *fft, bool &returnCode)
 
void processSourceReference (const SourceReference *reference)
 
void processValidateAction (const Action *action, Okular::FormFieldText *fft, bool &returnCode)
 
void registerView (View *view)
 
void removeObserver (DocumentObserver *observer)
 
void removePageAnnotation (int page, Annotation *annotation)
 
void removePageAnnotations (int page, const QList< Annotation * > &annotations)
 
void reparseConfig ()
 
void requestPixmaps (const QLinkedList< PixmapRequest * > &requests)
 
void requestPixmaps (const QLinkedList< PixmapRequest * > &requests, PixmapRequestFlags reqOptions)
 
void requestTextPage (uint pageNumber)
 
void resetSearch (int searchID)
 
Rotation rotation () const
 
bool saveChanges (const QString &fileName)
 
bool saveChanges (const QString &fileName, QString *errorText)
 
bool saveDocumentArchive (const QString &fileName)
 
void searchText (int searchID, const QString &text, bool fromStart, Qt::CaseSensitivity caseSensitivity, SearchType type, bool moveViewport, const QColor &color)
 
void setAnnotationEditingEnabled (bool enable)
 
void setHistoryClean (bool clean)
 
void setNextDocumentDestination (const QString &namedDestination)
 
void setNextDocumentViewport (const DocumentViewport &viewport)
 
void setNextViewport ()
 
void setPageTextSelection (int page, RegularAreaRect *rect, const QColor &color)
 
void setPrevViewport ()
 
void setViewport (const DocumentViewport &viewport, DocumentObserver *excludeObserver=nullptr, bool smoothMove=false)
 
void setViewportPage (int page, DocumentObserver *excludeObserver=nullptr, bool smoothMove=false)
 
void setViewportWithHistory (const DocumentViewport &viewport, DocumentObserver *excludeObserver=nullptr, bool smoothMove=false, bool updateHistory=true)
 
void setVisiblePageRects (const QVector< VisiblePageRect * > &visiblePageRects, DocumentObserver *excludeObserver=nullptr)
 
void setZoom (int factor, DocumentObserver *excludeObserver=nullptr)
 
void startFontReading ()
 
void stopFontReading ()
 
QStringList supportedMimeTypes () const
 
bool supportsPageSizes () const
 
bool supportsPrintToFile () const
 
bool supportsSearching () const
 
bool supportsTiles () const
 
bool swapBackingFile (const QString &newFileName, const QUrl &url)
 
bool swapBackingFileArchive (const QString &newFileName, const QUrl &url)
 
void translatePageAnnotation (int page, Annotation *annotation, const Okular::NormalizedPoint &delta)
 
void unregisterView (View *view)
 
const DocumentViewportviewport () const
 
const QVector< VisiblePageRect * > & visiblePageRects () const
 
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
 

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

Detailed Description

The Document.

Heart of everything. Actions take place here.

The Document is the main object in Okular. All views query the Document to get data/properties or even for accessing pages (in a 'const' way).

It is designed to keep it detached from the document type (pdf, ps, you name it..) so whenever you want to get some data, it asks its internal generators to do the job and return results in a format-independent way.

Apart from the generator (the currently running one) the document stores all the Pages ('Page' class) of the current document in a vector and notifies all the registered DocumentObservers when some content changes.

For a better understanding of hierarchies

See also
README.internals.png
DocumentObserver, Page

Definition at line 190 of file document.h.

Member Enumeration Documentation

Describes the result of an open document operation.

Since
0.20 (KDE 4.14)

Definition at line 209 of file document.h.

Describes the possible options for the pixmap requests.

Enumerator
NoOption 

No options.

RemoveAllPrevious 

Remove all the previous requests, even for non requested page pixmaps.

Definition at line 477 of file document.h.

What type of printing a document supports.

Enumerator
NoPrinting 

Printing Not Supported.

NativePrinting 

Native Cross-Platform Printing.

PostscriptPrinting 

Postscript file printing.

Definition at line 725 of file document.h.

Saving capabilities.

Their availability varies according to the underlying generator and/or the document type.

See also
canSaveChanges (SaveCapability)
Since
0.15 (KDE 4.9)
Enumerator
SaveFormsCapability 

Can save form changes.

SaveAnnotationsCapability 

Can save annotation changes.

Definition at line 833 of file document.h.

Describes how search ended.

Enumerator
MatchFound 

Any match was found.

NoMatchFound 

No match was found.

SearchCancelled 

The search was cancelled.

EndOfDocumentReached 

This is not ever emitted since 1.3. The end of document was reached without any match.

Since
0.20 (KDE 4.14)

Definition at line 626 of file document.h.

Describes the possible search types.

Enumerator
NextMatch 

Search next match.

PreviousMatch 

Search previous match.

AllDocument 

Search complete document.

GoogleAll 

Search complete document (all words in google style)

GoogleAny 

Search complete document (any words in google style)

Definition at line 614 of file document.h.

Constructor & Destructor Documentation

Document::Document ( QWidget widget)
explicit

Creates a new document with the given widget as widget to relay GUI things (messageboxes, ...).

Definition at line 2119 of file document.cpp.

Document::~Document ( )
override

Destroys the document.

Definition at line 2136 of file document.cpp.

Member Function Documentation

void Okular::Document::aboutToClose ( )
signal

This signal is emitted whenever the document is about to close.

Since
1.5.3
void Document::addObserver ( DocumentObserver observer)

Registers a new observer for the document.

Definition at line 2616 of file document.cpp.

void Document::addPageAnnotation ( int  page,
Annotation annotation 
)

Adds a new annotation to the given page.

Definition at line 3254 of file document.cpp.

void Document::adjustPageAnnotation ( int  page,
Annotation annotation,
const Okular::NormalizedPoint delta1,
const Okular::NormalizedPoint delta2 
)

Adjusts the position of the top-left and bottom-right corners of given annotation on the given page.

Can be used to implement resize functionality. delta1 in normalized coordinates is added to top-left. delta2 in normalized coordinates is added to bottom-right.

Consecutive adjustments applied to the same annotation are merged together on the undo stack if the BeingResized flag is set on the annotation.

Since
1.1.0

Definition at line 3318 of file document.cpp.

QSizeF Document::allPagesSize ( ) const

If all pages have the same size this method returns it, if the page sizes differ an empty size object is returned.

Definition at line 2997 of file document.cpp.

void Okular::Document::annotationContentsChangedByUndoRedo ( Okular::Annotation annotation,
const QString contents,
int  cursorPos,
int  anchorPos 
)
signal

This signal is emitted whenever the contents of the given annotation are changed by an undo or redo action.

The new contents (contents), cursor position (cursorPos), and anchor position (anchorPos) are included

Since
0.17 (KDE 4.11)
QList< int > Document::bookmarkedPageList ( ) const

Returns a list of the bookmarked.pages.

Definition at line 3775 of file document.cpp.

QString Document::bookmarkedPageRange ( ) const

Returns the range of the bookmarked.pages.

Definition at line 3789 of file document.cpp.

BookmarkManager * Document::bookmarkManager ( ) const

Returns the bookmark manager of the document.

Definition at line 3770 of file document.cpp.

void Document::cancelSearch ( )
slot

Cancels the current search.

Definition at line 3714 of file document.cpp.

bool Document::canConfigurePrinter ( ) const

Returns whether the document can configure the printer itself.

Definition at line 2695 of file document.cpp.

bool Document::canExportToText ( ) const

Returns whether the document supports the export to ASCII text.

Definition at line 2884 of file document.cpp.

bool Document::canModifyPageAnnotation ( const Annotation annotation) const

Tests if the annotation can be modified.

Since
0.15 (KDE 4.9)

Definition at line 3264 of file document.cpp.

bool Document::canProvideFontInformation ( ) const

Whether the current document can provide information about the fonts used in it.

Definition at line 2791 of file document.cpp.

bool Document::canRedo ( ) const

Returns true if there is a redo command available; otherwise returns false.

Since
0.17 (KDE 4.11)

Definition at line 3421 of file document.cpp.

void Okular::Document::canRedoChanged ( bool  redoAvailable)
signal

This signal is emitted whenever the availability of the redo function changes.

Since
0.17 (KDE 4.11)
bool Document::canRemovePageAnnotation ( const Annotation annotation) const

Tests if the annotation can be removed.

Since
0.15 (KDE 4.9)

Definition at line 3332 of file document.cpp.

bool Document::canSaveChanges ( SaveCapability  cap) const

Returns whether it's possible to save a given category of changes to another document.

Since
0.15 (KDE 4.9)

Definition at line 4540 of file document.cpp.

bool Document::canSaveChanges ( ) const

Returns whether the changes to the document (modified annotations, values in form fields, etc) can be saved to another document.

Equivalent to the logical OR of canSaveChanges(SaveCapability) for each capability.

Since
0.7 (KDE 4.1)

Definition at line 4525 of file document.cpp.

bool Document::canSwapBackingFile ( ) const

Returns whether the generator supports hot-swapping the current file with another identical file.

Since
1.3

Definition at line 4394 of file document.cpp.

bool Document::canUndo ( ) const

Returns true if there is an undo command available; otherwise returns false.

Since
0.17 (KDE 4.11)

Definition at line 3416 of file document.cpp.

void Okular::Document::canUndoChanged ( bool  undoAvailable)
signal

This signal is emitted whenever the availability of the undo function changes.

Since
0.17 (KDE 4.11)
void Okular::Document::close ( )
signal

This signal is emitted whenever an action requests a document close operation.

void Document::closeDocument ( )

Closes the document.

Definition at line 2490 of file document.cpp.

int Document::configurableGenerators ( ) const

Returns the number of generators that have a configuration widget.

Definition at line 4356 of file document.cpp.

void Document::continueSearch ( int  searchID)

Continues the search for the given searchID.

Definition at line 3656 of file document.cpp.

void Document::continueSearch ( int  searchID,
SearchType  type 
)

Continues the search for the given searchID, optionally specifying a new type for the search.

Since
0.7 (KDE 4.1)

Definition at line 3671 of file document.cpp.

QUrl Document::currentDocument ( ) const

Returns the url of the currently opened document.

Definition at line 2839 of file document.cpp.

uint Document::currentPage ( ) const

Returns the number of the current page.

Definition at line 2829 of file document.cpp.

void Document::docdataMigrationDone ( )

Delete annotations and form data from the docdata folder.

Call it if isDocdataMigrationNeeded() was true and you've just saved them to an external file.

Since
1.3

Definition at line 4872 of file document.cpp.

DocumentInfo Document::documentInfo ( ) const

Returns the meta data of the document.

Definition at line 2704 of file document.cpp.

DocumentInfo Document::documentInfo ( const QSet< DocumentInfo::Key > &  keys) const

Returns the asked set of meta data of the document.

The result may contain more metadata than the one asked for.

Definition at line 2714 of file document.cpp.

const DocumentSynopsis * Document::documentSynopsis ( ) const

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

Definition at line 2751 of file document.cpp.

const SourceReference * Document::dynamicSourceReference ( int  pageNr,
double  absX,
double  absY 
)

Asks the generator to dynamically generate a SourceReference for a given page number and absolute X and Y position on this page.

Attention
Ownership of the returned SourceReference is transferred to the caller.
Note
This method does not call processSourceReference( const SourceReference * )
Since
0.10 (KDE 4.4)

Definition at line 4191 of file document.cpp.

void Document::editFormButtons ( int  pageNumber,
const QList< Okular::FormFieldButton * > &  formButtons,
const QList< bool > &  newButtonStates 
)
slot

Set the states of the group of form buttons formButtons on page page to newButtonStates.

The lists formButtons and newButtonStates should be the same length and true values in newButtonStates indicate that the corresponding entry in formButtons should be enabled.

Definition at line 3755 of file document.cpp.

void Document::editFormCombo ( int  pageNumber,
Okular::FormFieldChoice form,
const QString newText,
int  newCursorPos,
int  prevCursorPos,
int  prevAnchorPos 
)
slot

Set the active choice in the combo box form on page page to newText The new cursor position (newCursorPos), previous cursor position (prevCursorPos), and previous anchor position (prevAnchorPos) will be restored by the undo / redo commands.

Since
0.17 (KDE 4.11)

Definition at line 3742 of file document.cpp.

void Document::editFormList ( int  pageNumber,
Okular::FormFieldChoice form,
const QList< int > &  newChoices 
)
slot

Edit the selected list entries in form on page page to be newChoices.

Since
0.17 (KDE 4.11)

Definition at line 3735 of file document.cpp.

void Document::editFormText ( int  pageNumber,
Okular::FormFieldText form,
const QString newContents,
int  newCursorPos,
int  prevCursorPos,
int  prevAnchorPos 
)
slot

Edit the text contents of the specified form on page page to be newContents.

The new text cursor position (newCursorPos), previous text cursor position (prevCursorPos), and previous cursor anchor position will be restored by the undo / redo commands.

Since
0.17 (KDE 4.11)

Definition at line 3729 of file document.cpp.

void Document::editPageAnnotationContents ( int  page,
Annotation annotation,
const QString newContents,
int  newCursorPos,
int  prevCursorPos,
int  prevAnchorPos 
)

Edits the plain text contents of the given annotation on the given page.

The contents are set to newContents with cursor position newCursorPos. The previous cursor position prevCursorPos and previous anchor position prevAnchorPos must also be supplied so that they can be restored if the edit action is undone.

The Annotation's internal contents should not be modified prior to calling this method.

Since
0.17 (KDE 4.11)

Definition at line 3325 of file document.cpp.

const QList< EmbeddedFile * > * Document::embeddedFiles ( ) const

Returns the list of embedded files or 0 if no embedded files are available.

Definition at line 2796 of file document.cpp.

void Okular::Document::error ( const QString text,
int  duration 
)
signal

This signal is emitted whenever an error occurred.

Parameters
textThe description of the error.
durationThe time in milliseconds the message should be shown to the user.
ExportFormat::List Document::exportFormats ( ) const

Returns the list of supported export formats.

See also
ExportFormat

Definition at line 2905 of file document.cpp.

bool Document::exportTo ( const QString fileName,
const ExportFormat format 
) const

Exports the document in the given format and saves it under fileName.

Definition at line 2914 of file document.cpp.

bool Document::exportToText ( const QString fileName) const

Exports the document as ASCII text and saves it under fileName.

Definition at line 2893 of file document.cpp.

bool Document::extractArchivedFile ( const QString destFileName)

Extract the document file from the current archive.

Warning
This function only works if the current file is a document archive
Since
1.3

Definition at line 4817 of file document.cpp.

void Document::fillConfigDialog ( KConfigDialog dialog)

Fill the KConfigDialog dialog with the setting pages of the generators.

Definition at line 4289 of file document.cpp.

QByteArray Document::fontData ( const FontInfo font) const

Gets the font data for the given font.

Since
0.8 (KDE 4.2)

Definition at line 4608 of file document.cpp.

void Okular::Document::fontReadingEnded ( )
signal

Reports that the reading of the fonts in the document is finished.

void Okular::Document::fontReadingProgress ( int  page)
signal

Reports the progress when reading the fonts in the document.

Parameters
pageis the page that was just finished to scan for fonts
void Okular::Document::formButtonsChangedByUndoRedo ( int  page,
const QList< Okular::FormFieldButton * > &  formButtons 
)
signal

This signal is emitted whenever the state of the specified group of form buttons (formButtons) on the given page is changed by an undo or redo action.

Since
0.17 (KDE 4.11)
void Okular::Document::formComboChangedByUndoRedo ( int  page,
Okular::FormFieldChoice form,
const QString text,
int  cursorPos,
int  anchorPos 
)
signal

This signal is emitted whenever the active text for the given combo form on the given page is changed by an undo or redo action.

Since
0.17 (KDE 4.11)
void Okular::Document::formListChangedByUndoRedo ( int  page,
Okular::FormFieldChoice form,
const QList< int > &  choices 
)
signal

This signal is emitted whenever the selected choices for the given list form on the given page are changed by an undo or redo action.

Since
0.17 (KDE 4.11)
void Okular::Document::formTextChangedByUndoRedo ( int  page,
Okular::FormFieldText form,
const QString contents,
int  cursorPos,
int  anchorPos 
)
signal

This signal is emitted whenever the text contents of the given text form on the given page are changed by an undo or redo action.

The new text contents (contents), cursor position (cursorPos), and anchor position (anchorPos) are included

Since
0.17 (KDE 4.11)
KPluginMetaData Document::generatorInfo ( ) const

Returns the metadata associated with the generator.

May be invalid.

Definition at line 4346 of file document.cpp.

void Okular::Document::gotFont ( const Okular::FontInfo font)
signal

Emitted when a new font is found during the reading of the fonts of the document.

KXMLGUIClient * Document::guiClient ( )

Returns the gui client of the generator, if it provides one.

Definition at line 2480 of file document.cpp.

bool Document::historyAtBegin ( ) const

Returns whether the document history is at the begin.

Definition at line 2919 of file document.cpp.

bool Document::historyAtEnd ( ) const

Returns whether the document history is at the end.

Definition at line 2924 of file document.cpp.

bool Document::isAllowed ( Permission  action) const

Returns whether the given action is allowed in the document.

See also
Permission

Definition at line 2844 of file document.cpp.

bool Document::isDocdataMigrationNeeded ( ) const

Since version 0.21, okular does not allow editing annotations and form data if they are stored in the docdata directory (like older okular versions did by default).

If this flag is set, then annotations and forms cannot be edited.

Since
1.3

Definition at line 4867 of file document.cpp.

bool Document::isOpened ( ) const

Returns whether the document is currently opened.

Definition at line 2690 of file document.cpp.

QAbstractItemModel * Document::layersModel ( ) const

Returns the model for rendering layers (NULL if the document has no layers)

Since
0.24

Definition at line 4880 of file document.cpp.

void Okular::Document::linkEndPresentation ( )
signal

This signal is emitted whenever an action requests an end presentation operation.

void Okular::Document::linkFind ( )
signal

This signal is emitted whenever an action requests a find operation.

void Okular::Document::linkGoToPage ( )
signal

This signal is emitted whenever an action requests a goto operation.

void Okular::Document::linkPresentation ( )
signal

This signal is emitted whenever an action requests a start presentation operation.

QVariant Document::metaData ( const QString key,
const QVariant option = QVariant() 
) const

Returns the meta data for the given key and option or an empty variant if the key doesn't exists.

Definition at line 2929 of file document.cpp.

void Document::modifyPageAnnotationProperties ( int  page,
Annotation annotation 
)

Modifies the given annotation on the given page.

Must be preceded by a call to prepareToModifyAnnotationProperties before the annotation's properties are modified

Since
0.17 (KDE 4.11)

Definition at line 3298 of file document.cpp.

void Okular::Document::notice ( const QString text,
int  duration 
)
signal

This signal is emitted to signal a notice.

Parameters
textThe description of the notice.
durationThe time in milliseconds the message should be shown to the user.
Document::OpenResult Document::openDocument ( const QString docFile,
const QUrl url,
const QMimeType mime,
const QString password = QString() 
)

Opens the document.

Since
0.20 (KDE 4.14)

Definition at line 2260 of file document.cpp.

Document::OpenResult Document::openDocumentArchive ( const QString docFile,
const QUrl url,
const QString password = QString() 
)

Opens a document archive.

Since
0.20 (KDE 4.14)

Definition at line 4708 of file document.cpp.

QString Document::openError ( ) const

Returns the reason why the file opening failed, if any.

Since
1.10

Definition at line 4885 of file document.cpp.

void Okular::Document::openUrl ( const QUrl url)
signal

This signal is emitted whenever an action requests an open url operation for the given document url.

QPrinter::Orientation Document::orientation ( ) const

Returns the orientation of the document (for printing purposes).

This is used in the KPart to initialize the print dialog and in the generators to check whether the document needs to be rotated or not.

Since
0.14 (KDE 4.8)

Definition at line 4828 of file document.cpp.

const Page * Document::page ( int  number) const

Returns the page object for the given page number or 0 if the number is out of range.

Definition at line 2801 of file document.cpp.

uint Document::pages ( ) const

Returns the number of pages of the document.

Definition at line 2834 of file document.cpp.

PageSize::List Document::pageSizes ( ) const

Returns the list of supported page sizes or an empty list if this feature is not available.

See also
supportsPageSizes()

Definition at line 2874 of file document.cpp.

QString Document::pageSizeString ( int  page) const

Returns the size string for the given page or an empty string if the page is out of range.

Definition at line 3015 of file document.cpp.

void Document::prepareToModifyAnnotationProperties ( Annotation annotation)

Prepares to modify the properties of the given annotation.

Must be called before the annotation's properties are modified

Since
0.17 (KDE 4.11)

Definition at line 3288 of file document.cpp.

bool Document::print ( QPrinter printer)

Prints the document to the given printer.

Definition at line 4238 of file document.cpp.

QWidget * Document::printConfigurationWidget ( ) const

Returns a custom printer configuration page or 0 if no custom printer configuration page is available.

The returned object should be of a PrintOptionsWidget subclass (which is not officially enforced by the signature for binary compatibility reasons).

Definition at line 4280 of file document.cpp.

QString Document::printError ( ) const

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

Since
0.11 (KDE 4.5)

Definition at line 4243 of file document.cpp.

Document::PrintingType Document::printingSupport ( ) const

Returns what sort of printing the document supports: Native, Postscript, None.

Definition at line 4216 of file document.cpp.

void Document::processAction ( const Action action)

Processes the given action.

Definition at line 3830 of file document.cpp.

void Document::processFocusAction ( const Action action,
Okular::FormField field 
)

Processes the given focus action on the field.

Since
1.9

Definition at line 4092 of file document.cpp.

void Document::processFormatAction ( const Action action,
Okular::FormFieldText fft 
)

Processes the given format action on fft.

Since
1.9

Definition at line 4025 of file document.cpp.

void Document::processKeystrokeAction ( const Action action,
Okular::FormFieldText fft,
bool &  returnCode 
)

Processes the given keystroke action on fft.

Since
1.9

Definition at line 4069 of file document.cpp.

void Okular::Document::processMovieAction ( const Okular::MovieAction action)
signal

This signal is emitted whenever an movie action is triggered and the UI should process it.

void Okular::Document::processRenditionAction ( const Okular::RenditionAction action)
signal

This signal is emitted whenever an rendition action is triggered and the UI should process it.

Since
0.16 (KDE 4.10)
void Document::processSourceReference ( const SourceReference reference)

Processes/Executes the given source reference.

Definition at line 4133 of file document.cpp.

void Document::processValidateAction ( const Action action,
Okular::FormFieldText fft,
bool &  returnCode 
)

Processes the given keystroke action on fft.

Since
1.9

Definition at line 4112 of file document.cpp.

void Okular::Document::quit ( )
signal

This signal is emitted whenever an action requests an application quit operation.

void Document::redo ( )
slot

Redo last undone edit command.

Since
0.17 (KDE 4.11)

Definition at line 3724 of file document.cpp.

void Okular::Document::refreshFormWidget ( Okular::FormField field)
signal

This signal is emitted whenever a FormField was changed programmatically and the according widget should be updated.

Since
1.4
void Document::refreshPixmaps ( int  pageNumber)
slot

Refresh the pixmaps for the given pageNumber.

Since
1.10

Definition at line 4908 of file document.cpp.

void Document::registerView ( View view)

Register the specified view for the current document.

It is unregistered from the previous document, if any.

Since
0.7 (KDE 4.1)

Definition at line 4577 of file document.cpp.

void Document::reloadDocument ( ) const
slot

Reloads the pixmaps for whole document.

Since
0.24

Definition at line 3761 of file document.cpp.

void Document::removeObserver ( DocumentObserver observer)

Unregisters the given observer for the document.

Definition at line 2628 of file document.cpp.

void Document::removePageAnnotation ( int  page,
Annotation annotation 
)

Removes the given annotation from the given page.

Definition at line 3354 of file document.cpp.

void Document::removePageAnnotations ( int  page,
const QList< Annotation * > &  annotations 
)

Removes the given annotations from the given page.

Definition at line 3360 of file document.cpp.

void Document::reparseConfig ( )

Reparses and applies the configuration.

Definition at line 2660 of file document.cpp.

void Document::requestPixmaps ( const QLinkedList< PixmapRequest * > &  requests)

Sends requests for pixmap generation.

The same as requestPixmaps( requests, RemoveAllPrevious );

Definition at line 3099 of file document.cpp.

void Document::requestPixmaps ( const QLinkedList< PixmapRequest * > &  requests,
PixmapRequestFlags  reqOptions 
)

Sends requests for pixmap generation.

Parameters
requeststhe linked list of requests
reqOptionsthe options for the request
Since
0.7 (KDE 4.1)

Definition at line 3104 of file document.cpp.

QByteArray Document::requestSignedRevisionData ( const Okular::SignatureInfo info)
slot

Returns the part of document covered by the given signature info.

Since
1.7

Definition at line 4890 of file document.cpp.

void Document::requestTextPage ( uint  pageNumber)

Sends a request for text page generation for the given page pageNumber.

Definition at line 3233 of file document.cpp.

void Document::resetSearch ( int  searchID)

Resets the search for the given searchID.

Definition at line 3686 of file document.cpp.

Rotation Document::rotation ( ) const

Returns the current rotation of the document.

Definition at line 2992 of file document.cpp.

bool Document::saveChanges ( const QString fileName)

Save the document and the optional changes to it to the specified fileName.

Since
0.7 (KDE 4.1)

Definition at line 4556 of file document.cpp.

bool Document::saveChanges ( const QString fileName,
QString errorText 
)

Save the document and the optional changes to it to the specified fileName and returns a errorText if fails.

Since
0.10 (KDE 4.4)

Definition at line 4562 of file document.cpp.

bool Document::saveDocumentArchive ( const QString fileName)

Saves a document archive.

Since
0.8 (KDE 4.2)

Definition at line 4727 of file document.cpp.

void Okular::Document::searchFinished ( int  searchID,
Okular::Document::SearchStatus  endStatus 
)
signal

Reports that the current search finished.

void Document::searchText ( int  searchID,
const QString text,
bool  fromStart,
Qt::CaseSensitivity  caseSensitivity,
SearchType  type,
bool  moveViewport,
const QColor color 
)

Searches the given text in the document.

Parameters
searchIDThe unique id for this search request.
textThe text to be searched.
fromStartWhether the search should be started at begin of the document.
caseSensitivityWhether the search is case sensitive.
typeThe type of the search. SearchType
moveViewportWhether the viewport shall be moved to the position of the matches.
colorThe highlighting color of the matches.

Definition at line 3561 of file document.cpp.

void Document::setAnnotationEditingEnabled ( bool  enable)

Control annotation editing (creation, modification and removal), which is enabled by default.

Since
0.15 (KDE 4.9)

Definition at line 4852 of file document.cpp.

void Document::setHistoryClean ( bool  clean)

Sets the history to be clean.

Since
1.3

Definition at line 4517 of file document.cpp.

void Document::setNextDocumentDestination ( const QString namedDestination)

Sets the next namedDestination in the viewport history.

Since
0.9 (KDE 4.3)

Definition at line 3556 of file document.cpp.

void Document::setNextDocumentViewport ( const DocumentViewport viewport)

Sets the next viewport in the viewport history.

Definition at line 3551 of file document.cpp.

void Document::setNextViewport ( )

Sets the current document viewport to the previous viewport in the viewport history.

Definition at line 3533 of file document.cpp.

void Document::setPageSize ( const Okular::PageSize size)
slot

This slot is called whenever the user changes the page size of the document.

Definition at line 5079 of file document.cpp.

void Document::setPageTextSelection ( int  page,
RegularAreaRect rect,
const QColor color 
)

Clears the text selection highlights for the given page, creates new ones if rect is not nullptr, and deletes rect.

Parameters
pageThe number of the page.
rectThe rectangle of the selection.
colorThe color of the selection.

Definition at line 3400 of file document.cpp.

void Document::setPrevViewport ( )

Sets the current document viewport to the next viewport in the viewport history.

Definition at line 3517 of file document.cpp.

void Document::setRotation ( int  rotation)
slot

This slot is called whenever the user changes the rotation of the document.

Definition at line 5049 of file document.cpp.

void Document::setViewport ( const DocumentViewport viewport,
DocumentObserver excludeObserver = nullptr,
bool  smoothMove = false 
)

Sets the current document viewport to the given viewport.

Parameters
viewportThe document viewport.
excludeObserverThe observer which shouldn't be effected by this change.
smoothMoveWhether the move shall be animated smoothly.

Definition at line 3503 of file document.cpp.

void Document::setViewportPage ( int  page,
DocumentObserver excludeObserver = nullptr,
bool  smoothMove = false 
)

Sets the current document viewport to the given page.

Parameters
pageThe number of the page.
excludeObserverThe observer ids which shouldn't be effected by this change.
smoothMoveWhether the move shall be animated smoothly.

Definition at line 3491 of file document.cpp.

void Document::setViewportWithHistory ( const DocumentViewport viewport,
DocumentObserver excludeObserver = nullptr,
bool  smoothMove = false,
bool  updateHistory = true 
)

Sets the current document viewport to the given viewport.

BCI TODO: merge with setViewport, adding a parameter "bool updateHistory = true"

Parameters
viewportThe document viewport.
excludeObserverThe observer which shouldn't be effected by this change.
smoothMoveWhether the move shall be animated smoothly.
updateHistoryWhether to consider the change of viewport for the history navigation

Definition at line 3442 of file document.cpp.

void Document::setVisiblePageRects ( const QVector< VisiblePageRect * > &  visiblePageRects,
DocumentObserver excludeObserver = nullptr 
)

Sets the list of visible page rectangles.

See also
VisiblePageRect

Definition at line 2816 of file document.cpp.

void Document::setZoom ( int  factor,
DocumentObserver excludeObserver = nullptr 
)

Sets the zoom for the current document.

Definition at line 3509 of file document.cpp.

void Okular::Document::sourceReferenceActivated ( const QString absFileName,
int  line,
int  col,
bool *  handled 
)
signal

This signal is emitted whenever a source reference with the given parameters has been activated.

Parameters
absFileNameabsolute name of the file.
lineline number.
colcolumn number.
handledshould be set to 'true' if a slot handles this source reference; the default action to launch the configured editor will then not be performed by the document
Since
0.14 (KDE 4.8)
void Document::startFontReading ( )

Starts the reading of the information about the fonts in the document, if available.

The results as well the end of the reading is notified using the signals gotFont(), fontReadingProgress() and fontReadingEnded()

Definition at line 2756 of file document.cpp.

void Document::stopFontReading ( )

Force the termination of the reading of the information about the fonts in the document, if running.

Definition at line 2780 of file document.cpp.

QStringList Document::supportedMimeTypes ( ) const

Returns the list with the supported MIME types.

Definition at line 4361 of file document.cpp.

bool Document::supportsPageSizes ( ) const

Returns whether the document supports the listing of page sizes.

Definition at line 2864 of file document.cpp.

bool Document::supportsPrintToFile ( ) const

Returns whether the document supports printing to both PDF and PS files.

Definition at line 4233 of file document.cpp.

bool Document::supportsSearching ( ) const

Returns whether the document supports searching.

Definition at line 2859 of file document.cpp.

bool Document::supportsTiles ( ) const

Returns whether the current document supports tiles.

Since
0.16 (KDE 4.10)

Definition at line 2869 of file document.cpp.

bool Document::swapBackingFile ( const QString newFileName,
const QUrl url 
)

Reload the document from a new location, without any visible effect to the user.

The new file must be identical to the current one or, if the document has been modified (eg the user edited forms and annotations), the new document must have these changes too. For example, you can call saveChanges first to write changes to a file and then swapBackingFile to switch to the new location.

Since
1.3

Definition at line 4402 of file document.cpp.

bool Document::swapBackingFileArchive ( const QString newFileName,
const QUrl url 
)

Same as swapBackingFile, but newFileName must be a .okular file.

The new file must be identical to the current one or, if the document has been modified (eg the user edited forms and annotations), the new document must have these changes too. For example, you can call saveDocumentArchive first to write changes to a file and then swapBackingFileArchive to switch to the new location.

Since
1.3

Definition at line 4497 of file document.cpp.

void Document::translatePageAnnotation ( int  page,
Annotation annotation,
const Okular::NormalizedPoint delta 
)

Translates the position of the given annotation on the given page by a distance delta in normalized coordinates.

Consecutive translations applied to the same annotation are merged together on the undo stack if the BeingMoved flag is set on the annotation.

Since
0.17 (KDE 4.11)

Definition at line 3311 of file document.cpp.

void Document::undo ( )
slot

Undo last edit command.

Since
0.17 (KDE 4.11)

Definition at line 3719 of file document.cpp.

void Okular::Document::undoHistoryCleanChanged ( bool  clean)
signal

This signal is emitted whenever the undo history is clean (i.e.

the same status the last time it was saved)

Since
1.3
void Document::unregisterView ( View view)

Unregister the specified view from the current document.

Since
0.7 (KDE 4.1)

Definition at line 4595 of file document.cpp.

const DocumentViewport & Document::viewport ( ) const

Returns the current viewport of the document.

Definition at line 2806 of file document.cpp.

const QVector< VisiblePageRect * > & Document::visiblePageRects ( ) const

Returns the list of visible page rectangles.

Definition at line 2811 of file document.cpp.

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

Returns which wallet data to use to read/write the password for the given fileName.

Since
0.20 (KDE 4.14)

Definition at line 4858 of file document.cpp.

void Okular::Document::warning ( const QString text,
int  duration 
)
signal

This signal is emitted to signal a warning.

Parameters
textThe description of the warning.
durationThe time in milliseconds 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 Mon Nov 30 2020 22:36:28 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.