wxVariantObjectSetAccessor Class Reference

#include <variantutils/variantpropertyobj.h>

List of all members.

Public Member Functions
	wxVariantObjectSetAccessor (wxVariant &objectSet)
	wxVariantObjectSetAccessor (wxVariant *objectSet)
	wxVariantObjectSetAccessor (const wxVariant *objectSet)
bool	IsValid () const
	Is this an object set?
bool	MakeObjectSet ()
	If not already an object set (could be null), make sure it is.
bool	Clear ()
	Clear the set.
wxVariant *	GetVariant (int n)
	Access the nth variant object in the set.
wxVariant	GetVariant (int n) const
void	SetVariant (int n, const wxVariant &variant)
	Set the nth variant object.
wxVariant *	FindVariant (const wxString &property, const wxVariant &value)
	Find the variant object by property name/value pair (e.g. Name, Julian).
wxVariant *	FindVariant (const wxString &property, const wxString &value)
int	FindVariantIndex (wxVariant *var)
	Find the variant index by pointer.
void	AddVariant (wxVariant *variant)
	Add a variant.
void	InsertVariant (wxVariant *variant, int pos)
	Insert a variant at the given position.
bool	DeleteVariant (int pos)
	Delete a variant at the given position.
wxVariant *	GetProperty (int var, int property)
	Delete a variant by name/value.
wxVariant *	FindProperty (int var, const wxString &propertyName)
	Find the named property in the given variant object.
int	GetPropertyIndex (int var, const wxString &propertyName)
	Find the index of the property in the given variant object.
bool	SetProperty (int var, const wxString &propertyName, const wxVariant &value)
	Set the named property in the given variant object.
bool	SetProperty (int var, const wxString &propertyName, const wxString &value)
bool	SetProperty (int var, int property, const wxVariant &value)
bool	SetProperty (int var, int property, const wxString &value)
bool	SetPropertyImage (int var, int property, const wxImage &image, int type=wxBITMAP_TYPE_JPEG)
	Set the property image.
bool	SetPropertyImage (int var, int property, const wxString &filename, int type=wxBITMAP_TYPE_JPEG)
bool	SetPropertyImage (int var, const wxString &propertyName, const wxImage &image, int type=wxBITMAP_TYPE_JPEG)
bool	SetPropertyImage (int var, const wxString &propertyName, const wxString &filename, int type=wxBITMAP_TYPE_JPEG)
wxImage *	GetPropertyImage (int var, int property)
	Get the image, if any.
wxImage *	FindPropertyImage (int var, const wxString &propertyName)
wxImageBlock *	GetPropertyImageBlock (int var, int property)
	Get the image block.
wxImageBlock *	FindPropertyImageBlock (int var, const wxString &propertyName)
bool	MakePropertyImage (int var, int property, bool force=false)
	Ensure image has been created from the data.
bool	MakePropertyImage (int var, const wxString &propertyName, bool force=false)
wxVariant	Copy () const
	Make a copy of the object set.
int	GetCount () const
	Get the object set count.
void	AllocExclusive () const
	Make sure we're the exclusive owner of the data.
wxVariant *	GetObjectSet ()
void	SetObjectSet (wxVariant *objectSet)
wxVariantObjectSetData *	GetData () const
	Get the data.

---

Detailed Description

wxVariantObjectSetAccessor: a class to make it easy to manipulate an "objectset" wxVariant

---

Constructor & Destructor Documentation

wxVariantObjectSetAccessor::wxVariantObjectSetAccessor

(

wxVariant &

objectSet

)

[inline]

wxVariantObjectSetAccessor::wxVariantObjectSetAccessor

(

wxVariant *

objectSet

)

[inline]

wxVariantObjectSetAccessor::wxVariantObjectSetAccessor

(

const wxVariant *

objectSet

)

[inline]

---

Member Function Documentation

void wxVariantObjectSetAccessor::AddVariant

(

wxVariant *

variant

)

Add a variant.

void wxVariantObjectSetAccessor::AllocExclusive

(

)

const

Make sure we're the exclusive owner of the data.

bool wxVariantObjectSetAccessor::Clear

(

)

Clear the set.

wxVariant wxVariantObjectSetAccessor::Copy

(

)

const

Make a copy of the object set.

bool wxVariantObjectSetAccessor::DeleteVariant

(

int

pos

)

Delete a variant at the given position.

wxVariant * wxVariantObjectSetAccessor::FindProperty	(	int	var,
		const wxString &	propertyName
	)

