Okular
document.h
6 SPDX-FileCopyrightText: 2017 Klarälvdalens Datakonsult AB a KDAB Group company <[email protected]>
196 * Creates a new document with the given @p widget as widget to relay GUI things (messageboxes, ...).
212 OpenNeedsPassword //< The document needs a password to be opened or the one provided is not the correct
219 OpenResult openDocument(const QString &docFile, const QUrl &url, const QMimeType &mime, const QString &password = QString());
310 void setVisiblePageRects(const QVector<VisiblePageRect *> &visiblePageRects, DocumentObserver *excludeObserver = nullptr);
428 void setViewportPage(int page, DocumentObserver *excludeObserver = nullptr, bool smoothMove = false);
437 void setViewport(const DocumentViewport &viewport, DocumentObserver *excludeObserver = nullptr, bool smoothMove = false);
448 void setViewportWithHistory(const DocumentViewport &viewport, DocumentObserver *excludeObserver = nullptr, bool smoothMove = false, bool updateHistory = true);
484 RemoveAllPrevious = 1 ///< Remove all the previous requests, even for non requested page pixmaps
542 * Translates the position of the given @p annotation on the given @p page by a distance @p delta in normalized coordinates.
544 * Consecutive translations applied to the same @p annotation are merged together on the undo stack if the
549 void translatePageAnnotation(int page, Annotation *annotation, const Okular::NormalizedPoint &delta);
552 * Adjusts the position of the top-left and bottom-right corners of given @p annotation on the given @p page.
558 * Consecutive adjustments applied to the same @p annotation are merged together on the undo stack if the
563 void adjustPageAnnotation(int page, Annotation *annotation, const Okular::NormalizedPoint &delta1, const Okular::NormalizedPoint &delta2);
576 void editPageAnnotationContents(int page, Annotation *annotation, const QString &newContents, int newCursorPos, int prevCursorPos, int prevAnchorPos);
649 void searchText(int searchID, const QString &text, bool fromStart, Qt::CaseSensitivity caseSensitivity, SearchType type, bool moveViewport, const QColor &color);
691 void processKeystrokeAction(const Action *action, Okular::FormFieldText *fft, const QVariant &newValue);
929 OpenResult openDocumentArchive(const QString &docFile, const QUrl &url, const QString &password = QString());
980 void walletDataForFile(const QString &fileName, QString *walletName, QString *walletFolder, QString *walletKey) const;
1076 * The new text cursor position (@p newCursorPos), previous text cursor position (@p prevCursorPos),
1080 void editFormText(int pageNumber, Okular::FormFieldText *form, const QString &newContents, int newCursorPos, int prevCursorPos, int prevAnchorPos);
1086 void editFormList(int pageNumber, Okular::FormFieldChoice *form, const QList<int> &newChoices);
1096 void editFormCombo(int pageNumber, Okular::FormFieldChoice *form, const QString &newText, int newCursorPos, int prevCursorPos, int prevAnchorPos);
1099 * Set the states of the group of form buttons @p formButtons on page @p page to @p newButtonStates.
1101 * in @p newButtonStates indicate that the corresponding entry in @p formButtons should be enabled.
1103 void editFormButtons(int pageNumber, const QList<Okular::FormFieldButton *> &formButtons, const QList<bool> &newButtonStates);
1269 * This signal is emitted whenever the undo history is clean (i.e. the same status the last time it was saved)
1275 * This signal is emitted whenever an rendition action is triggered and the UI should process it.
1282 * This signal is emitted whenever the contents of the given @p annotation are changed by an undo
1285 * The new contents (@p contents), cursor position (@p cursorPos), and anchor position (@p anchorPos) are
1289 void annotationContentsChangedByUndoRedo(Okular::Annotation *annotation, const QString &contents, int cursorPos, int anchorPos);
1292 * This signal is emitted whenever the text contents of the given text @p form on the given @p page
1295 * The new text contents (@p contents), cursor position (@p cursorPos), and anchor position (@p anchorPos) are
1299 void formTextChangedByUndoRedo(int page, Okular::FormFieldText *form, const QString &contents, int cursorPos, int anchorPos);
1306 void formListChangedByUndoRedo(int page, Okular::FormFieldChoice *form, const QList<int> &choices);
1313 void formComboChangedByUndoRedo(int page, Okular::FormFieldChoice *form, const QString &text, int cursorPos, int anchorPos);
1316 * This signal is emitted whenever the state of the specified group of form buttons (@p formButtons) on the
1320 void formButtonsChangedByUndoRedo(int page, const QList<Okular::FormFieldButton *> &formButtons);
1521 explicit VisiblePageRect(int pageNumber = -1, const NormalizedRect &rectangle = NormalizedRect());
A helper class to store information about x509 certificate.
Definition: signatureutils.h:254
CaseSensitivity
The Rendition action executes an operation on a video or executes some JavaScript code on activation.
Definition: action.h:499
Annotation struct holds properties shared by all annotations.
Definition: annotations.h:95
@ Creator
The creator of the document (this can be different from the author)
Definition: document.h:87
NormalizedPoint is a helper class which stores the coordinates of a normalized point.
Definition: area.h:116
Base class for objects being notified when something changes.
Definition: observer.h:28
The Movie action executes an operation on a video on activation.
Definition: action.h:445
This is a list of NormalizedRect, to describe an area consisting of multiple rectangles using normali...
Definition: area.h:932
A NormalizedRect is a rectangle which can be defined by two NormalizedPoints.
Definition: area.h:188
Generator
A helper class to store information about digital signature.
Definition: signatureutils.h:142
Orientation
The DocumentInfo structure can be filled in by generators to display metadata about the currently ope...
Definition: document.h:74
virtual QVariant get(ScriptableExtension *callerPrincipal, quint64 objId, const QString &propName)
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Mar 27 2023 04:09:00 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Mar 27 2023 04:09:00 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.