diff options
Diffstat (limited to 'common/system.h')
| -rw-r--r-- | common/system.h | 38 |
1 files changed, 30 insertions, 8 deletions
diff --git a/common/system.h b/common/system.h index 46e14589ab..6f3dc6b6c8 100644 --- a/common/system.h +++ b/common/system.h @@ -151,6 +151,10 @@ public: * It is currently used only by some Macintosh versions of Humongous * Entertainment games. If the backend doesn't implement this feature then * the engine switches to b/w versions of cursors. + * The GUI also relies on this feature for mouse cursors. + * + * To enable the cursor palette call "disableCursorPalette" with false. + * @see disableCursorPalette */ kFeatureCursorHasPalette, @@ -721,10 +725,25 @@ public: - /** @name Mouse */ + /** @name Mouse + * This is the lower level implementation as provided by the + * backends. The engines should use the Graphics::CursorManager + * class instead of using it directly. + */ //@{ - /** Show or hide the mouse cursor. */ + /** + * Show or hide the mouse cursor. + * + * Currently the backend is not required to immediately draw the + * mouse cursor on showMouse(true). + * + * TODO: We might want to reconsider this fact, + * check Graphics::CursorManager::showMouse for some details about + * this. + * + * @see Graphics::CursorManager::showMouse + */ virtual bool showMouse(bool visible) = 0; /** @@ -890,6 +909,9 @@ public: * @name Audio CD * The methods in this group deal with Audio CD playback. * The default implementation simply does nothing. + * This is the lower level implementation as provided by the + * backends. The engines should use the Audio::AudioCDManager + * class instead of using it directly. */ //@{ @@ -935,13 +957,11 @@ public: /** * Set a window caption or any other comparable status display to the - * given value. The caption must be a pure ASCII string. Passing a - * non-ASCII string may lead to unexpected behavior, even crashes. + * given value. The caption must be a pure ISO LATIN 1 string. Passing a + * string with a different encoding may lead to unexpected behavior, + * even crashes. * - * In a future revision of this API, this may be changed to allowing - * UTF-8 or UTF-16 encoded data, or maybe ISO LATIN 1. - * - * @param caption the window caption to use, as an ASCII string + * @param caption the window caption to use, as an ISO LATIN 1 string */ virtual void setWindowCaption(const char *caption) {} @@ -951,6 +971,8 @@ public: * rectangle over the regular screen content; or in a message box beneath * it; etc.). * + * Currently, only pure ASCII messages can be expected to show correctly. + * * @note There is a default implementation which uses a TimedMessageDialog * to display the message. Hence implementing this is optional. * |