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