Minor formating

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@54922 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Robert Roebling
2008-08-02 14:10:54 +00:00
parent 707d9f4047
commit 0c339e7c64
2 changed files with 31 additions and 18 deletions

View File

@@ -123,6 +123,8 @@ public:
append something to a C string (including literal constants), so to do this it
should be converted to a wxString first.
@li insert()
@li append()
@li operator<<()
@li operator+=()
@li operator+()
@@ -137,6 +139,7 @@ public:
@li wxString()
@li operator=()
@li ~wxString()
@li assign()
The MakeXXX() variants modify the string in place, while the other functions
return a new string which contains the original text converted to the upper or
@@ -146,6 +149,8 @@ public:
@li Upper()
@li MakeLower()
@li Lower()
@li MakeCapitalized()
@li Capitalize()
Many functions below take a character index in the string. As with C
strings and arrays, the indices start from 0, so the first character of a
@@ -169,10 +174,9 @@ public:
@li mb_str()
@li fn_str()
The default comparison function Cmp() is case-sensitive and
so is the default version of IsSameAs(). For case
insensitive comparisons you should use CmpNoCase() or
give a second parameter to IsSameAs. This last function is may be more
The default comparison function Cmp() is case-sensitive and so is the default
version of IsSameAs(). For case insensitive comparisons you should use CmpNoCase()
or give a second parameter to IsSameAs(). This last function is maybe more
convenient if only equality of the strings matters because it returns a boolean
@true value if the strings are the same and not 0 (which is usually @false
in C) as Cmp() does.
@@ -182,6 +186,7 @@ public:
with some predefined prefix and is more efficient than doing direct string
comparison as you would also have to precalculate the length of the prefix.
@li compare()
@li Cmp()
@li CmpNoCase()
@li IsSameAs()
@@ -206,6 +211,8 @@ public:
when working with some external API which requires the caller to provide
a writable buffer.
@li reserve()
@li resize()
@li Alloc()
@li Shrink()
@li wxStringBuffer
@@ -220,6 +227,8 @@ public:
These functions return the string length and check whether the string
is empty or they empty it.
@li length()
@li size()
@li Len()
@li IsEmpty()
@li operator!()
@@ -230,6 +239,7 @@ public:
original string is not modified and the function returns the extracted
substring.
@li substr()
@li Mid()
@li operator()()
@li Left()
@@ -244,6 +254,9 @@ public:
These functions replace the standard @e strchr() and @e strstr()
functions.
@li find()
@li rfind()
@li replace()
@li Find()
@li Replace()

View File

@@ -22,8 +22,8 @@
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
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.
@@ -204,35 +204,35 @@ public:
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 );
/**
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 );
/**
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.
*/
wxUString &insert( size_type 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);
/**
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.
*/
@@ -241,44 +241,44 @@ public:
};
/**
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);
/**
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);
/**
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);
/**
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);
/**
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);
/**
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);
/**
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.
*/