Cpl::Text::FStringItem< S > Class Template Reference

This template class implements the StringItem class for a 'String' using a 'FString' as the internal storage for String instance. More...

Detailed Description

template<int S>
class Cpl::Text::FStringItem< S >

This template class implements the StringItem class for a 'String' using a 'FString' as the internal storage for String instance.

Template Args: S:= Max Size of the String WITHOUT the null terminator!

#include <FStringItem.h>

Inheritance diagram for Cpl::Text::FStringItem< S >:

Collaboration diagram for Cpl::Text::FStringItem< S >:

Public Member Functions
	FStringItem (const Cpl::Text::String &string)
	Constructor.
	FStringItem (const char *string="")
	Constructor.
Public Member Functions inherited from Cpl::Text::StringItem
String &	get () const
	Returns a reference to the actual String.
const char *	getString () const
	Returns a pointer to the internal C string.
	operator String & () const
	Cast to a String reference.
	operator const char * () const
	Cast to read-only character string pointer.
const char *	operator() () const
	Returns a Read-only pointer to the "raw" (short-hand for getString())
const Cpl::Container::Key &	getKey () const noexcept
	Return Cpl::Container::DictItem (used with Maps and Dictionaries)
Public Member Functions inherited from Cpl::Container::Item
bool	insert_ (void *newContainerPtr)
	Helper method to trap when inserting an item in multiple containers.
bool	isInContainer_ (const void *containerPtr) const noexcept
	Returns 'true' if the instance is in the specified container.

Protected Attributes
FString< S >	m_internalString
	Underlying String.
Protected Attributes inherited from Cpl::Text::StringItem
String &	m_myString
	Reference to the actual String/storage.
Protected Attributes inherited from Cpl::Container::MapItem
void *	m_parentPtr_
	Link field to the parent node.
bool	m_is_NOT_root_
	I am the root node.
Balance_T	m_balance_
	Balance status.
Protected Attributes inherited from Cpl::Container::DictItem
unsigned int	m_hashCode_
	Remember which hash bucket I am stored in.

Additional Inherited Members
Static Public Member Functions inherited from Cpl::Container::Item
static void	remove_ (Item *itemPtr) noexcept
	Helper method to do the proper 'clean-up' for the multiple-containers-error-trap when removing an item from a container.
Public Attributes inherited from Cpl::Container::ExtendedItem
void *	m_prevPtr_
	The previous link field.
Public Attributes inherited from Cpl::Container::Item
void *	m_nextPtr_
	The link field.
void *	m_inListPtr_
	Debug field.
Protected Types inherited from Cpl::Container::MapItem
enum	Balance_T { eLEFT_ =-1 , eEVEN_ =0 , eRIGHT_ =1 }
	Magic values for balance status. More...
Protected Member Functions inherited from Cpl::Text::StringItem
	StringItem (String &string)
	Constructor.
Protected Member Functions inherited from Cpl::Container::MapItem
	MapItem ()
	Constructor.
	MapItem (const char *ignoreThisParameter_usedToCreateAUniqueConstructor)
	Constructor -->special constructor to allow a Map to be statically allocated.
void	initialize (MapItem *parent)
	Initialize the node when being inserted in the tree.
MapItem *	getParent () const
	Get tree connection/pointer.
void	setParent (MapItem *n)
	Set tree connection/pointer.
MapItem *	getLeft () const
	Get tree connection/pointer.
void	setLeft (MapItem *n)
	Set tree connection/pointer.
MapItem *	getRight () const
	Get tree connection/pointer.
void	setRight (MapItem *n)
	Set tree connection/pointer.
Protected Member Functions inherited from Cpl::Container::DictItem
	DictItem ()
	Constructor.
	DictItem (const char *ignoreThisParameter_usedToCreateAUniqueConstructor)
	Constructor used ONLY with the child class MapItem: -->special constructor to allow a Map to be statically allocated.
Protected Member Functions inherited from Cpl::Container::ExtendedItem
	ExtendedItem ()
	Constructor.
	ExtendedItem (const char *ignoreThisParameter_usedToCreateAUniqueConstructor)
	Constructor used ONLY with the child class MapItem: -->special constructor to allow a Map to be statically allocated.
Protected Member Functions inherited from Cpl::Container::Item
	Item ()
	Constructor.
	Item (const char *)
	Constructor used ONLY with the child class MapItem: -->special constructor to allow a Map to be statically allocated.

Constructor & Destructor Documentation

FStringItem() [1/2]

template<int S>

Cpl::Text::FStringItem< S >::FStringItem ( const Cpl::Text::String &  string )

inline

Constructor.

FStringItem() [2/2]

template<int S>

Cpl::Text::FStringItem< S >::FStringItem ( const char *  string = "" )

inline

Constructor.

Member Data Documentation

m_internalString

template<int S>

FString<S> Cpl::Text::FStringItem< S >::m_internalString

protected

Underlying String.

---

The documentation for this class was generated from the following file:

• Cpl/Text/FStringItem.h