2 * \file GuiApplication.h
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
8 * \author Abdelrazak Younes
10 * Full author contact details are available in file CREDITS.
13 #ifndef GUIAPPLICATION_H
14 #define GUIAPPLICATION_H
16 #include "KeyModifier.h"
18 #include "frontends/Application.h"
19 #include "support/filetools.h"
21 #include <QApplication>
24 #include <QAbstractNativeEventFilter>
27 class QAbstractItemModel;
29 class QSessionManager;
50 /// The Qt main application class
52 There should be only one instance of this class. No Qt object
53 initialisation should be done before the instantiation of this class.
55 class GuiApplication : public QApplication, public Application
57 , public QAbstractNativeEventFilter
63 GuiApplication(int & argc, char ** argv);
66 /// \name Methods inherited from Application class
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;
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;
89 bool getStatus(FuncRequest const & cmd, FuncStatus & status) const;
91 void hideDialogs(std::string const & name, Inset * inset) const;
94 /// Return true if current position is RTL of if no document is open and interface if RTL
95 bool rtlContext() const;
97 /// Scale Pixmaps properly (also for HiDPI)
98 QPixmap getScaledPixmap(QString imagedir, QString name) const;
101 Clipboard & clipboard();
103 Selection & selection();
105 FontLoader & fontLoader();
108 Toolbars const & toolbars() const;
110 Toolbars & toolbars();
112 Menus const & menus() const;
116 /// \returns true if painting the workarea requires a backing store.
117 bool needsBackingStore() const;
119 /// \name Methods inherited from QApplication class
121 bool notify(QObject * receiver, QEvent * event) override;
122 void commitData(QSessionManager & sm);
124 #if (QT_VERSION < 0x060000)
127 #define QINTPTR qintptr
129 virtual bool nativeEventFilter(const QByteArray & eventType, void * message,
130 QINTPTR * result) override;
134 /// Create the main window with given geometry settings.
135 /// \param geometry_arg: only for Windows platform.
136 /// \param optional id identifier.
137 void createView(QString const & geometry_arg = QString(),
138 bool autoShow = true, int id = 0);
139 /// FIXME: this method and the one above are quite ugly.
140 void createView(int id);
142 GuiView const * currentView() const { return current_view_; }
144 GuiView * currentView() { return current_view_; }
146 void setCurrentView(GuiView * view) { current_view_ = view; }
148 QList<int> viewIds() const;
150 /// Clear all session information.
154 ColorCache & colorCache();
156 QAbstractItemModel * languageModel();
158 /// return a suitable serif font name.
159 QString const romanFontName();
161 /// return a suitable sans serif font name.
162 QString const sansFontName();
164 /// return a suitable monospaced font name.
165 QString const typewriterFontName();
166 QFont const typewriterSystemFont();
169 void unregisterView(GuiView * gv);
171 GuiView & view(int id) const;
173 /// Current ratio between physical pixels and device-independent pixels
174 double pixelRatio() const;
176 /// How to load image files
177 support::search_mode imageSearchMode() const {
178 return pixelRatio() > 1 ? support::check_hidpi : support::must_exist;
181 /// return true if the key is part of a shortcut
182 bool queryKeySym(KeySymbol const & key, KeyModifier state) const;
184 void processKeySym(KeySymbol const & key, KeyModifier state);
185 /// return the status bar state string
186 docstring viewStatusMessage();
188 /// \name Methods to process FuncRequests
190 /// process the func request
191 void processFuncRequest(FuncRequest const &);
192 /// add a func request to the queue and process it asynchronously
193 /// \note As a side-effect this will also process the
194 /// func requests that were added to the queue before.
195 void processFuncRequestAsync(FuncRequest const &);
196 /// process the func requests in the queue
197 void processFuncRequestQueue();
198 /// process the func requests in the queue asynchronously
199 void processFuncRequestQueueAsync();
200 /// add a func request to the queue for later processing
201 void addToFuncRequestQueue(FuncRequest const &);
205 /// openFile: whether or not open a file if the file is not opened
206 /// switchToBuffer: whether or not switch to buffer if the buffer is
207 /// not the current buffer
208 void gotoBookmark(unsigned int idx, bool openFile, bool switchToBuffer);
210 /// Start a long operation with some cancel possibility (button or ESC)
211 void startLongOperation() override;
212 /// This needs to be periodically called to avoid freezing the GUI
213 bool longOperationCancelled() override;
214 /// Stop the long operation mode (i.e., release the GUI)
215 void stopLongOperation() override;
216 /// A started long operation is still in progress ?
217 bool longOperationStarted() override;
220 void execBatchCommands();
222 void socketDataReceived(int fd);
223 /// events to be triggered by Private::general_timer_ should go here
224 void handleRegularEvents();
226 void onLastWindowClosed();
228 void onLocaleChanged();
230 void onPaletteChanged();
232 void slotProcessFuncRequestQueue() { processFuncRequestQueue(); }
234 void onApplicationStateChanged(Qt::ApplicationState state);
238 void validateCurrentView();
240 void updateCurrentView(FuncRequest const & cmd, DispatchResult & dr);
242 bool closeAllViews();
243 /// Things that need to be done when the OSes session manager
244 /// requests a log out.
245 bool prepareAllViewsForLogout();
246 /// read the given ui (menu/toolbar) file
247 bool readUIFile(QString const & name, bool include = false);
255 ReturnValues readUIFile(support::FileName const & ui_path);
257 void setGuiLanguage();
259 void reconfigure(std::string const & option);
261 /// This GuiView is the one receiving Clipboard and Selection
263 GuiView * current_view_;
270 extern GuiApplication * guiApp;
273 /// Absolute path to icon file
275 /// Swap the icon in RTL mode
277 /// Invert the icon in dark mode
281 /// \return the pixmap for the given path, name and extension.
282 /// in case of errors a warning is produced and an empty pixmap is returned.
283 QPixmap getPixmap(QString const & path, QString const & name, QString const & ext);
285 /// \return an icon for the given action.
286 QIcon getIcon(FuncRequest const & f, bool unknown, bool rtl = false);
289 GuiApplication * theGuiApp();
291 } // namespace frontend
294 #endif // GUIAPPLICATION_H