/**
- Constructs a string from the string literal @c psz using
+ Constructs a string from the string literal @e psz using
the current locale encoding to convert it to Unicode (wxConvLibc).
*/
wxString(const char *psz);
/**
- Constructs a string from the string literal @c psz using
- @c conv to convert it Unicode.
+ Constructs a string from the string literal @e psz using
+ @e conv to convert it Unicode.
*/
wxString(const char *psz, const wxMBConv& conv);
/**
- Constructs a string from the first @ nLength character of the string literal @c psz using
+ Constructs a string from the first @e nLength character of the string literal @e psz using
the current locale encoding to convert it to Unicode (wxConvLibc).
*/
wxString(const char *psz, size_t nLength);
/**
- Constructs a string from the first @ nLength character of the string literal @c psz using
- @c conv to convert it Unicode.
+ Constructs a string from the first @e nLength character of the string literal @e psz using
+ @e conv to convert it Unicode.
*/
wxString(const char *psz, const wxMBConv& conv, size_t nLength);
/**
- Constructs a string from the string literal @c pwz.
+ Constructs a string from the string literal @e pwz.
*/
wxString(const wchar_t *pwz);
/**
- Constructs a string from the first @ nLength characters of the string literal @c pwz.
+ Constructs a string from the first @e nLength characters of the string literal @e pwz.
*/
wxString(const wchar_t *pwz, size_t nLength);
/**
- Constructs a string from @c buf using the using
+ Constructs a string from @e buf using the using
the current locale encoding to convert it to Unicode.
*/
wxString(const wxCharBuffer& buf);
/**
- Constructs a string from @c buf.
+ Constructs a string from @e buf.
*/
wxString(const wxWCharBuffer& buf);
/**
- Constructs a string from @str using the using the current locale encoding
+ Constructs a string from @e str using the using the current locale encoding
to convert it to Unicode (wxConvLibc).
*/
wxString(const std::string& str);
/**
- Constructs a string from @str.
+ Constructs a string from @e str.
*/
wxString(const std::wstring& str);
/**
Gets all the characters after the first occurrence of @e ch.
- Returns the empty string if @a ch is not found.
+ Returns the empty string if @e ch is not found.
*/
wxString AfterFirst(wxUniChar ch) const;
/**
Gets all the characters after the last occurrence of @e ch.
- Returns the whole string if @a ch is not found.
+ Returns the whole string if @e ch is not found.
*/
wxString AfterLast(wxUniChar ch) const;
*/
bool Alloc(size_t nLen);
- //@{
/**
- Appends the string or string literal or character.
+ Appends the string literal @e psz.
+ */
+ wxString& Append(const char* psz);
+
+ /**
+ Appends the wide string literal @e pwz.
+ */
+ wxString& Append(const wchar_t* pwz)
+
+ /**
+ Appends the string literal @e psz with max length @e nLen.
*/
wxString& Append(const char* psz, size_t nLen);
+
+ /**
+ Appends the wide string literal @e psz with max length @e nLen.
+ */
wxString& Append(const wchar_t* pwz, size_t nLen)
+
+ /**
+ Appends the string @e s.
+ */
wxString &Append(const wxString &s);
+
+ /**
+ Appends the character @e ch @e count times.
+ */
wxString &Append(wxUniChar ch, size_t count = 1u);
- //@}
/**
Gets all characters before the first occurrence of @e ch.
Case-sensitive comparison.
Returns a positive value if the string is greater than the argument,
zero if it is equal to it or a negative value if it is less than the
- argument (same semantics as the standard @e strcmp() function).
+ argument (same semantics as the standard @c strcmp() function).
See also CmpNoCase(), IsSameAs().
*/
Case-insensitive comparison.
Returns a positive value if the string is greater than the argument,
zero if it is equal to it or a negative value if it is less than the
- argument (same semantics as the standard @e strcmp() function).
+ argument (same semantics as the standard @c strcmp() function).
See also Cmp(), IsSameAs().
*/
/**
This function can be used to test if the string ends with the specified
@e suffix. If it does, the function will return @true and put the
- beginning of the string before the suffix into @a rest string if it is not
+ beginning of the string before the suffix into @e rest string if it is not
@NULL. Otherwise, the function returns @false and doesn't
modify the @e rest.
*/
bool EndsWith(const wxString& suffix, wxString rest = NULL) const;
- //@{
/**
- Searches for the given string. Returns the starting index, or
+ Searches for the given character @e ch. Returns the position or
@c wxNOT_FOUND if not found.
*/
int Find(wxUniChar ch, bool fromEnd = false) const;
+
+ /**
+ Searches for the given string @e sub. Returns the starting position or
+ @c wxNOT_FOUND if not found.
+ */
int Find(const wxString& sub) const;
- //@}
//@{
/**
static wxString FormatV(const wxChar format, va_list argptr);
/**
- Returns the number of occurrences of @a ch in the string.
- This is a wxWidgets 1.xx compatibility function; you should not use it in new
- code.
+ Returns the number of occurrences of @e ch in the string.
+ This is a wxWidgets 1.xx compatibility function; you should not
+ use it in new code.
*/
int Freq(wxUniChar ch) const;
/**
Converts given buffer of binary data from 8-bit string to wxString. In
Unicode build, the string is interpreted as being in ISO-8859-1
- encoding. The version without @a len parameter takes NUL-terminated
+ encoding. The version without @e len parameter takes NUL-terminated
data.
This is a convenience method useful when storing binary data in
projects / wxWidgets.git / blobdiff