src/uisupport/graphicalui.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2018 by the Quassel Project                        *
   3  *   devel@quassel-irc.org                                                 *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) version 3.                                           *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  19  ***************************************************************************/
  20
  21 #ifndef GRAPHICALUI_H_
  22 #define GRAPHICALUI_H_
  23
  24 #include "abstractui.h"
  25 #include "singleton.h"
  26
  27 class ActionCollection;
  28 class ContextMenuActionProvider;
  29 class ToolBarActionProvider;
  30 class UiStyle;
  31
  32 #ifdef Q_OS_WIN
  33 #  include <windows.h>
  34 #endif
  35 #ifdef Q_OS_MAC
  36 #include <Carbon/Carbon.h>
  37 #endif
  38
  39 class GraphicalUi : public AbstractUi, protected Singleton<GraphicalUi>
  40 {
  41     Q_OBJECT
  42
  43 public:
  44     //! Access global ActionCollections.
  45     /** These ActionCollections are associated with the main window, i.e. they contain global
  46     *  actions (and thus, shortcuts). Widgets providing application-wide shortcuts should
  47     *  create appropriate Action objects using GraphicalUi::actionCollection(cat)->add\<Action\>().
  48     *  @param category The category (default: "General")
  49     */
  50     static ActionCollection *actionCollection(const QString &category = "General", const QString &translatedCategory = QString());
  51     static QHash<QString, ActionCollection *> actionCollections();
  52
  53     //! Load custom shortcuts from ShortcutSettings
  54     /** @note This method assumes that all configurable actions are defined when being called
  55      */
  56     static void loadShortcuts();
  57
  58     //! Save custom shortcuts to ShortcutSettings
  59     static void saveShortcuts();
  60
  61     inline static ContextMenuActionProvider *contextMenuActionProvider();
  62     inline static ToolBarActionProvider *toolBarActionProvider();
  63     inline static UiStyle *uiStyle();
  64     inline static QWidget *mainWidget();
  65
  66     //! Force the main widget to the front and focus it (may not work in all window systems)
  67     static void activateMainWidget();
  68
  69     //! Hide main widget (storing the current desktop if possible)
  70     static void hideMainWidget();
  71
  72     //! Toggle main widget
  73     static void toggleMainWidget();
  74
  75     //! Check if the main widget if (fully, in KDE) visible
  76     static bool isMainWidgetVisible();
  77
  78 protected:
  79     GraphicalUi(QObject *parent = 0);
  80     virtual void init();
  81
  82     //! This is the widget we associate global actions with, typically the main window
  83     void setMainWidget(QWidget *);
  84
  85     //! Check if the mainWidget is visible and optionally toggle its visibility
  86     /** With KDE integration, we check if the mainWidget is (partially) obscured in order to determine if
  87      *  it should be activated or hidden. Without KDE, we need to resort to checking the current state
  88      *  as Qt knows it, ignoring windows covering it.
  89      *  @param  performToggle If true, toggle the window's state in addition to checking visibility
  90      *  @return True, if the window is currently *not* visible (needs activation)
  91      */
  92     bool checkMainWidgetVisibility(bool performToggle);
  93
  94     //! Minimize to or restore main widget
  95     virtual void minimizeRestore(bool show);
  96
  97     //! Whether it is allowed to hide the mainWidget
  98     /** The default implementation returns false, meaning that we won't hide the mainWidget even
  99      *  if requested. This is to prevent hiding in case we don't have a tray icon to restore from.
 100      */
 101     virtual inline bool isHidingMainWidgetAllowed() const;
 102
 103     void setContextMenuActionProvider(ContextMenuActionProvider *);
 104     void setToolBarActionProvider(ToolBarActionProvider *);
 105     void setUiStyle(UiStyle *);
 106
 107     virtual bool eventFilter(QObject *obj, QEvent *event);
 108
 109 protected slots:
 110     virtual void disconnectedFromCore();
 111
 112 private:
 113     static QWidget *_mainWidget;
 114     static QHash<QString, ActionCollection *> _actionCollections;
 115     static ContextMenuActionProvider *_contextMenuActionProvider;
 116     static ToolBarActionProvider *_toolBarActionProvider;
 117     static UiStyle *_uiStyle;
 118
 119 #ifdef Q_OS_WIN
 120     DWORD _dwTickCount;
 121 #endif
 122 #ifdef Q_OS_MAC
 123     ProcessSerialNumber _procNum;
 124 #endif
 125 };
 126
 127
 128 // inlines
 129
 130 ContextMenuActionProvider *GraphicalUi::contextMenuActionProvider() { return _contextMenuActionProvider; }
 131 ToolBarActionProvider *GraphicalUi::toolBarActionProvider() { return _toolBarActionProvider; }
 132 UiStyle *GraphicalUi::uiStyle() { return _uiStyle; }
 133 QWidget *GraphicalUi::mainWidget() { return _mainWidget; }
 134 bool GraphicalUi::isHidingMainWidgetAllowed() const { return false; }
 135
 136 #endif