iHStringCharIt Struct Reference

Inheritance diagram for iHStringCharIt:

Detailed Description

HString character iterator interface.

Public Member Functions
virtual iHString *	GetString () const =0
	Get the string being iterated. {Property}. More...
virtual iHStringCharIt *	Clone () const =0
	Clone the iterator. More...
virtual tBool	GetIsStart () const =0
	Get whether the current position is the start of the iterator. {Property}. More...
virtual tBool	GetIsEnd () const =0
	Get whether the current position is the end of the iterator. {Property}. More...
virtual tU32	GetPosition () const =0
	Get the current position from the start of the iterator in bytes. {Property}. More...
virtual void	ToStart ()=0
	Move the iterator to its starting point. More...
virtual tSize	ToEnd ()=0
	Move the iterator to its end point. More...
virtual tSize	GetNumChars () const =0
	Get the number of characters covered by the iterator. {Property}. More...
virtual tSize	GetNumBytes () const =0
	Get the number of bytes covered by the iterator. {Property}. More...
virtual tU32	PeekNext () const =0
	Return the next character in the string without moving the iterator. More...
virtual tU32	Next ()=0
	Return the next character in the string moving the iterator forward. More...
virtual tU32	PeekPrior () const =0
	Return the previous character in the string without moving the iterator. More...
virtual tU32	Prior ()=0
	Return the next character in the string moving the iterator backward. More...
virtual tU32	PeekAdvance (tU32 fwd) const =0
	Return the nth character in the string without moving the iterator. More...
virtual tU32	Advance (tU32 n)=0
	Return the nth character in the string moving the iterator forward. More...
virtual tU32	PeekRewind (tU32 back) const =0
	Return the nth previous character in the string without moving the iterator. More...
virtual tU32	Rewind (tU32 n)=0
	Return the nth previous character in the string moving the iterator backward. More...
virtual void	ToPosition (tU32 anOffsetInBytes)=0
	Move the iterator to the specified position in bytes. More...
Public Member Functions inherited from iUnknown
virtual tBool	IsOK () const =0
	Check if the object is valid. More...
virtual tI32	AddRef ()=0
	Signal that one more reference of the object has been created. More...
virtual tI32	Release ()=0
	Release a reference of the object. More...
virtual void	DeleteThis ()=0
	Bypass any reference counting and delete this object. More...
virtual void	Invalidate ()=0
	Invalidate the object. More...
virtual iUnknown *	QueryInterface (const tUUID &aIID)=0
	Query an interface. More...
virtual void	ListInterfaces (iMutableCollection *apLst, tU32 anFlags) const =0
	Fill a UUID list containing the UUIDs of the implemented interfaces. More...
virtual tI32	SetNumRefs (tI32 anNumRefs)=0
	Set the reference counter directly. More...
virtual tI32	GetNumRefs () const =0
	Get the number of references to this object. More...

Member Function Documentation

virtual iHString* GetString ( ) const

pure virtual

Get the string being iterated. {Property}.

virtual iHStringCharIt* Clone ( ) const

pure virtual

Clone the iterator.

virtual tBool GetIsStart ( ) const

pure virtual

Get whether the current position is the start of the iterator. {Property}.

virtual tBool GetIsEnd ( ) const

pure virtual

Get whether the current position is the end of the iterator. {Property}.

virtual tU32 GetPosition ( ) const

pure virtual

Get the current position from the start of the iterator in bytes. {Property}.

virtual void ToStart ( )

pure virtual

Move the iterator to its starting point.

virtual tSize ToEnd ( )

pure virtual

Move the iterator to its end point.

virtual tSize GetNumChars ( ) const

pure virtual

Get the number of characters covered by the iterator. {Property}.

virtual tSize GetNumBytes ( ) const

pure virtual

Get the number of bytes covered by the iterator. {Property}.

virtual tU32 PeekNext ( ) const

pure virtual

Return the next character in the string without moving the iterator.

virtual tU32 Next ( )

pure virtual

Return the next character in the string moving the iterator forward.

virtual tU32 PeekPrior ( ) const

pure virtual

Return the previous character in the string without moving the iterator.

virtual tU32 Prior ( )

pure virtual

Return the next character in the string moving the iterator backward.

virtual tU32 PeekAdvance ( tU32  fwd ) const

pure virtual

Return the nth character in the string without moving the iterator.

virtual tU32 Advance ( tU32  n )

pure virtual

Return the nth character in the string moving the iterator forward.

virtual tU32 PeekRewind ( tU32  back ) const

pure virtual

Return the nth previous character in the string without moving the iterator.

virtual tU32 Rewind ( tU32  n )

pure virtual

Return the nth previous character in the string moving the iterator backward.

virtual void ToPosition ( tU32  anOffsetInBytes )

pure virtual

Move the iterator to the specified position in bytes.