]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/tokenizr.tex
wxPython documentation updates
[wxWidgets.git] / docs / latex / wx / tokenizr.tex
1 \section{\class{wxStringTokenizer}}\label{wxstringtokenizer}
2
3 wxStringTokenizer helps you to break a string up into a number of tokens.
4
5 \wxheading{Derived from}
6
7 \helpref{wxObject}{wxobject}
8
9 \wxheading{Include files}
10
11 <wx/tokenzr.h>
12
13 \latexignore{\rtfignore{\wxheading{Members}}}
14
15 \membersection{wxStringTokenizer::wxStringTokenizer}\label{wxstringtokenizerwxstringtokenizer}
16
17 \func{}{wxStringTokenizer}{\void}
18
19 Default constructor.
20
21 \func{}{wxStringTokenizer}{\param{const wxString\& }{to\_tokenize}, \param{const wxString\& }{delims = " $\backslash$t$\backslash$r$\backslash$n"}, \param{bool }{ret\_delim = FALSE}}
22
23 Constructor. Pass the string to tokenize, a string containing delimiters,
24 a flag specifying whether delimiters are retained.
25
26 \membersection{wxStringTokenizer::\destruct{wxStringTokenizer}}\label{wxstringtokenizerdtor}
27
28 \func{}{\destruct{wxStringTokenizer}}{\void}
29
30 Destructor.
31
32 \membersection{wxStringTokenizer::CountTokens}\label{wxstringtokenizercounttokens}
33
34 \constfunc{int}{CountTokens}{\void}
35
36 Returns the number of tokens in the input string.
37
38 \membersection{wxStringTokenizer::HasMoreTokens}\label{wxstringtokenizerhasmoretokens}
39
40 \constfunc{bool}{HasMoreTokens}{\void}
41
42 Returns TRUE if the tokenizer has further tokens.
43
44 \membersection{wxStringTokenizer::GetNextToken}\label{wxstringtokenizergetnexttoken}
45
46 \constfunc{wxString}{GetNextToken}{\void}
47
48 Returns the next token.
49
50 \membersection{wxStringTokenizer::GetString}\label{wxstringtokenizergetstring}
51
52 \constfunc{wxString}{GetString}{\void}
53
54 Returns the input string.
55
56 \membersection{wxStringTokenizer::SetString}\label{wxstringtokenizersetstring}
57
58 \func{void}{SetString}{\param{const wxString\& }{to\_tokenize}, \param{const wxString\& }{delims = " $\backslash$t$\backslash$r$\backslash$n"}, \param{bool }{ret\_delim = FALSE}}
59
60 Initializes the tokenizer.
61
62 Pass the string to tokenize, a string containing delimiters,
63 a flag specifying whether delimiters are retained.
64