PackString_MultipleLines Class Reference
[Base Type Serializable Classes]

#include <PackString_MultipleLines.h>

Detailed Description

Extension to PackString to manages long texts with multiple lines. When used in non editable compilation mode, it is cast as a PackString.

Definition at line 19 of file PackString_MultipleLines.h.

Public Types

enum eVedaUpdate {
  eVedaUpdate_NoUpdate = 0, eVedaUpdate_MemberIsGoingToChange, eVedaUpdate_MemberChanged, eVedaUpdate_MemberChangedBecauseOfUndo,
  eVedaUpdate_MemberDestroyed, eVedaUpdate_ObjectNew, eVedaUpdate_ObjectDestroyed, eVedaUpdate_ObjectReCreated,
  eVedaUpdate_ObjectClosed, eVedaUpdate_NewRegisteredClass
}

enum used by BaseContext::NotifyObjectChange() to describe the notification meaning. Used by interfaces to monitor a context. More...

Public Member Functions

PackString_MultipleLines (void)

Constructor.

virtual ~PackString_MultipleLines (void)

Destructor.

virtual const char * GetClassID () const

Each BaseType's inherited classes must explicit an ID for their class, or let use one of the super class at least through this virtual method. This is needed by GUIs to detect the types of each sub-members, and shape an interface for each Object according to their member list.

virtual const unsigned char * Serialize_In (const unsigned char *_pDescriptionChunk)

Read the object description from a byte chunk. Could crash if chunk not valid.

virtual unsigned int GetSerializedDescriptionSize (void)

get the size of the whole byte chunk that will be written by Serialize_Out().

virtual unsigned char * Serialize_Out (unsigned char *_pDescriptionChunkToFill)

write the Current object definition to a Chunk using private packed types, recursively.

virtual const char * ValueToString ()

convert the value of this object to an explicit string. The object manages the string privately, so just read it or copy it. the string would be destroyed with the objects, and changed when using Set() methods. Note: this is not virtual, but each class can manage m_pValueString or not.

void AddInt (int _value)

add a int value at the end of the current chain.

void AddString (const char *_pstr)

apend a character string..

virtual void Set (const char *_pCharacterString)

set the string value. It reallocates memory. as it is used by serialisation, it returns a pointer on the read memory AFTER the zero for convenience. This "set" is exceptionnaly compiled in non-editable mode, because it is used by serialization.

const char * Get () const

set the string value.

unsigned int length ()

like strlen()

virtual unsigned int WriteFile (const char *_pFileName)

write a serialized form, using GetSerializedDescriptionSize() and Serialize_Out().

virtual unsigned int ReadFile (const char *_pFileName)

Try to read a serialized form, using Serialize_In().

virtual void SetObjectThatManagesThis (BaseObject *_pManager)

The Object this one belong to as a member. Should only be used at init.

void SetMemberName (const char *_MemberName)

Explicits the name of an object when used as a class member. It exists only in editable mode, and then can be used by any GUI. A member with an infoString not NULL, should be drawn in a GUI and receive updates. an object member with GetMemberName() returning NULL should not be edited by an interface or undo-managed. Use REGISTER_MEMBER macros family: it registers the members and use SetMemberName() automatically (or not, according to the compilation mode).

const char * GetMemberName () const

Explicits the name of an object when used as a class member. It exists only in editable mode, and then can be used by any GUI. A member with an infoString not NULL, should be drawn in a GUI and receive updates. an object member with GetMemberName() to NULL should not be edited by an interface or undo-managed. set with SetMemberName().

void SetMemberInfo (const char *_MemberInfo)

Explicits the use of an object when used as a class member. It should explain what the member does for the object. It exists only in editable mode,and can be used by any GUI. Don't use html tags , only \n are allowed. Use REGISTER_MEMBER_INFO macro after the REGISTER_MEMBER macro in the constructors. It can be left NULL.

const char * GetMemberInfo () const

Explicits the use of an object when used as a class member. It exists only in editable mode and can be used by any GUI. It should explain what the member does for the object.

BaseObject * GetObjectThatManagesThis ()

