aboutsummaryrefslogtreecommitdiff
path: root/common/system.h
diff options
context:
space:
mode:
Diffstat (limited to 'common/system.h')
-rw-r--r--common/system.h12
1 files changed, 6 insertions, 6 deletions
diff --git a/common/system.h b/common/system.h
index bfec20e319..a8f3b1c903 100644
--- a/common/system.h
+++ b/common/system.h
@@ -886,13 +886,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) {}
@@ -902,6 +900,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.
*