iHString Struct Reference

Inheritance diagram for iHString:

Detailed Description

HString interface.

Public Member Functions
virtual const achar *	GetChars () const =0
	Get the string's characters. {Property}. More...
virtual tU32	GetLength () const =0
	Get the string's length. {Property}. More...
virtual tI32	Cmp (const iHString *ahspString) const =0
	Compare this string with another HString. More...
virtual tI32	ICmp (const iHString *ahspString) const =0
	Case insensitive compare with another HString. More...
virtual iHString *	GetLocalized () const =0
	Get the string localized in the default locale. {Property}. More...
virtual iHString *	GetLocalizedEx (iHString *locale) const =0
	Get the string localized in the specified locale. More...
virtual tBool	IsLocalized (iHString *locale) const =0
	Get the whether the string is localized in the specified locale. More...
virtual iHStringCharIt *	CreateCharIt (tU32 offset) const =0
	Return a character iterator to iterate over the string starting at the specified byte offset. More...
virtual iHStringCharIt *	CreateRangeIt (tU32 offset, tU32 size) const =0
	Return a character iterator to iterate over the specifed byte range in the string. 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 const achar* GetChars ( ) const

pure virtual

Get the string's characters. {Property}.

virtual tU32 GetLength ( ) const

pure virtual

Get the string's length. {Property}.

virtual tI32 Cmp ( const iHString *  ahspString ) const

pure virtual

Compare this string with another HString.

Remarks

If the passed string is not from the same string table a regular string compare will be performed.

virtual tI32 ICmp ( const iHString *  ahspString ) const

pure virtual

Case insensitive compare with another HString.

Remarks

If the passed string is not from the same string table a regular string compare will be performed.

virtual iHString* GetLocalized ( ) const

pure virtual

Get the string localized in the default locale. {Property}.

virtual iHString* GetLocalizedEx ( iHString *  locale ) const

pure virtual

Get the string localized in the specified locale.

virtual tBool IsLocalized ( iHString *  locale ) const

pure virtual

Get the whether the string is localized in the specified locale.

virtual iHStringCharIt* CreateCharIt ( tU32  offset ) const

pure virtual

Return a character iterator to iterate over the string starting at the specified byte offset.

Returns

NULL if the offset is out of range, else the new iterator.

virtual iHStringCharIt* CreateRangeIt ( tU32  offset, tU32  size  ) const

pure virtual

Return a character iterator to iterate over the specifed byte range in the string.

Returns

NULL if the offset or size is out of range, else the new iterator.