wxPropertyGridEvent Class Reference

A propertygrid event holds information about events associated with wxPropertyGrid objects. More...

#include <propgrid.h>

Public Member Functions
bool	CanVeto () const
virtual wxEvent *	Clone () const
void	DisableProperty ()
void	EnableProperty (bool enable=true)
unsigned int	GetColumn () const
wxPGProperty *	GetMainParent () const
wxPGProperty *	GetProperty () const
wxPGProperty::ClientDataType	GetPropertyClientData () const
const wxString &	GetPropertyLabel () const
wxString	GetPropertyName () const
wxVariant	GetPropertyValue () const
wxArrayInt	GetPropertyValueAsArrayInt () const
wxArrayString	GetPropertyValueAsArrayString () const
long	GetPropertyValueAsBool () const
double	GetPropertyValueAsDouble () const
int	GetPropertyValueAsInt () const
long	GetPropertyValueAsLong () const
wxPoint	GetPropertyValueAsPoint () const
wxSize	GetPropertyValueAsSize () const
wxString	GetPropertyValueAsString () const
void *	GetPropertyValueAsVoidPtr () const
const wxObject *	GetPropertyValueAsWxObjectPtr () const
wxPGVFBFlags	GetValidationFailureBehavior () const
wxPGValidationInfo &	GetValidationInfo ()
const wxVariant &	GetValue () const
bool	HasProperty () const
bool	IsPropertyEnabled () const
void	SetCanVeto (bool canVeto)
void	SetColumn (unsigned int column)
void	SetProperty (wxPGProperty *p)
void	SetPropertyGrid (wxPropertyGrid *pg)
void	SetupValidationInfo ()
void	SetValidationFailureBehavior (int flags)
void	SetValidationFailureMessage (const wxString &message)
void	Veto (bool veto=true)
bool	WasVetoed () const
	wxPropertyGridEvent (const wxPropertyGridEvent &event)
	wxPropertyGridEvent (wxEventType commandType=0, int id=0)
	~wxPropertyGridEvent ()
Private Member Functions
void	Init ()
Private Attributes
bool	m_canVeto
unsigned int	m_column
wxPropertyGrid *	m_pg
wxPGProperty *	m_property
wxPGValidationInfo *	m_validationInfo
bool	m_wasVetoed

Detailed Description

A propertygrid event holds information about events associated with wxPropertyGrid objects.

Derived from

wxNotifyEvent
wxCommandEvent
wxEvent
wxObject

Include files

Definition at line 8390 of file propgrid.h.

Constructor & Destructor Documentation

wxPropertyGridEvent::wxPropertyGridEvent	(	wxEventType	commandType = `0`,
		int	id = `0`
	)

Constructor.

wxPropertyGridEvent::wxPropertyGridEvent ( const wxPropertyGridEvent & event )

Copy constructor.

wxPropertyGridEvent::~wxPropertyGridEvent ( )

Destructor.

Member Function Documentation

bool wxPropertyGridEvent::CanVeto ( ) const [inline]

Returns true if you can veto the action that the event is signaling.

Definition at line 8548 of file propgrid.h.

virtual wxEvent* wxPropertyGridEvent::Clone ( ) const [virtual]

Copyer.

void wxPropertyGridEvent::DisableProperty ( ) [inline]

Disables property.

Definition at line 8413 of file propgrid.h.

void wxPropertyGridEvent::EnableProperty ( bool enable = true ) [inline]

Enables property.

Definition at line 8407 of file propgrid.h.

unsigned int wxPropertyGridEvent::GetColumn ( ) const [inline]

Returns the column index associated with this event.

Definition at line 8421 of file propgrid.h.

wxPGProperty* wxPropertyGridEvent::GetMainParent ( ) const [inline]

Definition at line 8426 of file propgrid.h.

wxPGProperty* wxPropertyGridEvent::GetProperty ( ) const [inline]

Returns id of associated property.

Definition at line 8433 of file propgrid.h.

wxPGProperty::ClientDataType wxPropertyGridEvent::GetPropertyClientData ( ) const [inline]

Returns client data of relevant property.

Definition at line 8466 of file propgrid.h.

const wxString& wxPropertyGridEvent::GetPropertyLabel ( ) const [inline]

Returns label of associated property.

