src/uisupport/graphicalui.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2016 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
  26 class ActionCollection;
  27 class ContextMenuActionProvider;
  28 class ToolBarActionProvider;
  29 class UiStyle;
  30
  31 #ifdef Q_OS_WIN
  32 #  include <windows.h>
  33 #endif
  34 #ifdef Q_OS_MAC
  35 #include <Carbon/Carbon.h>
  36 #endif
  37
  38 class GraphicalUi : public AbstractUi
  39 {
  40     Q_OBJECT
  41
  42 public:
  43     GraphicalUi(QObject *parent = 0);
  44     virtual void init();
  45
  46     //! Access global ActionCollections.
  47     /** These ActionCollections are associated with the main window, i.e. they contain global
  48     *  actions (and thus, shortcuts). Widgets providing application-wide shortcuts should
  49     *  create appropriate Action objects using GraphicalUi::actionCollection(cat)->add\<Action\>().
  50     *  @param category The category (default: "General")
  51     */
  52     static ActionCollection *actionCollection(const QString &category = "General", const QString &translatedCategory = QString());
  53     static QHash<QString, ActionCollection *> actionCollections();
  54
  55     //! Load custom shortcuts from ShortcutSettings
  56     /** @note This method assumes that all configurable actions are defined when being called
  57      */
  58     static void loadShortcuts();
  59
  60     //! Save custom shortcuts to ShortcutSettings
  61     static void saveShortcuts();
  62
  63     inline static ContextMenuActionProvider *contextMenuActionProvider();
  64     inline static ToolBarActionProvider *toolBarActionProvider();
  65     inline static UiStyle *uiStyle();
  66     inline static QWidget *mainWidget();
  67
  68     //! Force the main widget to the front and focus it (may not work in all window systems)
  69     static void activateMainWidget();
  70
  71     //! Hide main widget (storing the current desktop if possible)
  72     static void hideMainWidget();
  73
  74     //! Toggle main widget
  75     static void toggleMainWidget();
  76
  77     //! Check if the main widget if (fully, in KDE) visible
  78     static bool isMainWidgetVisible();
  79
  80 protected:
  81     //! This is the widget we associate global actions with, typically the main window
  82     void setMainWidget(QWidget *);
  83
  84     //! Check if the mainWidget is visible and optionally toggle its visibility
  85     /** With KDE integration, we check if the mainWidget is (partially) obscured in order to determine if
  86      *  it should be activated or hidden. Without KDE, we need to resort to checking the current state
  87      *  as Qt knows it, ignoring windows covering it.
  88      *  @param  performToggle If true, toggle the window's state in addition to checking visibility
  89      *  @return True, if the window is currently *not* visible (needs activation)
  90      */
  91     bool checkMainWidgetVisibility(bool performToggle);
  92
  93     //! Minimize to or restore main widget
  94     virtual void minimizeRestore(bool show);
  95
  96     //! Whether it is allowed to hide the mainWidget
  97     /** The default implementation returns false, meaning that we won't hide the mainWidget even
  98      *  if requested. This is to prevent hiding in case we don't have a tray icon to restore from.
  99      */
 100     virtual inline bool isHidingMainWidgetAllowed() const;
 101
 102     void setContextMenuActionProvider(ContextMenuActionProvider *);
 103     void setToolBarActionProvider(ToolBarActionProvider *);
 104     void setUiStyle(UiStyle *);
 105
 106     virtual bool eventFilter(QObject *obj, QEvent *event);
 107
 108 protected slots:
 109     virtual void disconnectedFromCore();
 110
 111 private:
 112     static inline GraphicalUi *instance();
 113
 114     static GraphicalUi *_instance;
 115     static QWidget *_mainWidget;
 116     static QHash<QString, ActionCollection *> _actionCollections;
 117     static ContextMenuActionProvider *_contextMenuActionProvider;
 118     static ToolBarActionProvider *_toolBarActionProvider;
 119     static UiStyle *_uiStyle;
 120     static bool _onAllDesktops;
 121
 122 #ifdef Q_OS_WIN
 123     DWORD _dwTickCount;
 124 #endif
 125 #ifdef Q_OS_MAC
 126     ProcessSerialNumber _procNum;
 127 #endif
 128 };
 129
 130
 131 // inlines
 132
 133 GraphicalUi *GraphicalUi::instance() { return _instance; }
 134 ContextMenuActionProvider *GraphicalUi::contextMenuActionProvider() { return _contextMenuActionProvider; }
 135 ToolBarActionProvider *GraphicalUi::toolBarActionProvider() { return _toolBarActionProvider; }
 136 UiStyle *GraphicalUi::uiStyle() { return _uiStyle; }
 137 QWidget *GraphicalUi::mainWidget() { return _mainWidget; }
 138 bool GraphicalUi::isHidingMainWidgetAllowed() const { return false; }
 139
 140 #endif