]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/tokenizr.tex
Fixed to work with the new wxMacControl system.
[wxWidgets.git] / docs / latex / wx / tokenizr.tex
... / ...
CommitLineData
1\section{\class{wxStringTokenizer}}\label{wxstringtokenizer}
2
3wxStringTokenizer helps you to break a string up into a number of tokens. It
4replaces the standard C function {\tt strtok()} and also extends it in a
5number of ways.
6
7To use this class, you should create a wxStringTokenizer object, give it the
8string to tokenize and also the delimiters which separate tokens in the string
9(by default, white space characters will be used).
10
11Then \helpref{GetNextToken}{wxstringtokenizergetnexttoken} may be called
12repeatedly until it \helpref{HasMoreTokens}{wxstringtokenizerhasmoretokens}
13returns \false.
14
15For example:
16
17\begin{verbatim}
18
19wxStringTokenizer tkz(wxT("first:second:third:fourth"), wxT(":"));
20while ( tkz.HasMoreTokens() )
21{
22 wxString token = tkz.GetNextToken();
23
24 // process token here
25}
26\end{verbatim}
27
28By default, wxStringTokenizer will behave in the same way as {\tt strtok()} if
29the delimiters string only contains white space characters but, unlike the
30standard function, it will return empty tokens if this is not the case. This
31is helpful for parsing strictly formatted data where the number of fields is
32fixed but some of them may be empty (i.e. {\tt TAB} or comma delimited text
33files).
34
35The behaviour is governed by the last
36\helpref{constructor}{wxstringtokenizerwxstringtokenizer}/\helpref{SetString}{wxstringtokenizersetstring}
37parameter {\tt mode} which may be one of the following:
38
39\twocolwidtha{5cm}%
40\begin{twocollist}\itemsep=0pt
41\twocolitem{{\tt wxTOKEN\_DEFAULT}}{Default behaviour (as described above):
42same as {\tt wxTOKEN\_STRTOK} if the delimiter string contains only
43whitespaces, same as {\tt wxTOKEN\_RET\_EMPTY} otherwise}
44\twocolitem{{\tt wxTOKEN\_RET\_EMPTY}}{In this mode, the empty tokens in the
45middle of the string will be returned, i.e. {\tt "a::b:"} will be tokenized in
46three tokens `a', `' and `b'.}
47\twocolitem{{\tt wxTOKEN\_RET\_EMPTY\_ALL}}{In this mode, empty trailing token
48(after the last delimiter character) will be returned as well. The string as
49above will contain four tokens: the already mentioned ones and another empty
50one as the last one.}
51\twocolitem{{\tt wxTOKEN\_RET\_DELIMS}}{In this mode, the delimiter character
52after the end of the current token (there may be none if this is the last
53token) is returned appended to the token. Otherwise, it is the same mode as
54{\tt wxTOKEN\_RET\_EMPTY}.}
55\twocolitem{{\tt wxTOKEN\_STRTOK}}{In this mode the class behaves exactly like
56the standard {\tt strtok()} function. The empty tokens are never returned.}
57\end{twocollist}
58
59\wxheading{Derived from}
60
61\helpref{wxObject}{wxobject}
62
63\wxheading{Include files}
64
65<wx/tokenzr.h>
66
67\latexignore{\rtfignore{\wxheading{Members}}}
68
69
70\membersection{wxStringTokenizer::wxStringTokenizer}\label{wxstringtokenizerwxstringtokenizer}
71
72\func{}{wxStringTokenizer}{\void}
73
74Default constructor. You must call
75\helpref{SetString}{wxstringtokenizersetstring} before calling any other
76methods.
77
78\func{}{wxStringTokenizer}{\param{const wxString\& }{str}, \param{const wxString\& }{delims = " $\backslash$t$\backslash$r$\backslash$n"}, \param{wxStringTokenizerMode }{mode = wxTOKEN\_DEFAULT}}
79
80Constructor. Pass the string to tokenize, a string containing delimiters
81and the mode specifying how the string should be tokenized.
82
83
84\membersection{wxStringTokenizer::CountTokens}\label{wxstringtokenizercounttokens}
85
86\constfunc{int}{CountTokens}{\void}
87
88Returns the number of tokens remaining in the input string. The number of
89tokens returned by this function is decremented each time
90\helpref{GetNextToken}{wxstringtokenizergetnexttoken} is called and when it
91reaches $0$ \helpref{HasMoreTokens}{wxstringtokenizerhasmoretokens} returns
92\false.
93
94
95\membersection{wxStringTokenizer::HasMoreTokens}\label{wxstringtokenizerhasmoretokens}
96
97\constfunc{bool}{HasMoreTokens}{\void}
98
99Returns \true if the tokenizer has further tokens, \false if none are left.
100
101
102\membersection{wxStringTokenizer::GetNextToken}\label{wxstringtokenizergetnexttoken}
103
104\func{wxString}{GetNextToken}{\void}
105
106Returns the next token or empty string if the end of string was reached.
107
108
109\membersection{wxStringTokenizer::GetPosition}\label{wxstringtokenizergetposition}
110
111\constfunc{size\_t}{GetPosition}{\void}
112
113Returns the current position (i.e. one index after the last returned
114token or 0 if GetNextToken() has never been called) in the original
115string.
116
117
118\membersection{wxStringTokenizer::GetString}\label{wxstringtokenizergetstring}
119
120\constfunc{wxString}{GetString}{\void}
121
122Returns the part of the starting string without all token already extracted.
123
124
125\membersection{wxStringTokenizer::SetString}\label{wxstringtokenizersetstring}
126
127\func{void}{SetString}{\param{const wxString\& }{to\_tokenize}, \param{const wxString\& }{delims = " $\backslash$t$\backslash$r$\backslash$n"}, \param{wxStringTokenizerMode }{mode = wxTOKEN\_DEFAULT}}
128
129Initializes the tokenizer.
130
131Pass the string to tokenize, a string containing delimiters,
132and the mode specifying how the string should be tokenized.
133