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 "frontends/Application.h"
17 #include "support/filetools.h"
19 #include <QApplication>
22 #include <QAbstractNativeEventFilter>
25 class QAbstractItemModel;
27 class QSessionManager;
48 /// The Qt main application class
50 There should be only one instance of this class. No Qt object
51 initialisation should be done before the instantiation of this class.
53 class GuiApplication : public QApplication, public Application
55 , public QAbstractNativeEventFilter
61 GuiApplication(int & argc, char ** argv);
64 /// \name Methods inherited from Application class
66 DispatchResult const & dispatch(FuncRequest const &) override;
67 void dispatch(FuncRequest const &, DispatchResult & dr) override;
68 FuncStatus getStatus(FuncRequest const & cmd) const override;
69 void restoreGuiSession() override;
70 Buffer const * updateInset(Inset const * inset) const override;
72 void exit(int status) override;
73 bool event(QEvent * e) override;
74 bool getRgbColor(ColorCode col, RGBColor & rgbcol) override;
75 std::string const hexName(ColorCode col) override;
76 void registerSocketCallback(int fd, SocketCallback func) override;
77 void unregisterSocketCallback(int fd) override;
78 bool searchMenu(FuncRequest const & func, docstring_list & names) const override;
79 bool hasBufferView() const override;
80 std::string inputLanguageCode() const override;
81 void handleKeyFunc(FuncCode action) override;
82 bool unhide(Buffer * buf) override;
86 bool getStatus(FuncRequest const & cmd, FuncStatus & status) const;
88 void hideDialogs(std::string const & name, Inset * inset) const;
91 /// Return true if current position is RTL of if no document is open and interface if RTL
92 bool rtlContext() const;
95 Clipboard & clipboard();
97 Selection & selection();
99 FontLoader & fontLoader();
102 Toolbars const & toolbars() const;
104 Toolbars & toolbars();
106 Menus const & menus() const;
110 /// \name Methods inherited from QApplication class
112 bool notify(QObject * receiver, QEvent * event) override;
113 void commitData(QSessionManager & sm);
115 bool x11EventFilter(XEvent * ev) override;
116 #elif defined(QPA_XCB)
117 virtual bool nativeEventFilter(const QByteArray & eventType, void * message,
118 long * result) override;
122 /// Create the main window with given geometry settings.
123 /// \param geometry_arg: only for Windows platform.
124 /// \param optional id identifier.
125 void createView(QString const & geometry_arg = QString(),
126 bool autoShow = true, int id = 0);
127 /// FIXME: this method and the one above are quite ugly.
128 void createView(int id);
130 GuiView const * currentView() const { return current_view_; }
132 GuiView * currentView() { return current_view_; }
134 void setCurrentView(GuiView * view) { current_view_ = view; }
136 QList<int> viewIds() const;
138 /// Clear all session information.
142 ColorCache & colorCache();
144 QAbstractItemModel * languageModel();
146 /// return a suitable serif font name.
147 QString const romanFontName();
149 /// return a suitable sans serif font name.
150 QString const sansFontName();
152 /// return a suitable monospaced font name.
153 QString const typewriterFontName();
154 QFont const typewriterSystemFont();
157 void unregisterView(GuiView * gv);
159 GuiView & view(int id) const;
161 /// Current ratio between physical pixels and device-independent pixels
162 double pixelRatio() const;
164 /// How to load image files
165 support::search_mode imageSearchMode() const {
166 #if QT_VERSION >= 0x050000
167 return pixelRatio() > 1 ? support::check_hidpi : support::must_exist;
169 return support::must_exist;
173 /// return true if the key is part of a shortcut
174 bool queryKeySym(KeySymbol const & key, KeyModifier state) const;
176 void processKeySym(KeySymbol const & key, KeyModifier state);
177 /// return the status bar state string
178 docstring viewStatusMessage();
180 /// \name Methods to process FuncRequests
182 /// process the func request
183 void processFuncRequest(FuncRequest const &);
184 /// add a func request to the queue and process it asynchronously
185 /// \note As a side-effect this will also process the
186 /// func requests that were added to the queue before.
187 void processFuncRequestAsync(FuncRequest const &);
188 /// process the func requests in the queue
189 void processFuncRequestQueue();
190 /// process the func requests in the queue asynchronously
191 void processFuncRequestQueueAsync();
192 /// add a func request to the queue for later processing
193 void addToFuncRequestQueue(FuncRequest const &);
197 /// openFile: whether or not open a file if the file is not opened
198 /// switchToBuffer: whether or not switch to buffer if the buffer is
199 /// not the current buffer
200 void gotoBookmark(unsigned int idx, bool openFile, bool switchToBuffer);
202 /// Start a long operation with some cancel possibility (button or ESC)
203 void startLongOperation() override;
204 /// This needs to be periodically called to avoid freezing the GUI
205 bool longOperationCancelled() override;
206 /// Stop the long operation mode (i.e., release the GUI)
207 void stopLongOperation() override;
208 /// A started long operation is still in progress ?
209 bool longOperationStarted() override;
212 void execBatchCommands();
214 void socketDataReceived(int fd);
215 /// events to be triggered by Private::general_timer_ should go here
216 void handleRegularEvents();
218 void onLastWindowClosed();
220 void onLocaleChanged();
222 void slotProcessFuncRequestQueue() { processFuncRequestQueue(); }
226 void validateCurrentView();
228 void updateCurrentView(FuncRequest const & cmd, DispatchResult & dr);
230 bool closeAllViews();
231 /// Things that need to be done when the OSes session manager
232 /// requests a log out.
233 bool prepareAllViewsForLogout();
234 /// read the given ui (menu/toolbar) file
235 bool readUIFile(QString const & name, bool include = false);
243 ReturnValues readUIFile(support::FileName);
245 void setGuiLanguage();
247 void reconfigure(std::string const & option);
249 /// This GuiView is the one receiving Clipboard and Selection
251 GuiView * current_view_;
258 extern GuiApplication * guiApp;
260 /// \return the icon file name for the given action.
261 QString iconName(FuncRequest const & f, bool unknown,
262 QString const & suffix = QString());
264 /// \return the pixmap for the given path, name and extension.
265 /// in case of errors a warning is produced and an empty pixmap is returned.
266 QPixmap getPixmap(QString const & path, QString const & name, QString const & ext);
268 /// \return an icon for the given action.
269 QIcon getIcon(FuncRequest const & f, bool unknown, bool rtl = false);
272 GuiApplication * theGuiApp();
274 } // namespace frontend
277 #endif // GUIAPPLICATION_H