src/frontends/qt/GuiApplication.h

   1 /**
   2  * \file GuiApplication.h
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author unknown
   7  * \author John Levon
   8  * \author Abdelrazak Younes
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #ifndef GUIAPPLICATION_H
  14 #define GUIAPPLICATION_H
  15
  16 #include "KeyModifier.h"
  17
  18 #include "frontends/Application.h"
  19 #include "support/filetools.h"
  20
  21 #include <QApplication>
  22 #include <QList>
  23 #ifdef QPA_XCB
  24 #include <QAbstractNativeEventFilter>
  25 #endif
  26
  27 class QAbstractItemModel;
  28 class QIcon;
  29 class QSessionManager;
  30 class QFont;
  31
  32 namespace lyx {
  33
  34 class ColorCache;
  35 class KeySymbol;
  36
  37 namespace support {
  38 class FileName;
  39 }
  40
  41 namespace frontend {
  42
  43 class Clipboard;
  44 class FontLoader;
  45 class GuiView;
  46 class Menus;
  47 class Selection;
  48 class Toolbars;
  49
  50 /// The Qt main application class
  51 /**
  52 There should be only one instance of this class. No Qt object
  53 initialisation should be done before the instantiation of this class.
  54 */
  55 class GuiApplication : public QApplication, public Application
  56 #ifdef QPA_XCB
  57                      , public QAbstractNativeEventFilter
  58 #endif
  59 {
  60         Q_OBJECT
  61
  62 public:
  63         GuiApplication(int & argc, char ** argv);
  64         ~GuiApplication();
  65
  66         /// \name Methods inherited from Application class
  67         //@{
  68         DispatchResult const & dispatch(FuncRequest const &) override;
  69         void dispatch(FuncRequest const &, DispatchResult & dr) override;
  70         FuncStatus getStatus(FuncRequest const & cmd) const override;
  71         void restoreGuiSession() override;
  72         Buffer const * updateInset(Inset const * inset) const override;
  73         int exec() override;
  74         void exit(int status) override;
  75         bool event(QEvent * e) override;
  76         bool getRgbColor(ColorCode col, RGBColor & rgbcol) override;
  77         bool isInDarkMode() override;
  78         std::string const hexName(ColorCode col) override;
  79         void registerSocketCallback(int fd, SocketCallback func) override;
  80         void unregisterSocketCallback(int fd) override;
  81         bool searchMenu(FuncRequest const & func, docstring_list & names) const override;
  82         bool hasBufferView() const override;
  83         std::string inputLanguageCode() const override;
  84         void handleKeyFunc(FuncCode action) override;
  85         bool unhide(Buffer * buf) override;
  86         //@}
  87
  88         ///
  89         bool getStatus(FuncRequest const & cmd, FuncStatus & status) const;
  90         ///
  91         void hideDialogs(std::string const & name, Inset * inset) const;
  92         ///
  93         void resetGui();
  94         /// Return true if current position is RTL of if no document is open and interface if RTL
  95         bool rtlContext() const;
  96
  97         /// Scale Pixmaps properly (also for HiDPI)
  98         QPixmap getScaledPixmap(QString imagedir, QString name) const;
  99
 100         ///
 101         Clipboard & clipboard();
 102         ///
 103         Selection & selection();
 104         ///
 105         FontLoader & fontLoader();
 106
 107         ///
 108         Toolbars const & toolbars() const;
 109         ///
 110         Toolbars & toolbars();
 111         ///
 112         Menus const & menus() const;
 113         ///
 114         Menus & menus();
 115
 116         /// \returns true if painting the workarea requires a backing store.
 117         bool needsBackingStore() const;
 118
 119         /// \name Methods inherited from QApplication class
 120         //@{
 121         bool notify(QObject * receiver, QEvent * event) override;
 122         void commitData(QSessionManager & sm);
 123 #if defined(QPA_XCB)
 124         virtual bool nativeEventFilter(const QByteArray & eventType, void * message,
 125                                        long * result) override;
 126 #endif
 127         //@}
 128
 129         /// Create the main window with given geometry settings.
 130         /// \param geometry_arg: only for Windows platform.
 131         /// \param optional id identifier.
 132         void createView(QString const & geometry_arg = QString(),
 133                 bool autoShow = true, int id = 0);
 134         /// FIXME: this method and the one above are quite ugly.
 135         void createView(int id);
 136         ///
 137         GuiView const * currentView() const { return current_view_; }
 138         ///
 139         GuiView * currentView() { return current_view_; }
 140         ///
 141         void setCurrentView(GuiView * view) { current_view_ = view; }
 142         ///
 143         QList<int> viewIds() const;
 144
 145         /// Clear all session information.
 146         void clearSession();
 147
 148         ///
 149         ColorCache & colorCache();
 150         ///
 151         QAbstractItemModel * languageModel();
 152
 153         /// return a suitable serif font name.
 154         QString const romanFontName();
 155
 156         /// return a suitable sans serif font name.
 157         QString const sansFontName();
 158
 159         /// return a suitable monospaced font name.
 160         QString const typewriterFontName();
 161         QFont const typewriterSystemFont();
 162
 163         ///
 164         void unregisterView(GuiView * gv);
 165         ///
 166         GuiView & view(int id) const;
 167
 168         /// Current ratio between physical pixels and device-independent pixels
 169         double pixelRatio() const;
 170
 171         /// How to load image files
 172         support::search_mode imageSearchMode() const {
 173                 return pixelRatio() > 1 ? support::check_hidpi : support::must_exist;
 174         }
 175
 176         /// return true if the key is part of a shortcut
 177         bool queryKeySym(KeySymbol const & key, KeyModifier state) const;
 178         ///
 179         void processKeySym(KeySymbol const & key, KeyModifier state);
 180         /// return the status bar state string
 181         docstring viewStatusMessage();
 182
 183         /// \name Methods to process FuncRequests
 184         //@{
 185         /// process the func request
 186         void processFuncRequest(FuncRequest const &);
 187         /// add a func request to the queue and process it asynchronously
 188         /// \note As a side-effect this will also process the
 189         /// func requests that were added to the queue before.
 190         void processFuncRequestAsync(FuncRequest const &);
 191         /// process the func requests in the queue
 192         void processFuncRequestQueue();
 193         /// process the func requests in the queue asynchronously
 194         void processFuncRequestQueueAsync();
 195         /// add a func request to the queue for later processing
 196         void addToFuncRequestQueue(FuncRequest const &);
 197         //@}
 198
 199         /// goto a bookmark
 200         /// openFile: whether or not open a file if the file is not opened
 201         /// switchToBuffer: whether or not switch to buffer if the buffer is
 202         ///             not the current buffer
 203         void gotoBookmark(unsigned int idx, bool openFile, bool switchToBuffer);
 204
 205         /// Start a long operation with some cancel possibility (button or ESC)
 206         void startLongOperation() override;
 207         /// This needs to be periodically called to avoid freezing the GUI
 208         bool longOperationCancelled() override;
 209         /// Stop the long operation mode (i.e., release the GUI)
 210         void stopLongOperation() override;
 211         /// A started long operation is still in progress ?
 212         bool longOperationStarted() override;
 213 private Q_SLOTS:
 214         ///
 215         void execBatchCommands();
 216         ///
 217         void socketDataReceived(int fd);
 218         /// events to be triggered by Private::general_timer_ should go here
 219         void handleRegularEvents();
 220         ///
 221         void onLastWindowClosed();
 222         ///
 223         void onLocaleChanged();
 224         ///
 225         void onPaletteChanged();
 226         ///
 227         void slotProcessFuncRequestQueue() { processFuncRequestQueue(); }
 228         ///
 229         void onApplicationStateChanged(Qt::ApplicationState state);
 230
 231 private:
 232         ///
 233         void validateCurrentView();
 234         ///
 235         void updateCurrentView(FuncRequest const & cmd, DispatchResult & dr);
 236         ///
 237         bool closeAllViews();
 238         /// Things that need to be done when the OSes session manager
 239         /// requests a log out.
 240         bool prepareAllViewsForLogout();
 241         /// read the given ui (menu/toolbar) file
 242         bool readUIFile(QString const & name, bool include = false);
 243         ///
 244         enum ReturnValues {
 245                 ReadOK,
 246                 ReadError,
 247                 FormatMismatch
 248         };
 249         ///
 250         ReturnValues readUIFile(support::FileName const & ui_path);
 251         ///
 252         void setGuiLanguage();
 253         ///
 254         void reconfigure(std::string const & option);
 255
 256         /// This GuiView is the one receiving Clipboard and Selection
 257         /// events
 258         GuiView * current_view_;
 259
 260         ///
 261         struct Private;
 262         Private * const d;
 263 }; // GuiApplication
 264
 265 extern GuiApplication * guiApp;
 266
 267 struct IconInfo {
 268         /// Absolute path to icon file
 269         QString filepath;
 270         /// Swap the icon in RTL mode
 271         bool swap = false;
 272         /// Invert the icon in dark mode
 273         bool invert = false;
 274 };
 275
 276 /// \return the pixmap for the given path, name and extension.
 277 /// in case of errors a warning is produced and an empty pixmap is returned.
 278 QPixmap getPixmap(QString const & path, QString const & name, QString const & ext);
 279
 280 /// \return an icon for the given action.
 281 QIcon getIcon(FuncRequest const & f, bool unknown, bool rtl = false);
 282
 283 ///
 284 GuiApplication * theGuiApp();
 285
 286 } // namespace frontend
 287 } // namespace lyx
 288
 289 #endif // GUIAPPLICATION_H