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 void handleKeyFunc(FuncCode action) override;
81 bool unhide(Buffer * buf) override;
85 bool getStatus(FuncRequest const & cmd, FuncStatus & status) const;
87 void hideDialogs(std::string const & name, Inset * inset) const;
92 Clipboard & clipboard();
94 Selection & selection();
96 FontLoader & fontLoader();
99 Toolbars const & toolbars() const;
101 Toolbars & toolbars();
103 Menus const & menus() const;
107 /// \name Methods inherited from QApplication class
109 bool notify(QObject * receiver, QEvent * event) override;
110 void commitData(QSessionManager & sm);
112 bool x11EventFilter(XEvent * ev) override;
113 #elif defined(QPA_XCB)
114 virtual bool nativeEventFilter(const QByteArray & eventType, void * message,
115 long * result) override;
119 /// Create the main window with given geometry settings.
120 /// \param geometry_arg: only for Windows platform.
121 /// \param optional id identifier.
122 void createView(QString const & geometry_arg = QString(),
123 bool autoShow = true, int id = 0);
124 /// FIXME: this method and the one above are quite ugly.
125 void createView(int id);
127 GuiView const * currentView() const { return current_view_; }
129 GuiView * currentView() { return current_view_; }
131 void setCurrentView(GuiView * view) { current_view_ = view; }
133 QList<int> viewIds() const;
135 /// Clear all session information.
139 ColorCache & colorCache();
141 QAbstractItemModel * languageModel();
143 /// return a suitable serif font name.
144 QString const romanFontName();
146 /// return a suitable sans serif font name.
147 QString const sansFontName();
149 /// return a suitable monospaced font name.
150 QString const typewriterFontName();
151 QFont const typewriterSystemFont();
154 void unregisterView(GuiView * gv);
156 GuiView & view(int id) const;
158 /// Current ratio between physical pixels and device-independent pixels
159 double pixelRatio() const;
161 /// How to load image files
162 support::search_mode imageSearchMode() const {
163 #if QT_VERSION >= 0x050000
164 return pixelRatio() > 1 ? support::check_hidpi : support::must_exist;
166 return support::must_exist;
170 /// return true if the key is part of a shortcut
171 bool queryKeySym(KeySymbol const & key, KeyModifier state) const;
173 void processKeySym(KeySymbol const & key, KeyModifier state);
174 /// return the status bar state string
175 docstring viewStatusMessage();
177 /// \name Methods to process FuncRequests
179 /// process the func request
180 void processFuncRequest(FuncRequest const &);
181 /// add a func request to the queue and process it asynchronously
182 /// \note As a side-effect this will also process the
183 /// func requests that were added to the queue before.
184 void processFuncRequestAsync(FuncRequest const &);
185 /// process the func requests in the queue
186 void processFuncRequestQueue();
187 /// process the func requests in the queue asynchronously
188 void processFuncRequestQueueAsync();
189 /// add a func request to the queue for later processing
190 void addToFuncRequestQueue(FuncRequest const &);
194 /// openFile: whether or not open a file if the file is not opened
195 /// switchToBuffer: whether or not switch to buffer if the buffer is
196 /// not the current buffer
197 void gotoBookmark(unsigned int idx, bool openFile, bool switchToBuffer);
199 /// Start a long operation with some cancel possibility (button or ESC)
200 void startLongOperation() override;
201 /// This needs to be periodically called to avoid freezing the GUI
202 bool longOperationCancelled() override;
203 /// Stop the long operation mode (i.e., release the GUI)
204 void stopLongOperation() override;
205 /// A started long operation is still in progress ?
206 bool longOperationStarted() override;
209 void execBatchCommands();
211 void socketDataReceived(int fd);
212 /// events to be triggered by Private::general_timer_ should go here
213 void handleRegularEvents();
215 void onLastWindowClosed();
217 void slotProcessFuncRequestQueue() { processFuncRequestQueue(); }
221 void validateCurrentView();
223 void updateCurrentView(FuncRequest const & cmd, DispatchResult & dr);
225 bool closeAllViews();
226 /// Things that need to be done when the OSes session manager
227 /// requests a log out.
228 bool prepareAllViewsForLogout();
229 /// read the given ui (menu/toolbar) file
230 bool readUIFile(QString const & name, bool include = false);
238 ReturnValues readUIFile(support::FileName);
240 void setGuiLanguage();
242 void reconfigure(std::string const & option);
244 /// This GuiView is the one receiving Clipboard and Selection
246 GuiView * current_view_;
253 extern GuiApplication * guiApp;
255 /// \return the icon file name for the given action.
256 QString iconName(FuncRequest const & f, bool unknown);
258 /// \return the pixmap for the given path, name and extension.
259 /// in case of errors a warning is produced and an empty pixmap is returned.
260 QPixmap getPixmap(QString const & path, QString const & name, QString const & ext);
261 /// Load the file at \param path and convert it to a pixmap.
262 /// \return true on success otherwise invalidate the pixmap and return false.
263 /// The caller is responsible for error reporting.
264 bool getPixmap(QPixmap & pixmap, QString const & path);
266 /// \return an icon for the given action.
267 QIcon getIcon(FuncRequest const & f, bool unknown);
270 GuiApplication * theGuiApp();
272 } // namespace frontend
275 #endif // GUIAPPLICATION_H