diff options
| author | Littleboy | 2011-04-26 15:31:56 -0400 |
|---|---|---|
| committer | Julien | 2011-06-16 14:23:17 -0400 |
| commit | 28aa4f0f33c662b8d0c9273011d43237451b9659 (patch) | |
| tree | 263f0101c2ca73717a08021eb4e49a90eae73316 | |
| parent | fdada1dbffb57e12f5683f54e5bbaf7cc5eafdce (diff) | |
| download | scummvm-rg350-28aa4f0f33c662b8d0c9273011d43237451b9659.tar.gz scummvm-rg350-28aa4f0f33c662b8d0c9273011d43237451b9659.tar.bz2 scummvm-rg350-28aa4f0f33c662b8d0c9273011d43237451b9659.zip | |
COMMON: Add overall documentation to TaskbarManager interface
| -rw-r--r-- | common/taskbar.h | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/common/taskbar.h b/common/taskbar.h index 2219e6e04f..f040af8786 100644 --- a/common/taskbar.h +++ b/common/taskbar.h @@ -29,6 +29,17 @@ namespace Common { +/** + * The TaskbarManager allows interaction with the ScummVM icon in the taskbar. + * + * 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) + * + * @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: /** |