add note for wxWidgets user with a skeleton for a very minimal console app

[wxWidgets.git] / interface / wx / ustring.h

diff --git a/interface/wx/ustring.h b/interface/wx/ustring.h
index 14bb5fd0e89de47e8a37df8e779d5554d28f76dc..c42b7db65ea3c572f599ff859351e55c0431a0ac 100644 (file)
--- a/interface/wx/ustring.h
+++ b/interface/wx/ustring.h
@@ -17,20 +17,20 @@
     as a squence of simple 8-bit charactesr and also different from
     @c std::wstring which stores the string differently depending on
     the definition of wchar_t.
     as a squence of simple 8-bit charactesr and also different from
     @c std::wstring which stores the string differently depending on
     the definition of wchar_t.

-    
+

     The main purpose of wxUString is a to give users a Unicode string
     The main purpose of wxUString is a to give users a Unicode string

-    class that has O(1) access to its content, to be identical on all 
+    class that has O(1) access to its content, to be identical on all

     platforms and to be easily convertable to wxString as well as other
     ways to store strings (C string literals, wide character
     platforms and to be easily convertable to wxString as well as other
     ways to store strings (C string literals, wide character

-    string literals, character buffer, etc) by providing many overload
-    and built-in conversion to and from the various format.
-    
+    string literals, character buffer, etc) by providing several overloads
+    and built-in conversions to and from the various string formats.
+

     wxUString derives from @c std::basic_string<wxChar32> and therefore
     offers the complete API of @c std::string.
     wxUString derives from @c std::basic_string<wxChar32> and therefore
     offers the complete API of @c std::string.

-    
+

     @library{wxbase}
     @category{data}
     @library{wxbase}
     @category{data}

-    
+

     @see wxString, @ref overview_string "wxString overview", @ref overview_unicode
     "Unicode overview"
 */
     @see wxString, @ref overview_string "wxString overview", @ref overview_unicode
     "Unicode overview"
 */


