iFieldCustomDatatype Class Reference

#include <customgui_field.h>

Inheritance diagram for iFieldCustomDatatype:

Public Member Functions
	~iFieldCustomDatatype ()

Static Public Member Functions
static iFieldCustomDatatype *	Alloc ()
static void	Free (iFieldCustomDatatype *&pData)
Static Public Member Functions inherited from iCustomDataType< iFieldCustomDatatype >
static iFieldCustomDatatype *	Alloc ()
static void	Free (iFieldCustomDatatype *&data)

Public Attributes
FieldlayerRootNode *	_fieldHead
Int32	_idCounter
FIELDLIST_FLAGS	_fieldFlags

Protected Member Functions
	iFieldCustomDatatype ()
Bool	Init ()
Bool	CopyFrom (const iFieldCustomDatatype *source, COPYFLAGS flags, AliasTrans *trans)
Bool	Read (HyperFile *hf, Int32 level)
Bool	Write (HyperFile *hf) const

Friends
class	CustomDataTypeFieldClass

Constructor & Destructor Documentation

~iFieldCustomDatatype()

~iFieldCustomDatatype

(

)

Destructor.

iFieldCustomDatatype()

iFieldCustomDatatype ( )

protected

Default constructor.

Member Function Documentation

Alloc()

static iFieldCustomDatatype* Alloc ( )

static

Allocate iFieldCustomDatatype. If this function is used, no need to call Init. Use Free(iFieldCustomDatatype*&) for de-allocation.

Returns

allocated iFieldCustomDatatype

Free()

static void Free ( iFieldCustomDatatype *&  pData )

static

Init()

Bool Init ( )

protected

Allocate mandatory data. This is required before use if allocation is not done with iFieldCustomDatatype::Alloc()

Returns

A maxon::Result<void>

CopyFrom()

Bool CopyFrom ( const iFieldCustomDatatype *  source, COPYFLAGS  flags, AliasTrans *  trans  )

protected

Copies this from a passed source instance of the iFieldCustomDatatype.

Parameters

[in]	source	Another instance to copy from.
[in]	flags	The flags.
[in]	trans	If non-null, the AliasTrans to translate any document linkages.

Returns

A maxon::Result<void>

Read()

Bool Read ( HyperFile *  hf, Int32  level  )

protected

Reads the field customdatatype from the passed hyperfile.

Parameters

[in]	hf	The hyperfile to read from.
[in]	level	The file level.

Returns

A maxon::Result<void>

Write()

Bool Write ( HyperFile *  hf ) const

protected

Writes the field customdatatype from the passed hyperfile.

Parameters

[in]

hf

The hyperfile to write to.

Returns

A maxon::Result<void>

Friends And Related Function Documentation

CustomDataTypeFieldClass

friend class CustomDataTypeFieldClass

friend

Member Data Documentation

_fieldHead

FieldlayerRootNode* _fieldHead

_idCounter

Int32 _idCounter

The root holding the fields.

_fieldFlags

FIELDLIST_FLAGS _fieldFlags

The ID counter used to add new entries.