[Scummvm-cvs-logs] SF.net SVN: scummvm: [20780] scummvm/trunk/common/system.h

[fingolfin at users.sourceforge.net]

Revision: 20780
Author:   fingolfin
Date:     2006-02-20 05:09:39 -0800 (Mon, 20 Feb 2006)
ViewCVS:  http://svn.sourceforge.net/scummvm?rev=20780&view=rev

Log Message:
-----------
Clarified that OSystem::setWindowCaption currently only supports ASCII captions

Modified Paths:
--------------
    scummvm/trunk/common/system.h
Modified: scummvm/trunk/common/system.h
===================================================================
--- scummvm/trunk/common/system.h	2006-02-19 23:25:27 UTC (rev 20779)
+++ scummvm/trunk/common/system.h	2006-02-20 13:09:39 UTC (rev 20780)
@@ -896,8 +896,13 @@
 
 	/**
 	 * Set a window caption or any other comparable status display to the
-	 * given value.
-	 * @param caption	the window caption to use from now on
+	 * given value. The caption must be a pure ASCII string. Passing a
+	 * non-ASCII string 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
 	 */
 	virtual void setWindowCaption(const char *caption) {}