1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
|
/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
#ifndef COMMON_TASKBAR_MANAGER_H
#define COMMON_TASKBAR_MANAGER_H
#include "common/scummsys.h"
#if defined(USE_TASKBAR)
#include "common/str.h"
#include "common/config-manager.h"
#include "common/file.h"
namespace Common {
/**
* @defgroup common_taskbar Taskbar Manager
* @ingroup common
*
* @brief The TaskbarManager module allows for interaction with the ScummVM application icon.
*
* @{
*/
/**
* The TaskbarManager allows interaction with the ScummVM application icon:
* - in the taskbar on Windows 7 and later
* - in the launcher for Unity
* - in the dock on macOS
* - ...
*
* This allows GUI code and engines to display a progress bar, an overlay icon and/or count
* associated with the ScummVM icon as well as add the started engine to the recent items
* list (so that the user can start the engine directly in one click).
*
* Examples of use:
* - Track search progress and found engines when running the Mass Add dialog
* - Add an entry to the recent items when starting an engine
* - Show the current running engine icon as an overlay
*
* @note functionality will vary between supported platforms (due to API limitations)
* and some of the methods will just be no-ops or approximate the functionality
* as best as possible
*/
class TaskbarManager {
public:
/**
* Values representing the taskbar progress state
*/
enum TaskbarProgressState {
kTaskbarNoProgress = 0,
kTaskbarIndeterminate = 1,
kTaskbarNormal = 2,
kTaskbarError = 4,
kTaskbarPaused = 8
};
TaskbarManager() {}
virtual ~TaskbarManager() {}
/**
* Sets an overlay icon on the taskbar icon
*
* When an empty name is given, no icon is shown
* and the current overlay icon (if any) is removed
*
* @param name Path to the icon
* @param description The description
*
* @note on Windows, the icon should be an ICO file
*/
virtual void setOverlayIcon(const String &name, const String &description) {}
/**
* Sets a progress value on the taskbar icon
*
* @param completed The current progress value.
* @param total The maximum progress value.
*/
virtual void setProgressValue(int completed, int total) {}
/**
* Sets the progress state on the taskbar icon
*
* State can be any of the following:
* - NoProgress: disable display of progress state
* - Indeterminate
* - Normal
* - Error
* - Paused
*
* @param state The progress state
*/
virtual void setProgressState(TaskbarProgressState state) {}
/**
* Sets the count number associated with the icon as an overlay
*
* @param count The count
*
* @note Setting a count of 0 will hide the count
*/
virtual void setCount(int count) {}
/**
* Adds an engine to the recent items list
*
* Path is automatically set to the current executable path,
* an icon name is generated (with fallback to default icon)
* and the command line is set to start the engine on click.
*
* @param name The target name.
* @param description The description.
*/
virtual void addRecent(const String &name, const String &description) {}
/**
* Notifies the user an error occurred through the taskbar icon
*
* This will for example show the taskbar icon as red (using progress of 100% and an error state)
* on Windows, and set the launcher icon in the urgent state on Unity
*/
virtual void notifyError() {}
/**
* Clears the error notification
*/
virtual void clearError() {}
protected:
/**
* Get the path to an icon for the game
*
* @param target The game target
* @param extension The icon extension
* @return The icon path (or "" if no icon was found)
*/
Common::Path getIconPath(const Common::String &target, const Common::String &extension) {
// We first try to look for a iconspath configuration variable then
// fallback to the extra path
//
// Icons can be either in a subfolder named "icons" or directly in the path
Common::Path iconsPath = ConfMan.getPath("iconspath");
Common::Path extraPath = ConfMan.getPath("extrapath");
Common::String targetIcon = target + extension;
Common::String qualifiedIcon = ConfMan.get("engineid") + "-" + ConfMan.get("gameid") + extension;
Common::String gameIcon = ConfMan.get("gameid") + extension;
Common::String engineIcon = ConfMan.get("engineid") + extension;
#define TRY_ICON_PATH(path) { \
Common::FSNode node((path)); \
if (node.exists()) \
return (path); \
}
if (!iconsPath.empty()) {
TRY_ICON_PATH(iconsPath.join(targetIcon));
TRY_ICON_PATH(iconsPath.join(qualifiedIcon));
TRY_ICON_PATH(iconsPath.join(gameIcon));
TRY_ICON_PATH(iconsPath.join(engineIcon));
TRY_ICON_PATH(iconsPath.join("icons/" + targetIcon));
TRY_ICON_PATH(iconsPath.join("icons/" + qualifiedIcon));
TRY_ICON_PATH(iconsPath.join("icons/" + gameIcon));
TRY_ICON_PATH(iconsPath.join("icons/" + engineIcon));
}
if (!extraPath.empty()) {
TRY_ICON_PATH(extraPath.join(targetIcon));
TRY_ICON_PATH(extraPath.join(qualifiedIcon));
TRY_ICON_PATH(extraPath.join(gameIcon));
TRY_ICON_PATH(extraPath.join(engineIcon));
TRY_ICON_PATH(extraPath.join("icons/" + targetIcon));
TRY_ICON_PATH(extraPath.join("icons/" + qualifiedIcon));
TRY_ICON_PATH(extraPath.join("icons/" + gameIcon));
TRY_ICON_PATH(extraPath.join("icons/" + engineIcon));
}
#undef TRY_ICON_PATH
return Common::Path();
}
};
/** @} */
} // End of namespace Common
#endif
#endif // COMMON_TASKBAR_MANAGER_H
|