If there is any, get the object that manages this one as a member.

void MakeCloneOf (BaseType &_ModelObject)

Tool that makes an object take the values of another using serialization. Use with care: You got to clone a PackUlong with a PackULong, a PackString with a PackString: Clone Object of the same type or it will crash . A test is done at the beginning to check that for both types are the sames, if not it does nothing. however it may still crash with 2 objects from unherited classes. Also, some type like PackObjectReference, will not clone its value by copying a pointer.Reference member clonage is done with BaseObject::Clone().

Static Public Member Functions

static int Compare (const char *_pStringToCompare, const char *_pOtherStringToCompare)

compare a string. looks like strcmp().

Protected Member Functions

virtual void Free ()

delete if was allocated.

void BeginChangeNotification ()

In edition mode, when a member of an object is changed (like in a Set()), you got to use BeginChangeNotification(), make your changes, and then EndChangeNotification(), so that the edition of this object and member is known by the context, and allows it to manage a GUI update and the undo stack.

void EndChangeNotification ()

In edition mode, when a member of an object is changed (like in a Set()), you got to use BeginChangeNotification(), make your changes, and then EndChangeNotification(), so that the edition of this object and member is known by the context, and allows it to manage a GUI update and the undo stack.

Static Protected Member Functions

static unsigned int length (const char *_pString)

private tool. like strlen(), but with +1 for the zero end.

static const char * strcopy (char *_pStringToFill, const char *_pSourceString)

private tool. like strcpy(), but with +1 for the zero end. as it is used by serialisation, it returns a pointer on the read memory AFTER the zero for convenience.

Protected Attributes

char * m_StringBuffer

the string buffer.

unsigned int m_UsedByteLength

the current m_StringBuffer used buffer. as it is zero ended, m_StringBuffer[m_UsedByteLength-1]==0

unsigned int m_TotalByteLength

current m_StringBuffer total allocation. is multiple of m_GrowByteLength.

BaseObject * m_pObjectThatManagesThis

an object can belong (or not) to a BaseObject,( and to a BaseContext through it).

const char * m_pMemberName

If used as a member in an object, the member name, or NULL (not editable member).

const char * m_pMemberInfo

a short string explaining what's the object for in editable mode. OK if NULL (no info).

PackString * m_pValueString

a string standing for an expression of the value of the object:

unsigned char * m_pPreviousValueShape

used as a temp for object change notification in Begin/EndChangeNotification():

unsigned int m_PreviousValueShapeLength

Static Protected Attributes

static const unsigned int m_GrowByteLength = 64

the re-allocation constant.

Member Enumeration Documentation

enum eVedaUpdate [inherited]

enum used by BaseContext::NotifyObjectChange() to describe the notification meaning. Used by interfaces to monitor a context.

Enumerator:

eVedaUpdate_NoUpdate 0 means No Update.

eVedaUpdate_MemberIsGoingToChange Sent before a BaseObject member value change.( in order to lock the context to prevent object use from other thread.).

eVedaUpdate_MemberChanged a member of a BaseObject just changed.

eVedaUpdate_MemberChangedBecauseOfUndo a member of a BaseObject just changed, but because of an undo. you may treat it the same as eVedaUpdate_MemberChanged.

eVedaUpdate_MemberDestroyed Member of object Destroyed ! Watch out, the ID of the member is a dead pointer.

eVedaUpdate_ObjectNew new BaseObject created.

eVedaUpdate_ObjectDestroyed BaseObject just destroyed.Watch out, the ID of the object is a dead pointer.

eVedaUpdate_ObjectReCreated an object has just been Created; It's state has changed!

eVedaUpdate_ObjectClosed an object has just been closed; It's state has changed!

eVedaUpdate_NewRegisteredClass TODO: a new class has been registered to the context.

Definition at line 194 of file BaseType.h.

Constructor & Destructor Documentation

PackString_MultipleLines ( void )

Constructor.

virtual ~PackString_MultipleLines ( void ) [virtual]

Destructor.

Member Function Documentation

void AddInt ( int _value ) [inherited]

add a int value at the end of the current chain.

