#define GUIAPPLICATION_H
#include "frontends/Application.h"
+#include "support/filetools.h"
#include <QApplication>
-#include <QObject>
-#include <QVector>
+#include <QList>
+#ifdef QPA_XCB
+#include <QAbstractNativeEventFilter>
+#endif
-class QSessionManager;
class QAbstractItemModel;
-class QSortFilterProxyModel;
+class QIcon;
+class QSessionManager;
+class QFont;
namespace lyx {
class BufferView;
class ColorCache;
+class KeySymbol;
+
+namespace support {
+class FileName;
+}
namespace frontend {
class GuiView;
-class LyXView;
-class GlobalMenuBar;
class GuiWorkArea;
class Menus;
class SocketNotifier;
+class Toolbars;
/// The Qt main application class
/**
There should be only one instance of this class. No Qt object
-initialisation should be done before the instanciation of this class.
+initialisation should be done before the instantiation of this class.
*/
class GuiApplication : public QApplication, public Application
+#ifdef QPA_XCB
+ , public QAbstractNativeEventFilter
+#endif
{
Q_OBJECT
GuiApplication(int & argc, char ** argv);
~GuiApplication();
- /// Method inherited from \c Application class
+ /// \name Methods inherited from Application class
//@{
- bool getStatus(FuncRequest const & cmd, FuncStatus & flag) const;
- bool dispatch(FuncRequest const &);
- void resetGui();
+ DispatchResult const & dispatch(FuncRequest const &);
+ void dispatch(FuncRequest const &, DispatchResult & dr);
+ FuncStatus getStatus(FuncRequest const & cmd) const;
void restoreGuiSession();
- Clipboard & clipboard();
- Selection & selection();
- FontLoader & fontLoader();
+ Buffer const * updateInset(Inset const * inset) const;
int exec();
void exit(int status);
bool event(QEvent * e);
bool getRgbColor(ColorCode col, RGBColor & rgbcol);
std::string const hexName(ColorCode col);
- void readMenus(Lexer & lex);
void registerSocketCallback(int fd, SocketCallback func);
void unregisterSocketCallback(int fd);
- bool searchMenu(FuncRequest const & func, std::vector<docstring> & names) const;
- void hideDialogs(std::string const & name, Inset * inset) const;
- Buffer const * updateInset(Inset const * inset) const;
+ bool searchMenu(FuncRequest const & func, docstring_list & names) const;
+ void handleKeyFunc(FuncCode action);
//@}
+ ///
+ bool getStatus(FuncRequest const & cmd, FuncStatus & status) const;
+ ///
+ void hideDialogs(std::string const & name, Inset * inset) const;
+ ///
+ void resetGui();
+
+ ///
+ Clipboard & clipboard();
+ ///
+ Selection & selection();
+ ///
+ FontLoader & fontLoader();
+
+ ///
+ Toolbars const & toolbars() const;
+ ///
+ Toolbars & toolbars();
+ ///
Menus const & menus() const;
+ ///
Menus & menus();
- /// Methods inherited from \c QApplication class
+
+ /// \name Methods inherited from QApplication class
//@{
bool notify(QObject * receiver, QEvent * event);
void commitData(QSessionManager & sm);
#ifdef Q_WS_X11
bool x11EventFilter(XEvent * ev);
+#elif defined(QPA_XCB)
+ virtual bool nativeEventFilter(const QByteArray & eventType, void * message,
+ long * result) Q_DECL_OVERRIDE;
#endif
//@}
/// Create the main window with given geometry settings.
/// \param geometry_arg: only for Windows platform.
+ /// \param optional id identifier.
void createView(QString const & geometry_arg = QString(),
- bool autoShow = true);
+ bool autoShow = true, int id = 0);
+ /// FIXME: this method and the one above are quite ugly.
+ void createView(int id);
///
GuiView const * currentView() const { return current_view_; }
///
///
void setCurrentView(GuiView * view) { current_view_ = view; }
///
- QVector<int> viewIds();
+ QList<int> viewIds() const;
+
+ /// Clear all session information.
+ void clearSession();
///
ColorCache & colorCache();
-
+ ///
QAbstractItemModel * languageModel();
/// return a suitable serif font name.
/// return a suitable monospaced font name.
QString const typewriterFontName();
+ QFont const typewriterSystemFont();
+
///
void unregisterView(GuiView * gv);
///
GuiView & view(int id) const;
+ /// Current ratio between physical pixels and device-independent pixels
+ double pixelRatio() const;
+
+ /// How to load image files
+ support::search_mode imageSearchMode() const {
+#if QT_VERSION >= 0x050000
+ return pixelRatio() > 1 ? support::check_hidpi : support::must_exist;
+#else
+ return support::must_exist;
+#endif
+ }
+
+ /// return true if the key is part of a shortcut
+ bool queryKeySym(KeySymbol const & key, KeyModifier state) const;
+ ///
+ void processKeySym(KeySymbol const & key, KeyModifier state);
+ /// return the status bar state string
+ docstring viewStatusMessage();
+
+ /// \name Methods to process FuncRequests
+ //@{
+ /// process the func request
+ void processFuncRequest(FuncRequest const &);
+ /// add a func request to the queue and process it asynchronously
+ /// \note As a side-effect this will also process the
+ /// func requests that were added to the queue before.
+ void processFuncRequestAsync(FuncRequest const &);
+ /// process the func requests in the queue
+ void processFuncRequestQueue();
+ /// process the func requests in the queue asynchronously
+ void processFuncRequestQueueAsync();
+ /// add a func request to the queue for later processing
+ void addToFuncRequestQueue(FuncRequest const &);
+ //@}
+
+ /// goto a bookmark
+ /// openFile: whether or not open a file if the file is not opened
+ /// switchToBuffer: whether or not switch to buffer if the buffer is
+ /// not the current buffer
+ void gotoBookmark(unsigned int idx, bool openFile, bool switchToBuffer);
+
+ /// Start a long operation with some cancel possibility (button or ESC)
+ void startLongOperation();
+ /// This needs to be periodically called to avoid freezing the GUI
+ bool longOperationCancelled();
+ /// Stop the long operation mode (i.e., release the GUI)
+ void stopLongOperation();
+ /// A started long operation is still in progress ?
+ bool longOperationStarted();
private Q_SLOTS:
///
void execBatchCommands();
///
void socketDataReceived(int fd);
- /// events to be triggered by general_timer_ should go here
+ /// events to be triggered by Private::general_timer_ should go here
void handleRegularEvents();
///
void onLastWindowClosed();
-
+ ///
+ void slotProcessFuncRequestQueue() { processFuncRequestQueue(); }
+
private:
+ ///
+ void validateCurrentView();
+ ///
+ void updateCurrentView(FuncRequest const & cmd, DispatchResult & dr);
///
bool closeAllViews();
- /// This LyXView is the one receiving Clipboard and Selection
+ /// Things that need to be done when the OSes session manager
+ /// requests a log out.
+ bool prepareAllViewsForLogout();
+ /// read the given ui (menu/toolbar) file
+ bool readUIFile(QString const & name, bool include = false);
+ ///
+ enum ReturnValues {
+ ReadOK,
+ ReadError,
+ FormatMismatch
+ };
+ ///
+ ReturnValues readUIFile(support::FileName);
+ ///
+ void setGuiLanguage();
+ ///
+ void reconfigure(std::string const & option);
+
+ /// This GuiView is the one receiving Clipboard and Selection
/// events
GuiView * current_view_;
+
///
struct Private;
Private * const d;
extern GuiApplication * guiApp;
+/// \return the icon file name for the given action.
+QString iconName(FuncRequest const & f, bool unknown);
+
+/// \return the pixmap for the given path, name and extension.
+/// in case of errors a warning is produced and an empty pixmap is returned.
+QPixmap getPixmap(QString const & path, QString const & name, QString const & ext);
+/// Load the file at \param path and convert it to a pixmap.
+/// \return true on success otherwise invalidate the pixmap and return false.
+/// The caller is responsible for error reporting.
+bool getPixmap(QPixmap & pixmap, QString const & path);
+
+/// \return an icon for the given action.
+QIcon getIcon(FuncRequest const & f, bool unknown);
+
+///
+GuiApplication * theGuiApp();
+
} // namespace frontend
} // namespace lyx