ParaEngine::CDataColumnInfo Class Reference

Inheritance diagram for ParaEngine::CDataColumnInfo:

Public Member Functions
	CDataColumnInfo (IType *ptype)
	CDataColumnInfo (const string &szColumnName)
	CDataColumnInfo (const string &szColumnName, IType *ptype)
virtual const IType *	GetType () const
virtual IObject *	Clone () const
	Clone the object's contains and return a pointer to the newly created object. More...
virtual void	Clone (IObject *obj) const
	Clone the object's contains to a pointer. More...
virtual const char *	GetCaption () const
	Get or set caption of the column. More...
virtual void	SetCaption (const char *szText)
virtual const char *	GetColumnName () const
virtual void	SetColumnName (const char *szText)
virtual bool	GetReadOnly () const
virtual void	SetReadOnly (bool readonly)
virtual int	GetMaxLength () const
virtual void	SetMaxLength (int maxlength)
virtual bool	GetAllowNull () const
virtual void	SetAllowNull (bool allownull)
virtual const IType *	GetDataType () const
Public Member Functions inherited from ParaEngine::IObject
virtual bool	Equals (const IObject *obj) const
	Compare the object with another object. More...
virtual std::string	ToString () const
WeakPtr_type &	GetWeakReference ()
	get weak reference object. More...
virtual int	ProcessObjectEvent (const ObjectEvent &event)
	this function is only used to backward compatibility of ParaObject:AddEvent() function. More...
Public Member Functions inherited from ParaEngine::CRefCounted
void	addref () const
	add reference count of the object. More...
bool	delref () const
	decrease reference count of the object. More...
int	GetRefCount () const
	get the reference count
virtual int	Release ()
CRefCounted *	AddToAutoReleasePool ()
	addref and releases the ownership sometime soon automatically (usually at the end of the current frame). More...

Protected Attributes
IType *	m_datatype
CBaseTable *	m_parent
string	m_szCaption
string	m_szColumnName
bool	m_bReadonly
bool	m_bAllowNull
int	m_nMaxLength
IType *	m_type
Protected Attributes inherited from ParaEngine::IObject
WeakPtr_type	m_weak_reference
Protected Attributes inherited from ParaEngine::CRefCounted
int	m_refcount

Friends
class	CDataTable
class	CDataRow
class	CColumnCollection

Additional Inherited Members
Public Types inherited from ParaEngine::IObject
typedef ParaEngine::weak_ptr< IObject >	WeakPtr_type

Member Function Documentation

Clone() [1/2]

IObject * CDataColumnInfo::Clone ( ) const

virtual

Clone the object's contains and return a pointer to the newly created object.

The caller should free the memory of the return object. Inheritance should implement this function void Clone(IObject*) and IObject* Clone() should have the same behavior

Reimplemented from ParaEngine::IObject.

Clone() [2/2]

void CDataColumnInfo::Clone ( IObject *  obj ) const

virtual

Clone the object's contains to a pointer.

The caller should allocate the memory and pass the pointer to this function.. Inheritance should implement this function void Clone(IObject*) and IObject* Clone() should have the same behavior In some cases, if you want to avoid Dead Reference( one object is being referred to by many objects and you can't update all the references). It is possible to use this function to replace the contains at a given pointer. But this may result in memory leak if you do not implement this function carefully or misuse it.

Reimplemented from ParaEngine::IObject.

GetCaption()

const char * CDataColumnInfo::GetCaption ( ) const

virtual

Get or set caption of the column.

Caption is what is displayed in the header of the column If m_szCaption's length==0, return ColumnName instead

---

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

• Client/trunk/ParaEngineClient/CommonFramework/DataTable.h
• Client/trunk/ParaEngineClient/CommonFramework/DataTable.cpp