@@ -38,7 +38,7 @@
 
 class WXDLLIMPEXP_BASE wxUString: public std::basic_string<wxChar32>
 {
 
 class WXDLLIMPEXP_BASE wxUString: public std::basic_string<wxChar32>
 {

-public: 
+public:

     /**
         Default constructor.
     */
     /**
         Default constructor.
     */


@@ -50,11 +50,11 @@ public:
     /**
         Constructs a string from a 32-bit string literal.
     */
     /**
         Constructs a string from a 32-bit string literal.
     */

-    wxUString( const wxChar32 *str );                            
+    wxUString( const wxChar32 *str );

     /**
         Constructs a string from 32-bit string buffer.
     */
     /**
         Constructs a string from 32-bit string buffer.
     */

-    wxUString( const wxU32CharBuffer &buf );                   
+    wxUString( const wxU32CharBuffer &buf );

     /**
         Constructs a string from C string literal using wxConvLibc to convert it to Unicode.
     */
     /**
         Constructs a string from C string literal using wxConvLibc to convert it to Unicode.
     */


@@ -106,28 +106,28 @@ public:
     /**
         Constructs a string from @a n characters @a ch.
     */
     /**
         Constructs a string from @a n characters @a ch.
     */

-    wxUString( size_type n, char ch );
+    wxUString( size_t n, char ch );

     /**
         Constructs a string from @a n characters @a ch.
     */
     /**
         Constructs a string from @a n characters @a ch.
     */

-    wxUString( size_type n, wxChar16 ch );
+    wxUString( size_t n, wxChar16 ch );

     /**
         Constructs a string from @a n characters @a ch.
     */
     /**
         Constructs a string from @a n characters @a ch.
     */

-    wxUString( size_type n, wxChar32 ch );
+    wxUString( size_t n, wxChar32 ch );

     /**
         Constructs a string from @a n characters @a ch.
     */
     /**
         Constructs a string from @a n characters @a ch.
     */

-    wxUString( size_type n, wxUniChar ch );
+    wxUString( size_t n, wxUniChar ch );

     /**
         Constructs a string from @a n characters @a ch.
     */
     /**
         Constructs a string from @a n characters @a ch.
     */

-    wxUString( size_type n, wxUniCharRef ch );
-    
+    wxUString( size_t n, wxUniCharRef ch );
+

     /**
         Static construction of a wxUString from a 7-bit ASCII string
     */
     /**
         Static construction of a wxUString from a 7-bit ASCII string
     */

-    static wxUString FromAscii( const char *str, size_type n );
+    static wxUString FromAscii( const char *str, size_t n );

     /**
         Static construction of a wxUString from a 7-bit ASCII string
     */
     /**
         Static construction of a wxUString from a 7-bit ASCII string
     */


@@ -135,7 +135,7 @@ public:
     /**
         Static construction of a wxUString from a UTF-8 encoded string
     */
     /**
         Static construction of a wxUString from a UTF-8 encoded string
     */

-    static wxUString FromUTF8( const char *str, size_type n );
+    static wxUString FromUTF8( const char *str, size_t n );

     /**
         Static construction of a wxUString from a UTF-8 encoded string
     */
     /**
         Static construction of a wxUString from a UTF-8 encoded string
     */


@@ -143,46 +143,46 @@ public:
     /**
         Static construction of a wxUString from a UTF-16 encoded string
     */
     /**
         Static construction of a wxUString from a UTF-16 encoded string
     */

-    static wxUString FromUTF16( const wxChar16 *str, size_type n );
+    static wxUString FromUTF16( const wxChar16 *str, size_t n );

     /**
         Static construction of a wxUString from a UTF-16 encoded string
     */
     static wxUString FromUTF16( const wxChar16 *str );
     /**
         Static construction of a wxUString from a UTF-16 encoded string
     */
     static wxUString FromUTF16( const wxChar16 *str );

-    
+

 
     /**
        Assigment from a 7-bit ASCII string literal
 
     /**
        Assigment from a 7-bit ASCII string literal

-    */    
+    */

     wxUString &assignFromAscii( const char *str );
     /**
        Assigment from a 7-bit ASCII string literal
     wxUString &assignFromAscii( const char *str );
     /**
        Assigment from a 7-bit ASCII string literal

-    */    
-    wxUString &assignFromAscii( const char *str, size_type n );
+    */
+    wxUString &assignFromAscii( const char *str, size_t n );

     /**
        Assigment from a UTF-8 string literal
     /**
        Assigment from a UTF-8 string literal

-    */    
+    */

     wxUString &assignFromUTF8( const char *str );
     /**
        Assigment from a UTF-8 string literal
     wxUString &assignFromUTF8( const char *str );
     /**
        Assigment from a UTF-8 string literal

-    */    
-    wxUString &assignFromUTF8( const char *str, size_type n );
+    */
+    wxUString &assignFromUTF8( const char *str, size_t n );

     /**
        Assigment from a UTF-16 string literal
     /**
        Assigment from a UTF-16 string literal

-    */    
+    */

     wxUString &assignFromUTF16( const wxChar16* str );
     /**
        Assigment from a UTF-16 string literal
     wxUString &assignFromUTF16( const wxChar16* str );
     /**
        Assigment from a UTF-16 string literal

-    */    
-    wxUString &assignFromUTF16( const wxChar16* str, size_type n );
+    */
+    wxUString &assignFromUTF16( const wxChar16* str, size_t n );

     /**
        Assigment from a C string literal using wxConvLibc
     /**
        Assigment from a C string literal using wxConvLibc

-    */    
+    */

     wxUString &assignFromCString( const char* str );
     /**
        Assigment from a C string literal using @a conv
     wxUString &assignFromCString( const char* str );
     /**
        Assigment from a C string literal using @a conv

-    */    
+    */

     wxUString &assignFromCString( const char* str, const wxMBConv &conv );
     wxUString &assignFromCString( const char* str, const wxMBConv &conv );

- 
+

     /**
         Conversion to a UTF-8 string
     */
     /**
         Conversion to a UTF-8 string
     */


@@ -191,7 +191,7 @@ public:
         Conversion to a UTF-16 string
     */
     wxU16CharBuffer utf16_str() const;
         Conversion to a UTF-16 string
     */
     wxU16CharBuffer utf16_str() const;

-    
+

     /**
         Conversion to a wide character string (either UTF-16
         or UCS-4, depending on the size of wchar_t).
     /**
         Conversion to a wide character string (either UTF-16
         or UCS-4, depending on the size of wchar_t).


@@ -204,86 +204,82 @@ public:
     operator wxString() const;
 
     /**
     operator wxString() const;
 
     /**

-       wxUString assignment. wxUString addtionally provides overloads for
+       wxUString assignment. wxUString additionally provides overloads for

        wxString, C string, UTF-16 strings, 32-bit strings, char buffers,
        single and repeated characters etc.
     */
     wxUString &assign( const wxUString &str );
        wxString, C string, UTF-16 strings, 32-bit strings, char buffers,
        single and repeated characters etc.
     */
     wxUString &assign( const wxUString &str );

-     
+

     /**
     /**

-       Appending. wxUString addtionally provides overloads for
+       Appending. wxUString additionally provides overloads for

        wxString, C string, UTF-16 strings, 32-bit strings, char buffers,
        single and repeated characters etc.
     */
     wxUString &append( const wxUString &s );
        wxString, C string, UTF-16 strings, 32-bit strings, char buffers,
        single and repeated characters etc.
     */
     wxUString &append( const wxUString &s );

-    
+

     /**
     /**

-       Insertion. wxUString addtionally provides overloads for
+       Insertion. wxUString additionally provides overloads for

        wxString, C string, UTF-16 strings, 32-bit strings, char buffers,
        single characters etc.
     */
        wxString, C string, UTF-16 strings, 32-bit strings, char buffers,
        single characters etc.
     */

-    wxUString &insert( size_type pos, const wxUString &s );
+    wxUString &insert( size_t pos, const wxUString &s );

 
     /**
 
     /**

-       Assignment operator. wxUString addtionally provides overloads for
+       Assignment operator. wxUString additionally provides overloads for

        wxString, C string, UTF-16 strings, 32-bit strings, char buffers,
        single characters etc.
     */
     inline wxUString& operator=(const wxUString& s);
        wxString, C string, UTF-16 strings, 32-bit strings, char buffers,
        single characters etc.
     */
     inline wxUString& operator=(const wxUString& s);

-    
+

     /**
     /**

-       Concatenation operator. wxUString addtionally provides overloads for
+       Concatenation operator. wxUString additionally provides overloads for

        wxString, C string, UTF-16 strings, 32-bit strings, char buffers,
        single characters etc.
     */
     inline wxUString& operator+=(const wxUString& s);
        wxString, C string, UTF-16 strings, 32-bit strings, char buffers,
        single characters etc.
     */
     inline wxUString& operator+=(const wxUString& s);

-    
+

 };
 
     /**
 };
 
     /**

-       Concatenation operator. wxUString addtionally provides overloads for
+       Concatenation operator. wxUString additionally provides overloads for

        wxString, C string, UTF-16 strings, 32-bit strings, char buffers,
        single characters etc.
     */
 inline wxUString operator+(const wxUString &s1, const wxUString &s2);
 
     /**
        wxString, C string, UTF-16 strings, 32-bit strings, char buffers,
        single characters etc.
     */
 inline wxUString operator+(const wxUString &s1, const wxUString &s2);
 
     /**

-       Equality operator. wxUString addtionally provides overloads for
+       Equality operator. wxUString additionally provides overloads for

        wxString, C string, UTF-16 strings, 32-bit strings, char buffers,
        single characters etc.
     */
 inline bool operator==(const wxUString& s1, const wxUString& s2);
     /**
        wxString, C string, UTF-16 strings, 32-bit strings, char buffers,
        single characters etc.
     */
 inline bool operator==(const wxUString& s1, const wxUString& s2);
     /**

-       Inequality operator. wxUString addtionally provides overloads for
+       Inequality operator. wxUString additionally provides overloads for

        wxString, C string, UTF-16 strings, 32-bit strings, char buffers,
        single characters etc.
     */
 inline bool operator!=(const wxUString& s1, const wxUString& s2);
     /**
        wxString, C string, UTF-16 strings, 32-bit strings, char buffers,
        single characters etc.
     */
 inline bool operator!=(const wxUString& s1, const wxUString& s2);
     /**

-       Comparison operator. wxUString addtionally provides overloads for
+       Comparison operator. wxUString additionally provides overloads for

        wxString, C string, UTF-16 strings, 32-bit strings, char buffers,
        single characters etc.
     */
 inline bool operator< (const wxUString& s1, const wxUString& s2);
     /**
        wxString, C string, UTF-16 strings, 32-bit strings, char buffers,
        single characters etc.
     */
 inline bool operator< (const wxUString& s1, const wxUString& s2);
     /**

-       Comparison operator. wxUString addtionally provides overloads for
+       Comparison operator. wxUString additionally provides overloads for

        wxString, C string, UTF-16 strings, 32-bit strings, char buffers,
        single characters etc.
     */
 inline bool operator> (const wxUString& s1, const wxUString& s2);
     /**
        wxString, C string, UTF-16 strings, 32-bit strings, char buffers,
        single characters etc.
     */
 inline bool operator> (const wxUString& s1, const wxUString& s2);
     /**

-       Comparison operator. wxUString addtionally provides overloads for
+       Comparison operator. wxUString additionally provides overloads for

        wxString, C string, UTF-16 strings, 32-bit strings, char buffers,
        single characters etc.
     */
 inline bool operator<=(const wxUString& s1, const wxUString& s2);
     /**
        wxString, C string, UTF-16 strings, 32-bit strings, char buffers,
        single characters etc.
     */
 inline bool operator<=(const wxUString& s1, const wxUString& s2);
     /**

-       Comparison operator. wxUString addtionally provides overloads for
+       Comparison operator. wxUString additionally provides overloads for

        wxString, C string, UTF-16 strings, 32-bit strings, char buffers,
        single characters etc.
     */
 inline bool operator>=(const wxUString& s1, const wxUString& s2);
        wxString, C string, UTF-16 strings, 32-bit strings, char buffers,
        single characters etc.
     */
 inline bool operator>=(const wxUString& s1, const wxUString& s2);

-
-
-#endif
-    // _WX_USTRING_H_BASE_