aboutsummaryrefslogtreecommitdiff
path: root/common
diff options
context:
space:
mode:
authorLittleboy2011-04-27 16:07:03 -0400
committerJulien2011-06-16 14:23:20 -0400
commit7458073bad16f7f15fe8a98227e7b718ecb8a075 (patch)
tree7717bef9f43f97292c034ecf0e15abfbd636e567 /common
parent1e3603b9371204c88a60983cbfb61a4adcef0b94 (diff)
downloadscummvm-rg350-7458073bad16f7f15fe8a98227e7b718ecb8a075.tar.gz
scummvm-rg350-7458073bad16f7f15fe8a98227e7b718ecb8a075.tar.bz2
scummvm-rg350-7458073bad16f7f15fe8a98227e7b718ecb8a075.zip
COMMON: Update TaskbarManager header with better documentation and examples of use
Diffstat (limited to 'common')
-rw-r--r--common/taskbar.h17
1 files changed, 13 insertions, 4 deletions
diff --git a/common/taskbar.h b/common/taskbar.h
index f040af8786..ff9fd9c264 100644
--- a/common/taskbar.h
+++ b/common/taskbar.h
@@ -30,11 +30,20 @@
namespace Common {
/**
- * The TaskbarManager allows interaction with the ScummVM icon in the taskbar.
+ * 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 MacOSX
+ * - ...
*
- * This allows the application to set a progress bar, an overlay icon and count
- * as well as add the started engine to the recent items list (so that the user
- * can start the engine directly in one click)
+ * 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