|
From: andrew7 <bd...@us...> - 2006-11-30 00:45:40
|
Update of /cvsroot/smartwin/SmartWin/SmartUtil In directory sc8-pr-cvs8.sourceforge.net:/tmp/cvs-serv22886/SmartUtil Modified Files: StringConversion.h Log Message: Documentation improve Index: StringConversion.h =================================================================== RCS file: /cvsroot/smartwin/SmartWin/SmartUtil/StringConversion.h,v retrieving revision 1.6 retrieving revision 1.7 diff -u -d -r1.6 -r1.7 --- StringConversion.h 3 Sep 2006 15:25:24 -0000 1.6 +++ StringConversion.h 30 Nov 2006 00:45:35 -0000 1.7 @@ -69,13 +69,17 @@ * Often you would for instance use a WidgetLoadFile or a WidgetSaveFile Widget to retrieve a path from the user.<br> * These classes returns their file paths in UNICODE format ifi UNICODE is defined.<br> * But the std::fstream constructors cannot take any string types other than char * types for a file path.<br> - * Then you can use this class to convert from wchar_t string to char strings. + * Then you can use this class to convert from wchar_t string to char strings. <br> + * Example: <br> + * std::string charHi = "hello"; + * SmartUtil::tstring hi= SmartUtil::UnicodeConverter<char, TCHAR>::doConvert( charHi, SmartUtil::ConversionCodepage::UTF8 ); <br> + * will convert if needed, and do nothing if TCHAR is char ! */ template< > class UnicodeConverter< wchar_t, char > { public: - /** There may axist many reasons as to why conversion is NOT possible. + /** There may exist many reasons as to why conversion is NOT possible. * E.g. we may have a string which contains a character which has not been fully seen! * You might have had some stream operation which haven't extracted a string containing the whole character, meaning * you may have seen a leading byte for an UTF-8 conversion but no trailing byte etc. @@ -86,7 +90,7 @@ } /// Returns true if conversion is possible - /** There may axist many reasons as to why conversion is NOT possible. + /** There may exist many reasons as to why conversion is NOT possible. * E.g. we may have a string which contains a character which has not been fully seen! * You might have had some stream operation which haven't extracted a string containing the whole character, meaning * you may have seen a leading byte for an UTF-8 conversion but no trailing byte etc. @@ -133,7 +137,7 @@ { public: /// Returns true if conversion is possible - /** There may axist many reasons as to why conversion is NOT possible. + /** There may exist many reasons as to why conversion is NOT possible. * E.g. we may have a string which contains a character which has not been fully seen! * You might have had some stream operation which haven't extracted a string containing the whole character, meaning * you may have seen a leading byte for an UTF-8 conversion but no trailing byte etc. @@ -254,7 +258,7 @@ class UnicodeConverter< char, char > { public: - /** There may axist many reasons as to why conversion is NOT possible. + /** There may exist many reasons as to why conversion is NOT possible. * E.g. we may have a string which contains a character which has not been fully seen! * You might have had some stream operation which haven't extracted a string containing the whole character, meaning * you may have seen a leading byte for an UTF-8 conversion but no trailing byte etc. @@ -265,7 +269,7 @@ } /// Returns true if conversion is possible - /** There may axist many reasons as to why conversion is NOT possible. + /** There may exist many reasons as to why conversion is NOT possible. * E.g. we may have a string which contains a character which has not been fully seen! * You might have had some stream operation which haven't extracted a string containing the whole character, meaning * you may have seen a leading byte for an UTF-8 conversion but no trailing byte etc. @@ -304,7 +308,7 @@ class UnicodeConverter< wchar_t, wchar_t > { public: - /** There may axist many reasons as to why conversion is NOT possible. + /** There may exist many reasons as to why conversion is NOT possible. * E.g. we may have a string which contains a character which has not been fully seen! * You might have had some stream operation which haven't extracted a string containing the whole character, meaning * you may have seen a leading byte for an UTF-8 conversion but no trailing byte etc. @@ -315,7 +319,7 @@ } /// Returns true if conversion is possible - /** There may axist many reasons as to why conversion is NOT possible. + /** There may exist many reasons as to why conversion is NOT possible. * E.g. we may have a string which contains a character which has not been fully seen! * You might have had some stream operation which haven't extracted a string containing the whole character, meaning * you may have seen a leading byte for an UTF-8 conversion but no trailing byte etc. |