[wxWidgets.git] / docs / latex / wx / tokenizr.tex

\section{\class{wxStringTokenizer}}\label{wxstringtokenizer}

wxStringTokenizer helps you to break a string up into a number of tokens.

\wxheading{Derived from}

\helpref{wxObject}{wxobject}

\wxheading{Include files}

<wx/tokenzr.h>

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxStringTokenizer::wxStringTokenizer}\label{wxstringtokenizerwxstringtokenizer}

\func{}{wxStringTokenizer}{\void}

Default constructor.

\func{}{wxStringTokenizer}{\param{const wxString\& }{to\_tokenize}, \param{const wxString\& }{delims = " $\backslash$t$\backslash$r$\backslash$n"}, \param{bool }{ret\_delim = FALSE}}

Constructor. Pass the string to tokenize, a string containing delimiters,
a flag specifying whether delimiters are retained.

\membersection{wxStringTokenizer::\destruct{wxStringTokenizer}}\label{wxstringtokenizerdtor}

\func{}{\destruct{wxStringTokenizer}}{\void}

Destructor.

\membersection{wxStringTokenizer::CountTokens}\label{wxstringtokenizercounttokens}

\constfunc{int}{CountTokens}{\void}

Returns the number of tokens in the input string.

\membersection{wxStringTokenizer::HasMoreTokens}\label{wxstringtokenizerhasmoretokens}

\constfunc{bool}{HasMoreTokens}{\void}

Returns TRUE if the tokenizer has further tokens.

\membersection{wxStringTokenizer::GetNextToken}\label{wxstringtokenizergetnexttoken}

\constfunc{wxString}{GetNextToken}{\void}

Returns the next token.

\membersection{wxStringTokenizer::GetString}\label{wxstringtokenizergetstring}

\constfunc{wxString}{GetString}{\void}

Returns the input string.

\membersection{wxStringTokenizer::SetString}\label{wxstringtokenizersetstring}

\func{void}{SetString}{\param{const wxString\& }{to\_tokenize}, \param{const wxString\& }{delims = " $\backslash$t$\backslash$r$\backslash$n"}, \param{bool }{ret\_delim = FALSE}}

Initializes the tokenizer.

Pass the string to tokenize, a string containing delimiters,
a flag specifying whether delimiters are retained.
Commit	Line	Data
d134d2d4 JS	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
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
	19	Default 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	23	Constructor. Pass the string to tokenize, a string containing delimiters,
d134d2d4 JS	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
ad813b00	34	\constfunc{int}{CountTokens}{\void}
d134d2d4 JS	35
	36	Returns the number of tokens in the input string.
	37
ad813b00	38	\membersection{wxStringTokenizer::HasMoreTokens}\label{wxstringtokenizerhasmoretokens}
d134d2d4	39
ad813b00	40	\constfunc{bool}{HasMoreTokens}{\void}
d134d2d4 JS	41
	42	Returns TRUE if the tokenizer has further tokens.
	43
ad813b00	44	\membersection{wxStringTokenizer::GetNextToken}\label{wxstringtokenizergetnexttoken}
d134d2d4	45
ad813b00	46	\constfunc{wxString}{GetNextToken}{\void}
d134d2d4 JS	47
	48	Returns the next token.
	49
	50	\membersection{wxStringTokenizer::GetString}\label{wxstringtokenizergetstring}
	51
ad813b00	52	\constfunc{wxString}{GetString}{\void}
d134d2d4 JS	53
	54	Returns 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	60	Initializes the tokenizer.
	61
	62	Pass the string to tokenize, a string containing delimiters,
	63	a flag specifying whether delimiters are retained.
d134d2d4	64