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;
98 Clipboard & clipboard();
100 Selection & selection();
102 FontLoader & fontLoader();
105 Toolbars const & toolbars() const;
107 Toolbars & toolbars();
109 Menus const & menus() const;
113 /// \returns true if painting the workarea requires a backing store.
114 bool needsBackingStore() const;
116 /// \name Methods inherited from QApplication class
118 bool notify(QObject * receiver, QEvent * event) override;
119 void commitData(QSessionManager & sm);
121 bool x11EventFilter(XEvent * ev) override;
122 #elif defined(QPA_XCB)
123 virtual bool nativeEventFilter(const QByteArray & eventType, void * message,
124 long * result) override;
128 /// Create the main window with given geometry settings.
129 /// \param geometry_arg: only for Windows platform.
130 /// \param optional id identifier.
131 void createView(QString const & geometry_arg = QString(),
132 bool autoShow = true, int id = 0);
133 /// FIXME: this method and the one above are quite ugly.
134 void createView(int id);
136 GuiView const * currentView() const { return current_view_; }
138 GuiView * currentView() { return current_view_; }
140 void setCurrentView(GuiView * view) { current_view_ = view; }
142 QList<int> viewIds() const;
144 /// Clear all session information.
148 ColorCache & colorCache();
150 QAbstractItemModel * languageModel();
152 /// return a suitable serif font name.
153 QString const romanFontName();
155 /// return a suitable sans serif font name.
156 QString const sansFontName();
158 /// return a suitable monospaced font name.
159 QString const typewriterFontName();
160 QFont const typewriterSystemFont();
163 void unregisterView(GuiView * gv);
165 GuiView & view(int id) const;
167 /// Current ratio between physical pixels and device-independent pixels
168 double pixelRatio() const;
170 /// How to load image files
171 support::search_mode imageSearchMode() const {
172 return pixelRatio() > 1 ? support::check_hidpi : support::must_exist;
175 /// return true if the key is part of a shortcut
176 bool queryKeySym(KeySymbol const & key, KeyModifier state) const;
178 void processKeySym(KeySymbol const & key, KeyModifier state);
179 /// return the status bar state string
180 docstring viewStatusMessage();
182 /// \name Methods to process FuncRequests
184 /// process the func request
185 void processFuncRequest(FuncRequest const &);
186 /// add a func request to the queue and process it asynchronously
187 /// \note As a side-effect this will also process the
188 /// func requests that were added to the queue before.
189 void processFuncRequestAsync(FuncRequest const &);
190 /// process the func requests in the queue
191 void processFuncRequestQueue();
192 /// process the func requests in the queue asynchronously
193 void processFuncRequestQueueAsync();
194 /// add a func request to the queue for later processing
195 void addToFuncRequestQueue(FuncRequest const &);
199 /// openFile: whether or not open a file if the file is not opened
200 /// switchToBuffer: whether or not switch to buffer if the buffer is
201 /// not the current buffer
202 void gotoBookmark(unsigned int idx, bool openFile, bool switchToBuffer);
204 /// Start a long operation with some cancel possibility (button or ESC)
205 void startLongOperation() override;
206 /// This needs to be periodically called to avoid freezing the GUI
207 bool longOperationCancelled() override;
208 /// Stop the long operation mode (i.e., release the GUI)
209 void stopLongOperation() override;
210 /// A started long operation is still in progress ?
211 bool longOperationStarted() override;
214 void execBatchCommands();
216 void socketDataReceived(int fd);
217 /// events to be triggered by Private::general_timer_ should go here
218 void handleRegularEvents();
220 void onLastWindowClosed();
222 void onLocaleChanged();
224 void onPaletteChanged();
226 void slotProcessFuncRequestQueue() { processFuncRequestQueue(); }
228 #if (QT_VERSION >= 0x050100)
229 void onApplicationStateChanged(Qt::ApplicationState state);
234 void validateCurrentView();
236 void updateCurrentView(FuncRequest const & cmd, DispatchResult & dr);
238 bool closeAllViews();
239 /// Things that need to be done when the OSes session manager
240 /// requests a log out.
241 bool prepareAllViewsForLogout();
242 /// read the given ui (menu/toolbar) file
243 bool readUIFile(QString const & name, bool include = false);
251 ReturnValues readUIFile(support::FileName const & ui_path);
253 void setGuiLanguage();
255 void reconfigure(std::string const & option);
257 /// This GuiView is the one receiving Clipboard and Selection
259 GuiView * current_view_;
266 extern GuiApplication * guiApp;
269 /// Absolute path to icon file
271 /// Swap the icon in RTL mode
273 /// Invert the icon in dark mode
277 /// \return the pixmap for the given path, name and extension.
278 /// in case of errors a warning is produced and an empty pixmap is returned.
279 QPixmap getPixmap(QString const & path, QString const & name, QString const & ext);
281 /// \return an icon for the given action.
282 QIcon getIcon(FuncRequest const & f, bool unknown, bool rtl = false);
285 GuiApplication * theGuiApp();
287 } // namespace frontend
290 #endif // GUIAPPLICATION_H