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 "ColorCache.h"
  17 #include "FontLoader.h"
  18 #include "GuiClipboard.h"
  19 #include "GuiSelection.h"
  20 #include "Menus.h"
  21
  22 #include "frontends/Application.h"
  23
  24 #include <QObject>
  25 #include <QApplication>
  26 #include <QTimer>
  27 #include <QTranslator>
  28
  29 #include <map>
  30 #include <vector>
  31
  32 class QSessionManager;
  33 class QAbstractItemModel;
  34
  35 namespace lyx {
  36
  37 class BufferView;
  38
  39 namespace frontend {
  40
  41 class GuiView;
  42 class LyXView;
  43 class GlobalMenuBar;
  44 class GuiWorkArea;
  45 class SocketNotifier;
  46
  47 /// The Qt main application class
  48 /**
  49 There should be only one instance of this class. No Qt object
  50 initialisation should be done before the instanciation of this class.
  51 */
  52 class GuiApplication : public QApplication, public Application
  53 {
  54         Q_OBJECT
  55
  56 public:
  57         GuiApplication(int & argc, char ** argv);
  58
  59         /// Method inherited from \c Application class
  60         //@{
  61         virtual FuncStatus getStatus(FuncRequest const &);
  62         virtual bool dispatch(FuncRequest const &);
  63         virtual void resetGui();
  64         void restoreGuiSession();
  65         virtual Clipboard & clipboard();
  66         virtual Selection & selection();
  67         virtual FontLoader & fontLoader() { return font_loader_; }
  68         virtual int exec();
  69         virtual void exit(int status);
  70         virtual bool event(QEvent * e);
  71         virtual bool getRgbColor(ColorCode col, RGBColor & rgbcol);
  72         virtual std::string const hexName(ColorCode col);
  73         virtual void updateColor(ColorCode col);
  74         virtual void readMenus(Lexer & lex);
  75         virtual void initGlobalMenu();
  76         virtual void registerSocketCallback(int fd, SocketCallback func);
  77         void unregisterSocketCallback(int fd);
  78         bool searchMenu(FuncRequest const & func, std::vector<docstring> & names) const;
  79         //@}
  80
  81         Menus const & menus() const { return menus_; }
  82         Menus & menus() { return menus_; }
  83         /// Methods inherited from \c QApplication class
  84         //@{
  85         bool notify(QObject * receiver, QEvent * event);
  86         void commitData(QSessionManager & sm);
  87         //@}
  88
  89         /// Create the main window with given geometry settings.
  90         /// \param geometry_arg: only for Windows platform.
  91         void createView(QString const & geometry_arg = QString(),
  92                 bool autoShow = true);
  93         ///
  94         GuiView const * currentView() const { return current_view_; }
  95         ///
  96         GuiView * currentView() { return current_view_; }
  97         ///
  98         void setCurrentView(GuiView * view) { current_view_ = view; }
  99         ///
 100         virtual size_t viewCount() const { return view_ids_.size(); }
 101         ///
 102         std::vector<int> const & viewIds() { return view_ids_; }
 103
 104         ///
 105         ColorCache & colorCache() { return color_cache_; }
 106
 107         QAbstractItemModel * languageModel();
 108
 109         /// return a suitable serif font name.
 110         virtual QString const romanFontName();
 111
 112         /// return a suitable sans serif font name.
 113         virtual QString const sansFontName();
 114
 115         /// return a suitable monospaced font name.
 116         virtual QString const typewriterFontName();
 117         ///
 118         virtual bool unregisterView(int id);
 119         ///
 120         virtual GuiView & view(int id) const;
 121         ///
 122         virtual void hideDialogs(std::string const & name, Inset * inset) const;
 123         ///
 124         virtual Buffer const * updateInset(Inset const * inset) const;
 125
 126 private Q_SLOTS:
 127         ///
 128         void execBatchCommands();
 129         ///
 130         void socketDataReceived(int fd);
 131         /// events to be triggered by general_timer_ should go here
 132         void handleRegularEvents();
 133         ///
 134         void onLastWindowClosed();
 135
 136 private:
 137         ///
 138         bool closeAllViews();
 139         ///
 140         GuiClipboard clipboard_;
 141         ///
 142         GuiSelection selection_;
 143         ///
 144         FontLoader font_loader_;
 145         ///
 146         ColorCache color_cache_;
 147         ///
 148         QSortFilterProxyModel * language_model_;
 149         ///
 150         QTranslator qt_trans_;
 151         ///
 152         std::map<int, SocketNotifier *> socket_notifiers_;
 153         ///
 154         Menus menus_;
 155         /// this timer is used for any regular events one wants to
 156         /// perform. at present it is used to check if forked processes
 157         /// are done.
 158         QTimer general_timer_;
 159
 160 #ifdef Q_WS_X11
 161 public:
 162         bool x11EventFilter(XEvent * ev);
 163 #endif
 164         /// A translator suitable for the entries in the LyX menu.
 165         /// Only needed with Qt/Mac.
 166         void addMenuTranslator();
 167
 168         /// Multiple views container.
 169         /**
 170         * Warning: This must not be a smart pointer as the destruction of the
 171         * object is handled by Qt when the view is closed
 172         * \sa Qt::WA_DeleteOnClose attribute.
 173         */
 174         std::map<int, GuiView *> views_;
 175         ///
 176         std::vector<int> view_ids_;
 177         /// This LyXView is the one receiving Clipboard and Selection
 178         /// events
 179         GuiView * current_view_;
 180         /// only used on mac
 181         GlobalMenuBar * global_menubar_;
 182 }; // GuiApplication
 183
 184 extern GuiApplication * guiApp;
 185
 186 } // namespace frontend
 187 } // namespace lyx
 188
 189 #endif // GUIAPPLICATION_H