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