1 /***************************************************************************
2 * Copyright (C) 2005-2018 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 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
19 ***************************************************************************/
21 #ifndef GRAPHICALUI_H_
22 #define GRAPHICALUI_H_
24 #include "abstractui.h"
26 class ActionCollection;
27 class ContextMenuActionProvider;
28 class ToolBarActionProvider;
35 #include <Carbon/Carbon.h>
38 class GraphicalUi : public AbstractUi
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")
49 static ActionCollection *actionCollection(const QString &category = "General", const QString &translatedCategory = QString());
50 static QHash<QString, ActionCollection *> actionCollections();
52 //! Load custom shortcuts from ShortcutSettings
53 /** @note This method assumes that all configurable actions are defined when being called
55 static void loadShortcuts();
57 //! Save custom shortcuts to ShortcutSettings
58 static void saveShortcuts();
60 inline static ContextMenuActionProvider *contextMenuActionProvider();
61 inline static ToolBarActionProvider *toolBarActionProvider();
62 inline static UiStyle *uiStyle();
63 inline static QWidget *mainWidget();
65 //! Force the main widget to the front and focus it (may not work in all window systems)
66 static void activateMainWidget();
68 //! Hide main widget (storing the current desktop if possible)
69 static void hideMainWidget();
71 //! Toggle main widget
72 static void toggleMainWidget();
74 //! Check if the main widget if (fully, in KDE) visible
75 static bool isMainWidgetVisible();
78 GraphicalUi(QObject *parent = 0);
81 //! This is the widget we associate global actions with, typically the main window
82 void setMainWidget(QWidget *);
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)
91 bool checkMainWidgetVisibility(bool performToggle);
93 //! Minimize to or restore main widget
94 virtual void minimizeRestore(bool show);
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.
100 virtual inline bool isHidingMainWidgetAllowed() const;
102 void setContextMenuActionProvider(ContextMenuActionProvider *);
103 void setToolBarActionProvider(ToolBarActionProvider *);
104 void setUiStyle(UiStyle *);
106 virtual bool eventFilter(QObject *obj, QEvent *event);
109 virtual void disconnectedFromCore();
112 static GraphicalUi *instance();
114 static QWidget *_mainWidget;
115 static QHash<QString, ActionCollection *> _actionCollections;
116 static ContextMenuActionProvider *_contextMenuActionProvider;
117 static ToolBarActionProvider *_toolBarActionProvider;
118 static UiStyle *_uiStyle;
119 static bool _onAllDesktops;
125 ProcessSerialNumber _procNum;
132 ContextMenuActionProvider *GraphicalUi::contextMenuActionProvider() { return _contextMenuActionProvider; }
133 ToolBarActionProvider *GraphicalUi::toolBarActionProvider() { return _toolBarActionProvider; }
134 UiStyle *GraphicalUi::uiStyle() { return _uiStyle; }
135 QWidget *GraphicalUi::mainWidget() { return _mainWidget; }
136 bool GraphicalUi::isHidingMainWidgetAllowed() const { return false; }