src/uisupport/graphicalui.h

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