Find the named property in the given variant object.

wxImage * wxVariantObjectSetAccessor::FindPropertyImage	(	int	var,
		const wxString &	propertyName
	)

wxImageBlock * wxVariantObjectSetAccessor::FindPropertyImageBlock	(	int	var,
		const wxString &	propertyName
	)

wxVariant * wxVariantObjectSetAccessor::FindVariant	(	const wxString &	property,
		const wxString &	value
	)

wxVariant * wxVariantObjectSetAccessor::FindVariant	(	const wxString &	property,
		const wxVariant &	value
	)

Find the variant object by property name/value pair (e.g. Name, Julian).

int wxVariantObjectSetAccessor::FindVariantIndex

(

wxVariant *

var

)

Find the variant index by pointer.

int wxVariantObjectSetAccessor::GetCount

(

)

const

Get the object set count.

wxVariantObjectSetData * wxVariantObjectSetAccessor::GetData

(

)

const

Get the data.

Get the ref data (containing the real data).

wxVariant* wxVariantObjectSetAccessor::GetObjectSet

(

)

[inline]

wxVariant * wxVariantObjectSetAccessor::GetProperty	(	int	var,
		int	property
	)

Delete a variant by name/value.

Get the property for the given variant object.

Get the property for the given variant object

wxImage * wxVariantObjectSetAccessor::GetPropertyImage	(	int	var,
		int	property
	)

Get the image, if any.

wxImageBlock * wxVariantObjectSetAccessor::GetPropertyImageBlock	(	int	var,
		int	property
	)

Get the image block.

int wxVariantObjectSetAccessor::GetPropertyIndex	(	int	var,
		const wxString &	propertyName
	)

Find the index of the property in the given variant object.

wxVariant wxVariantObjectSetAccessor::GetVariant

(

int

n

)

const

wxVariant * wxVariantObjectSetAccessor::GetVariant

(

int

n

)

Access the nth variant object in the set.

void wxVariantObjectSetAccessor::InsertVariant	(	wxVariant *	variant,
		int	pos
	)

Insert a variant at the given position.

bool wxVariantObjectSetAccessor::IsValid

(

)

const

Is this an object set?

wxVariantObjectSetAccessor: a class to make it easy to manipulate an "objectset" wxVariant

bool wxVariantObjectSetAccessor::MakeObjectSet

(

)

If not already an object set (could be null), make sure it is.

bool wxVariantObjectSetAccessor::MakePropertyImage	(	int	var,
		const wxString &	propertyName,
		bool	force = false
	)

bool wxVariantObjectSetAccessor::MakePropertyImage	(	int	var,
		int	property,
		bool	force = false
	)

Ensure image has been created from the data.

void wxVariantObjectSetAccessor::SetObjectSet

(

wxVariant *

objectSet

)

[inline]

bool wxVariantObjectSetAccessor::SetProperty	(	int	var,
		int	property,
		const wxString &	value
	)

bool wxVariantObjectSetAccessor::SetProperty	(	int	var,
		int	property,
		const wxVariant &	value
	)

bool wxVariantObjectSetAccessor::SetProperty	(	int	var,
		const wxString &	propertyName,
		const wxString &	value
	)

bool wxVariantObjectSetAccessor::SetProperty	(	int	var,
		const wxString &	propertyName,
		const wxVariant &	value
	)

Set the named property in the given variant object.

bool wxVariantObjectSetAccessor::SetPropertyImage	(	int	var,
		const wxString &	propertyName,
		const wxString &	filename,
		int	type = wxBITMAP_TYPE_JPEG
	)

bool wxVariantObjectSetAccessor::SetPropertyImage	(	int	var,
		const wxString &	propertyName,
		const wxImage &	image,
		int	type = wxBITMAP_TYPE_JPEG
	)

bool wxVariantObjectSetAccessor::SetPropertyImage	(	int	var,
		int	property,
		const wxString &	filename,
		int	type = wxBITMAP_TYPE_JPEG
	)

bool wxVariantObjectSetAccessor::SetPropertyImage	(	int	var,
		int	property,
		const wxImage &	image,
		int	type = wxBITMAP_TYPE_JPEG
	)

Set the property image.

void wxVariantObjectSetAccessor::SetVariant	(	int	n,
		const wxVariant &	variant
	)

Set the nth variant object.

---

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

• include/variantutils/variantpropertyobj.h
• src/variantutils/variantpropertyobj.cpp