Parameters:

_value the integer value.

void AddString ( const char * _pstr ) [inherited]

apend a character string..

Parameters:

_pstr

void BeginChangeNotification ( ) [protected, inherited]

In edition mode, when a member of an object is changed (like in a Set()), you got to use BeginChangeNotification(), make your changes, and then EndChangeNotification(), so that the edition of this object and member is known by the context, and allows it to manage a GUI update and the undo stack.

static int Compare ( const char * _pStringToCompare,

const char * _pOtherStringToCompare

) [static, inherited]

compare a string. looks like strcmp().

Parameters:

_pStringToCompare the string to compare to the value

_pOtherStringToCompare the other string

Returns:
0 if the same. case sensitive test.

void EndChangeNotification ( ) [protected, inherited]

In edition mode, when a member of an object is changed (like in a Set()), you got to use BeginChangeNotification(), make your changes, and then EndChangeNotification(), so that the edition of this object and member is known by the context, and allows it to manage a GUI update and the undo stack.

virtual void Free ( ) [protected, virtual, inherited]

delete if was allocated.

const char* Get ( ) const [inline, inherited]

set the string value.

Definition at line 105 of file PackString.h.
References PackString::m_StringBuffer.
Referenced by MediaAccess::GetExportName(), PackResource::GetFileExtension(), PackResource::GetFilePath(), NamedObject::GetName(), and BaseObject::GetObjectInfoLine().

virtual const char* GetClassID ( ) const [inline, virtual]

Each BaseType's inherited classes must explicit an ID for their class, or let use one of the super class at least through this virtual method. This is needed by GUIs to detect the types of each sub-members, and shape an interface for each Object according to their member list.

Returns:
a const character string, that must be unique and unchanged for all serializable base type.

Reimplemented from PackString.
Definition at line 43 of file PackString_MultipleLines.h.

const char* GetMemberInfo ( ) const [inline, inherited]

Explicits the use of an object when used as a class member. It exists only in editable mode and can be used by any GUI. It should explain what the member does for the object.

Returns:
a short string explaining what's the object for, or NULL if not set.

Definition at line 144 of file BaseType.h.
References BaseType::m_pMemberInfo.

const char* GetMemberName ( ) const [inline, inherited]

Explicits the name of an object when used as a class member. It exists only in editable mode, and then can be used by any GUI. A member with an infoString not NULL, should be drawn in a GUI and receive updates. an object member with GetMemberName() to NULL should not be edited by an interface or undo-managed. set with SetMemberName().

Returns:
the member name or NULL

Definition at line 123 of file BaseType.h.
References BaseType::m_pMemberName.

BaseObject* GetObjectThatManagesThis ( ) [inline, inherited]

If there is any, get the object that manages this one as a member.

Returns:
the object that manages this one as a member, or NULL

Definition at line 170 of file BaseType.h.
References BaseType::m_pObjectThatManagesThis.

virtual unsigned int GetSerializedDescriptionSize ( void ) [virtual, inherited]

get the size of the whole byte chunk that will be written by Serialize_Out().

Returns:
byte size of the serialisation to do.(1,2,3, or4)

Implements BaseType.

static unsigned int length ( const char * _pString ) [static, protected, inherited]

private tool. like strlen(), but with +1 for the zero end.

Parameters:

_pString string.

Returns:
length+1 for the zero at the end.

unsigned int length ( ) [inline, inherited]

like strlen()

Returns:
length, not including the last zero.

Definition at line 118 of file PackString.h.

void MakeCloneOf ( BaseType & _ModelObject ) [inherited]

Tool that makes an object take the values of another using serialization. Use with care: You got to clone a PackUlong with a PackULong, a PackString with a PackString: Clone Object of the same type or it will crash . A test is done at the beginning to check that for both types are the sames, if not it does nothing. however it may still crash with 2 objects from unherited classes. Also, some type like PackObjectReference, will not clone its value by copying a pointer.Reference member clonage is done with BaseObject::Clone().

Parameters:

_ModelObject the object took as a model.

virtual unsigned int ReadFile ( const char * _pFileName ) [virtual, inherited]

