PLGui::DataObject Class Reference

Represents a data object, use e.g. for the clipboard and drag&drop events. More...

#include <DataObject.h>

List of all members.

Public Member Functions
PLGUI_API	DataObject ()
	Constructor.
PLGUI_API	DataObject (const PLCore::String &sString)
	Constructor.
PLGUI_API	DataObject (const PLCore::Container< PLCore::String > &lstFiles)
	Constructor.
PLGUI_API	DataObject (PLCore::uint32 nValue)
	Constructor.
PLGUI_API	DataObject (PLCore::uint8 *pData, PLCore::uint32 nSize)
	Constructor.
PLGUI_API	DataObject (const DataObject &cOther)
	Copy constructor.
PLGUI_API	~DataObject ()
	Destructor.
PLGUI_API bool	operator== (const DataObject &cOther) const
	Comparison operator.
PLGUI_API DataObject &	operator= (const DataObject &cOther)
	Assignment operator.
PLGUI_API EDataType	GetType () const
	Get data type.
PLGUI_API PLCore::String	GetString () const
	Get string data.
PLGUI_API void	Set (const PLCore::String &sString)
	Set string data.
PLGUI_API const PLCore::Container < PLCore::String > &	GetFiles () const
	Get file names.
PLGUI_API void	Set (const PLCore::Container< PLCore::String > &lstFiles)
	Set file names.
PLGUI_API PLCore::uint32	GetValue () const
	Get custom data.
PLGUI_API void	Set (PLCore::uint32 nValue)
	Set custom data.
PLGUI_API PLCore::uint32	GetBinarySize () const
	Get binary data size.
PLGUI_API PLCore::uint8 *	GetBinaryData () const
	Get binary data.
PLGUI_API void	Set (PLCore::uint8 *pData, PLCore::uint32 nSize)
	Set binary data.
PLGUI_API void	Clear ()
	Clear data.

---

Detailed Description

Represents a data object, use e.g. for the clipboard and drag&drop events.

---

Constructor & Destructor Documentation

PLGUI_API PLGui::DataObject::DataObject

(

)

Constructor.

PLGUI_API PLGui::DataObject::DataObject

(

const PLCore::String &

sString

)

Constructor.

Parameters:

[in]

sString

String

PLGUI_API PLGui::DataObject::DataObject

(

const PLCore::Container< PLCore::String > &

lstFiles

)

Constructor.

Parameters:

[in]

lstFiles

List of file names

PLGUI_API PLGui::DataObject::DataObject

(

PLCore::uint32

nValue

)

Constructor.

Parameters:

[in]

nValue

Data value

PLGUI_API PLGui::DataObject::DataObject	(	PLCore::uint8 *	pData,
		PLCore::uint32	nSize
	)

Constructor.

Parameters:

[in]	pData	Data buffer
[in]	nSize	Size of data buffer

PLGUI_API PLGui::DataObject::DataObject

(

const DataObject &

cOther

)

Copy constructor.

Parameters:

[in]

cOther

Data object

PLGUI_API PLGui::DataObject::~DataObject

(

)

Destructor.

---

Member Function Documentation

PLGUI_API bool PLGui::DataObject::operator==

(

const DataObject &

cOther

)

const

Comparison operator.

Parameters:

[in]

cOther

Data object

Returns:

'true' if equal, else 'false'

PLGUI_API DataObject& PLGui::DataObject::operator=

(

const DataObject &

cOther

)

Assignment operator.

Parameters:

[in]

cOther

Data object

Returns:

Reference to this object

PLGUI_API EDataType PLGui::DataObject::GetType

(

)

const

Get data type.

Returns:

Data type

PLGUI_API PLCore::String PLGui::DataObject::GetString

(

)

const

Get string data.

Returns:

String, empty string if data type is other than DataString

PLGUI_API void PLGui::DataObject::Set

(

const PLCore::String &

sString

)

Set string data.

Parameters:

[in]

sString

String

PLGUI_API const PLCore::Container<PLCore::String>& PLGui::DataObject::GetFiles

(

)

const

Get file names.

Returns:

List of file names, empty list if data type is other than DataFiles

PLGUI_API void PLGui::DataObject::Set

(

const PLCore::Container< PLCore::String > &

lstFiles

)

Set file names.

Parameters:

[in]

lstFiles

List of file names

PLGUI_API PLCore::uint32 PLGui::DataObject::GetValue

(

)

const

Get custom data.

Returns:

Data value, 0 if data type is other than DataCustom

PLGUI_API void PLGui::DataObject::Set

(

PLCore::uint32

nValue

)

Set custom data.

Parameters:

[in]

nValue

Data value

PLGUI_API PLCore::uint32 PLGui::DataObject::GetBinarySize

(

)

const

Get binary data size.

Returns:

Size of custom data, 0 if data type is other than DataBinary

PLGUI_API PLCore::uint8* PLGui::DataObject::GetBinaryData

(

)

const

Get binary data.

Returns:

Data pointer, a null pointer if data type is other than DataBinary

PLGUI_API void PLGui::DataObject::Set	(	PLCore::uint8 *	pData,
		PLCore::uint32	nSize
	)

Set binary data.

Parameters:

[in]	pData	Data buffer
[in]	nSize	Size of data buffer

Remarks:

A new buffer of the given size will be allocated and the data will be copied to that buffer. The class takes care of deleting the allocated memory later.

PLGUI_API void PLGui::DataObject::Clear

(

)

Clear data.

---

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

• DataObject.h