1 /***************************************************************************
2 * Copyright (C) 2005-09 by the Quassel Project *
3 * devel@quassel-irc.org *
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. *
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. *
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 ***************************************************************************/
21 #ifndef GRAPHICALUI_H_
22 #define GRAPHICALUI_H_
24 #include "abstractui.h"
26 class ActionCollection;
27 class ContextMenuActionProvider;
28 class ToolBarActionProvider;
35 class GraphicalUi : public AbstractUi {
39 GraphicalUi(QObject *parent = 0);
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")
48 static ActionCollection *actionCollection(const QString &category = "General");
50 inline static ContextMenuActionProvider *contextMenuActionProvider();
51 inline static ToolBarActionProvider *toolBarActionProvider();
52 inline static UiStyle *uiStyle();
53 inline static QWidget *mainWidget();
55 //! Force the main widget to the front and focus it (may not work in all window systems)
56 static void activateMainWidget();
58 //! Hide main widget (storing the current desktop if possible)
59 static void hideMainWidget();
61 //! Toggle main widget
62 static void toggleMainWidget();
64 //! Check if the main widget if (fully, in KDE) visible
65 static bool isMainWidgetVisible();
68 //! This is the widget we associate global actions with, typically the main window
69 void setMainWidget(QWidget *);
71 //! Check if the mainWidget is visible and optionally toggle its visibility
72 /** With KDE integration, we check if the mainWidget is (partially) obscured in order to determine if
73 * it should be activated or hidden. Without KDE, we need to resort to checking the current state
74 * as Qt knows it, ignoring windows covering it.
75 * @param performToggle If true, toggle the window's state in addition to checking visibility
76 * @return True, if the window is currently *not* visible (needs activation)
78 bool checkMainWidgetVisibility(bool performToggle);
80 //! Minimize to or restore main widget
81 virtual void minimizeRestore(bool show);
83 //! Whether it is allowed to hide the mainWidget
84 /** The default implementation returns false, meaning that we won't hide the mainWidget even
85 * if requested. This is to prevent hiding in case we don't have a tray icon to restore from.
87 virtual inline bool isHidingMainWidgetAllowed() const;
89 void setContextMenuActionProvider(ContextMenuActionProvider *);
90 void setToolBarActionProvider(ToolBarActionProvider *);
91 void setUiStyle(UiStyle *);
93 virtual bool eventFilter(QObject *obj, QEvent *event);
96 virtual void disconnectedFromCore();
99 static inline GraphicalUi *instance();
101 static GraphicalUi *_instance;
102 static QWidget *_mainWidget;
103 static QHash<QString, ActionCollection *> _actionCollections;
104 static ContextMenuActionProvider *_contextMenuActionProvider;
105 static ToolBarActionProvider *_toolBarActionProvider;
106 static UiStyle *_uiStyle;
107 static bool _onAllDesktops;
117 GraphicalUi *GraphicalUi::instance() { return _instance; }
118 ContextMenuActionProvider *GraphicalUi::contextMenuActionProvider() { return _contextMenuActionProvider; }
119 ToolBarActionProvider *GraphicalUi::toolBarActionProvider() { return _toolBarActionProvider; }
120 UiStyle *GraphicalUi::uiStyle() { return _uiStyle; }
121 QWidget *GraphicalUi::mainWidget() { return _mainWidget; }
122 bool GraphicalUi::isHidingMainWidgetAllowed() const { return false; }