Try to read a serialized form, using Serialize_In().

Parameters:

_pFileName the file path.

Returns:
0 if OK.

virtual const unsigned char* Serialize_In ( const unsigned char * _pDescriptionChunk ) [virtual, inherited]

Read the object description from a byte chunk. Could crash if chunk not valid.

Parameters:

_pDescriptionChunk the objet description chunk.

Returns:
the end of the chunk written, possibly unlocated. Don't use this if you don't need it.

Implements BaseType.

virtual unsigned char* Serialize_Out ( unsigned char * _pDescriptionChunkToFill ) [virtual, inherited]

write the Current object definition to a Chunk using private packed types, recursively.

Parameters:

_pDescriptionChunkToFill the chunk where to write the objet description chunk.

Returns:
the end of the chunk written, possibly unlocated. Don't use this if you don't need it.

Implements BaseType.

virtual void Set ( const char * _pCharacterString ) [virtual, inherited]

set the string value. It reallocates memory. as it is used by serialisation, it returns a pointer on the read memory AFTER the zero for convenience. This "set" is exceptionnaly compiled in non-editable mode, because it is used by serialization.

Parameters:

_pCharacterString the string to copy.

Returns:
a pointer after read memory.

void SetMemberInfo ( const char * _MemberInfo ) [inherited]

Explicits the use of an object when used as a class member. It should explain what the member does for the object. It exists only in editable mode,and can be used by any GUI. Don't use html tags , only \n are allowed. Use REGISTER_MEMBER_INFO macro after the REGISTER_MEMBER macro in the constructors. It can be left NULL.

Parameters:

_MemberName a short string explaining what's the object for.

void SetMemberName ( const char * _MemberName ) [inherited]

Explicits the name of an object when used as a class member. It exists only in editable mode, and then can be used by any GUI. A member with an infoString not NULL, should be drawn in a GUI and receive updates. an object member with GetMemberName() returning NULL should not be edited by an interface or undo-managed. Use REGISTER_MEMBER macros family: it registers the members and use SetMemberName() automatically (or not, according to the compilation mode).

Parameters:

_MemberName the member name

virtual void SetObjectThatManagesThis ( BaseObject * _pManager ) [virtual, inherited]

The Object this one belong to as a member. Should only be used at init.

Parameters:

_pManager BaseObject

Reimplemented in PackObjectReference, PackResource, PackStruct, and PackTreeCell.

static const char* strcopy ( char * _pStringToFill,

const char * _pSourceString

) [static, protected, inherited]

private tool. like strcpy(), but with +1 for the zero end. as it is used by serialisation, it returns a pointer on the read memory AFTER the zero for convenience.

Parameters:

_pStringToFill destination.

_pSourceString source.

Returns:
a pointer after read memory

virtual const char* ValueToString ( ) [virtual, inherited]

convert the value of this object to an explicit string. The object manages the string privately, so just read it or copy it. the string would be destroyed with the objects, and changed when using Set() methods. Note: this is not virtual, but each class can manage m_pValueString or not.

Returns:
the value as a const string.

Reimplemented from BaseType.

virtual unsigned int WriteFile ( const char * _pFileName ) [virtual, inherited]

write a serialized form, using GetSerializedDescriptionSize() and Serialize_Out().

Parameters:

_pFileName the file path.

Returns:
0 if OK.

Member Data Documentation

const unsigned int m_GrowByteLength = 64 [static, protected, inherited]

the re-allocation constant.

Definition at line 129 of file PackString.h.

const char* m_pMemberInfo [protected, inherited]

a short string explaining what's the object for in editable mode. OK if NULL (no info).

Definition at line 259 of file BaseType.h.
Referenced by BaseType::GetMemberInfo().

const char* m_pMemberName [protected, inherited]

If used as a member in an object, the member name, or NULL (not editable member).

Definition at line 255 of file BaseType.h.
Referenced by BaseType::GetMemberName().

BaseObject* m_pObjectThatManagesThis [protected, inherited]

an object can belong (or not) to a BaseObject,( and to a BaseContext through it).

