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