src/uisupport/graphicalui.h

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