Because text, background and other colours tend to differ between platforms, wxSystemColourProperty must be able to select between system colour and, when necessary, to pick a custom one. More...

#include <wx/propgrid/advprops.h>

Inheritance diagram for wxColourPropertyValue:

Detailed Description

Because text, background and other colours tend to differ between platforms, wxSystemColourProperty must be able to select between system colour and, when necessary, to pick a custom one.

wxSystemColourProperty value makes this possible.

Public Member Functions
	wxColourPropertyValue ()

	wxColourPropertyValue (const wxColourPropertyValue &v)

	wxColourPropertyValue (const wxColour &colour)

	wxColourPropertyValue (wxUint32 type)

	wxColourPropertyValue (wxUint32 type, const wxColour &colour)

virtual	~wxColourPropertyValue ()

void	Init (wxUint32 type, const wxColour &colour)

void	operator= (const wxColourPropertyValue &cpv)

Public Member Functions inherited from wxObject
	wxObject ()
	Default ctor; initializes to NULL the internal reference data.

	wxObject (const wxObject &other)
	Copy ctor.

virtual	~wxObject ()
	Destructor.

virtual wxClassInfo *	GetClassInfo () const
	This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar).

wxObjectRefData *	GetRefData () const
	Returns the wxObject::m_refData pointer, i.e. the data referenced by this object.

bool	IsKindOf (const wxClassInfo *info) const
	Determines whether this class is a subclass of (or the same class as) the given class.

bool	IsSameAs (const wxObject &obj) const
	Returns true if this object has the same data pointer as obj.

void	Ref (const wxObject &clone)
	Makes this object refer to the data in clone.

void	SetRefData (wxObjectRefData *data)
	Sets the wxObject::m_refData pointer.

void	UnRef ()
	Decrements the reference count in the associated data, and if it is zero, deletes the data.

void	UnShare ()
	This is the same of AllocExclusive() but this method is public.

void	operator delete (void *buf)
	The delete operator is defined for debugging versions of the library only, when the identifier `__WXDEBUG__` is defined.

void *	operator new (size_t size, const wxString &filename=NULL, int lineNum=0)
	The new operator is defined for debugging versions of the library only, when the identifier `__WXDEBUG__` is defined.

Public Attributes
wxUint32	m_type
	An integer value relating to the colour, and which exact meaning depends on the property with which it is used.

wxColour	m_colour
	Resulting colour.

Additional Inherited Members
Protected Member Functions inherited from wxObject
void	AllocExclusive ()
	Ensure that this object's data is not shared with any other object.

virtual wxObjectRefData *	CreateRefData () const
	Creates a new instance of the wxObjectRefData-derived class specific to this object and returns it.

virtual wxObjectRefData *	CloneRefData (const wxObjectRefData *data) const
	Creates a new instance of the wxObjectRefData-derived class specific to this object and initializes it copying data.

Protected Attributes inherited from wxObject
wxObjectRefData *	m_refData
	Pointer to an object which is the object's reference-counted data.

Constructor & Destructor Documentation

◆ wxColourPropertyValue() [1/5]

wxColourPropertyValue::wxColourPropertyValue ( )

◆ wxColourPropertyValue() [2/5]

wxColourPropertyValue::wxColourPropertyValue ( const wxColourPropertyValue & v )

◆ wxColourPropertyValue() [3/5]

wxColourPropertyValue::wxColourPropertyValue ( const wxColour & colour )

◆ wxColourPropertyValue() [4/5]

wxColourPropertyValue::wxColourPropertyValue ( wxUint32 type )

◆ wxColourPropertyValue() [5/5]

wxColourPropertyValue::wxColourPropertyValue	(	wxUint32	type,
		const wxColour &	colour )

◆ ~wxColourPropertyValue()

virtual wxColourPropertyValue::~wxColourPropertyValue ( )

virtual

Member Function Documentation

◆ Init()

void wxColourPropertyValue::Init	(	wxUint32	type,
		const wxColour &	colour )

◆ operator=()

void wxColourPropertyValue::operator= ( const wxColourPropertyValue & cpv )

Member Data Documentation

◆ m_colour

wxColour wxColourPropertyValue::m_colour

Resulting colour.

Should be correct regardless of type.

◆ m_type

wxUint32 wxColourPropertyValue::m_type

An integer value relating to the colour, and which exact meaning depends on the property with which it is used.

For wxSystemColourProperty:

Any of wxSYS_COLOUR_XXX, or any web-colour ( use wxPG_TO_WEB_COLOUR macro - (currently unsupported) ), or wxPG_COLOUR_CUSTOM.

For custom colour properties without values array specified:

index or wxPG_COLOUR_CUSTOM

For custom colour properties with values array specified:

m_arrValues[index] or wxPG_COLOUR_CUSTOM

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

interface/wx/propgrid/advprops.h