mirror of
https://invent.kde.org/graphics/okular
synced 2024-09-19 16:01:41 +00:00
a0135a3c8e
SlotDoFileDirty tries to reload the file at regular intervals. This patch fixes it so that it can actually reopen the file even if it is not ready at the first timer shot. BUG: 310531
351 lines
12 KiB
C++
351 lines
12 KiB
C++
/***************************************************************************
|
|
* Copyright (C) 2002 by Wilco Greven <greven@kde.org> *
|
|
* Copyright (C) 2003-2004 by Christophe Devriese *
|
|
* <Christophe.Devriese@student.kuleuven.ac.be> *
|
|
* Copyright (C) 2003 by Andy Goossens <andygoossens@telenet.be> *
|
|
* Copyright (C) 2003 by Laurent Montel <montel@kde.org> *
|
|
* Copyright (C) 2004 by Dominique Devriese <devriese@kde.org> *
|
|
* Copyright (C) 2004-2007 by Albert Astals Cid <aacid@kde.org> *
|
|
* *
|
|
* This program is free software; you can redistribute it and/or modify *
|
|
* it under the terms of the GNU General Public License as published by *
|
|
* the Free Software Foundation; either version 2 of the License, or *
|
|
* (at your option) any later version. *
|
|
***************************************************************************/
|
|
|
|
#ifndef _PART_H_
|
|
#define _PART_H_
|
|
|
|
#include <kparts/part.h>
|
|
#include <kpluginfactory.h>
|
|
#include <qicon.h>
|
|
#include <qlist.h>
|
|
#include <qpointer.h>
|
|
#include <qprocess.h>
|
|
#include "core/observer.h"
|
|
#include "core/document.h"
|
|
#include "kdocumentviewer.h"
|
|
#include "interfaces/viewerinterface.h"
|
|
|
|
#include <QtDBus/QtDBus>
|
|
|
|
class QAction;
|
|
class QWidget;
|
|
class QPrinter;
|
|
class QMenu;
|
|
|
|
class KUrl;
|
|
class KConfigGroup;
|
|
class KDirWatch;
|
|
class KToggleAction;
|
|
class KToggleFullScreenAction;
|
|
class KSelectAction;
|
|
class KAboutData;
|
|
class KTemporaryFile;
|
|
class KAction;
|
|
class KMenu;
|
|
namespace KParts { class GUIActivateEvent; }
|
|
|
|
class FindBar;
|
|
class ThumbnailList;
|
|
class PageSizeLabel;
|
|
class PageView;
|
|
class PageViewTopMessage;
|
|
class PresentationWidget;
|
|
class ProgressWidget;
|
|
class SearchWidget;
|
|
class Sidebar;
|
|
class TOC;
|
|
class MiniBar;
|
|
class MiniBarLogic;
|
|
class FileKeeper;
|
|
class Reviews;
|
|
class BookmarkList;
|
|
|
|
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 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)
|
|
|
|
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, KComponentData componentData);
|
|
|
|
// Destructor
|
|
~Part();
|
|
|
|
// inherited from DocumentObserver
|
|
uint observerId() const { return PART_ID; }
|
|
void notifySetup( const QVector< Okular::Page * > &pages, int setupFlags );
|
|
void notifyViewportChanged( bool smoothMove );
|
|
void notifyPageChanged( int page, int flags );
|
|
|
|
bool openDocument(const KUrl& url, uint page);
|
|
void startPresentation();
|
|
QStringList supportedMimeTypes() const;
|
|
|
|
KUrl realUrl() const;
|
|
|
|
void showSourceLocation(const QString& fileName, int line, int column, bool showGraphically = true);
|
|
void clearLastShownSourceLocation();
|
|
bool isWatchFileModeEnabled() const;
|
|
void setWatchFileModeEnabled(bool enable);
|
|
bool areSourceLocationsShownGraphically() const;
|
|
void setShowSourceLocationsGraphically(bool show);
|
|
|
|
public slots: // dbus
|
|
Q_SCRIPTABLE Q_NOREPLY void goToPage(uint page);
|
|
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 Q_NOREPLY void reload();
|
|
|
|
signals:
|
|
void enablePrintAction(bool enable);
|
|
void openSourceReference(const QString& absFileName, int line, int column);
|
|
void viewerMenuStateChange(bool enabled);
|
|
void enableCloseAction(bool enable);
|
|
|
|
protected:
|
|
// reimplemented from KParts::ReadWritePart
|
|
bool openFile();
|
|
bool openUrl(const KUrl &url);
|
|
void guiActivateEvent(KParts::GUIActivateEvent *event);
|
|
public:
|
|
bool saveFile();
|
|
bool queryClose();
|
|
bool closeUrl();
|
|
bool closeUrl(bool promptToSave);
|
|
void setReadWrite(bool readwrite);
|
|
bool saveAs(const KUrl & saveUrl);
|
|
|
|
protected slots:
|
|
// connected to actions
|
|
void openUrlFromDocument(const KUrl &url);
|
|
void openUrlFromBookmarks(const KUrl &url);
|
|
void slotGoToPage();
|
|
void slotHistoryBack();
|
|
void slotHistoryNext();
|
|
void slotAddBookmark();
|
|
void slotRenameBookmarkFromMenu();
|
|
void slotRenameCurrentViewportBookmark();
|
|
void slotAboutToShowContextMenu(KMenu *menu, QAction *action, QMenu *contextMenu);
|
|
void slotPreviousBookmark();
|
|
void slotNextBookmark();
|
|
void slotFindNext();
|
|
void slotFindPrev();
|
|
void slotSaveFileAs();
|
|
void slotSaveCopyAs();
|
|
void slotGetNewStuff();
|
|
void slotNewConfig();
|
|
void slotNewGeneratorConfig();
|
|
void slotShowMenu(const Okular::Page *page, const QPoint &point);
|
|
void slotShowProperties();
|
|
void slotShowEmbeddedFiles();
|
|
void slotShowLeftPanel();
|
|
void slotShowBottomBar();
|
|
void slotShowPresentation();
|
|
void slotHidePresentation();
|
|
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();
|
|
|
|
public slots:
|
|
// connected to Shell action (and browserExtension), not local one
|
|
void slotPrint();
|
|
void restoreDocument(const KConfigGroup &group);
|
|
void saveDocumentRestoreInfo(KConfigGroup &group);
|
|
void slotFileDirty( const QString& );
|
|
void slotDoFileDirty();
|
|
void psTransformEnded(int, QProcess::ExitStatus);
|
|
|
|
private:
|
|
void setupViewerActions();
|
|
void setViewerShortcuts();
|
|
void setupActions();
|
|
|
|
void setupPrint( QPrinter &printer );
|
|
void doPrint( QPrinter &printer );
|
|
bool handleCompressed( QString &destpath, const QString &path, const QString &compressedMimetype );
|
|
void rebuildBookmarkMenu( bool unplugActions = true );
|
|
void updateAboutBackendAction();
|
|
void unsetDummyMode();
|
|
void slotRenameBookmark( const DocumentViewport &viewport );
|
|
|
|
static int numberOfParts;
|
|
|
|
KTemporaryFile *m_tempfile;
|
|
|
|
// the document
|
|
Okular::Document * m_document;
|
|
QString m_temporaryLocalFile;
|
|
bool isDocumentArchive;
|
|
|
|
// main widgets
|
|
Sidebar *m_sidebar;
|
|
SearchWidget *m_searchWidget;
|
|
FindBar * m_findBar;
|
|
PageViewTopMessage * m_topMessage;
|
|
PageViewTopMessage * m_formsMessage;
|
|
QPointer<ThumbnailList> m_thumbnailList;
|
|
QPointer<PageView> m_pageView;
|
|
QPointer<TOC> m_toc;
|
|
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;
|
|
|
|
// document watcher (and reloader) variables
|
|
KDirWatch *m_watcher;
|
|
QTimer *m_dirtyHandler;
|
|
KUrl m_oldUrl;
|
|
Okular::DocumentViewport m_viewportDirty;
|
|
bool m_wasPresentationOpen;
|
|
int m_dirtyToolboxIndex;
|
|
bool m_wasSidebarVisible;
|
|
bool m_wasSidebarCollapsed;
|
|
bool m_fileWasRemoved;
|
|
Rotation m_dirtyPageRotation;
|
|
|
|
// Remember the search history
|
|
QStringList m_searchHistory;
|
|
|
|
// actions
|
|
KAction *m_gotoPage;
|
|
KAction *m_prevPage;
|
|
KAction *m_nextPage;
|
|
KAction *m_beginningOfDocument;
|
|
KAction *m_endOfDocument;
|
|
KAction *m_historyBack;
|
|
KAction *m_historyNext;
|
|
KAction *m_addBookmark;
|
|
KAction *m_renameBookmark;
|
|
KAction *m_prevBookmark;
|
|
KAction *m_nextBookmark;
|
|
KAction *m_copy;
|
|
KAction *m_selectAll;
|
|
KAction *m_find;
|
|
KAction *m_findNext;
|
|
KAction *m_findPrev;
|
|
KAction *m_saveAs;
|
|
KAction *m_saveCopyAs;
|
|
KAction *m_printPreview;
|
|
KAction *m_showProperties;
|
|
KAction *m_showEmbeddedFiles;
|
|
KAction *m_exportAs;
|
|
QAction *m_exportAsText;
|
|
QAction *m_exportAsDocArchive;
|
|
KAction *m_showPresentation;
|
|
KToggleAction* m_showMenuBarAction;
|
|
KToggleAction* m_showLeftPanel;
|
|
KToggleAction* m_showBottomBar;
|
|
KToggleFullScreenAction* m_showFullScreenAction;
|
|
KAction *m_aboutBackend;
|
|
KAction *m_reload;
|
|
QMenu *m_exportAsMenu;
|
|
KAction *m_closeFindBar;
|
|
|
|
bool m_actionsSearched;
|
|
BrowserExtension *m_bExtension;
|
|
|
|
QList<Okular::ExportFormat> m_exportFormats;
|
|
QList<QAction*> m_bookmarkActions;
|
|
bool m_cliPresentation;
|
|
QString m_addBookmarkText;
|
|
QIcon m_addBookmarkIcon;
|
|
|
|
EmbedMode m_embedMode;
|
|
|
|
KUrl m_realUrl;
|
|
|
|
KXMLGUIClient *m_generatorGuiClient;
|
|
FileKeeper *m_keeper;
|
|
|
|
private slots:
|
|
void slotGeneratorPreferences();
|
|
void slotHandleActivatedSourceReference(const QString& absFileName, int line, int col, bool *handled);
|
|
};
|
|
|
|
class PartFactory : public KPluginFactory
|
|
{
|
|
Q_OBJECT
|
|
|
|
public:
|
|
PartFactory();
|
|
virtual ~PartFactory();
|
|
|
|
protected:
|
|
virtual QObject *create(const char *iface, QWidget *parentWidget, QObject *parent, const QVariantList &args, const QString &keyword);
|
|
};
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
/* kate: replace-tabs on; indent-width 4; */
|