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"
18 #include <QApplication>
21 class QAbstractItemModel;
24 class QSessionManager;
25 class QSortFilterProxyModel;
42 /// The Qt main application class
44 There should be only one instance of this class. No Qt object
45 initialisation should be done before the instanciation of this class.
47 class GuiApplication : public QApplication, public Application
52 GuiApplication(int & argc, char ** argv);
55 /// Clear all session information.
58 /// \name Methods inherited from Application class
60 void dispatch(FuncRequest const &);
61 void dispatch(FuncRequest const &, DispatchResult & dr);
62 FuncStatus getStatus(FuncRequest const & cmd) const;
63 void restoreGuiSession();
64 Clipboard & clipboard();
65 Selection & selection();
66 FontLoader & fontLoader();
68 void exit(int status);
69 bool event(QEvent * e);
70 bool getRgbColor(ColorCode col, RGBColor & rgbcol);
71 std::string const hexName(ColorCode col);
72 void registerSocketCallback(int fd, SocketCallback func);
73 void unregisterSocketCallback(int fd);
74 bool searchMenu(FuncRequest const & func, docstring_list & names) const;
75 docstring iconName(FuncRequest const & f, bool unknown);
76 Buffer const * updateInset(Inset const * inset) const;
77 void handleKeyFunc(FuncCode action);
80 bool getStatus(FuncRequest const & cmd, FuncStatus & status) const;
82 void hideDialogs(std::string const & name, Inset * inset) const;
86 Toolbars const & toolbars() const;
87 Toolbars & toolbars();
88 Menus const & menus() const;
91 /// \name Methods inherited from QApplication class
93 bool notify(QObject * receiver, QEvent * event);
94 void commitData(QSessionManager & sm);
96 bool x11EventFilter(XEvent * ev);
100 /// Create the main window with given geometry settings.
101 /// \param geometry_arg: only for Windows platform.
102 /// \param optional id identifier.
103 void createView(QString const & geometry_arg = QString(),
104 bool autoShow = true, int id = 0);
105 /// FIXME: this method and the one above are quite ugly.
106 void createView(int id);
108 GuiView const * currentView() const { return current_view_; }
110 GuiView * currentView() { return current_view_; }
112 void setCurrentView(GuiView * view) { current_view_ = view; }
114 QList<int> viewIds() const;
117 ColorCache & colorCache();
119 QAbstractItemModel * languageModel();
121 /// return a suitable serif font name.
122 QString const romanFontName();
124 /// return a suitable sans serif font name.
125 QString const sansFontName();
127 /// return a suitable monospaced font name.
128 QString const typewriterFontName();
130 void unregisterView(GuiView * gv);
132 GuiView & view(int id) const;
134 void processKeySym(KeySymbol const & key, KeyModifier state);
135 /// return the status bar state string
136 docstring viewStatusMessage();
138 /// add a func request to the queue for later procession
139 void addtoFuncRequestQueue(FuncRequest const &);
140 /// process the func request in the queue asynchronously
141 void processFuncRequestQueueAsync();
144 /// openFile: whether or not open a file if the file is not opened
145 /// switchToBuffer: whether or not switch to buffer if the buffer is
146 /// not the current buffer
147 void gotoBookmark(unsigned int idx, bool openFile, bool switchToBuffer);
151 void execBatchCommands();
153 void socketDataReceived(int fd);
154 /// events to be triggered by general_timer_ should go here
155 void handleRegularEvents();
157 void onLastWindowClosed();
160 void processFuncRequestQueue();
164 bool closeAllViews();
165 /// read the given ui (menu/toolbar) file
166 bool readUIFile(QString const & name, bool include = false);
168 void setGuiLanguage();
170 void reconfigure(std::string const & option);
171 /// add a func request to the queue and process it asynchronously
172 void dispatchDelayed(FuncRequest const &);
174 /// This GuiView is the one receiving Clipboard and Selection
176 GuiView * current_view_;
183 extern GuiApplication * guiApp;
185 /// \return the icon file name for the given action.
186 QString iconName(FuncRequest const & f, bool unknown);
189 /// \return the pixmap for the given path, name and extension.
190 QPixmap getPixmap(QString const & path, QString const & name, QString const & ext);
192 /// \return an icon for the given action.
193 QIcon getIcon(FuncRequest const & f, bool unknown);
195 GuiApplication * theGuiApp();
197 } // namespace frontend
200 #endif // GUIAPPLICATION_H