]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/wxstring.tex
missing WXDLLEXPORT added
[wxWidgets.git] / docs / latex / wx / wxstring.tex
CommitLineData
a660d684
KB
1\section{\class{wxString}}\label{wxstring}
2
40b480c3
JS
3wxString is a class representing a character string. Please see the
4\helpref{wxString overview}{wxstringoverview} for more information about it. As explained
5there, wxString implements about 90\% of methods of the std::string class (iterators
6are not supported, nor all methods which use them).
7These standard functions are not documented in this manual so please see the STL documentation.
99f09bc1
VZ
8The behaviour of all these functions is identical to the behaviour described
9there.
10
0aa35d19
VZ
11You may notice that wxString sometimes has many functions which do the same
12thing like, for example, \helpref{Length()}{wxstringlength},
13\helpref{Len()}{wxstringlen} and {\tt length()} which all return the string
14length. In all cases of such duplication the {\tt std::string}-compatible
15method ({\tt length()} in this case, always the lowercase version) should be
16used as it will ensure smoother transition to {\tt std::string} when wxWindows
17starts using it instead of wxString.
18
b3324be2
JS
19\wxheading{Derived from}
20
21None
a660d684 22
954b8ae6
JS
23\wxheading{Include files}
24
25<wx/string.h>
26
20e85460
JS
27\wxheading{Predefined objects}
28
29Objects:
30
31{\bf wxEmptyString}
32
b3324be2
JS
33\wxheading{See also}
34
35\overview{Overview}{wxstringoverview}
a660d684 36
99f09bc1
VZ
37\latexignore{\rtfignore{\wxheading{Function groups}}}
38
39\membersection{Constructors and assignment operators}
40
2edb0bde 41A string may be constructed either from a C string, (some number of copies of)
99f09bc1
VZ
42a single character or a wide (UNICODE) string. For all constructors (except the
43default which creates an empty string) there is also a corresponding assignment
44operator.
45
46\helpref{wxString}{wxstringconstruct}\\
47\helpref{operator $=$}{wxstringoperatorassign}\\
48\helpref{\destruct{wxString}}{wxstringdestruct}
49
50\membersection{String length}
51
52These functions return the string length and check whether the string is empty
53or empty it.
54
55\helpref{Len}{wxstringlen}\\
56\helpref{IsEmpty}{wxstringisempty}\\
57\helpref{operator!}{wxstringoperatornot}\\
58\helpref{Empty}{wxstringempty}\\
59\helpref{Clear}{wxstringclear}
60
61\membersection{Character access}
62
63Many functions in this section take a character index in the string. As with C
64strings and/or arrays, the indices start from $0$, so the first character of a
65string is string[$0$]. Attempt to access a character beyond the end of the
2edb0bde 66string (which may be even $0$ if the string is empty) will provoke an assert
99f09bc1
VZ
67failure in \helpref{debug build}{debuggingoverview}, but no checks are done in
68release builds.
69
70This section also contains both implicit and explicit conversions to C style
71strings. Although implicit conversion is quite convenient, it is advised to use
72explicit \helpref{c\_str()}{wxstringcstr} method for the sake of clarity. Also
fd34e3a5 73see \helpref{overview}{wxstringadvices} for the cases where it is necessary to
99f09bc1
VZ
74use it.
75
76\helpref{GetChar}{wxstringgetchar}\\
77\helpref{GetWritableChar}{wxstringgetwritablechar}\\
78\helpref{SetChar}{wxstringsetchar}\\
79\helpref{Last}{wxstringlast}\\
80\helpref{operator []}{wxstringoperatorbracket}\\
81\helpref{c\_str}{wxstringcstr}\\
82\helpref{operator const char*}{wxstringoperatorconstcharpt}
83
84\membersection{Concatenation}
85
86Anything may be concatenated (appended to) with a string. However, you can't
87append something to a C string (including literal constants), so to do this it
88should be converted to a wxString first.
89
90\helpref{operator \cinsert}{wxstringoperatorout}\\
91\helpref{operator $+=$}{wxstringplusequal}\\
92\helpref{operator $+$}{wxstringoperatorplus}\\
93\helpref{Append}{wxstringappend}\\
94\helpref{Prepend}{wxstringprepend}
95
96\membersection{Comparison}
97
98The default comparison function \helpref{Cmp}{wxstringcmp} is case-sensitive and
99so is the default version of \helpref{IsSameAs}{wxstringissameas}. For case
100insensitive comparisons you should use \helpref{CmpNoCase}{wxstringcmpnocase} or
101give a second parameter to IsSameAs. This last function is may be more
102convenient if only equality of the strings matters because it returns a boolean
cc81d32f 103true value if the strings are the same and not 0 (which is usually false in C)
f6bcfd97 104as {\tt Cmp()} does.
99f09bc1
VZ
105
106\helpref{Matches}{wxstringmatches} is a poor man's regular expression matcher:
107it only understands '*' and '?' metacharacters in the sense of DOS command line
108interpreter.
109
f6bcfd97
BP
110\helpref{StartsWith}{wxstringstartswith} is helpful when parsing a line of
111text which should start with some predefined prefix and is more efficient than
2edb0bde 112doing direct string comparison as you would also have to precalculate the
f6bcfd97
BP
113length of the prefix then.
114
99f09bc1
VZ
115\helpref{Cmp}{wxstringcmp}\\
116\helpref{CmpNoCase}{wxstringcmpnocase}\\
117\helpref{IsSameAs}{wxstringissameas}\\
f6bcfd97
BP
118\helpref{Matches}{wxstringmatches}\\
119\helpref{StartsWith}{wxstringstartswith}
99f09bc1
VZ
120
121\membersection{Substring extraction}
122
123These functions allow to extract substring from this string. All of them don't
124modify the original string and return a new string containing the extracted
125substring.
126
127\helpref{Mid}{wxstringmid}\\
128\helpref{operator()}{wxstringoperatorparenth}\\
129\helpref{Left}{wxstringleft}\\
130\helpref{Right}{wxstringright}\\
131\helpref{BeforeFirst}{wxstringbeforefirst}\\
132\helpref{BeforeLast}{wxstringbeforelast}\\
133\helpref{AfterFirst}{wxstringafterfirst}\\
f6bcfd97
BP
134\helpref{AfterLast}{wxstringafterlast}\\
135\helpref{StartsWith}{wxstringstartswith}
99f09bc1
VZ
136
137\membersection{Case conversion}
138
139The MakeXXX() variants modify the string in place, while the other functions
2edb0bde 140return a new string which contains the original text converted to the upper or
99f09bc1
VZ
141lower case and leave the original string unchanged.
142
143\helpref{MakeUpper}{wxstringmakeupper}\\
144\helpref{Upper}{wxstringupper}\\
145\helpref{MakeLower}{wxstringmakelower}\\
146\helpref{Lower}{wxstringlower}
147
148\membersection{Searching and replacing}
149
40b480c3 150These functions replace the standard {\it strchr()} and {\it strstr()}
99f09bc1
VZ
151functions.
152
153\helpref{Find}{wxstringfind}\\
154\helpref{Replace}{wxstringreplace}
155
cd0b1709
VZ
156\membersection{Conversion to numbers}
157
158The string provides functions for conversion to signed and unsigned integer and
159floating point numbers. All three functions take a pointer to the variable to
cc81d32f 160put the numeric value in and return true if the {\bf entire} string could be
cd0b1709
VZ
161converted to a number.
162
163\helpref{ToLong}{wxstringtolong}\\
164\helpref{ToULong}{wxstringtoulong}\\
165\helpref{ToDouble}{wxstringtodouble}
166
99f09bc1
VZ
167\membersection{Writing values into the string}
168
169Both formatted versions (\helpref{Printf}{wxstringprintf}) and stream-like
341e7d28
VZ
170insertion operators exist (for basic types only). Additionally, the
171\helpref{Format}{wxstringformat} function allows to use simply append
172formatted value to a string:
99f09bc1 173
341e7d28
VZ
174\begin{verbatim}
175 // the following 2 snippets are equivalent
176
177 wxString s = "...";
178 s += wxString::Format("%d", n);
179
180 wxString s;
181 s.Printf("...%d", n);
182\end{verbatim}
183
184\helpref{Format}{wxstringformat}\\
185\helpref{FormatV}{wxstringformatv}\\
99f09bc1
VZ
186\helpref{Printf}{wxstringprintf}\\
187\helpref{PrintfV}{wxstringprintfv}\\
40b480c3 188\helpref{operator \cinsert}{wxstringoperatorout}
99f09bc1
VZ
189
190\membersection{Memory management}
191
2edb0bde 192These are "advanced" functions and they will be needed quite rarely.
99f09bc1
VZ
193\helpref{Alloc}{wxstringalloc} and \helpref{Shrink}{wxstringshrink} are only
194interesting for optimization purposes.
195\helpref{GetWriteBuf}{wxstringgetwritebuf} may be very useful when working with
196some external API which requires the caller to provide a writable buffer, but
197extreme care should be taken when using it: before performing any other
198operation on the string \helpref{UngetWriteBuf}{wxstringungetwritebuf} {\bf
199must} be called!
200
201\helpref{Alloc}{wxstringalloc}\\
202\helpref{Shrink}{wxstringshrink}\\
203\helpref{GetWriteBuf}{wxstringgetwritebuf}\\
204\helpref{UngetWriteBuf}{wxstringungetwritebuf}
205
206\membersection{Miscellaneous}
207
208Other string functions.
209
210\helpref{Trim}{wxstringtrim}\\
211\helpref{Pad}{wxstringpad}\\
212\helpref{Truncate}{wxstringtruncate}
213
f6bcfd97 214\membersection{wxWindows 1.xx compatibility functions}
99f09bc1 215
f6bcfd97 216These functions are deprecated, please consider using new wxWindows 2.0
99f09bc1
VZ
217functions instead of them (or, even better, std::string compatible variants).
218
219\helpref{SubString}{wxstringsubstring}\\
220\helpref{sprintf}{wxstringsprintf}\\
221\helpref{CompareTo}{wxstringcompareto}\\
222\helpref{Length}{wxstringlength}\\
223\helpref{Freq}{wxstringfreq}\\
224\helpref{LowerCase}{wxstringlowercase}\\
225\helpref{UpperCase}{wxstringuppercase}\\
226\helpref{Strip}{wxstringstrip}\\
227\helpref{Index}{wxstringindex}\\
228\helpref{Remove}{wxstringremove}\\
229\helpref{First}{wxstringfirst}\\
230\helpref{Last}{wxstringlast}\\
231\helpref{Contains}{wxstringcontains}\\
232\helpref{IsNull}{wxstringisnull}\\
233\helpref{IsAscii}{wxstringisascii}\\
234\helpref{IsNumber}{wxstringisnumber}\\
235\helpref{IsWord}{wxstringisword}
236
ed93168b 237\membersection{std::string compatibility functions}\label{wxstringat}
99f09bc1
VZ
238
239The supported functions are only listed here, please see any STL reference for
240their documentation.
241
242\begin{verbatim}
243 // take nLen chars starting at nPos
244 wxString(const wxString& str, size_t nPos, size_t nLen);
245 // take all characters from pStart to pEnd (poor man's iterators)
246 wxString(const void *pStart, const void *pEnd);
247
248 // lib.string.capacity
249 // return the length of the string
250 size_t size() const;
251 // return the length of the string
252 size_t length() const;
253 // return the maximum size of the string
254 size_t max_size() const;
255 // resize the string, filling the space with c if c != 0
256 void resize(size_t nSize, char ch = '\0');
257 // delete the contents of the string
258 void clear();
259 // returns true if the string is empty
260 bool empty() const;
261
262 // lib.string.access
263 // return the character at position n
264 char at(size_t n) const;
265 // returns the writable character at position n
266 char& at(size_t n);
267
268 // lib.string.modifiers
269 // append a string
270 wxString& append(const wxString& str);
271 // append elements str[pos], ..., str[pos+n]
272 wxString& append(const wxString& str, size_t pos, size_t n);
273 // append first n (or all if n == npos) characters of sz
274 wxString& append(const char *sz, size_t n = npos);
275
276 // append n copies of ch
277 wxString& append(size_t n, char ch);
278
279 // same as `this_string = str'
280 wxString& assign(const wxString& str);
281 // same as ` = str[pos..pos + n]
282 wxString& assign(const wxString& str, size_t pos, size_t n);
283 // same as `= first n (or all if n == npos) characters of sz'
284 wxString& assign(const char *sz, size_t n = npos);
285 // same as `= n copies of ch'
286 wxString& assign(size_t n, char ch);
287
288 // insert another string
289 wxString& insert(size_t nPos, const wxString& str);
290 // insert n chars of str starting at nStart (in str)
291 wxString& insert(size_t nPos, const wxString& str, size_t nStart, size_t n);
292
293 // insert first n (or all if n == npos) characters of sz
294 wxString& insert(size_t nPos, const char *sz, size_t n = npos);
295 // insert n copies of ch
296 wxString& insert(size_t nPos, size_t n, char ch);
297
298 // delete characters from nStart to nStart + nLen
299 wxString& erase(size_t nStart = 0, size_t nLen = npos);
300
301 // replaces the substring of length nLen starting at nStart
302 wxString& replace(size_t nStart, size_t nLen, const char* sz);
303 // replaces the substring with nCount copies of ch
304 wxString& replace(size_t nStart, size_t nLen, size_t nCount, char ch);
305 // replaces a substring with another substring
306 wxString& replace(size_t nStart, size_t nLen,
307 const wxString& str, size_t nStart2, size_t nLen2);
308 // replaces the substring with first nCount chars of sz
309 wxString& replace(size_t nStart, size_t nLen,
310 const char* sz, size_t nCount);
311
312 // swap two strings
313 void swap(wxString& str);
314
315 // All find() functions take the nStart argument which specifies the
316 // position to start the search on, the default value is 0. All functions
317 // return npos if there were no match.
318
319 // find a substring
320 size_t find(const wxString& str, size_t nStart = 0) const;
321
322 // find first n characters of sz
323 size_t find(const char* sz, size_t nStart = 0, size_t n = npos) const;
324
7335902d 325 // find the first occurrence of character ch after nStart
99f09bc1
VZ
326 size_t find(char ch, size_t nStart = 0) const;
327
328 // rfind() family is exactly like find() but works right to left
329
330 // as find, but from the end
331 size_t rfind(const wxString& str, size_t nStart = npos) const;
332
333 // as find, but from the end
334 size_t rfind(const char* sz, size_t nStart = npos,
335 size_t n = npos) const;
336 // as find, but from the end
337 size_t rfind(char ch, size_t nStart = npos) const;
338
7335902d 339 // find first/last occurrence of any character in the set
99f09bc1
VZ
340
341 //
342 size_t find_first_of(const wxString& str, size_t nStart = 0) const;
343 //
344 size_t find_first_of(const char* sz, size_t nStart = 0) const;
345 // same as find(char, size_t)
346 size_t find_first_of(char c, size_t nStart = 0) const;
347 //
348 size_t find_last_of (const wxString& str, size_t nStart = npos) const;
349 //
350 size_t find_last_of (const char* s, size_t nStart = npos) const;
351 // same as rfind(char, size_t)
352 size_t find_last_of (char c, size_t nStart = npos) const;
353
7335902d 354 // find first/last occurrence of any character not in the set
99f09bc1
VZ
355
356 //
357 size_t find_first_not_of(const wxString& str, size_t nStart = 0) const;
358 //
359 size_t find_first_not_of(const char* s, size_t nStart = 0) const;
360 //
361 size_t find_first_not_of(char ch, size_t nStart = 0) const;
362 //
363 size_t find_last_not_of(const wxString& str, size_t nStart=npos) const;
364 //
365 size_t find_last_not_of(const char* s, size_t nStart = npos) const;
366 //
367 size_t find_last_not_of(char ch, size_t nStart = npos) const;
368
369 // All compare functions return a negative, zero or positive value
370 // if the [sub]string is less, equal or greater than the compare() argument.
371
372 // just like strcmp()
373 int compare(const wxString& str) const;
374 // comparison with a substring
375 int compare(size_t nStart, size_t nLen, const wxString& str) const;
376 // comparison of 2 substrings
377 int compare(size_t nStart, size_t nLen,
378 const wxString& str, size_t nStart2, size_t nLen2) const;
379 // just like strcmp()
380 int compare(const char* sz) const;
381 // substring comparison with first nCount characters of sz
382 int compare(size_t nStart, size_t nLen,
383 const char* sz, size_t nCount = npos) const;
384
385 // substring extraction
386 wxString substr(size_t nStart = 0, size_t nLen = npos) const;
387\end{verbatim}
388
389%%%%% MEMBERS HERE %%%%%
390\helponly{\insertatlevel{2}{
391
392\wxheading{Members}
393
394}}
a660d684
KB
395
396\membersection{wxString::wxString}\label{wxstringconstruct}
397
b3324be2 398\func{}{wxString}{\void}
a660d684 399
b3324be2 400Default constructor.
a660d684 401
b3324be2 402\func{}{wxString}{\param{const wxString\&}{ x}}
a660d684 403
b3324be2 404Copy constructor.
a660d684 405
b3324be2 406\func{}{wxString}{\param{char}{ ch}, \param{size\_t}{ n = 1}}
a660d684 407
b3324be2 408Constructs a string of {\it n} copies of character {\it ch}.
a660d684 409
99f09bc1 410\func{}{wxString}{\param{const char*}{ psz}, \param{size\_t}{ nLength = wxSTRING\_MAXLEN}}
a660d684 411
b3324be2 412Takes first {\it nLength} characters from the C string {\it psz}.
f6bcfd97
BP
413The default value of wxSTRING\_MAXLEN means to take all the string.
414
415Note that this constructor may be used even if {\it psz} points to a buffer
416with binary data (i.e. containing {\tt NUL} characters) as long as you provide
417the correct value for {\it nLength}. However, the default form of it works
418only with strings without intermediate {\tt NUL}s because it uses
419{\tt strlen()} to calculate the effective length and it would not give correct
420results otherwise.
a660d684 421
99f09bc1 422\func{}{wxString}{\param{const unsigned char*}{ psz}, \param{size\_t}{ nLength = wxSTRING\_MAXLEN}}
a660d684 423
b3324be2 424For compilers using unsigned char: takes first {\it nLength} characters from the C string {\it psz}.
99f09bc1 425The default value of wxSTRING\_MAXLEN means take all the string.
a660d684 426
b3324be2 427\func{}{wxString}{\param{const wchar\_t*}{ psz}}
a660d684 428
b3324be2 429Constructs a string from the wide (UNICODE) string.
a660d684 430
b3324be2 431\membersection{wxString::\destruct{wxString}}\label{wxstringdestruct}
a660d684 432
b3324be2 433\func{}{\destruct{wxString}}{\void}
a660d684 434
b3324be2 435String destructor. Note that this is not virtual, so wxString must not be inherited from.
a660d684 436
99f09bc1
VZ
437\membersection{wxString::Alloc}\label{wxstringalloc}
438
439\func{void}{Alloc}{\param{size\_t}{ nLen}}
440
441Preallocate enough space for wxString to store {\it nLen} characters. This function
442may be used to increase speed when the string is constructed by repeated
443concatenation as in
444
445\begin{verbatim}
a660d684 446
99f09bc1
VZ
447// delete all vowels from the string
448wxString DeleteAllVowels(const wxString& original)
449{
450 wxString result;
a660d684 451
99f09bc1 452 size_t len = original.length();
a660d684 453
99f09bc1
VZ
454 result.Alloc(len);
455
456 for ( size_t n = 0; n < len; n++ )
457 {
458 if ( strchr("aeuio", tolower(original[n])) == NULL )
459 result += original[n];
460 }
461
462 return result;
463}
464
465\end{verbatim}
466
467because it will avoid the need of reallocating string memory many times (in case
468of long strings). Note that it does not set the maximal length of a string - it
469will still expand if more than {\it nLen} characters are stored in it. Also, it
470does not truncate the existing string (use
471\helpref{Truncate()}{wxstringtruncate} for this) even if its current length is
472greater than {\it nLen}
473
474\membersection{wxString::Append}\label{wxstringappend}
b3324be2
JS
475
476\func{wxString\&}{Append}{\param{const char*}{ psz}}
a660d684 477
b3324be2 478Concatenates {\it psz} to this string, returning a reference to it.
a660d684 479
b3324be2 480\func{wxString\&}{Append}{\param{char}{ ch}, \param{int}{ count = 1}}
a660d684 481
b3324be2
JS
482Concatenates character {\it ch} to this string, {\it count} times, returning a reference
483to it.
484
99f09bc1 485\membersection{wxString::AfterFirst}\label{wxstringafterfirst}
b3324be2 486
99f09bc1 487\constfunc{wxString}{AfterFirst}{\param{char}{ ch}}
b3324be2 488
7335902d 489Gets all the characters after the first occurrence of {\it ch}.
b3324be2 490Returns the empty string if {\it ch} is not found.
a660d684 491
99f09bc1 492\membersection{wxString::AfterLast}\label{wxstringafterlast}
a660d684 493
99f09bc1
VZ
494\constfunc{wxString}{AfterLast}{\param{char}{ ch}}
495
7335902d 496Gets all the characters after the last occurrence of {\it ch}.
99f09bc1
VZ
497Returns the whole string if {\it ch} is not found.
498
499\membersection{wxString::BeforeFirst}\label{wxstringbeforefirst}
500
501\constfunc{wxString}{BeforeFirst}{\param{char}{ ch}}
502
7335902d 503Gets all characters before the first occurrence of {\it ch}.
99f09bc1
VZ
504Returns the whole string if {\it ch} is not found.
505
506\membersection{wxString::BeforeLast}\label{wxstringbeforelast}
507
508\constfunc{wxString}{BeforeLast}{\param{char}{ ch}}
b3324be2 509
7335902d 510Gets all characters before the last occurrence of {\it ch}.
99f09bc1 511Returns the empty string if {\it ch} is not found.
a660d684 512
ed93168b
VZ
513\membersection{wxString::c\_str}\label{wxstringcstr}
514
515\constfunc{const char *}{c\_str}{\void}
516
517Returns a pointer to the string data.
518
519\membersection{wxString::Clear}\label{wxstringclear}
520
521\func{void}{Clear}{\void}
522
523Empties the string and frees memory occupied by it.
524
525See also: \helpref{Empty}{wxstringempty}
526
f7bd2698
JS
527\membersection{wxString::Cmp}\label{wxstringcmp}
528
529\constfunc{int}{Cmp}{\param{const char*}{ psz}}
530
531Case-sensitive comparison.
532
99f09bc1 533Returns a positive value if the string is greater than the argument, zero if
f6bcfd97 534it is equal to it or a negative value if it is less than the argument (same semantics
99f09bc1 535as the standard {\it strcmp()} function).
f7bd2698 536
99f09bc1 537See also \helpref{CmpNoCase}{wxstringcmpnocase}, \helpref{IsSameAs}{wxstringissameas}.
f7bd2698
JS
538
539\membersection{wxString::CmpNoCase}\label{wxstringcmpnocase}
540
541\constfunc{int}{CmpNoCase}{\param{const char*}{ psz}}
542
543Case-insensitive comparison.
544
99f09bc1 545Returns a positive value if the string is greater than the argument, zero if
f6bcfd97 546it is equal to it or a negative value if it is less than the argument (same semantics
99f09bc1 547as the standard {\it strcmp()} function).
f7bd2698 548
99f09bc1 549See also \helpref{Cmp}{wxstringcmp}, \helpref{IsSameAs}{wxstringissameas}.
f7bd2698 550
99f09bc1 551\membersection{wxString::CompareTo}\label{wxstringcompareto}
a660d684
KB
552
553\begin{verbatim}
554#define NO_POS ((int)(-1)) // undefined position
b3324be2 555enum caseCompare {exact, ignoreCase};
a660d684 556\end{verbatim}
ed93168b 557
b3324be2 558\constfunc{int}{CompareTo}{\param{const char*}{ psz}, \param{caseCompare}{ cmp = exact}}
a660d684 559
b3324be2 560Case-sensitive comparison. Returns 0 if equal, 1 if greater or -1 if less.
a660d684 561
99f09bc1 562\membersection{wxString::Contains}\label{wxstringcontains}
a660d684 563
99f09bc1 564\constfunc{bool}{Contains}{\param{const wxString\&}{ str}}
a660d684 565
b3324be2 566Returns 1 if target appears anyhere in wxString; else 0.
a660d684 567
f7bd2698 568\membersection{wxString::Empty}\label{wxstringempty}
a660d684 569
f7bd2698
JS
570\func{void}{Empty}{\void}
571
ed93168b
VZ
572Makes the string empty, but doesn't free memory occupied by the string.
573
574See also: \helpref{Clear()}{wxstringclear}.
f7bd2698
JS
575
576\membersection{wxString::Find}\label{wxstringfind}
577
cc81d32f 578\constfunc{int}{Find}{\param{char}{ ch}, \param{bool}{ fromEnd = false}}
f7bd2698
JS
579
580Searches for the given character. Returns the starting index, or -1 if not found.
581
582\constfunc{int}{Find}{\param{const char*}{ sz}}
583
584Searches for the given string. Returns the starting index, or -1 if not found.
a660d684 585
b3324be2 586\membersection{wxString::First}\label{wxstringfirst}
a660d684 587
0aa35d19 588\func{int}{First}{\param{char}{ c}}
a660d684 589
0aa35d19 590\constfunc{int}{First}{\param{const char*}{ psz}}
a660d684 591
0aa35d19 592\constfunc{int}{First}{\param{const wxString\&}{ str}}
a660d684 593
0aa35d19 594Same as \helpref{Find}{wxstringfind}.
a660d684 595
341e7d28
VZ
596\membersection{wxString::Format}\label{wxstringformat}
597
598\func{static wxString}{Format}{\param{const wxChar }{*format}, \param{}{...}}
599
600This static function returns the string containing the result of calling
601\helpref{Printf}{wxstringprintf} with the passed parameters on it.
602
603\wxheading{See also}
604
605\helpref{FormatV}{wxstringformatv}, \helpref{Printf}{wxstringprintf}
606
607\membersection{wxString::FormatV}\label{wxstringformatv}
608
609\func{static wxString}{Format}{\param{const wxChar }{*format}, \param{va\_list }{argptr}}
610
611This static function returns the string containing the result of calling
612\helpref{PrintfV}{wxstringprintfv} with the passed parameters on it.
613
614\wxheading{See also}
615
616\helpref{Format}{wxstringformat}, \helpref{PrintfV}{wxstringprintfv}
617
99f09bc1
VZ
618\membersection{wxString::Freq}\label{wxstringfreq}
619
f6bcfd97 620\constfunc{int}{Freq}{\param{char }{ch}}
99f09bc1 621
f6bcfd97 622Returns the number of occurrences of {\it ch} in the string.
99f09bc1 623
f7bd2698 624\membersection{wxString::GetChar}\label{wxstringgetchar}
a660d684 625
f7bd2698 626\constfunc{char}{GetChar}{\param{size\_t}{ n}}
a660d684 627
f7bd2698 628Returns the character at position {\it n} (read-only).
a660d684 629
99f09bc1 630\membersection{wxString::GetData}\label{wxstringgetdata}
a660d684 631
f7bd2698 632\constfunc{const char*}{GetData}{\void}
a660d684 633
f7bd2698 634wxWindows compatibility conversion. Returns a constant pointer to the data in the string.
a660d684 635
f7bd2698 636\membersection{wxString::GetWritableChar}\label{wxstringgetwritablechar}
a660d684 637
f7bd2698 638\func{char\&}{GetWritableChar}{\param{size\_t}{ n}}
a660d684 639
f7bd2698 640Returns a reference to the character at position {\it n}.
a660d684 641
f7bd2698 642\membersection{wxString::GetWriteBuf}\label{wxstringgetwritebuf}
a660d684 643
9a55c2ee 644\func{wxChar*}{GetWriteBuf}{\param{size\_t}{ len}}
a660d684 645
f7bd2698 646Returns a writable buffer of at least {\it len} bytes.
8161ba08
JS
647It returns a pointer to a new memory block, and the
648existing data will not be copied.
a660d684 649
f7bd2698
JS
650Call \helpref{wxString::UngetWriteBuf}{wxstringungetwritebuf} as soon as possible
651to put the string back into a reasonable state.
a660d684 652
99f09bc1 653\membersection{wxString::Index}\label{wxstringindex}
a660d684 654
5ef056a3 655\constfunc{size\_t}{Index}{\param{char}{ ch}}
a660d684 656
f7bd2698 657\constfunc{size\_t}{Index}{\param{const char*}{ sz}}
a660d684 658
f7bd2698 659Same as \helpref{wxString::Find}{wxstringfind}.
a660d684 660
cc81d32f 661\constfunc{size\_t}{Index}{\param{const char*}{ sz}, \param{bool}{ caseSensitive = true}, \param{bool}{ fromEnd = false}}
a660d684 662
f7bd2698 663Search the element in the array, starting from either side.
a660d684 664
cc81d32f 665If {\it fromEnd} is true, reverse search direction.
a660d684 666
f7bd2698 667If {\bf caseSensitive}, comparison is case sensitive (the default).
a660d684 668
2b5f62a0 669Returns the index of the first item matched, or wxNOT\_FOUND.
a660d684 670
8a2c6ef8
JS
671% TODO
672%\membersection{wxString::insert}\label{wxstringinsert}
673% Wrong!
99f09bc1 674%\func{void}{insert}{\param{const wxString\&}{ str}, \param{size\_t}{ index}}
8a2c6ef8
JS
675%
676%Add new element at the given position.
677%
99f09bc1 678\membersection{wxString::IsAscii}\label{wxstringisascii}
a660d684 679
f7bd2698 680\constfunc{bool}{IsAscii}{\void}
a660d684 681
cc81d32f 682Returns true if the string contains only ASCII characters.
a660d684 683
f7bd2698 684\membersection{wxString::IsEmpty}\label{wxstringisempty}
a660d684 685
f7bd2698 686\constfunc{bool}{IsEmpty}{\void}
a660d684 687
cc81d32f 688Returns true if the string is empty.
a660d684 689
99f09bc1 690\membersection{wxString::IsNull}\label{wxstringisnull}
a660d684 691
f7bd2698 692\constfunc{bool}{IsNull}{\void}
a660d684 693
cc81d32f 694Returns true if the string is empty (same as \helpref{IsEmpty}{wxstringisempty}).
a660d684 695
99f09bc1 696\membersection{wxString::IsNumber}\label{wxstringisnumber}
a660d684 697
f7bd2698
JS
698\constfunc{bool}{IsNumber}{\void}
699
cc81d32f 700Returns true if the string is an integer (with possible sign).
f7bd2698
JS
701
702\membersection{wxString::IsSameAs}\label{wxstringissameas}
703
cc81d32f 704\constfunc{bool}{IsSameAs}{\param{const char*}{ psz}, \param{bool}{ caseSensitive = true}}
f7bd2698
JS
705
706Test for string equality, case-sensitive (default) or not.
707
cc81d32f 708caseSensitive is true by default (case matters).
a660d684 709
cc81d32f 710Returns true if strings are equal, false otherwise.
f7bd2698 711
f33fee2a
VZ
712See also \helpref{Cmp}{wxstringcmp}, \helpref{CmpNoCase}{wxstringcmpnocase}, \helpref{IsSameAs}{wxstringissameas2}
713
714\membersection{wxString::IsSameAs}\label{wxstringissameas2}
715
cc81d32f 716\constfunc{bool}{IsSameAs}{\param{char}{ c}, \param{bool}{ caseSensitive = true}}
f33fee2a
VZ
717
718Test whether the string is equal to the single character {\it c}. The test is
cc81d32f 719case-sensitive if {\it caseSensitive} is true (default) or not if it is false.
f33fee2a 720
cc81d32f 721Returns true if the string is equal to the character, false otherwise.
f33fee2a
VZ
722
723See also \helpref{Cmp}{wxstringcmp}, \helpref{CmpNoCase}{wxstringcmpnocase}, \helpref{IsSameAs}{wxstringissameas}
a660d684 724
99f09bc1 725\membersection{wxString::IsWord}\label{wxstringisword}
a660d684 726
f7bd2698 727\constfunc{bool}{IsWord}{\void}
a660d684 728
cc81d32f 729Returns true if the string is a word. TODO: what's the definition of a word?
a660d684 730
99f09bc1 731\membersection{wxString::Last}\label{wxstringlast}
a660d684 732
f7bd2698 733\constfunc{char}{Last}{\void}
a660d684 734
f7bd2698 735Returns the last character.
a660d684 736
f7bd2698 737\func{char\&}{Last}{\void}
a660d684 738
f7bd2698 739Returns a reference to the last character (writable).
a660d684 740
f7bd2698
JS
741\membersection{wxString::Left}\label{wxstringleft}
742
743\constfunc{wxString}{Left}{\param{size\_t}{ count}}
744
fefc4f15 745Returns the first {\it count} characters of the string.
a660d684 746
f7bd2698 747\membersection{wxString::Len}\label{wxstringlen}
a660d684 748
f7bd2698
JS
749\constfunc{size\_t}{Len}{\void}
750
751Returns the length of the string.
752
753\membersection{wxString::Length}\label{wxstringlength}
754
755\constfunc{size\_t}{Length}{\void}
756
757Returns the length of the string (same as Len).
a660d684 758
99f09bc1
VZ
759\membersection{wxString::Lower}\label{wxstringlower}
760
761\constfunc{wxString}{Lower}{\void}
762
763Returns this string converted to the lower case.
764
765\membersection{wxString::LowerCase}\label{wxstringlowercase}
a660d684 766
f7bd2698
JS
767\func{void}{LowerCase}{\void}
768
769Same as MakeLower.
770
771\membersection{wxString::MakeLower}\label{wxstringmakelower}
772
773\func{void}{MakeLower}{\void}
774
775Converts all characters to lower case.
776
777\membersection{wxString::MakeUpper}\label{wxstringmakeupper}
778
779\func{void}{MakeUpper}{\void}
780
781Converts all characters to upper case.
a660d684 782
99f09bc1 783\membersection{wxString::Matches}\label{wxstringmatches}
a660d684 784
f7bd2698
JS
785\constfunc{bool}{Matches}{\param{const char*}{ szMask}}
786
cc81d32f 787Returns true if the string contents matches a mask containing '*' and '?'.
a660d684 788
f7bd2698 789\membersection{wxString::Mid}\label{wxstringmid}
a660d684 790
99f09bc1 791\constfunc{wxString}{Mid}{\param{size\_t}{ first}, \param{size\_t}{ count = wxSTRING\_MAXLEN}}
a660d684 792
f7bd2698
JS
793Returns a substring starting at {\it first}, with length {\it count}, or the rest of
794the string if {\it count} is the default value.
795
796\membersection{wxString::Pad}\label{wxstringpad}
797
cc81d32f 798\func{wxString\&}{Pad}{\param{size\_t}{ count}, \param{char}{ pad = ' '}, \param{bool}{ fromRight = true}}
f7bd2698
JS
799
800Adds {\it count} copies of {\it pad} to the beginning, or to the end of the string (the default).
801
802Removes spaces from the left or from the right (default).
a660d684 803
99f09bc1 804\membersection{wxString::Prepend}\label{wxstringprepend}
a660d684 805
f7bd2698 806\func{wxString\&}{Prepend}{\param{const wxString\&}{ str}}
a660d684 807
f7bd2698 808Prepends {\it str} to this string, returning a reference to this string.
a660d684 809
f7bd2698 810\membersection{wxString::Printf}\label{wxstringprintf}
a660d684 811
f7bd2698
JS
812\func{int}{Printf}{\param{const char* }{pszFormat}, \param{}{...}}
813
99f09bc1
VZ
814Similar to the standard function {\it sprintf()}. Returns the number of
815characters written, or an integer less than zero on error.
816
817{\bf NB:} This function will use a safe version of {\it vsprintf()} (usually called
818{\it vsnprintf()}) whenever available to always allocate the buffer of correct
819size. Unfortunately, this function is not available on all platforms and the
820dangerous {\it vsprintf()} will be used then which may lead to buffer overflows.
a660d684 821
f7bd2698
JS
822\membersection{wxString::PrintfV}\label{wxstringprintfv}
823
824\func{int}{PrintfV}{\param{const char* }{pszFormat}, \param{va\_list}{ argPtr}}
825
826Similar to vprintf. Returns the number of characters written, or an integer less than zero
827on error.
a660d684 828
99f09bc1 829\membersection{wxString::Remove}\label{wxstringremove}
a660d684 830
f7bd2698
JS
831\func{wxString\&}{Remove}{\param{size\_t}{ pos}}
832
833Same as Truncate. Removes the portion from {\it pos} to the end of the string.
834
835\func{wxString\&}{Remove}{\param{size\_t}{ pos}, \param{size\_t}{ len}}
836
42d14d4e 837Removes the {\it len} characters from the string, starting at {\it pos}.
f7bd2698
JS
838
839\membersection{wxString::RemoveLast}\label{wxstringremovelast}
a660d684 840
f7bd2698
JS
841\func{wxString\&}{RemoveLast}{\void}
842
843Removes the last character.
a660d684 844
99f09bc1 845\membersection{wxString::Replace}\label{wxstringreplace}
a660d684 846
cc81d32f 847\func{size\_t}{Replace}{\param{const char*}{ szOld}, \param{const char*}{ szNew}, \param{bool}{ replaceAll = true}}
f7bd2698 848
7335902d 849Replace first (or all) occurrences of substring with another one.
f7bd2698 850
7335902d 851{\it replaceAll}: global replace (default), or only the first occurrence.
f7bd2698
JS
852
853Returns the number of replacements made.
854
855\membersection{wxString::Right}\label{wxstringright}
856
857\constfunc{wxString}{Right}{\param{size\_t}{ count}}
a660d684 858
f7bd2698 859Returns the last {\it count} characters.
a660d684 860
f7bd2698 861\membersection{wxString::SetChar}\label{wxstringsetchar}
a660d684 862
f7bd2698
JS
863\func{void}{SetChar}{\param{size\_t}{ n}, \param{char}{ch}}
864
865Sets the character at position {\it n}.
866
867\membersection{wxString::Shrink}\label{wxstringshrink}
868
869\func{void}{Shrink}{\void}
870
99f09bc1
VZ
871Minimizes the string's memory. This can be useful after a call to
872\helpref{Alloc()}{wxstringalloc} if too much memory were preallocated.
a660d684
KB
873
874\membersection{wxString::sprintf}\label{wxstringsprintf}
a660d684 875
f7bd2698 876\func{void}{sprintf}{\param{const char* }{ fmt}}
a660d684 877
f7bd2698 878The same as Printf.
a660d684 879
f6bcfd97
BP
880\membersection{wxString::StartsWith}\label{wxstringstartswith}
881
882\constfunc{bool}{StartsWith}{\param{const wxChar }{*prefix}, \param{wxString }{*rest = NULL}}
883
884This function can be used to test if the string starts with the specified
cc81d32f 885{\it prefix}. If it does, the function will return {\tt true} and put the rest
f6bcfd97 886of the string (i.e. after the prefix) into {\it rest} string if it is not
cc81d32f 887{\tt NULL}. Otherwise, the function returns {\tt false} and doesn't modify the
f6bcfd97
BP
888{\it rest}.
889
99f09bc1 890\membersection{wxString::Strip}\label{wxstringstrip}
a660d684
KB
891
892\begin{verbatim}
f7bd2698 893enum stripType {leading = 0x1, trailing = 0x2, both = 0x3};
a660d684
KB
894\end{verbatim}
895
f7bd2698 896\constfunc{wxString}{Strip}{\param{stripType}{ s = trailing}}
a660d684 897
f7bd2698
JS
898Strip characters at the front and/or end. The same as Trim except that it
899doesn't change this string.
a660d684 900
99f09bc1
VZ
901\membersection{wxString::SubString}\label{wxstringsubstring}
902
f6bcfd97 903\constfunc{wxString}{SubString}{\param{size\_t}{ from}, \param{size\_t}{ to}}
99f09bc1 904
b855ef77
VZ
905Deprecated, use \helpref{Mid}{wxstringmid} instead (but note that parameters
906have different meaning).
907
908Returns the part of the string between the indices {\it from} and {\it to}
909inclusive.
99f09bc1 910
cd0b1709
VZ
911\membersection{wxString::ToDouble}\label{wxstringtodouble}
912
f6bcfd97 913\constfunc{bool}{ToDouble}{\param{double}{ *val}}
cd0b1709 914
cc81d32f
VS
915Attempts to convert the string to a floating point number. Returns true on
916success (the number is stored in the location pointed to by {\it val}) or false
cd0b1709
VZ
917if the string does not represent such number.
918
f6bcfd97
BP
919\wxheading{See also}
920
921\helpref{wxString::ToLong}{wxstringtolong},\\
922\helpref{wxString::ToULong}{wxstringtoulong}
923
cd0b1709
VZ
924\membersection{wxString::ToLong}\label{wxstringtolong}
925
538f35cc 926\constfunc{bool}{ToLong}{\param{long}{ *val}, \param{int }{base = $10$}}
cd0b1709 927
4eb438cf 928Attempts to convert the string to a signed integer in base {\it base}. Returns
cc81d32f
VS
929{\tt true} on success in which case the number is stored in the location
930pointed to by {\it val} or {\tt false} if the string does not represent a
4eb438cf
VZ
931valid number in the given base.
932
538f35cc
VZ
933The value of {\it base} must be comprised between $2$ and $36$, inclusive, or
934be a special value $0$ which means that the usual rules of {\tt C} numbers are
935applied: if the number starts with {\tt 0x} it is considered to be in base
936$16$, if it starts with {\tt 0} - in base $8$ and in base $10$ otherwise. Note
937that you may not want to specify the base $0$ if you are parsing the numbers
938which may have leading zeroes as they can yield unexpected (to the user not
939familiar with C) results.
cd0b1709 940
f6bcfd97
BP
941\wxheading{See also}
942
943\helpref{wxString::ToDouble}{wxstringtodouble},\\
944\helpref{wxString::ToULong}{wxstringtoulong}
945
cd0b1709
VZ
946\membersection{wxString::ToULong}\label{wxstringtoulong}
947
538f35cc 948\constfunc{bool}{ToULong}{\param{unsigned long}{ *val}, \param{int }{base = $10$}}
4eb438cf
VZ
949
950Attempts to convert the string to a ansigned integer in base {\it base}.
cc81d32f
VS
951Returns {\tt true} on success in which case the number is stored in the
952location pointed to by {\it val} or {\tt false} if the string does not
4eb438cf 953represent a valid number in the given base.
cd0b1709 954
ec64d632
VZ
955See \helpref{wxString::ToLong}{wxstringtolong} for the more detailed
956description of the {\it base} parameter.
cd0b1709 957
f6bcfd97
BP
958\wxheading{See also}
959
960\helpref{wxString::ToDouble}{wxstringtodouble},\\
961\helpref{wxString::ToLong}{wxstringtolong}
962
f7bd2698 963\membersection{wxString::Trim}\label{wxstringtrim}
a660d684 964
cc81d32f 965\func{wxString\&}{Trim}{\param{bool}{ fromRight = true}}
a660d684 966
f7bd2698 967Removes spaces from the left or from the right (default).
a660d684 968
f7bd2698 969\membersection{wxString::Truncate}\label{wxstringtruncate}
a660d684 970
f7bd2698 971\func{wxString\&}{Truncate}{\param{size\_t}{ len}}
a660d684 972
f7bd2698 973Truncate the string to the given length.
a660d684 974
f7bd2698
JS
975\membersection{wxString::UngetWriteBuf}\label{wxstringungetwritebuf}
976
977\func{void}{UngetWriteBuf}{\void}
978
448025b0
VZ
979\func{void}{UngetWriteBuf}{\param{size\_t }{len}}
980
981Puts the string back into a reasonable state (in which it can be used
982normally), after
f7bd2698 983\rtfsp\helpref{wxString::GetWriteBuf}{wxstringgetwritebuf} was called.
a660d684 984
448025b0
VZ
985The version of the function without the {\it len} parameter will calculate the
986new string length itself assuming that the string is terminated by the first
987{\tt NUL} character in it while the second one will use the specified length
988and thus is the only version which should be used with the strings with
989embedded {\tt NUL}s (it is also slightly more efficient as {\tt strlen()}
990doesn't have to be called).
991
99f09bc1
VZ
992\membersection{wxString::Upper}\label{wxstringupper}
993
994\constfunc{wxString}{Upper}{\void}
995
996Returns this string converted to upper case.
997
998\membersection{wxString::UpperCase}\label{wxstringuppercase}
a660d684 999
f7bd2698
JS
1000\func{void}{UpperCase}{\void}
1001
1002The same as MakeUpper.
a660d684 1003
99f09bc1
VZ
1004\membersection{wxString::operator!}\label{wxstringoperatornot}
1005
1006\constfunc{bool}{operator!}{\void}
1007
cc81d32f 1008Empty string is false, so !string will only return true if the string is empty.
99f09bc1
VZ
1009This allows the tests for NULLness of a {\it const char *} pointer and emptyness
1010of the string to look the same in the code and makes it easier to port old code
1011to wxString.
1012
1013See also \helpref{IsEmpty()}{wxstringisempty}.
1014
a660d684
KB
1015\membersection{wxString::operator $=$}\label{wxstringoperatorassign}
1016
f7bd2698
JS
1017\func{wxString\&}{operator $=$}{\param{const wxString\&}{ str}}
1018
1019\func{wxString\&}{operator $=$}{\param{const char*}{ psz}}
1020
1021\func{wxString\&}{operator $=$}{\param{char}{ c}}
1022
1023\func{wxString\&}{operator $=$}{\param{const unsigned char*}{ psz}}
1024
1025\func{wxString\&}{operator $=$}{\param{const wchar\_t*}{ pwz}}
a660d684 1026
99f09bc1
VZ
1027Assignment: the effect of each operation is the same as for the corresponding
1028constructor (see \helpref{wxString constructors}{wxstringconstruct}).
5de76427 1029
f6bcfd97 1030\membersection{wxString::operator $+$}\label{wxstringoperatorplus}
5de76427 1031
99f09bc1
VZ
1032Concatenation: all these operators return a new strign equal to the sum of the
1033operands.
5de76427
JS
1034
1035\func{wxString}{operator $+$}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y}}
1036
1037\func{wxString}{operator $+$}{\param{const wxString\&}{ x}, \param{const char*}{ y}}
1038
1039\func{wxString}{operator $+$}{\param{const wxString\&}{ x}, \param{char}{ y}}
1040
1041\func{wxString}{operator $+$}{\param{const char*}{ x}, \param{const wxString\&}{ y}}
1042
99f09bc1 1043\membersection{wxString::operator $+=$}\label{wxstringplusequal}
a660d684 1044
f7bd2698
JS
1045\func{void}{operator $+=$}{\param{const wxString\&}{ str}}
1046
1047\func{void}{operator $+=$}{\param{const char*}{ psz}}
1048
1049\func{void}{operator $+=$}{\param{char}{ c}}
a660d684 1050
99f09bc1 1051Concatenation in place: the argument is appended to the string.
a660d684
KB
1052
1053\membersection{wxString::operator []}\label{wxstringoperatorbracket}
1054
f7bd2698
JS
1055\func{char\&}{operator []}{\param{size\_t}{ i}}
1056
1057\func{char}{operator []}{\param{size\_t}{ i}}
1058
1059\func{char}{operator []}{\param{int}{ i}}
a660d684
KB
1060
1061Element extraction.
1062
1063\membersection{wxString::operator ()}\label{wxstringoperatorparenth}
1064
f7bd2698
JS
1065\func{wxString}{operator ()}{\param{size\_t}{ start}, \param{size\_t}{ len}}
1066
1067Same as Mid (substring extraction).
a660d684
KB
1068
1069\membersection{wxString::operator \cinsert}\label{wxstringoperatorout}
f7bd2698 1070
037267e1 1071\func{wxString\&}{operator \cinsert}{\param{const wxString\&}{ str}}
f7bd2698 1072
037267e1 1073\func{wxString\&}{operator \cinsert}{\param{const char*}{ psz}}
f7bd2698 1074
037267e1 1075\func{wxString\&}{operator \cinsert}{\param{char }{ch}}
f7bd2698
JS
1076
1077Same as $+=$.
a660d684 1078
99f09bc1
VZ
1079\func{wxString\&}{operator \cinsert}{\param{int}{ i}}
1080
1081\func{wxString\&}{operator \cinsert}{\param{float}{ f}}
1082
1083\func{wxString\&}{operator \cinsert}{\param{double}{ d}}
1084
1085These functions work as C++ stream insertion operators: they insert the given
1086value into the string. Precision or format cannot be set using them, you can use
1087\helpref{Printf}{wxstringprintf} for this.
1088
a660d684 1089\membersection{wxString::operator \cextract}\label{wxstringoperatorin}
a660d684 1090
f7bd2698 1091\func{friend istream\&}{operator \cextract}{\param{istream\&}{ is}, \param{wxString\&}{ str}}
a660d684 1092
f7bd2698 1093Extraction from a stream.
a660d684 1094
f7bd2698 1095\membersection{wxString::operator const char*}\label{wxstringoperatorconstcharpt}
a660d684 1096
f7bd2698 1097\constfunc{}{operator const char*}{\void}
a660d684 1098
f7bd2698 1099Implicit conversion to a C string.
a660d684 1100
99f09bc1 1101\membersection{Comparison operators}\label{wxstringcomparison}
a660d684 1102
f7bd2698 1103\func{bool}{operator $==$}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y}}
a660d684 1104
f7bd2698 1105\func{bool}{operator $==$}{\param{const wxString\&}{ x}, \param{const char*}{ t}}
a660d684 1106
f7bd2698 1107\func{bool}{operator $!=$}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y}}
a660d684 1108
f7bd2698 1109\func{bool}{operator $!=$}{\param{const wxString\&}{ x}, \param{const char*}{ t}}
a660d684 1110
f7bd2698 1111\func{bool}{operator $>$}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y}}
a660d684 1112
f7bd2698 1113\func{bool}{operator $>$}{\param{const wxString\&}{ x}, \param{const char*}{ t}}
a660d684 1114
f7bd2698 1115\func{bool}{operator $>=$}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y}}
a660d684 1116
f7bd2698 1117\func{bool}{operator $>=$}{\param{const wxString\&}{ x}, \param{const char*}{ t}}
a660d684 1118
f7bd2698 1119\func{bool}{operator $<$}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y}}
a660d684 1120
f7bd2698 1121\func{bool}{operator $<$}{\param{const wxString\&}{ x}, \param{const char*}{ t}}
a660d684 1122
f7bd2698 1123\func{bool}{operator $<=$}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y}}
a660d684 1124
f7bd2698 1125\func{bool}{operator $<=$}{\param{const wxString\&}{ x}, \param{const char*}{ t}}
a660d684 1126
f7bd2698 1127\wxheading{Remarks}
a660d684 1128
f7bd2698 1129These comparisons are case-sensitive.
a660d684 1130
1d218550
VZ
1131
1132\section{\class{wxStringBuffer}}\label{wxstringbuffer}
1133
1134This tiny class allows to conveniently access the \helpref{wxString}{wxstring}
1135internal buffer as a writable pointer without any risk to forget to restore
1136the string to the usable state later.
1137
1138For example, assuming you have a low-level OS function called
1139{\tt GetMeaningOfLifeAsString(char *)} returning the value in the provided
1140buffer (which must be writable, of course) you might call it like this:
1141
1142\begin{verbatim}
1143 wxString theAnswer;
1144 GetMeaningOfLifeAsString(wxStringBuffer(theAnswer, 1024));
1145 if ( theAnswer != "42" )
1146 {
1147 wxLogError("Something is very wrong!");
1148 }
1149\end{verbatim}
1150
1151\wxheading{Derived from}
1152
1153None
1154
1155\wxheading{Include files}
1156
1157<wx/string.h>
1158
1159\latexignore{\rtfignore{\wxheading{Members}}}
1160
1161\membersection{wxStringBuffer::wxStringBuffer}
1162
1163\func{}{wxStringBuffer}{\param{const wxString\& }{str}, \param{size\_t }{len}}
1164
1165Constructs a writable string buffer object associated with the given string
2edb0bde 1166and containing enough space for at least {\it len} characters. Basically, this
1d218550
VZ
1167is equivalent to calling \helpref{GetWriteBuf}{wxstringgetwritebuf} and
1168saving the result.
1169
1170\membersection{wxStringBuffer::\destruct{wxStringBuffer}}
1171
1172\func{}{\destruct{wxStringBuffer}}{\void}
1173
1174Restores the string passed to the constructor to the usable state by calling
1175\helpref{UngetWriteBuf}{wxstringungetwritebuf} on it.
1176
1177\membersection{wxStringBuffer::operator wxChar *}
1178
1179\constfunc{wxChar *}{operator wxChar *}{\void}
1180
1181Returns the writable pointer to a buffer of the size at least equal to the
1182length specified in the constructor.
1183
1184