Definition at line 8452 of file propgrid.h.

wxString wxPropertyGridEvent::GetPropertyName ( ) const [inline]

Returns global name of associated property.

Definition at line 8459 of file propgrid.h.

wxVariant wxPropertyGridEvent::GetPropertyValue ( ) const [inline]

Returns value of relevant property.

Definition at line 8474 of file propgrid.h.

wxArrayInt wxPropertyGridEvent::GetPropertyValueAsArrayInt ( ) const [inline]

Definition at line 8520 of file propgrid.h.

wxArrayString wxPropertyGridEvent::GetPropertyValueAsArrayString ( ) const [inline]

Definition at line 8508 of file propgrid.h.

long wxPropertyGridEvent::GetPropertyValueAsBool ( ) const [inline]

Definition at line 8492 of file propgrid.h.

double wxPropertyGridEvent::GetPropertyValueAsDouble ( ) const [inline]

Definition at line 8496 of file propgrid.h.

int wxPropertyGridEvent::GetPropertyValueAsInt ( ) const [inline]

Definition at line 8488 of file propgrid.h.

long wxPropertyGridEvent::GetPropertyValueAsLong ( ) const [inline]

Definition at line 8484 of file propgrid.h.

wxPoint wxPropertyGridEvent::GetPropertyValueAsPoint ( ) const [inline]

Definition at line 8512 of file propgrid.h.

wxSize wxPropertyGridEvent::GetPropertyValueAsSize ( ) const [inline]

Definition at line 8516 of file propgrid.h.

wxString wxPropertyGridEvent::GetPropertyValueAsString ( ) const [inline]

Definition at line 8480 of file propgrid.h.

void* wxPropertyGridEvent::GetPropertyValueAsVoidPtr ( ) const [inline]

Definition at line 8504 of file propgrid.h.

const wxObject* wxPropertyGridEvent::GetPropertyValueAsWxObjectPtr ( ) const [inline]

Definition at line 8500 of file propgrid.h.

wxPGVFBFlags wxPropertyGridEvent::GetValidationFailureBehavior ( ) const [inline]

Definition at line 8585 of file propgrid.h.

wxPGValidationInfo& wxPropertyGridEvent::GetValidationInfo ( ) [inline]

Definition at line 8532 of file propgrid.h.

const wxVariant& wxPropertyGridEvent::GetValue ( ) const [inline]

Returns value that is about to be set for wxEVT_PG_CHANGING.

Definition at line 8559 of file propgrid.h.

bool wxPropertyGridEvent::HasProperty ( ) const [inline]

Returns true if event has associated property.

Definition at line 8539 of file propgrid.h.

void wxPropertyGridEvent::Init ( ) [private]

bool wxPropertyGridEvent::IsPropertyEnabled ( ) const [inline]

Definition at line 8541 of file propgrid.h.

void wxPropertyGridEvent::SetCanVeto ( bool canVeto ) [inline]

Definition at line 8591 of file propgrid.h.

void wxPropertyGridEvent::SetColumn ( unsigned int column ) [inline]

Definition at line 8606 of file propgrid.h.

void wxPropertyGridEvent::SetProperty ( wxPGProperty * p ) [inline]

Changes the associated property.

Definition at line 8595 of file propgrid.h.

void wxPropertyGridEvent::SetPropertyGrid ( wxPropertyGrid * pg ) [inline]

Definition at line 8597 of file propgrid.h.

void wxPropertyGridEvent::SetupValidationInfo ( ) [inline]

Definition at line 8599 of file propgrid.h.

void wxPropertyGridEvent::SetValidationFailureBehavior ( int flags ) [inline]

Set override validation failure behavior. Only effective if Veto was also called, and only allowed if event type is wxEVT_PG_CHANGING.

Definition at line 8569 of file propgrid.h.

void wxPropertyGridEvent::SetValidationFailureMessage ( const wxString & message ) [inline]

Sets custom failure message for this time only. Only applies if wxPG_VFB_SHOW_MESSAGE is set in validation failure flags.

Definition at line 8578 of file propgrid.h.

void wxPropertyGridEvent::Veto ( bool veto = true ) [inline]

Call this from your event handler to veto action that the event is signaling. You can only veto a shutdown if wxPropertyGridEvent::CanVeto returns true.