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 &);
67 void dispatch(FuncRequest const &, DispatchResult & dr);
68 FuncStatus getStatus(FuncRequest const & cmd) const;
69 void restoreGuiSession();
70 Buffer const * updateInset(Inset const * inset) const;
72 void exit(int status);
73 bool event(QEvent * e);
74 bool getRgbColor(ColorCode col, RGBColor & rgbcol);
75 std::string const hexName(ColorCode col);
76 void registerSocketCallback(int fd, SocketCallback func);
77 void unregisterSocketCallback(int fd);
78 bool searchMenu(FuncRequest const & func, docstring_list & names) const;
79 void handleKeyFunc(FuncCode action);
80 bool unhide(Buffer * buf); //override
84 bool getStatus(FuncRequest const & cmd, FuncStatus & status) const;
86 void hideDialogs(std::string const & name, Inset * inset) const;
91 Clipboard & clipboard();
93 Selection & selection();
95 FontLoader & fontLoader();
98 Toolbars const & toolbars() const;
100 Toolbars & toolbars();
102 Menus const & menus() const;
106 /// \name Methods inherited from QApplication class
108 bool notify(QObject * receiver, QEvent * event);
109 void commitData(QSessionManager & sm);
111 bool x11EventFilter(XEvent * ev);
112 #elif defined(QPA_XCB)
113 virtual bool nativeEventFilter(const QByteArray & eventType, void * message,
114 long * result) Q_DECL_OVERRIDE;
118 /// Create the main window with given geometry settings.
119 /// \param geometry_arg: only for Windows platform.
120 /// \param optional id identifier.
121 void createView(QString const & geometry_arg = QString(),
122 bool autoShow = true, int id = 0);
123 /// FIXME: this method and the one above are quite ugly.
124 void createView(int id);
126 GuiView const * currentView() const { return current_view_; }
128 GuiView * currentView() { return current_view_; }
130 void setCurrentView(GuiView * view) { current_view_ = view; }
132 QList<int> viewIds() const;
134 /// Clear all session information.
138 ColorCache & colorCache();
140 QAbstractItemModel * languageModel();
142 /// return a suitable serif font name.
143 QString const romanFontName();
145 /// return a suitable sans serif font name.
146 QString const sansFontName();
148 /// return a suitable monospaced font name.
149 QString const typewriterFontName();
150 QFont const typewriterSystemFont();
153 void unregisterView(GuiView * gv);
155 GuiView & view(int id) const;
157 /// Current ratio between physical pixels and device-independent pixels
158 double pixelRatio() const;
160 /// How to load image files
161 support::search_mode imageSearchMode() const {
162 #if QT_VERSION >= 0x050000
163 return pixelRatio() > 1 ? support::check_hidpi : support::must_exist;
165 return support::must_exist;
169 /// return true if the key is part of a shortcut
170 bool queryKeySym(KeySymbol const & key, KeyModifier state) const;
172 void processKeySym(KeySymbol const & key, KeyModifier state);
173 /// return the status bar state string
174 docstring viewStatusMessage();
176 /// \name Methods to process FuncRequests
178 /// process the func request
179 void processFuncRequest(FuncRequest const &);
180 /// add a func request to the queue and process it asynchronously
181 /// \note As a side-effect this will also process the
182 /// func requests that were added to the queue before.
183 void processFuncRequestAsync(FuncRequest const &);
184 /// process the func requests in the queue
185 void processFuncRequestQueue();
186 /// process the func requests in the queue asynchronously
187 void processFuncRequestQueueAsync();
188 /// add a func request to the queue for later processing
189 void addToFuncRequestQueue(FuncRequest const &);
193 /// openFile: whether or not open a file if the file is not opened
194 /// switchToBuffer: whether or not switch to buffer if the buffer is
195 /// not the current buffer
196 void gotoBookmark(unsigned int idx, bool openFile, bool switchToBuffer);
198 /// Start a long operation with some cancel possibility (button or ESC)
199 void startLongOperation();
200 /// This needs to be periodically called to avoid freezing the GUI
201 bool longOperationCancelled();
202 /// Stop the long operation mode (i.e., release the GUI)
203 void stopLongOperation();
204 /// A started long operation is still in progress ?
205 bool longOperationStarted();
208 void execBatchCommands();
210 void socketDataReceived(int fd);
211 /// events to be triggered by Private::general_timer_ should go here
212 void handleRegularEvents();
214 void onLastWindowClosed();
216 void slotProcessFuncRequestQueue() { processFuncRequestQueue(); }
220 void validateCurrentView();
222 void updateCurrentView(FuncRequest const & cmd, DispatchResult & dr);
224 bool closeAllViews();
225 /// Things that need to be done when the OSes session manager
226 /// requests a log out.
227 bool prepareAllViewsForLogout();
228 /// read the given ui (menu/toolbar) file
229 bool readUIFile(QString const & name, bool include = false);
237 ReturnValues readUIFile(support::FileName);
239 void setGuiLanguage();
241 void reconfigure(std::string const & option);
243 /// This GuiView is the one receiving Clipboard and Selection
245 GuiView * current_view_;
252 extern GuiApplication * guiApp;
254 /// \return the icon file name for the given action.
255 QString iconName(FuncRequest const & f, bool unknown);
257 /// \return the pixmap for the given path, name and extension.
258 /// in case of errors a warning is produced and an empty pixmap is returned.
259 QPixmap getPixmap(QString const & path, QString const & name, QString const & ext);
260 /// Load the file at \param path and convert it to a pixmap.
261 /// \return true on success otherwise invalidate the pixmap and return false.
262 /// The caller is responsible for error reporting.
263 bool getPixmap(QPixmap & pixmap, QString const & path);
265 /// \return an icon for the given action.
266 QIcon getIcon(FuncRequest const & f, bool unknown);
269 GuiApplication * theGuiApp();
271 } // namespace frontend
274 #endif // GUIAPPLICATION_H