Showing content from https://unicode-org.github.io/icu-docs/apidoc/released/icu4c/classStringCharacterIterator.html below:
ICU 77.1: icu::StringCharacterIterator Class Reference
A concrete subclass of CharacterIterator that iterates over the characters (code units or code points) in a UnicodeString. More...
#include <schriter.h>
StringCharacterIterator (const UnicodeString &textStr) Create an iterator over the UnicodeString referred to by "textStr". More...
StringCharacterIterator (const UnicodeString &textStr, int32_t textPos) Create an iterator over the UnicodeString referred to by "textStr". More...
StringCharacterIterator (const UnicodeString &textStr, int32_t textBegin, int32_t textEnd, int32_t textPos) Create an iterator over the UnicodeString referred to by "textStr". More...
StringCharacterIterator (const StringCharacterIterator &that) Copy constructor. More...
virtual ~StringCharacterIterator () Destructor. More...
StringCharacterIterator & operator= (const StringCharacterIterator &that) Assignment operator. More...
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 same character. More...
virtual StringCharacterIterator * clone () const override Returns a new StringCharacterIterator referring to the same character in the same range of the same string as this one. More...
void setText (const UnicodeString &newText) Sets the iterator to iterate over the provided string. More...
virtual void getText (UnicodeString &result) override Copies the UnicodeString under iteration into the UnicodeString referred to by "result". More...
virtual UClassID getDynamicClassID () const override Return a class ID for this object (not really public) More...
UCharCharacterIterator (ConstChar16Ptr textPtr, int32_t length) Create an iterator over the char16_t array referred to by "textPtr". More...
UCharCharacterIterator (ConstChar16Ptr textPtr, int32_t length, int32_t position) Create an iterator over the char16_t array referred to by "textPtr". More...
UCharCharacterIterator (ConstChar16Ptr textPtr, int32_t length, int32_t textBegin, int32_t textEnd, int32_t position) Create an iterator over the char16_t array referred to by "textPtr". More...
UCharCharacterIterator (const UCharCharacterIterator &that) Copy constructor. More...
virtual ~UCharCharacterIterator () Destructor. More...
UCharCharacterIterator & operator= (const UCharCharacterIterator &that) Assignment operator. More...
virtual int32_t hashCode () const override Generates a hash code for this iterator. More...
virtual char16_t first () override Sets the iterator to refer to the first code unit in its iteration range, and returns that code unit. More...
virtual char16_t firstPostInc () override Sets the iterator to refer to the first code unit in its iteration range, returns that code unit, and moves the position to the second code unit. More...
virtual UChar32 first32 () override Sets the iterator to refer to the first code point in its iteration range, and returns that code unit, This can be used to begin an iteration with next32(). More...
virtual UChar32 first32PostInc () override Sets the iterator to refer to the first code point in its iteration range, returns that code point, and moves the position to the second code point. More...
virtual char16_t last () override Sets the iterator to refer to the last code unit in its iteration range, and returns that code unit. More...
virtual UChar32 last32 () override Sets the iterator to refer to the last code point in its iteration range, and returns that code unit. More...
virtual char16_t setIndex (int32_t position) override Sets the iterator to refer to the "position"-th code unit in the text-storage object the iterator refers to, and returns that code unit. More...
virtual UChar32 setIndex32 (int32_t position) override Sets the iterator to refer to the beginning of the code point that contains the "position"-th code unit in the text-storage object the iterator refers to, and returns that code point. More...
virtual char16_t current () const override Returns the code unit the iterator currently refers to. More...
virtual UChar32 current32 () const override Returns the code point the iterator currently refers to. More...
virtual char16_t next () override Advances to the next code unit in the iteration range (toward endIndex()), and returns that code unit. More...
virtual char16_t nextPostInc () override Gets the current code unit for returning and advances to the next code unit in the iteration range (toward endIndex()). More...
virtual UChar32 next32 () override Advances to the next code point in the iteration range (toward endIndex()), and returns that code point. More...
virtual UChar32 next32PostInc () override Gets the current code point for returning and advances to the next code point in the iteration range (toward endIndex()). More...
virtual UBool hasNext () override Returns false if there are no more code units or code points at or after the current position in the iteration range. More...
virtual char16_t previous () override Advances to the previous code unit in the iteration range (toward startIndex()), and returns that code unit. More...
virtual UChar32 previous32 () override Advances to the previous code point in the iteration range (toward startIndex()), and returns that code point. More...
virtual UBool hasPrevious () override Returns false if there are no more code units or code points before the current position in the iteration range. More...
virtual int32_t move (int32_t delta, EOrigin origin) override Moves the current position relative to the start or end of the iteration range, or relative to the current position itself. More...
virtual int32_t move32 (int32_t delta, EOrigin origin) override Moves the current position relative to the start or end of the iteration range, or relative to the current position itself. More...
void setText (ConstChar16Ptr newText, int32_t newTextLength) Sets the iterator to iterate over a new range of text. More...
virtual ~CharacterIterator () Destructor. More...
int32_t setToStart () Sets the iterator to refer to the first code unit or code point in its iteration range. More...
int32_t setToEnd () Sets the iterator to the end of its iteration range, just behind the last code unit or code point. More...
int32_t startIndex () const Returns the numeric index in the underlying text-storage object of the character returned by first(). More...
int32_t endIndex () const Returns the numeric index in the underlying text-storage object of the position immediately BEYOND the character returned by last(). More...
int32_t getIndex () const Returns the numeric index in the underlying text-storage object of the character the iterator currently refers to (i.e., the character returned by current()). More...
int32_t getLength () const Returns the length of the entire text in the underlying text-storage object. More...
virtual ~ForwardCharacterIterator () Destructor. More...
bool operator!= (const ForwardCharacterIterator &that) const Returns true when the iterators refer to different text-storage objects, or to different characters in the same text-storage object. More...
virtual ~UObject () Destructor. More...
StringCharacterIterator () Default constructor, iteration over empty string. More...
UCharCharacterIterator () Protected constructor. More...
CharacterIterator () Empty constructor. More...
CharacterIterator (int32_t length) Constructor, just setting the length field in this base class. More...
CharacterIterator (int32_t length, int32_t position) Constructor, just setting the length and position fields in this base class. More...
CharacterIterator (int32_t length, int32_t textBegin, int32_t textEnd, int32_t position) Constructor, just setting the length, start, end, and position fields in this base class. More...
CharacterIterator (const CharacterIterator &that) Copy constructor. More...
CharacterIterator & operator= (const CharacterIterator &that) Assignment operator. More...
ForwardCharacterIterator () Default constructor to be overridden in the implementing class. More...
ForwardCharacterIterator (const ForwardCharacterIterator &other) Copy constructor to be overridden in the implementing class. More...
ForwardCharacterIterator & operator= (const ForwardCharacterIterator &) Assignment operator to be overridden in the implementing class. More...
A concrete subclass of CharacterIterator that iterates over the characters (code units or code points) in a UnicodeString.
It's possible not only to create an iterator that iterates over an entire UnicodeString, but also to create one that iterates over only a subrange of a UnicodeString (iterators over different subranges of the same UnicodeString don't compare equal).
-
See also
-
CharacterIterator
-
ForwardCharacterIterator
-
Stable:
-
ICU 2.0
Definition at line 48 of file schriter.h.
◆ StringCharacterIterator() [1/5] icu::StringCharacterIterator::StringCharacterIterator ( const UnicodeString & textStr )
Create an iterator over the UnicodeString referred to by "textStr".
The UnicodeString object is copied. The iteration range is the whole string, and the starting position is 0.
-
Parameters
-
textStr The unicode string used to create an iterator
-
Stable:
-
ICU 2.0
◆ StringCharacterIterator() [2/5] icu::StringCharacterIterator::StringCharacterIterator ( const UnicodeString & textStr, int32_t textPos )
Create an iterator over the UnicodeString referred to by "textStr".
The iteration range is the whole string, and the starting position is specified by "textPos". If "textPos" is outside the valid iteration range, the behavior of this object is undefined.
-
Parameters
-
textStr The unicode string used to create an iterator textPos The starting position of the iteration
-
Stable:
-
ICU 2.0
◆ StringCharacterIterator() [3/5] icu::StringCharacterIterator::StringCharacterIterator ( const UnicodeString & textStr, int32_t textBegin, int32_t textEnd, int32_t textPos )
Create an iterator over the UnicodeString referred to by "textStr".
The UnicodeString object is copied. The iteration range begins with the code unit specified by "textBegin" and ends with the code unit BEFORE the code unit specified by "textEnd". The starting position is specified by "textPos". If "textBegin" and "textEnd" don't form a valid range on "text" (i.e., textBegin >= textEnd or either is negative or greater than text.size()), or "textPos" is outside the range defined by "textBegin" and "textEnd", the behavior of this iterator is undefined.
-
Parameters
-
textStr The unicode string used to create the StringCharacterIterator textBegin The begin position of the iteration range textEnd The end position of the iteration range textPos The starting position of the iteration
-
Stable:
-
ICU 2.0
◆ StringCharacterIterator() [4/5]
Copy constructor.
The new iterator iterates over the same range of the same string as "that", and its initial position is the same as "that"'s current position. The UnicodeString object in "that" is copied.
-
Parameters
-
-
Stable:
-
ICU 2.0
◆ ~StringCharacterIterator() virtual icu::StringCharacterIterator::~StringCharacterIterator ( ) virtual ◆ StringCharacterIterator() [5/5] icu::StringCharacterIterator::StringCharacterIterator ( ) protected
Default constructor, iteration over empty string.
-
Stable:
-
ICU 2.0
◆ clone() ◆ getDynamicClassID() virtual UClassID icu::StringCharacterIterator::getDynamicClassID ( ) const overridevirtual ◆ getStaticClassID() static UClassID icu::StringCharacterIterator::getStaticClassID ( ) static
Return a class ID for this class (not really public)
-
Returns
-
a class ID for this class
-
Stable:
-
ICU 2.0
◆ getText() virtual void icu::StringCharacterIterator::getText ( UnicodeString & result ) overridevirtual
Copies the UnicodeString under iteration into the UnicodeString referred to by "result".
Even if this iterator iterates across only a part of this string, the whole string is copied.
-
Parameters
-
result Receives a copy of the text under iteration.
-
Stable:
-
ICU 2.0
Reimplemented from icu::UCharCharacterIterator.
◆ operator=()
Assignment operator.
*this is altered to iterate over the same range of the same string as "that", and refers to the same character within that string as "that" does.
-
Parameters
-
that The object to be copied.
-
Returns
-
the newly created object.
-
Stable:
-
ICU 2.0
◆ operator==()
Returns true if the iterators iterate over the same range of the same string and are pointing at the same character.
-
Parameters
-
-
Returns
-
true if the iterators iterate over the same range of the same string and are pointing at the same character.
-
Stable:
-
ICU 2.0
Reimplemented from icu::UCharCharacterIterator.
◆ setText() void icu::StringCharacterIterator::setText ( const UnicodeString & newText )
Sets the iterator to iterate over the provided string.
-
Parameters
-
newText The string to be iterated over
-
Stable:
-
ICU 2.0
◆ text
The documentation for this class was generated from the following file:
RetroSearch is an open source project built by @garambo
| Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4