SkyGI::DataCollection Class Reference

Inheritance diagram for SkyGI::DataCollection:[legend]Collaboration diagram for SkyGI::DataCollection:[legend]List of all members.

Public Member Functions
	DataCollection ()
	DataCollection (void *vpPackedData, int iPackedSize)
	~DataCollection ()
void	Add (const String &cKey, const Variant &pVariant)
void	Set (const String &cKey, const Variant &pVariant)
bool	Get (const String &cKey, Variant &pVariant, int iIndex=0)
bool	Get (const String &cKey, String &cString, int iIndex=0)
bool	Get (const String &cKey, int &iValue, int iIndex=0)
bool	Get (const String &cKey, long long &llValue, int iIndex=0)
bool	Get (const String &cKey, bool &bBool, int iIndex=0)
bool	Get (const String &cKey, Color &nColor, int iIndex=0)
bool	Has (const String &cKey, int iIndex=0)
bool	Remove (const String &cKey, int iIndex=0)
void *	Pack (int &iSize) const
bool	Unpack (void *vpPackedData, int iPackedSize)
bool	IsValid ()
bool	Load (const String &szVendorName, const String &szApplicationName, const String &szDataCollectionName, unsigned int uiDataCollectionFlags)
bool	Write (const String &szVendorName, const String &szApplicationName, const String &szDataCollectionName, unsigned int uiDataCollectionFlags)
void	Clear ()
void *	GetNative ()
void	SetNative (void *vpData)
Variant	GetVariant (const String &cKey, int iIndex=0)
void	Dump ()
bool	Get (int iIndex, String &szName, Variant &pVariant)
bool	True (const String &cKey, int iIndex=0)
bool	Attach (const String &szVendorName, const String &szApplicationName, const String &szDataCollectionName, unsigned int uiDataCollectionFlags)
Static Public Member Functions
static bool	Exists (const String &szVendorName, const String &szApplicationName, const String &szDataCollectionName, unsigned int uiDataCollectionFlags)
static bool	IsDataCollection (const String &szVendorName, const String &szApplicationName, const String &szDataCollectionName, unsigned int uiDataCollectionFlags)
Classes
class	Private
struct	sSerializedHeader
struct	sSerializedItemHeader

---

Detailed Description

Examples:

clipboard.cpp, and dnd.cpp.

---

Constructor & Destructor Documentation

DataCollection::DataCollection

(

)

DataCollection::DataCollection	(	void *	vpPackedData,
		int	iPackedSize
	)

DataCollection::~DataCollection

(

)

---

Member Function Documentation

void DataCollection::Add	(	const String &	cKey,
		const Variant &	pVariant
	)

Examples:

clipboard.cpp, and dnd.cpp.

void DataCollection::Set	(	const String &	cKey,
		const Variant &	pVariant
	)

Examples:

clipboard.cpp.

bool DataCollection::Get	(	const String &	cKey,
		Variant &	pVariant,
		int	iIndex = 0
	)

Examples:

clipboard.cpp, and dnd.cpp.

bool DataCollection::Get	(	const String &	cKey,
		String &	cString,
		int	iIndex = 0
	)

bool DataCollection::Get	(	const String &	cKey,
		int &	iValue,
		int	iIndex = 0
	)

bool DataCollection::Get	(	const String &	cKey,
		long long &	llValue,
		int	iIndex = 0
	)

bool DataCollection::Get	(	const String &	cKey,
		bool &	bBool,
		int	iIndex = 0
	)

bool DataCollection::Get	(	const String &	cKey,
		Color &	nColor,
		int	iIndex = 0
	)

bool DataCollection::Has	(	const String &	cKey,
		int	iIndex = 0
	)

bool DataCollection::Remove	(	const String &	cKey,
		int	iIndex = 0
	)

void * DataCollection::Pack

(

int &

iSize

)

const

bool DataCollection::Unpack	(	void *	vpPackedData,
		int	iPackedSize
	)

bool DataCollection::IsValid

(

)

bool DataCollection::Load	(	const String &	szVendorName,
		const String &	szApplicationName,
		const String &	szDataCollectionName,
		unsigned int	uiDataCollectionFlags
	)

Load datacollection from a file

Description:

If the datacollection doesn't exist and DATACOLLECTION_MUST_EXIST is not specified a new one will be created. If USER_LOCAL_SETTINGS is specified datacollection will be loaded from:

• /boot/home/<user>/application settings/<szVendorName>/<szApplicationName>/<szDataCollectionName> If USER_LOCAL_SETTINGS is not specified datacollection will be loaded from:
  
• /boot/home/all/application settings/<szVendorName>/<szApplicationName>/<szDataCollectionName>

bool DataCollection::Write	(	const String &	szVendorName,
		const String &	szApplicationName,
		const String &	szDataCollectionName,
		unsigned int	uiDataCollectionFlags
	)

Write datacollection to file

Description:

If USER_LOCAL_SETTINGS is specified datacollection will be saved to:

• /boot/home/<user>/application settings/<szVendorName>/<szApplicationName>/<szDataCollectionName>
  If USER_LOCAL_SETTINGS is not specified datacollection will be saved to:
  
• /boot/home/all/application settings/<szVendorName>/<szApplicationName>/<szDataCollectionName>
  

bool DataCollection::Exists	(	const String &	szVendorName,
		const String &	szApplicationName,
		const String &	szDataCollectionName,
		unsigned int	uiDataCollectionFlags
	)			[static]

bool DataCollection::IsDataCollection	(	const String &	szVendorName,
		const String &	szApplicationName,
		const String &	szDataCollectionName,
		unsigned int	uiDataCollectionFlags
	)			[static]

void DataCollection::Clear

(

)

void* SkyGI::DataCollection::GetNative

(

)

void SkyGI::DataCollection::SetNative

(

void *

vpData

)

Variant SkyGI::DataCollection::GetVariant	(	const String &	cKey,
		int	iIndex = 0
	)

void DataCollection::Dump

(

)

bool DataCollection::Get	(	int	iIndex,
		String &	szName,
		Variant &	pVariant
	)

bool DataCollection::True	(	const String &	cKey,
		int	iIndex = 0
	)

bool DataCollection::Attach	(	const String &	szVendorName,
		const String &	szApplicationName,
		const String &	szDataCollectionName,
		unsigned int	uiDataCollectionFlags
	)

Attach datacollection from a file

Description:

Attaches a datacollection to this one If USER_LOCAL_SETTINGS is specified datacollection will be loaded from:

• /boot/home/<user>/application settings/<szVendorName>/<szApplicationName>/<szDataCollectionName> If USER_LOCAL_SETTINGS is not specified datacollection will be loaded from:
  
• /boot/home/all/application settings/<szVendorName>/<szApplicationName>/<szDataCollectionName>

---