/////////////////////////////////////////////////////////////////////////////
// Name: tokenzr.h
-// Purpose: documentation for wxStringTokenizer class
+// Purpose: interface of wxStringTokenizer
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
@library{wxbase}
@category{data}
- @seealso
- wxStringTokenize
+ @see wxStringTokenize()
*/
class wxStringTokenizer : public wxObject
{
reaches 0 HasMoreTokens() returns
@false.
*/
- int CountTokens();
+ int CountTokens() const;
/**
Returns the delimiter which ended scan for the last token returned by
GetNextToken() or @c NUL if
there had been no calls to this function yet or if it returned the trailing
empty token in @c wxTOKEN_RET_EMPTY_ALL mode.
-
- This function is new since wxWidgets version 2.7.0
+
+ @wxsince{2.7.0}
*/
wxChar GetLastDelimiter();
/**
Returns the next token or empty string if the end of string was reached.
*/
- wxString GetNextToken();
+ wxString GetNextToken() const;
/**
Returns the current position (i.e. one index after the last returned
token or 0 if GetNextToken() has never been called) in the original
string.
*/
- size_t GetPosition();
+ size_t GetPosition() const;
/**
Returns the part of the starting string without all token already extracted.
*/
- wxString GetString();
+ wxString GetString() const;
/**
Returns @true if the tokenizer has further tokens, @false if none are left.
*/
- bool HasMoreTokens();
+ bool HasMoreTokens() const;
/**
Initializes the tokenizer.
-
Pass the string to tokenize, a string containing delimiters,
and the mode specifying how the string should be tokenized.
*/
const wxString& delims = " \t\r\n",
wxStringTokenizerMode mode = wxTOKEN_DEFAULT);
};
+