[sword-cvs] sword/include stringmgr.h,1.2,1.3

[sword at www.crosswire.org]

Committed by: joachim

Update of /cvs/core/sword/include
In directory www:/tmp/cvs-serv30163/include

Modified Files:
	stringmgr.h 
Log Message:
fixed ICUStringMgr, so upperUtf8 works if ICU is used. Tested with ICu 2.8 (ICU is not very friendly to API newbies)

Index: stringmgr.h
===================================================================
RCS file: /cvs/core/sword/include/stringmgr.h,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -r1.2 -r1.3
--- stringmgr.h	19 Apr 2004 14:27:48 -0000	1.2
+++ stringmgr.h	20 Jul 2004 12:53:36 -0000	1.3
@@ -28,6 +28,9 @@
 
 SWORD_NAMESPACE_START
 
+/** StringMgr is a way to provide UTf8 handling by the Sword frontend
+ * Each platform, if it's up-to-date, should provide functions to handle unicode and utf8. This class makes it possible to implement Unicode support on the user-side and not in Sword itself.
+ */
 class StringMgr {
 public:
 	/** Sets the global StringMgr handle
@@ -38,7 +41,9 @@
 	* @return The global string handle
 	*/
 	static StringMgr* getSystemStringMgr();
-	/*
+	/* Checks whether Utf8 support is available.
+	* Override the function supportsUnicode() to tell whether your implementation has utf8 support.
+	* @return True if this implementation provides support for Utf8 handling or false if just latin1 handling is available
 	*/
 	static const bool hasUTF8Support() {
 		return getSystemStringMgr()->supportsUnicode();
@@ -57,7 +62,7 @@
 protected:
 	friend class __staticsystemStringMgr;
 	
-	/** Default constructor
+	/** Default constructor. Protected to make instances on user side impossible, because this is a Singleton
 	*/		
 	StringMgr();
 	/** Copy constructor