ICU 78.1: common/unicode/schriter.h Source File

ICU 78.1 78.1

schriter.h
Go to the documentation of this file.
1 // © 2016 and later: Unicode, Inc. and others.
2 // License & terms of use: http://www.unicode.org/copyright.html
3 /*
4 ******************************************************************************
5 *
6 * Copyright (C) 1998-2005, International Business Machines
7 * Corporation and others. All Rights Reserved.
8 *
9 ******************************************************************************
10 *
11 * File schriter.h
12 *
13 * Modification History:
14 *
15 * Date Name Description
16 * 05/05/99 stephen Cleaned up.
17 ******************************************************************************
18 */
19
20 #ifndef SCHRITER_H
21 #define SCHRITER_H
22
23 #include "unicode/utypes.h"
24
25 #if U_SHOW_CPLUSPLUS_API
26
27 #include "unicode/chariter.h"
28 #include "unicode/uchriter.h"
29
35 U_NAMESPACE_BEGIN
48 class U_COMMON_API StringCharacterIterator : public UCharCharacterIterator {
49 public:
57 StringCharacterIterator(const UnicodeString& textStr);
58
68 StringCharacterIterator(const UnicodeString& textStr,
69 int32_t textPos);
70
87 StringCharacterIterator(const UnicodeString& textStr,
88 int32_t textBegin,
89 int32_t textEnd,
90 int32_t textPos);
91
100 StringCharacterIterator(const StringCharacterIterator& that);
101
106 virtual ~StringCharacterIterator();
107
116 StringCharacterIterator&
117 operator=(const StringCharacterIterator& that);
118
127 virtual bool operator==(const ForwardCharacterIterator& that) const override;
128
136 virtual StringCharacterIterator* clone() const override;
137
143 void setText(const UnicodeString& newText);
144
152 virtual void getText(UnicodeString& result) override;
153
159 virtual UClassID getDynamicClassID() const override;
160
166 static UClassID U_EXPORT2 getStaticClassID();
167
168 protected:
173 StringCharacterIterator();
174
179 UnicodeString text;
180
181 };
182
183 U_NAMESPACE_END
184
185 #endif /* U_SHOW_CPLUSPLUS_API */
186
187 #endif
chariter.h
C++ API: Character Iterator.
icu::ForwardCharacterIterator
Abstract class that defines an API for forward-only iteration on text objects.
Definition: chariter.h:94
icu::StringCharacterIterator
A concrete subclass of CharacterIterator that iterates over the characters (code units or code points...
Definition: schriter.h:48
icu::StringCharacterIterator::~StringCharacterIterator
virtual ~StringCharacterIterator()
Destructor.
icu::StringCharacterIterator::StringCharacterIterator
StringCharacterIterator(const UnicodeString &textStr, int32_t textPos)
Create an iterator over the UnicodeString referred to by "textStr".
icu::StringCharacterIterator::StringCharacterIterator
StringCharacterIterator(const UnicodeString &textStr)
Create an iterator over the UnicodeString referred to by "textStr".
icu::StringCharacterIterator::clone
virtual StringCharacterIterator * clone() const override
Returns a new StringCharacterIterator referring to the same character in the same range of the same s...
icu::StringCharacterIterator::operator==
virtual bool operator==(const ForwardCharacterIterator &that) const override
Returns true if the iterators iterate over the same range of the same string and are pointing at the ...
icu::StringCharacterIterator::StringCharacterIterator
StringCharacterIterator(const UnicodeString &textStr, int32_t textBegin, int32_t textEnd, int32_t textPos)
Create an iterator over the UnicodeString referred to by "textStr".
icu::StringCharacterIterator::setText
void setText(const UnicodeString &newText)
Sets the iterator to iterate over the provided string.
icu::StringCharacterIterator::getStaticClassID
static UClassID getStaticClassID()
Return a class ID for this class (not really public)
icu::StringCharacterIterator::text
UnicodeString text
Copy of the iterated string object.
Definition: schriter.h:179
icu::StringCharacterIterator::StringCharacterIterator
StringCharacterIterator()
Default constructor, iteration over empty string.
icu::StringCharacterIterator::getDynamicClassID
virtual UClassID getDynamicClassID() const override
Return a class ID for this object (not really public)
icu::StringCharacterIterator::getText
virtual void getText(UnicodeString &result) override
Copies the UnicodeString under iteration into the UnicodeString referred to by "result".
icu::StringCharacterIterator::operator=
StringCharacterIterator & operator=(const StringCharacterIterator &that)
Assignment operator.
icu::StringCharacterIterator::StringCharacterIterator
StringCharacterIterator(const StringCharacterIterator &that)
Copy constructor.
icu::UCharCharacterIterator
A concrete subclass of CharacterIterator that iterates over the characters (code units or code points...
Definition: uchriter.h:38
icu::UnicodeString
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Definition: unistr.h:303
uchriter.h
C++ API: char16_t Character Iterator.
UClassID
void * UClassID
UClassID is used to identify classes without using the compiler's RTTI.
Definition: uobject.h:96
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:315