src/frontends/qt4/GuiApplication.h

   1 /**
   2  * \file GuiApplication.h
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author unknown
   7  * \author John Levon
   8  * \author Abdelrazak Younes
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #ifndef GUIAPPLICATION_H
  14 #define GUIAPPLICATION_H
  15
  16 #include "frontends/Application.h"
  17
  18 #include <QApplication>
  19 #include <QList>
  20
  21 class QAbstractItemModel;
  22 class QIcon;
  23 class QObject;
  24 class QSessionManager;
  25 class QSortFilterProxyModel;
  26
  27 namespace lyx {
  28
  29 class BufferView;
  30 class ColorCache;
  31 class KeySymbol;
  32
  33 namespace frontend {
  34
  35 class GuiView;
  36 class GlobalMenuBar;
  37 class GuiWorkArea;
  38 class Menus;
  39 class SocketNotifier;
  40 class Toolbars;
  41
  42 /// The Qt main application class
  43 /**
  44 There should be only one instance of this class. No Qt object
  45 initialisation should be done before the instanciation of this class.
  46 */
  47 class GuiApplication : public QApplication, public Application
  48 {
  49         Q_OBJECT
  50
  51 public:
  52         GuiApplication(int & argc, char ** argv);
  53         ~GuiApplication();
  54
  55         /// Clear all session information.
  56         void clearSession();
  57
  58         /// \name Methods inherited from Application class
  59         //@{
  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();
  68         int exec();
  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);
  79         //@}
  80         ///
  81         bool getStatus(FuncRequest const & cmd, FuncStatus & status) const;
  82         ///
  83         void hideDialogs(std::string const & name, Inset * inset) const;
  84         ///
  85         void resetGui();
  86
  87         Toolbars const & toolbars() const;
  88         Toolbars & toolbars();
  89         Menus const & menus() const;
  90         Menus & menus();
  91
  92         /// \name Methods inherited from QApplication class
  93         //@{
  94         bool notify(QObject * receiver, QEvent * event);
  95         void commitData(QSessionManager & sm);
  96 #ifdef Q_WS_X11
  97         bool x11EventFilter(XEvent * ev);
  98 #endif
  99         //@}
 100
 101         /// Create the main window with given geometry settings.
 102         /// \param geometry_arg: only for Windows platform.
 103         /// \param optional id identifier.
 104         void createView(QString const & geometry_arg = QString(),
 105                 bool autoShow = true, int id = 0);
 106         /// FIXME: this method and the one above are quite ugly.
 107         void createView(int id);
 108         ///
 109         GuiView const * currentView() const { return current_view_; }
 110         ///
 111         GuiView * currentView() { return current_view_; }
 112         ///
 113         void setCurrentView(GuiView * view) { current_view_ = view; }
 114         ///
 115         QList<int> viewIds() const;
 116
 117         ///
 118         ColorCache & colorCache();
 119
 120         QAbstractItemModel * languageModel();
 121
 122         /// return a suitable serif font name.
 123         QString const romanFontName();
 124
 125         /// return a suitable sans serif font name.
 126         QString const sansFontName();
 127
 128         /// return a suitable monospaced font name.
 129         QString const typewriterFontName();
 130         ///
 131         void unregisterView(GuiView * gv);
 132         ///
 133         GuiView & view(int id) const;
 134         ///
 135         void processKeySym(KeySymbol const & key, KeyModifier state);
 136         /// return the status bar state string
 137         docstring viewStatusMessage();
 138
 139         /// goto a bookmark
 140         /// openFile: whether or not open a file if the file is not opened
 141         /// switchToBuffer: whether or not switch to buffer if the buffer is
 142         ///             not the current buffer
 143         void gotoBookmark(unsigned int idx, bool openFile, bool switchToBuffer);
 144
 145 private Q_SLOTS:
 146         ///
 147         void execBatchCommands();
 148         ///
 149         void socketDataReceived(int fd);
 150         /// events to be triggered by general_timer_ should go here
 151         void handleRegularEvents();
 152         ///
 153         void onLastWindowClosed();
 154
 155         ///
 156         void processFuncRequestQueue();
 157
 158 private:
 159         ///
 160         bool closeAllViews();
 161         /// read the given ui (menu/toolbar) file
 162         bool readUIFile(QString const & name, bool include = false);
 163         ///
 164         void setGuiLanguage();
 165         ///
 166         void reconfigure(std::string const & option);
 167
 168         /// This GuiView is the one receiving Clipboard and Selection
 169         /// events
 170         GuiView * current_view_;
 171
 172         ///
 173         struct Private;
 174         Private * const d;
 175 }; // GuiApplication
 176
 177 extern GuiApplication * guiApp;
 178
 179 /// \return the icon file name for the given action.
 180 QString iconName(FuncRequest const & f, bool unknown);
 181
 182
 183 /// \return the pixmap for the given path, name and extension.
 184 QPixmap getPixmap(QString const & path, QString const & name, QString const & ext);
 185
 186 /// \return an icon for the given action.
 187 QIcon getIcon(FuncRequest const & f, bool unknown);
 188
 189 GuiApplication * theGuiApp();
 190
 191 } // namespace frontend
 192 } // namespace lyx
 193
 194 #endif // GUIAPPLICATION_H