document wxFSVolume (fixes #3977)

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

diff --git a/interface/wx/string.h b/interface/wx/string.h
index 7cf640a51f323a4a7e858b3b174c4251bce2e76a..ed2afa915ff5578b2c143b45d8780d84171180dc 100644 (file)
--- a/interface/wx/string.h
+++ b/interface/wx/string.h
@@ -320,14 +320,13 @@ public:
     @li Pad()
 
 
     @li Pad()
 
 

-    @section string_misc wxWidgets 1.xx compatibility functions
+    @section string_compat wxWidgets 1.xx compatibility functions

 
     The following functions are deprecated.
     Please consider using @c std::string compatible variants.
 
 
     The following functions are deprecated.
     Please consider using @c std::string compatible variants.
 

-    Contains(), First(), Freq(), IsAscii(), IsNull(),
-    IsNumber(), IsWord(), Last(), Length(), LowerCase(), Remove(), Strip(),
-    SubString(), UpperCase()
+    Contains(), First(), Freq(), IsAscii(), IsNull(), IsNumber(), IsWord(),
+    Last(), Length(), LowerCase(), Remove(), Strip(), SubString(), UpperCase()

 
 
     @library{wxbase}
 
 
     @library{wxbase}


@@ -494,22 +493,22 @@ public:
     /**
        Appends the wide string literal @e pwz.
     */
     /**
        Appends the wide string literal @e pwz.
     */

-    wxString& Append(const wchar_t* pwz)
+    wxString& Append(const wchar_t* pwz);

 
     /**
        Appends the string literal @e psz with max length @e nLen.
     */
 
     /**
        Appends the string literal @e psz with max length @e nLen.
     */

-    wxString& Append(const wchar_t* pwz);
+    wxString& Append(const char* psz, size_t nLen);

 
     /**
        Appends the wide string literal @e psz with max length @e nLen.
     */
 
     /**
        Appends the wide string literal @e psz with max length @e nLen.
     */

-    wxString& Append(const wchar_t* pwz, size_t nLen)
+    wxString& Append(const wchar_t* pwz, size_t nLen);

 
     /**
        Appends the string @e s.
     */
 
     /**
        Appends the string @e s.
     */

-    wxString& Append(const wchar_t* pwz, size_t nLen);
+    wxString& Append(const wxString& s);

 
     /**
        Appends the character @e ch @e count times.
 
     /**
        Appends the character @e ch @e count times.


@@ -742,7 +741,7 @@ public:
     /**
         wxWidgets compatibility conversion. Same as c_str().
     */
     /**
         wxWidgets compatibility conversion. Same as c_str().
     */

-    const wxCStrData* GetData() const;
+    const wxCStrData GetData() const;

 
     /**
         Returns a reference to the character at position @e n.
 
     /**
         Returns a reference to the character at position @e n.


@@ -881,15 +880,14 @@ public:
         Returns a substring starting at @e first, with length @e count, or the rest of
         the string if @a count is the default value.
     */
         Returns a substring starting at @e first, with length @e count, or the rest of
         the string if @a count is the default value.
     */

-    wxString Mid(size_t first, size_t count = wxSTRING_MAXLEN) const;
+    wxString Mid(size_t first, size_t nCount = wxString::npos) const;

 
 
     /**
         Adds @a count copies of @a pad to the beginning, or to the end of the
         string (the default).  Removes spaces from the left or from the right (default).
     */
 
 
     /**
         Adds @a count copies of @a pad to the beginning, or to the end of the
         string (the default).  Removes spaces from the left or from the right (default).
     */

-    wxString& Pad(size_t count, wxUniChar pad = ' ',
-                 bool fromRight = true);
+    wxString& Pad(size_t count, wxUniChar chPad = ' ', bool fromRight = true);

 
     /**
         Prepends @a str to this string, returning a reference to this string.
 
     /**
         Prepends @a str to this string, returning a reference to this string.


@@ -907,14 +905,14 @@ public:
         size. Unfortunately, this function is not available on all platforms and the
         dangerous @e vsprintf() will be used then which may lead to buffer overflows.
     */
         size. Unfortunately, this function is not available on all platforms and the
         dangerous @e vsprintf() will be used then which may lead to buffer overflows.
     */

-    int Printf(const wxChar* pszFormat, ...);
+    int Printf(const wxString& pszFormat, ...);

 
     /**
         Similar to vprintf. Returns the number of characters written, or an integer
         less than zero
         on error.
     */
 
     /**
         Similar to vprintf. Returns the number of characters written, or an integer
         less than zero
         on error.
     */

-    int PrintfV(const wxChar* pszFormat, va_list argPtr);
+    int PrintfV(const wxString& pszFormat, va_list argPtr);

 
     //@{
     /**
 
     //@{
     /**


@@ -929,7 +927,7 @@ public:
     /**
         Removes the last character.
     */
     /**
         Removes the last character.
     */

-    wxString RemoveLast();
+    wxString& RemoveLast(size_t n = 1);

 
     /**
         Replace first (or all) occurrences of substring with another one.
 
     /**
         Replace first (or all) occurrences of substring with another one.


@@ -953,7 +951,7 @@ public:
         Minimizes the string's memory. This can be useful after a call to
         Alloc() if too much memory were preallocated.
     */
         Minimizes the string's memory. This can be useful after a call to
         Alloc() if too much memory were preallocated.
     */

-    void Shrink();
+    bool Shrink();

 
     /**
         This function can be used to test if the string starts with the specified
 
     /**
         This function can be used to test if the string starts with the specified


@@ -1017,7 +1015,7 @@ public:
 
         @see ToLong(), ToULong()
     */
 
         @see ToLong(), ToULong()
     */

-    bool ToDouble(double val) const;
+    bool ToDouble(double* val) const;

 
     /**
         Attempts to convert the string to a signed integer in base @e base. Returns
 
     /**
         Attempts to convert the string to a signed integer in base @e base. Returns


@@ -1035,7 +1033,7 @@ public:
 
         @see ToDouble(), ToULong()
     */
 
         @see ToDouble(), ToULong()
     */

-    bool ToLong(long val, int base = 10) const;
+    bool ToLong(long* val, int base = 10) const;

 
     /**
         This is exactly the same as ToLong() but works with 64
 
     /**
         This is exactly the same as ToLong() but works with 64


@@ -1046,7 +1044,7 @@ public:
 
         @see ToLong(), ToULongLong()
     */
 
         @see ToLong(), ToULongLong()
     */

-    bool ToLongLong(wxLongLong_t val, int base = 10) const;
+    bool ToLongLong(wxLongLong_t* val, int base = 10) const;

 
     /**
         Attempts to convert the string to an unsigned integer in base @e base.
 
     /**
         Attempts to convert the string to an unsigned integer in base @e base.


@@ -1063,14 +1061,14 @@ public:
 
         @see ToDouble(), ToLong()
     */
 
         @see ToDouble(), ToLong()
     */

-    bool ToULong(unsigned long val, int base = 10) const;
+    bool ToULong(unsigned long* val, int base = 10) const;

 
     /**
         This is exactly the same as ToULong() but works with 64
         bit integer numbers.
         Please see ToLongLong() for additional remarks.
     */
 
     /**
         This is exactly the same as ToULong() but works with 64
         bit integer numbers.
         Please see ToLongLong() for additional remarks.
     */

-    bool ToULongLong(wxULongLong_t val, int base = 10) const;
+    bool ToULongLong(wxULongLong_t* val, int base = 10) const;

 
     //@{
     /**
 
     //@{
     /**


@@ -1139,7 +1137,7 @@ public:
 
         @see wc_str(), utf8_str(), c_str(), mb_str(), fn_str()
     */
 
         @see wc_str(), utf8_str(), c_str(), mb_str(), fn_str()
     */

-    const wxCStrData c_str() const;
+    wxCStrData c_str() const;

 
     /**
         Returns an object with string data that is implicitly convertible to
 
     /**
         Returns an object with string data that is implicitly convertible to


@@ -1200,22 +1198,23 @@ public:
     */
     friend istream operator>>(istream& is, wxString& str);
 
     */
     friend istream operator>>(istream& is, wxString& str);
 

+    //@{

     /**
         These functions work as C++ stream insertion operators. They insert the
         given value into the string. Precision and format cannot be set using them.
         Use Printf() instead.
     */
     wxString& operator<<(const wxString& s);
     /**
         These functions work as C++ stream insertion operators. They insert the
         given value into the string. Precision and format cannot be set using them.
         Use Printf() instead.
     */
     wxString& operator<<(const wxString& s);

-    wxString& operator<<(const char* psz)
-    wxString& operator<<(const wchar_t* pwz)
-    wxString& operator<<(const wxCStrData& psz)

     wxString& operator<<(const char* psz);
     wxString& operator<<(const char* psz);

-    wxString& operator<<(wxUniCharRef ch)
-    wxString& operator<<(char ch)
-    wxString& operator<<(unsigned char ch)
-    wxString& operator<<(wchar_t ch)
-    wxString& operator<<(const wxCharBuffer& s)
-    wxString& operator<<(const wxWCharBuffer& s)
+    wxString& operator<<(const wchar_t* pwz);
+    wxString& operator<<(const wxCStrData& psz);
+    wxString& operator<<(const char* psz);
+    wxString& operator<<(wxUniCharRef ch);
+    wxString& operator<<(char ch);
+    wxString& operator<<(unsigned char ch);
+    wxString& operator<<(wchar_t ch);
+    wxString& operator<<(const wxCharBuffer& s);
+    wxString& operator<<(const wxWCharBuffer& s);

     wxString& operator<<(wxUniCharRef ch);
     wxString& operator<<(unsigned int ui);
     wxString& operator<<(long l);
     wxString& operator<<(wxUniCharRef ch);
     wxString& operator<<(unsigned int ui);
     wxString& operator<<(long l);


@@ -1224,11 +1223,12 @@ public:
     wxString& operator<<(wxULongLong_t ul);
     wxString& operator<<(float f);
     wxString& operator<<(double d);
     wxString& operator<<(wxULongLong_t ul);
     wxString& operator<<(float f);
     wxString& operator<<(double d);

+    //@}

 
     /**
         Same as Mid() (substring extraction).
     */
 
     /**
         Same as Mid() (substring extraction).
     */

-    wxString operator ()(size_t start, size_t len);
+    wxString operator()(size_t start, size_t len) const;

 
     //@{
     /**
 
     //@{
     /**