ICU 56.1: schriter.h Source File

ICU 56.1 56.1

- Main Page
- Related Pages
- Modules
- Namespaces
- Data Structures
- Files

- File List
- Globals

schriter.h
Go to the documentation of this file.
1 /*
2 ******************************************************************************
3 *
4 * Copyright (C) 1998-2005, International Business Machines
5 * Corporation and others. All Rights Reserved.
6 *
7 ******************************************************************************
8 *
9 * File schriter.h
10 *
11 * Modification History:
12 *
13 * Date Name Description
14 * 05/05/99 stephen Cleaned up.
15 ******************************************************************************
16 */
17
18 #ifndef SCHRITER_H
19 #define SCHRITER_H
20
21 #include "unicode/utypes.h"
22 #include "unicode/chariter.h"
23 #include "unicode/uchriter.h"
24
30 U_NAMESPACE_BEGIN
43 class U_COMMON_API StringCharacterIterator : public UCharCharacterIterator {
44 public:
52 StringCharacterIterator(const UnicodeString& textStr);
53
63 StringCharacterIterator(const UnicodeString& textStr,
64 int32_t textPos);
65
82 StringCharacterIterator(const UnicodeString& textStr,
83 int32_t textBegin,
84 int32_t textEnd,
85 int32_t textPos);
86
95 StringCharacterIterator(const StringCharacterIterator& that);
96
101 virtual ~StringCharacterIterator();
102
111 StringCharacterIterator&
112 operator=(const StringCharacterIterator& that);
113
122 virtual UBool operator==(const ForwardCharacterIterator& that) const;
123
131 virtual CharacterIterator* clone(void) const;
132
138 void setText(const UnicodeString& newText);
139
147 virtual void getText(UnicodeString& result);
148
154 virtual UClassID getDynamicClassID(void) const;
155
161 static UClassID U_EXPORT2 getStaticClassID(void);
162
163 protected:
168 StringCharacterIterator();
169
176 void setText(const UChar* newText, int32_t newTextLength);
177
182 UnicodeString text;
183
184 };
185
186 U_NAMESPACE_END
187 #endif
icu::UCharCharacterIterator::getDynamicClassID
virtual UClassID getDynamicClassID(void) const
Return a class ID for this object (not really public)
UClassID
void * UClassID
UClassID is used to identify classes without using the compiler's RTTI.
Definition: uobject.h:91
icu::UCharCharacterIterator::operator=
UCharCharacterIterator & operator=(const UCharCharacterIterator &that)
Assignment operator.
icu::StringCharacterIterator::text
UnicodeString text
Copy of the iterated string object.
Definition: schriter.h:182
icu::UCharCharacterIterator::getText
virtual void getText(UnicodeString &result)
Copies the UChar array under iteration into the UnicodeString referred to by "result".
U_NAMESPACE_BEGIN
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition: uversion.h:129
icu::CharacterIterator
Abstract class that defines an API for iteration on text objects.
Definition: chariter.h:356
icu::UCharCharacterIterator
A concrete subclass of CharacterIterator that iterates over the characters (code units or code points...
Definition: uchriter.h:33
icu::StringCharacterIterator
A concrete subclass of CharacterIterator that iterates over the characters (code units or code points...
Definition: schriter.h:43
uchriter.h
C++ API: UChar Character Iterator.
icu::UCharCharacterIterator::setText
void setText(const UChar *newText, int32_t newTextLength)
Sets the iterator to iterate over a new range of text.
UChar
uint16_t UChar
Define UChar to be UCHAR_TYPE, if that is #defined (for example, to char16_t), or wchar_t if that is ...
Definition: umachine.h:312
U_NAMESPACE_END
#define U_NAMESPACE_END
This is used to end a declaration of a public ICU C++ API.
Definition: uversion.h:130
icu::UCharCharacterIterator::clone
virtual CharacterIterator * clone(void) const
Returns a new UCharCharacterIterator referring to the same character in the same range of the same st...
icu::ForwardCharacterIterator
Abstract class that defines an API for forward-only iteration on text objects.
Definition: chariter.h:89
icu::UCharCharacterIterator::getStaticClassID
static UClassID getStaticClassID(void)
Return a class ID for this class (not really public)
utypes.h
Basic definitions for ICU, for both C and C++ APIs.
U_COMMON_API
#define U_COMMON_API
Set to export library symbols from inside the common library, and to import them from outside...
Definition: utypes.h:357
icu::UnicodeString
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Definition: unistr.h:293
chariter.h
C++ API: Character Iterator.
UBool
int8_t UBool
The ICU boolean type.
Definition: umachine.h:234
icu::UCharCharacterIterator::operator==
virtual UBool operator==(const ForwardCharacterIterator &that) const
Returns true if the iterators iterate over the same range of the same string and are pointing at the ...