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 dispatchDelayed(FuncRequest const &);
64 void restoreGuiSession();
65 Clipboard & clipboard();
66 Selection & selection();
67 FontLoader & fontLoader();
69 void exit(int status);
70 bool event(QEvent * e);
71 bool getRgbColor(ColorCode col, RGBColor & rgbcol);
72 std::string const hexName(ColorCode col);
73 void registerSocketCallback(int fd, SocketCallback func);
74 void unregisterSocketCallback(int fd);
75 bool searchMenu(FuncRequest const & func, docstring_list & names) const;
76 docstring iconName(FuncRequest const & f, bool unknown);
77 Buffer const * updateInset(Inset const * inset) const;
78 void handleKeyFunc(FuncCode action);
81 void hideDialogs(std::string const & name, Inset * inset) const;
85 Toolbars const & toolbars() const;
86 Toolbars & toolbars();
87 Menus const & menus() const;
90 /// \name Methods inherited from QApplication class
92 bool notify(QObject * receiver, QEvent * event);
93 void commitData(QSessionManager & sm);
95 bool x11EventFilter(XEvent * ev);
99 /// Create the main window with given geometry settings.
100 /// \param geometry_arg: only for Windows platform.
101 /// \param optional id identifier.
102 void createView(QString const & geometry_arg = QString(),
103 bool autoShow = true, int id = 0);
104 /// FIXME: this method and the one above are quite ugly.
105 void createView(int id);
107 GuiView const * currentView() const { return current_view_; }
109 GuiView * currentView() { return current_view_; }
111 void setCurrentView(GuiView * view) { current_view_ = view; }
113 QList<int> viewIds() const;
116 ColorCache & colorCache();
118 QAbstractItemModel * languageModel();
120 /// return a suitable serif font name.
121 QString const romanFontName();
123 /// return a suitable sans serif font name.
124 QString const sansFontName();
126 /// return a suitable monospaced font name.
127 QString const typewriterFontName();
129 void unregisterView(GuiView * gv);
131 GuiView & view(int id) const;
133 void processKeySym(KeySymbol const & key, KeyModifier state);
134 /// return the status bar state string
135 docstring viewStatusMessage();
138 /// openFile: whether or not open a file if the file is not opened
139 /// switchToBuffer: whether or not switch to buffer if the buffer is
140 /// not the current buffer
141 void gotoBookmark(unsigned int idx, bool openFile, bool switchToBuffer);
145 void execBatchCommands();
147 void socketDataReceived(int fd);
148 /// events to be triggered by general_timer_ should go here
149 void handleRegularEvents();
151 void onLastWindowClosed();
154 void processFuncRequestQueue();
158 bool closeAllViews();
159 /// read the given ui (menu/toolbar) file
160 bool readUIFile(QString const & name, bool include = false);
162 void setGuiLanguage();
164 /// This GuiView is the one receiving Clipboard and Selection
166 GuiView * current_view_;
173 extern GuiApplication * guiApp;
175 /// \return the icon file name for the given action.
176 QString iconName(FuncRequest const & f, bool unknown);
179 /// \return the pixmap for the given path, name and extension.
180 QPixmap getPixmap(QString const & path, QString const & name, QString const & ext);
182 /// \return an icon for the given action.
183 QIcon getIcon(FuncRequest const & f, bool unknown);
185 GuiApplication * theGuiApp();
187 } // namespace frontend
190 #endif // GUIAPPLICATION_H