Definition at line 251 of file BaseType.h.
Referenced by BaseType::GetObjectThatManagesThis().

unsigned char* m_pPreviousValueShape [protected, inherited]

used as a temp for object change notification in Begin/EndChangeNotification():

Definition at line 269 of file BaseType.h.

PackString* m_pValueString [protected, inherited]

a string standing for an expression of the value of the object:

Definition at line 264 of file BaseType.h.

char* m_StringBuffer [protected, inherited]

the string buffer.

Definition at line 118 of file PackString.h.
Referenced by PackString::Get().

unsigned int m_TotalByteLength [protected, inherited]

current m_StringBuffer total allocation. is multiple of m_GrowByteLength.

Definition at line 133 of file PackString.h.

unsigned int m_UsedByteLength [protected, inherited]

the current m_StringBuffer used buffer. as it is zero ended, m_StringBuffer[m_UsedByteLength-1]==0

Definition at line 131 of file PackString.h.

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

Veda/PackString_MultipleLines.h

      /\/\        4         N         k         !         N         D
                      _______  _ __ ___  _____            ___ _ _  ____
     ___________  __//___   /________  |/    / ___________\_______/    \
    /   _   _   \/   _     /    _   /      _/_/____/    _       __     /
   /    /   /       /     /    /    \      \/     /    /    \   \     /
  \\___/___/___/    ¯    _____/_____/       ______\___/_____/\________\\
               \________/_ ___ __ l____\      /elD!  
                 http://www.m4nkind.com \____/


Public Types
enum	eVedaUpdate { eVedaUpdate_NoUpdate = 0, eVedaUpdate_MemberIsGoingToChange, eVedaUpdate_MemberChanged, eVedaUpdate_MemberChangedBecauseOfUndo, eVedaUpdate_MemberDestroyed, eVedaUpdate_ObjectNew, eVedaUpdate_ObjectDestroyed, eVedaUpdate_ObjectReCreated, eVedaUpdate_ObjectClosed, eVedaUpdate_NewRegisteredClass }
	enum used by BaseContext::NotifyObjectChange() to describe the notification meaning. Used by interfaces to monitor a context. More...
Public Member Functions
	PackString_MultipleLines (void)
	Constructor.
virtual	~PackString_MultipleLines (void)
	Destructor.
virtual const char *	GetClassID () const
	Each BaseType's inherited classes must explicit an ID for their class, or let use one of the super class at least through this virtual method. This is needed by GUIs to detect the types of each sub-members, and shape an interface for each Object according to their member list.
virtual const unsigned char *	Serialize_In (const unsigned char *_pDescriptionChunk)
	Read the object description from a byte chunk. Could crash if chunk not valid.
virtual unsigned int	GetSerializedDescriptionSize (void)
	get the size of the whole byte chunk that will be written by Serialize_Out().
virtual unsigned char *	Serialize_Out (unsigned char *_pDescriptionChunkToFill)
	write the Current object definition to a Chunk using private packed types, recursively.
virtual const char *	ValueToString ()
	convert the value of this object to an explicit string. The object manages the string privately, so just read it or copy it. the string would be destroyed with the objects, and changed when using Set() methods. Note: this is not virtual, but each class can manage m_pValueString or not.
void	AddInt (int _value)
	add a int value at the end of the current chain.
void	AddString (const char *_pstr)
	apend a character string..
virtual void	Set (const char *_pCharacterString)
	set the string value. It reallocates memory. as it is used by serialisation, it returns a pointer on the read memory AFTER the zero for convenience. This "set" is exceptionnaly compiled in non-editable mode, because it is used by serialization.
const char *	Get () const
	set the string value.
unsigned int	length ()
	like strlen()
virtual unsigned int	WriteFile (const char *_pFileName)
	write a serialized form, using GetSerializedDescriptionSize() and Serialize_Out().
virtual unsigned int	ReadFile (const char *_pFileName)
	Try to read a serialized form, using Serialize_In().
virtual void	SetObjectThatManagesThis (BaseObject *_pManager)
	The Object this one belong to as a member. Should only be used at init.
