Okular
document.h
102 };
197 * Creates a new document with the given @p widget as widget to relay GUI things (messageboxes, ...).
220 OpenResult openDocument(const QString &docFile, const QUrl &url, const QMimeType &mime, const QString &password = QString());
311 void setVisiblePageRects(const QVector<VisiblePageRect *> &visiblePageRects, DocumentObserver *excludeObserver = nullptr);
429 void setViewportPage(int page, DocumentObserver *excludeObserver = nullptr, bool smoothMove = false);
439 void setViewport(const DocumentViewport &viewport, DocumentObserver *excludeObserver = nullptr, bool smoothMove = false, bool updateHistory = true);
475 RemoveAllPrevious = 1 ///< Remove all the previous requests, even for non requested page pixmaps
476 };
533 * Translates the position of the given @p annotation on the given @p page by a distance @p delta in normalized coordinates.
535 * Consecutive translations applied to the same @p annotation are merged together on the undo stack if the
540 void translatePageAnnotation(int page, Annotation *annotation, const Okular::NormalizedPoint &delta);
543 * Adjusts the position of the top-left and bottom-right corners of given @p annotation on the given @p page.
549 * Consecutive adjustments applied to the same @p annotation are merged together on the undo stack if the
554 void adjustPageAnnotation(int page, Annotation *annotation, const Okular::NormalizedPoint &delta1, const Okular::NormalizedPoint &delta2);
567 void editPageAnnotationContents(int page, Annotation *annotation, const QString &newContents, int newCursorPos, int prevCursorPos, int prevAnchorPos);
595 void setPageTextSelection(int page, std::unique_ptr<RegularAreaRect> &&rect, const QColor &color);
618 };
627 };
640 void searchText(int searchID, const QString &text, bool fromStart, Qt::CaseSensitivity caseSensitivity, SearchType type, bool moveViewport, const QColor &color);
676 OKULARCORE_DEPRECATED void processFormatAction(const Action *action, Okular::FormFieldText *fft);
689 * @deprecated use processKeystrokeAction(const Action *, Okular::FormField *, const QVariant &, int, int)
691 OKULARCORE_DEPRECATED void processKeystrokeAction(const Action *action, Okular::FormFieldText *fft, const QVariant &newValue);
694 * Processes the given keystroke @p action on @p ff between the two positions @p prevCursorPos and @p prevAnchorPos
695 * @p prevCursorPos and @p prevAnchorPos are used to set the selStart and selEnd event properties.
699 void processKeystrokeAction(const Action *action, Okular::FormField *ff, const QVariant &newValue, int prevCursorPos, int prevAnchorPos);
708 OKULARCORE_DEPRECATED void processKeystrokeCommitAction(const Action *action, Okular::FormFieldText *fft);
717 void processKeystrokeCommitAction(const Action *action, Okular::FormField *ff, bool &returnCode);
732 OKULARCORE_DEPRECATED void processValidateAction(const Action *action, Okular::FormFieldText *fft, bool &returnCode);
735 * Validates the input value in the FormField @p ff and sets the @p returnCode for a given validate @p action.
742 * A method that executes the relevant keystroke, validate, calculate and format actions on a FormField @p ff.
754 OKULARCORE_DEPRECATED void processFormMouseUpScripAction(const Action *action, Okular::FormField *ff);
768 void processFormMouseScriptAction(const Action *action, Okular::FormField *ff, MouseEventType fieldMouseEventType);
817 };
944 };
1009 OpenResult openDocumentArchive(const QString &docFile, const QUrl &url, const QString &password = QString());
1060 void walletDataForFile(const QString &fileName, QString *walletName, QString *walletFolder, QString *walletKey) const;
1156 * The new text cursor position (@p newCursorPos), previous text cursor position (@p prevCursorPos),
1160 * @deprecated use editFormText(int pageNumber, Okular::FormFieldText *form, const QString &newContents,
1163 OKULARCORE_DEPRECATED void editFormText(int pageNumber, Okular::FormFieldText *form, const QString &newContents, int newCursorPos, int prevCursorPos, int prevAnchorPos);
1167 * previous contents are @p oldContents for undo/redo commands. The new text cursor position (@p newCursorPos),
1168 * previous text cursor position (@p prevCursorPos), and previous cursor anchor position will be restored by the undo / redo commands.
1171 void editFormText(int pageNumber, Okular::FormFieldText *form, const QString &newContents, int newCursorPos, int prevCursorPos, int prevAnchorPos, const QString &oldContents);
1177 void editFormList(int pageNumber, Okular::FormFieldChoice *form, const QList<int> &newChoices);
1187 void editFormCombo(int pageNumber, Okular::FormFieldChoice *form, const QString &newText, int newCursorPos, int prevCursorPos, int prevAnchorPos);
1190 * Set the states of the group of form buttons @p formButtons on page @p page to @p newButtonStates.
1192 * in @p newButtonStates indicate that the corresponding entry in @p formButtons should be enabled.
1194 void editFormButtons(int pageNumber, const QList<Okular::FormFieldButton *> &formButtons, const QList<bool> &newButtonStates);
1360 * This signal is emitted whenever the undo history is clean (i.e. the same status the last time it was saved)
1366 * This signal is emitted whenever an rendition action is triggered and the UI should process it.
1373 * This signal is emitted whenever the contents of the given @p annotation are changed by an undo
1376 * The new contents (@p contents), cursor position (@p cursorPos), and anchor position (@p anchorPos) are
1380 void annotationContentsChangedByUndoRedo(Okular::Annotation *annotation, const QString &contents, int cursorPos, int anchorPos);
1383 * This signal is emitted whenever the text contents of the given text @p form on the given @p page
1386 * The new text contents (@p contents), cursor position (@p cursorPos), and anchor position (@p anchorPos) are
1390 void formTextChangedByUndoRedo(int page, Okular::FormFieldText *form, const QString &contents, int cursorPos, int anchorPos);
1397 void formListChangedByUndoRedo(int page, Okular::FormFieldChoice *form, const QList<int> &choices);
1404 void formComboChangedByUndoRedo(int page, Okular::FormFieldChoice *form, const QString &text, int cursorPos, int anchorPos);
1407 * This signal is emitted whenever the state of the specified group of form buttons (@p formButtons) on the
1411 void formButtonsChangedByUndoRedo(int page, const QList<Okular::FormFieldButton *> &formButtons);
1612 explicit VisiblePageRect(int pageNumber = -1, const NormalizedRect &rectangle = NormalizedRect());
Annotation struct holds properties shared by all annotations.
Definition annotations.h:99
A helper class to store information about x509 certificate.
Definition signatureutils.h:517
The DocumentInfo structure can be filled in by generators to display metadata about the currently ope...
Definition document.h:76
@ Creator
The creator of the document (this can be different from the author)
Definition document.h:88
Base class for objects being notified when something changes.
Definition observer.h:29
void fontReadingEnded()
Reports that the reading of the fonts in the document is finished.
void error(const QString &text, int duration)
This signal is emitted whenever an error occurred.
void linkEndPresentation()
This signal is emitted whenever an action requests an end presentation operation.
void canUndoChanged(bool undoAvailable)
This signal is emitted whenever the availability of the undo function changes.
void linkGoToPage()
This signal is emitted whenever an action requests a goto operation.
void canRedoChanged(bool redoAvailable)
This signal is emitted whenever the availability of the redo function changes.
void linkPresentation()
This signal is emitted whenever an action requests a start presentation operation.
DocumentInfo documentInfo() const
Returns the meta data of the document.
DocumentAdditionalActionType
Describes the additional actions available in the Document.
Definition document.h:775
void linkFind()
This signal is emitted whenever an action requests a find operation.
void aboutToClose()
This signal is emitted whenever the document is about to close.
void gotFont(const Okular::FontInfo &font)
Emitted when a new font is found during the reading of the fonts of the document.
void requestPrint()
This signal is emitted whenever an action requests a document print operation.
void close()
This signal is emitted whenever an action requests a document close operation.
void annotationContentsChangedByUndoRedo(Okular::Annotation *annotation, const QString &contents, int cursorPos, int anchorPos)
This signal is emitted whenever the contents of the given annotation are changed by an undo or redo a...
void openUrl(const QUrl &url)
This signal is emitted whenever an action requests an open url operation for the given document url.
void sourceReferenceActivated(const QString &absFileName, int line, int col, bool *handled)
This signal is emitted whenever a source reference with the given parameters has been activated.
void notice(const QString &text, int duration)
This signal is emitted to signal a notice.
void requestSaveAs()
This signal is emitted whenever an action requests a document save as operation.
void quit()
This signal is emitted whenever an action requests an application quit operation.
void fontReadingProgress(int page)
Reports the progress when reading the fonts in the document.
void warning(const QString &text, int duration)
This signal is emitted to signal a warning.
void searchFinished(int searchID, Okular::Document::SearchStatus endStatus)
Reports that the current search finished.
void refreshFormWidget(Okular::FormField *field)
This signal is emitted whenever a FormField was changed programmatically and the according widget sho...
void undoHistoryCleanChanged(bool clean)
This signal is emitted whenever the undo history is clean (i.e.
void processMovieAction(const Okular::MovieAction *action)
This signal is emitted whenever an movie action is triggered and the UI should process it.
void formComboChangedByUndoRedo(int page, Okular::FormFieldChoice *form, const QString &text, int cursorPos, int anchorPos)
This signal is emitted whenever the active text for the given combo form on the given page is changed...
void formButtonsChangedByUndoRedo(int page, const QList< Okular::FormFieldButton * > &formButtons)
This signal is emitted whenever the state of the specified group of form buttons (formButtons) on the...
void processRenditionAction(const Okular::RenditionAction *action)
This signal is emitted whenever an rendition action is triggered and the UI should process it.
void formTextChangedByUndoRedo(int page, Okular::FormFieldText *form, const QString &contents, int cursorPos, int anchorPos)
This signal is emitted whenever the text contents of the given text form on the given page are change...
void formListChangedByUndoRedo(int page, Okular::FormFieldChoice *form, const QList< int > &choices)
This signal is emitted whenever the selected choices for the given list form on the given page are ch...
virtual int size() const =0
Returns the size (in bytes) of the file, if available, or -1 otherwise.
virtual QDateTime creationDate() const =0
Returns the creation date of the file, or an invalid date if not available.
virtual QDateTime modificationDate() const =0
Returns the modification date of the file, or an invalid date if not available.
virtual QString description() const =0
Returns the description of the file, or an empty string if not available.
virtual QByteArray data() const =0
Returns the real data representing the file contents.
The Movie action executes an operation on a video on activation.
Definition action.h:469
NormalizedPoint is a helper class which stores the coordinates of a normalized point.
Definition area.h:117
A NormalizedRect is a rectangle which can be defined by two NormalizedPoints.
Definition area.h:189
The Rendition action executes an operation on a video or executes some JavaScript code on activation.
Definition action.h:523
Generator
Annotation
Orientation
CaseSensitivity
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Oct 11 2024 12:08:40 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Oct 11 2024 12:08:40 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.