]> git.lyx.org Git - lyx.git/blobdiff - src/frontends/qt4/GuiApplication.h
Add missing initialization
[lyx.git] / src / frontends / qt4 / GuiApplication.h
index 29302a3cf1fd04a4f72433187e8cfdf22220b4a1..de6013d4c7e691fa127e128d9de5a37fcc0fbcb3 100644 (file)
 #define GUIAPPLICATION_H
 
 #include "frontends/Application.h"
+#include "support/filetools.h"
 
 #include <QApplication>
 #include <QList>
+#ifdef QPA_XCB
+#include <QAbstractNativeEventFilter>
+#endif
 
 class QAbstractItemModel;
 class QIcon;
-class QObject;
 class QSessionManager;
-class QSortFilterProxyModel;
+class QFont;
 
 namespace lyx {
 
@@ -30,11 +33,13 @@ class BufferView;
 class ColorCache;
 class KeySymbol;
 
+namespace support {
+class FileName;
+}
+
 namespace frontend {
 
 class GuiView;
-class LyXView;
-class GlobalMenuBar;
 class GuiWorkArea;
 class Menus;
 class SocketNotifier;
@@ -43,9 +48,12 @@ class Toolbars;
 /// The Qt main application class
 /**
 There should be only one instance of this class. No Qt object
-initialisation should be done before the instanciation of this class.
+initialisation should be done before the instantiation of this class.
 */
 class GuiApplication : public QApplication, public Application
+#ifdef QPA_XCB
+                    , public QAbstractNativeEventFilter
+#endif
 {
        Q_OBJECT
 
@@ -53,20 +61,13 @@ public:
        GuiApplication(int & argc, char ** argv);
        ~GuiApplication();
 
-       /// Clear all session information.
-       void clearSession();
-
        /// \name Methods inherited from Application class
        //@{
-       LyXView * currentWindow();
-       bool getStatus(FuncRequest const & cmd, FuncStatus & flag) const;
+       DispatchResult const & dispatch(FuncRequest const &);
        void dispatch(FuncRequest const &, DispatchResult & dr);
-       void dispatchDelayed(FuncRequest const &);
-       void resetGui();
+       FuncStatus getStatus(FuncRequest const & cmd) const;
        void restoreGuiSession();
-       Clipboard & clipboard();
-       Selection & selection();
-       FontLoader & fontLoader();
+       Buffer const * updateInset(Inset const * inset) const;
        int exec();
        void exit(int status);
        bool event(QEvent * e);
@@ -75,15 +76,30 @@ public:
        void registerSocketCallback(int fd, SocketCallback func);
        void unregisterSocketCallback(int fd);
        bool searchMenu(FuncRequest const & func, docstring_list & names) const;
-       docstring iconName(FuncRequest const & f, bool unknown);
-       void hideDialogs(std::string const & name, Inset * inset) const;
-       Buffer const * updateInset(Inset const * inset) const;
        void handleKeyFunc(FuncCode action);
        //@}
 
+       ///
+       bool getStatus(FuncRequest const & cmd, FuncStatus & status) const;
+       ///
+       void hideDialogs(std::string const & name, Inset * inset) const;
+       ///
+       void resetGui();
+
+       ///
+       Clipboard & clipboard();
+       ///
+       Selection & selection();
+       ///
+       FontLoader & fontLoader();
+
+       ///
        Toolbars const & toolbars() const;
+       ///
        Toolbars & toolbars();
+       ///
        Menus const & menus() const;
+       ///
        Menus & menus();
 
        /// \name Methods inherited from QApplication class
@@ -92,6 +108,9 @@ public:
        void commitData(QSessionManager & sm);
 #ifdef Q_WS_X11
        bool x11EventFilter(XEvent * ev);
+#elif defined(QPA_XCB)
+       virtual bool nativeEventFilter(const QByteArray & eventType, void * message,
+                                      long * result) Q_DECL_OVERRIDE;
 #endif
        //@}
 
@@ -111,9 +130,12 @@ public:
        ///
        QList<int> viewIds() const;
 
+       /// Clear all session information.
+       void clearSession();
+
        ///
        ColorCache & colorCache();
-
+       ///
        QAbstractItemModel * languageModel();
 
        /// return a suitable serif font name.
@@ -124,39 +146,103 @@ public:
 
        /// return a suitable monospaced font name.
        QString const typewriterFontName();
+       QFont const typewriterSystemFont();
+
        ///
        void unregisterView(GuiView * gv);
        ///
        GuiView & view(int id) const;
+
+       /// Current ratio between physical pixels and device-independent pixels
+       double pixelRatio() const;
+
+       /// How to load image files
+       support::search_mode imageSearchMode() const {
+#if QT_VERSION >= 0x050000
+               return pixelRatio() > 1 ? support::check_hidpi : support::must_exist;
+#else
+               return support::must_exist;
+#endif
+       }
+
+       /// return true if the key is part of a shortcut
+       bool queryKeySym(KeySymbol const & key, KeyModifier state) const;
        ///
        void processKeySym(KeySymbol const & key, KeyModifier state);
        /// return the status bar state string
        docstring viewStatusMessage();
 
+       /// \name Methods to process FuncRequests
+       //@{
+       /// process the func request
+       void processFuncRequest(FuncRequest const &);
+       /// add a func request to the queue and process it asynchronously
+       /// \note As a side-effect this will also process the
+       /// func requests that were added to the queue before.
+       void processFuncRequestAsync(FuncRequest const &);
+       /// process the func requests in the queue
+       void processFuncRequestQueue();
+       /// process the func requests in the queue asynchronously
+       void processFuncRequestQueueAsync();
+       /// add a func request to the queue for later processing
+       void addToFuncRequestQueue(FuncRequest const &);
+       //@}
+
+       /// goto a bookmark
+       /// openFile: whether or not open a file if the file is not opened
+       /// switchToBuffer: whether or not switch to buffer if the buffer is
+       ///             not the current buffer
+       void gotoBookmark(unsigned int idx, bool openFile, bool switchToBuffer);
+
+       /// Start a long operation with some cancel possibility (button or ESC)
+       void startLongOperation();
+       /// This needs to be periodically called to avoid freezing the GUI
+       bool longOperationCancelled();
+       /// Stop the long operation mode (i.e., release the GUI)
+       void stopLongOperation();
+       /// A started long operation is still in progress ?
+       bool longOperationStarted();
 private Q_SLOTS:
        ///
        void execBatchCommands();
        ///
        void socketDataReceived(int fd);
-       /// events to be triggered by general_timer_ should go here
+       /// events to be triggered by Private::general_timer_ should go here
        void handleRegularEvents();
        ///
        void onLastWindowClosed();
-
        ///
-       void processFuncRequestQueue();
+       void slotProcessFuncRequestQueue() { processFuncRequestQueue(); }
 
 private:
+       ///
+       void validateCurrentView();
+       ///
+       void updateCurrentView(FuncRequest const & cmd, DispatchResult & dr);
        ///
        bool closeAllViews();
+       /// Things that need to be done when the OSes session manager
+       /// requests a log out.
+       bool prepareAllViewsForLogout();
        /// read the given ui (menu/toolbar) file
        bool readUIFile(QString const & name, bool include = false);
        ///
+       enum ReturnValues {
+               ReadOK,
+               ReadError,
+               FormatMismatch
+       };
+       ///
+       ReturnValues readUIFile(support::FileName);
+       ///
        void setGuiLanguage();
+       ///
+       void reconfigure(std::string const & option);
 
-       /// This LyXView is the one receiving Clipboard and Selection
+       /// This GuiView is the one receiving Clipboard and Selection
        /// events
        GuiView * current_view_;
+
        ///
        struct Private;
        Private * const d;
@@ -167,13 +253,18 @@ extern GuiApplication * guiApp;
 /// \return the icon file name for the given action.
 QString iconName(FuncRequest const & f, bool unknown);
 
-
 /// \return the pixmap for the given path, name and extension.
+/// in case of errors a warning is produced and an empty pixmap is returned.
 QPixmap getPixmap(QString const & path, QString const & name, QString const & ext);
+/// Load the file at \param path and convert it to a pixmap.
+/// \return true on success otherwise invalidate the pixmap and return false.
+/// The caller is responsible for error reporting.
+bool getPixmap(QPixmap & pixmap, QString const & path);
 
 /// \return an icon for the given action.
 QIcon getIcon(FuncRequest const & f, bool unknown);
 
+///
 GuiApplication * theGuiApp();
 
 } // namespace frontend