okular/part/part.h
2021-11-09 01:27:50 +00:00

462 lines
15 KiB
C++

/*
SPDX-FileCopyrightText: 2002 Wilco Greven <greven@kde.org>
SPDX-FileCopyrightText: 2003-2004 Christophe Devriese <Christophe.Devriese@student.kuleuven.ac.be>
SPDX-FileCopyrightText: 2003 Andy Goossens <andygoossens@telenet.be>
SPDX-FileCopyrightText: 2003 Laurent Montel <montel@kde.org>
SPDX-FileCopyrightText: 2004 Dominique Devriese <devriese@kde.org>
SPDX-FileCopyrightText: 2004-2007 Albert Astals Cid <aacid@kde.org>
Work sponsored by the LiMux project of the city of Munich:
SPDX-FileCopyrightText: 2017 Klarälvdalens Datakonsult AB a KDAB Group company <info@kdab.com>
SPDX-License-Identifier: GPL-2.0-or-later
*/
#ifndef _PART_H_
#define _PART_H_
#include <QIcon>
#include <QList>
#include <QPointer>
#include <QProcess>
#include <QUrl>
#include <QtDBus> // krazy:exclude=includes
#include <KCompressionDevice>
#include <KIO/Job>
#include <KMessageWidget>
#include <KParts/ReadWritePart>
#include <KPluginFactory>
#include "../core/document.h"
#include "../core/observer.h"
#include "../interfaces/viewerinterface.h"
#include "../kdocumentviewer.h"
#include "okularpart_export.h"
#include <config-okular.h>
class QAction;
class QWidget;
class QPrinter;
class QMenu;
class KConfigDialog;
class KDirWatch;
class KHamburgerMenu;
class KMainWindow;
class KToggleAction;
class KToggleFullScreenAction;
class QTemporaryFile;
class QAction;
class QJsonObject;
namespace KParts
{
class GUIActivateEvent;
}
class FindBar;
class ThumbnailList;
class PageSizeLabel;
class PageView;
class PresentationWidget;
class ProgressWidget;
class SearchWidget;
class Sidebar;
class TOC;
class MiniBar;
class MiniBarLogic;
class FileKeeper;
class Reviews;
class BookmarkList;
class DrawingToolActions;
class Layers;
class SignaturePanel;
#if PURPOSE_FOUND
namespace Purpose
{
class Menu;
}
#endif
namespace Okular
{
class BrowserExtension;
class ExportFormat;
/**
* Describes the possible embedding modes of the part
*
* @since 0.14 (KDE 4.8)
*/
enum EmbedMode {
UnknownEmbedMode,
NativeShellMode, // embedded in the native Okular' shell
PrintPreviewMode, // embedded to show the print preview of a document
KHTMLPartMode, // embedded in KHTML
ViewerWidgetMode // the part acts as a widget that can display all kinds of documents
};
/**
* This is a "Part". It that does all the real work in a KPart
* application.
*
* @short Main Part
* @author Wilco Greven <greven@kde.org>
* @version 0.2
*/
class OKULARPART_EXPORT Part : public KParts::ReadWritePart, public Okular::DocumentObserver, public KDocumentViewer, public Okular::ViewerInterface
{
Q_OBJECT
Q_CLASSINFO("D-Bus Interface", "org.kde.okular")
Q_INTERFACES(KDocumentViewer)
Q_INTERFACES(Okular::ViewerInterface)
friend class PartTest;
public:
// Default constructor
/**
* If one element of 'args' contains one of the strings "Print/Preview" or "ViewerWidget",
* the part will be set up in the corresponding mode. Additionally, it is possible to specify
* which config file should be used by adding a string containing "ConfigFileName=<file name>"
* to 'args'.
**/
Part(QWidget *parentWidget, QObject *parent, const QVariantList &args);
// Destructor
~Part() override;
// inherited from DocumentObserver
void notifySetup(const QVector<Okular::Page *> &pages, int setupFlags) override;
void notifyViewportChanged(bool smoothMove) override;
void notifyPageChanged(int page, int flags) override;
bool openDocument(const QUrl &url, uint page) override;
void startPresentation() override;
QStringList supportedMimeTypes() const override;
QUrl realUrl() const;
void showSourceLocation(const QString &fileName, int line, int column, bool showGraphically = true) override;
void clearLastShownSourceLocation() override;
bool isWatchFileModeEnabled() const override;
void setWatchFileModeEnabled(bool enable) override;
bool areSourceLocationsShownGraphically() const override;
void setShowSourceLocationsGraphically(bool show) override;
bool openNewFilesInTabs() const override;
Q_INVOKABLE bool activateTabIfAlreadyOpenFile() const;
public Q_SLOTS: // dbus
Q_SCRIPTABLE Q_NOREPLY void goToPage(uint page) override;
Q_SCRIPTABLE Q_NOREPLY void openDocument(const QString &doc);
Q_SCRIPTABLE uint pages();
Q_SCRIPTABLE uint currentPage();
Q_SCRIPTABLE QString currentDocument();
Q_SCRIPTABLE QString documentMetaData(const QString &metaData) const;
Q_SCRIPTABLE void slotPreferences();
Q_SCRIPTABLE void slotFind();
Q_SCRIPTABLE void slotPrintPreview();
Q_SCRIPTABLE void slotPreviousPage();
Q_SCRIPTABLE void slotNextPage();
Q_SCRIPTABLE void slotGotoFirst();
Q_SCRIPTABLE void slotGotoLast();
Q_SCRIPTABLE void slotTogglePresentation();
Q_SCRIPTABLE void slotToggleChangeColors();
Q_SCRIPTABLE void slotSetChangeColors(bool active);
Q_SCRIPTABLE Q_NOREPLY void reload();
Q_SCRIPTABLE Q_NOREPLY void enableStartWithPrint();
Q_SCRIPTABLE Q_NOREPLY void enableExitAfterPrint();
Q_SCRIPTABLE Q_NOREPLY void enableStartWithFind(const QString &text);
Q_SCRIPTABLE void slotOpenContainingFolder();
Q_SIGNALS:
void enablePrintAction(bool enable);
void openSourceReference(const QString &absFileName, int line, int column);
void viewerMenuStateChange(bool enabled);
void enableCloseAction(bool enable);
void mimeTypeChanged(const QMimeType &mimeType);
void urlsDropped(const QList<QUrl> &urls);
void fitWindowToPage(const QSize pageViewPortSize, const QSize pageSize);
protected:
// reimplemented from KParts::ReadWritePart
bool openFile() override;
bool openUrl(const QUrl &url) override;
void guiActivateEvent(KParts::GUIActivateEvent *event) override;
void displayInfoMessage(const QString &message, KMessageWidget::MessageType messageType = KMessageWidget::Information, int duration = -1);
public:
bool queryClose() override;
bool closeUrl() override;
bool closeUrl(bool promptToSave) override;
void setReadWrite(bool readwrite) override;
bool saveAs(const QUrl &saveUrl) override;
protected Q_SLOTS:
// connected to actions
void openUrlFromDocument(const QUrl &url);
void openUrlFromBookmarks(const QUrl &url);
void handleDroppedUrls(const QList<QUrl> &urls);
void slotGoToPage();
void slotHistoryBack();
void slotHistoryNext();
void slotAddBookmark();
void slotRenameBookmarkFromMenu();
void slotRemoveBookmarkFromMenu();
void slotRenameCurrentViewportBookmark();
void slotPreviousBookmark();
void slotNextBookmark();
void slotFindNext();
void slotFindPrev();
bool slotSaveFileAs(bool showOkularArchiveAsDefaultFormat = false);
void slotNewConfig();
void slotShowMenu(const Okular::Page *page, const QPoint point);
void slotShowTOCMenu(const Okular::DocumentViewport &vp, const QPoint point, const QString &title);
void slotShowProperties();
void slotShowEmbeddedFiles();
void slotShowLeftPanel();
void slotShowBottomBar();
void slotShowPresentation();
void slotHidePresentation();
/**
* Updates the menu that is by default at the right end of the toolbar.
* In true "simple by default" fashion, the menu only contains the most important actions
* which are needed to use all essential Okular features. More advanced actions can be
* discovered through a sub-menu (@see KConfigWidgets::KHamburgerMenu::setMenuBarAdvertised()).
*/
void slotUpdateHamburgerMenu();
void slotExportAs(QAction *);
bool slotImportPSFile();
void slotAboutBackend();
void slotReload();
void close();
void cannotQuit();
void slotShowFindBar();
void slotHideFindBar();
void slotJobStarted(KIO::Job *job);
void slotJobFinished(KJob *job);
void loadCancelled(const QString &reason);
void setWindowTitleFromDocument();
// can be connected to widget elements
void updateViewActions();
void updateBookmarksActions();
void enableTOC(bool enable);
void slotRebuildBookmarkMenu();
void enableLayers(bool enable);
void enableSidebarSignaturesItem(bool enable);
public Q_SLOTS:
bool saveFile() override;
// connected to Shell action (and browserExtension), not local one
void slotPrint();
void slotFileDirty(const QString &);
bool slotAttemptReload(bool oneShot = false, const QUrl &newUrl = QUrl());
void psTransformEnded(int, QProcess::ExitStatus);
KConfigDialog *slotGeneratorPreferences();
void errorMessage(const QString &message, int duration = 0);
void warningMessage(const QString &message, int duration = -1);
void noticeMessage(const QString &message, int duration = -1);
void moveSplitter(const int sideWidgetSize);
private:
bool aboutToShowContextMenu(QMenu *menu, QAction *action, QMenu *contextMenu);
void showMenu(const Okular::Page *page, const QPoint point, const QString &bookmarkTitle = QString(), const Okular::DocumentViewport &vp = DocumentViewport(), bool showTOCActions = false);
/**
* Searches the actionCollections of all KXMLGUIClients that were created by the same factory()
* as this Part for a QAction that has both the specified name and the specified class.
* @return an action with class @p Action and name @p actionName. nullptr if no such action is found.
*/
template<class Action = QAction> Action *findActionInKPartHierarchy(const QString &actionName);
/** @return the first KMainWindow among the ancestors of this part. nullptr if no KMainWindow is found. */
KMainWindow *findMainWindow();
bool eventFilter(QObject *watched, QEvent *event) override;
Document::OpenResult doOpenFile(const QMimeType &mime, const QString &fileNameToOpen, bool *isCompressedFile);
bool openUrl(const QUrl &url, bool swapInsteadOfOpening);
void setupViewerActions();
void setViewerShortcuts();
void setupActions();
void setupPrint(QPrinter &printer);
bool doPrint(QPrinter &printer);
bool handleCompressed(QString &destpath, const QString &path, KCompressionDevice::CompressionType compressionType);
void rebuildBookmarkMenu(bool unplugActions = true);
void updateAboutBackendAction();
void unsetDummyMode();
void slotRenameBookmark(const DocumentViewport &viewport);
void slotRemoveBookmark(const DocumentViewport &viewport);
void resetStartArguments();
void checkNativeSaveDataLoss(bool *out_wontSaveForms, bool *out_wontSaveAnnotations) const;
enum SaveAsFlag {
NoSaveAsFlags = 0, ///< No options
SaveAsOkularArchive = 1 ///< Save as Okular Archive (.okular) instead of document's native format
};
Q_DECLARE_FLAGS(SaveAsFlags, SaveAsFlag)
bool saveAs(const QUrl &saveUrl, SaveAsFlags flags);
void setFileToWatch(const QString &filePath);
void unsetFileToWatch();
#if PURPOSE_FOUND
void slotShareActionFinished(const QJsonObject &output, int error, const QString &message);
#endif
bool tryOpeningUrlWithFragmentAsName();
/**
* Initializes Okular::Settings.
* Determines the config file path, and performs configuration updates not handled by kconf_update.
*
* @param args As passed to Part::Part().
* @param componentName As KXMLGUIClient::componentName(), probably "okular".
*/
void setupConfigSkeleton(const QVariantList &args, const QString &componentName);
static int numberOfParts;
QTemporaryFile *m_tempfile;
// the document
Okular::Document *m_document;
QDateTime m_fileLastModified;
QString m_temporaryLocalFile;
bool isDocumentArchive;
bool m_documentOpenWithPassword;
bool m_swapInsteadOfOpening; // if set, the next open operation will replace the backing file (used when reloading just saved files)
// main widgets
Sidebar *m_sidebar;
SearchWidget *m_searchWidget;
FindBar *m_findBar;
KMessageWidget *m_migrationMessage;
KMessageWidget *m_topMessage;
KMessageWidget *m_formsMessage;
KMessageWidget *m_infoMessage;
KMessageWidget *m_signatureMessage;
QPointer<ThumbnailList> m_thumbnailList;
QPointer<PageView> m_pageView;
QPointer<TOC> m_toc;
bool m_tocEnabled;
QPointer<MiniBarLogic> m_miniBarLogic;
QPointer<MiniBar> m_miniBar;
QPointer<MiniBar> m_pageNumberTool;
QPointer<QWidget> m_bottomBar;
QPointer<PresentationWidget> m_presentationWidget;
QPointer<ProgressWidget> m_progressWidget;
QPointer<PageSizeLabel> m_pageSizeLabel;
QPointer<Reviews> m_reviewsWidget;
QPointer<BookmarkList> m_bookmarkList;
QPointer<Layers> m_layers;
QPointer<SignaturePanel> m_signaturePanel;
// document watcher (and reloader) variables
KDirWatch *m_watcher;
QString m_watchedFilePath, m_watchedFileSymlinkTarget;
QTimer *m_dirtyHandler;
QUrl m_oldUrl;
Okular::DocumentViewport m_viewportDirty;
bool m_isReloading;
bool m_wasPresentationOpen;
QWidget *m_dirtyToolboxItem;
bool m_wasSidebarVisible;
bool m_fileWasRemoved;
Rotation m_dirtyPageRotation;
// Remember the search history
QStringList m_searchHistory;
// actions
QAction *m_gotoPage;
QAction *m_prevPage;
QAction *m_nextPage;
QAction *m_beginningOfDocument;
QAction *m_endOfDocument;
QAction *m_historyBack;
QAction *m_historyNext;
QAction *m_addBookmark;
QAction *m_renameBookmark;
QAction *m_prevBookmark;
QAction *m_nextBookmark;
QAction *m_copy;
QAction *m_selectAll;
QAction *m_selectCurrentPage;
QAction *m_find;
QAction *m_findNext;
QAction *m_findPrev;
QAction *m_save;
QAction *m_saveAs;
QAction *m_saveCopyAs;
QAction *m_printPreview;
QAction *m_showProperties;
QAction *m_showEmbeddedFiles;
QAction *m_exportAs;
QAction *m_exportAsText;
QAction *m_exportAsDocArchive;
#if PURPOSE_FOUND
QAction *m_share;
#endif
QAction *m_showPresentation;
QAction *m_openContainingFolder;
KHamburgerMenu *m_hamburgerMenuAction;
KToggleAction *m_showMenuBarAction;
KToggleAction *m_showLeftPanel;
KToggleAction *m_showBottomBar;
QAction *m_showSignaturePanel;
KToggleFullScreenAction *m_showFullScreenAction;
QAction *m_aboutBackend;
QAction *m_reload;
QMenu *m_exportAsMenu;
#if PURPOSE_FOUND
Purpose::Menu *m_shareMenu;
#endif
QAction *m_closeFindBar;
DrawingToolActions *m_presentationDrawingActions;
BrowserExtension *m_bExtension;
QList<Okular::ExportFormat> m_exportFormats;
QList<QAction *> m_bookmarkActions;
bool m_cliPresentation;
bool m_cliPrint;
bool m_cliPrintAndExit;
QString m_addBookmarkText;
QIcon m_addBookmarkIcon;
EmbedMode m_embedMode;
QUrl m_realUrl;
KXMLGUIClient *m_generatorGuiClient;
FileKeeper *m_keeper;
// Timer for m_infoMessage
QTimer *m_infoTimer;
QString m_registerDbusName;
// String to search in document startup
QString m_textToFindOnOpen;
// Set when opening an url that had fragment so that if it fails opening we try adding the fragment to the filename
// if we're opening http://localhost/foo#bar.pdf and the filename contains an # we can open it after trying to open foo fails
QUrl m_urlWithFragment;
private Q_SLOTS:
void slotAccessibilityPreferences();
void slotAnnotationPreferences();
void slotHandleActivatedSourceReference(const QString &absFileName, int line, int col, bool *handled);
};
}
#endif
/* kate: replace-tabs on; indent-width 4; */