void	SetMemberName (const char *_MemberName)
	Explicits the name of an object when used as a class member. It exists only in editable mode, and then can be used by any GUI. A member with an infoString not NULL, should be drawn in a GUI and receive updates. an object member with GetMemberName() returning NULL should not be edited by an interface or undo-managed. Use REGISTER_MEMBER macros family: it registers the members and use SetMemberName() automatically (or not, according to the compilation mode).
const char *	GetMemberName () const
	Explicits the name of an object when used as a class member. It exists only in editable mode, and then can be used by any GUI. A member with an infoString not NULL, should be drawn in a GUI and receive updates. an object member with GetMemberName() to NULL should not be edited by an interface or undo-managed. set with SetMemberName().
void	SetMemberInfo (const char *_MemberInfo)
	Explicits the use of an object when used as a class member. It should explain what the member does for the object. It exists only in editable mode,and can be used by any GUI. Don't use html tags , only \n are allowed. Use REGISTER_MEMBER_INFO macro after the REGISTER_MEMBER macro in the constructors. It can be left NULL.
const char *	GetMemberInfo () const
	Explicits the use of an object when used as a class member. It exists only in editable mode and can be used by any GUI. It should explain what the member does for the object.
BaseObject *	GetObjectThatManagesThis ()
	If there is any, get the object that manages this one as a member.
void	MakeCloneOf (BaseType &_ModelObject)
	Tool that makes an object take the values of another using serialization. Use with care: You got to clone a PackUlong with a PackULong, a PackString with a PackString: Clone Object of the same type or it will crash . A test is done at the beginning to check that for both types are the sames, if not it does nothing. however it may still crash with 2 objects from unherited classes. Also, some type like PackObjectReference, will not clone its value by copying a pointer.Reference member clonage is done with BaseObject::Clone().
Static Public Member Functions
static int	Compare (const char _pStringToCompare, const char _pOtherStringToCompare)
	compare a string. looks like strcmp().
Protected Member Functions
virtual void	Free ()
	delete if was allocated.
void	BeginChangeNotification ()
	In edition mode, when a member of an object is changed (like in a Set()), you got to use BeginChangeNotification(), make your changes, and then EndChangeNotification(), so that the edition of this object and member is known by the context, and allows it to manage a GUI update and the undo stack.
void	EndChangeNotification ()
	In edition mode, when a member of an object is changed (like in a Set()), you got to use BeginChangeNotification(), make your changes, and then EndChangeNotification(), so that the edition of this object and member is known by the context, and allows it to manage a GUI update and the undo stack.
Static Protected Member Functions
static unsigned int	length (const char *_pString)
	private tool. like strlen(), but with +1 for the zero end.
static const char *	strcopy (char _pStringToFill, const char _pSourceString)
	private tool. like strcpy(), but with +1 for the zero end. as it is used by serialisation, it returns a pointer on the read memory AFTER the zero for convenience.
Protected Attributes
char *	m_StringBuffer
	the string buffer.
unsigned int	m_UsedByteLength
	the current m_StringBuffer used buffer. as it is zero ended, m_StringBuffer[m_UsedByteLength-1]==0
unsigned int	m_TotalByteLength
	current m_StringBuffer total allocation. is multiple of m_GrowByteLength.
BaseObject *	m_pObjectThatManagesThis
	an object can belong (or not) to a BaseObject,( and to a BaseContext through it).
const char *	m_pMemberName
	If used as a member in an object, the member name, or NULL (not editable member).
const char *	m_pMemberInfo
	a short string explaining what's the object for in editable mode. OK if NULL (no info).
PackString *	m_pValueString
	a string standing for an expression of the value of the object:
unsigned char *	m_pPreviousValueShape
	used as a temp for object change notification in Begin/EndChangeNotification():
unsigned int	m_PreviousValueShapeLength
Static Protected Attributes
static const unsigned int	m_GrowByteLength = 64
	the re-allocation constant.

PackString_MultipleLines Class Reference [Base Type Serializable Classes]

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

PackString_MultipleLines Class Reference
[Base Type Serializable Classes]