Detailed Description

A property grid event holds information about events associated with wxPropertyGrid objects.

Public Member Functions
	wxPropertyGridEvent (wxEventType commandType=0, int id=0)
	Constructor.

	wxPropertyGridEvent (const wxPropertyGridEvent &event)
	Copy constructor.

	~wxPropertyGridEvent ()
	Destructor.

bool	CanVeto () const
	Returns true if you can veto the action that the event is signaling.

unsigned int	GetColumn () const
	Returns the column index associated with this event.

wxPGProperty *	GetMainParent () const
	Returns highest level non-category, non-root parent of property for which event occurred.

wxPGProperty *	GetProperty () const
	Returns property associated with this event.

wxPGVFBFlags	GetValidationFailureBehavior () const
	Returns current validation failure flags.

wxString	GetPropertyName () const
	Returns name of the associated property.

wxVariant	GetPropertyValue () const wxVariant GetValue() const
	Returns value of the associated property.

void	SetCanVeto (bool canVeto)
	Set if event can be vetoed.

void	SetProperty (wxPGProperty *p)
	Changes the property associated with this event.

void	SetValidationFailureBehavior (wxPGVFBFlags flags)
	Set override validation failure behaviour.

void	SetValidationFailureMessage (const wxString &message)
	Sets custom failure message for this time only.

void	Veto (bool veto=true)
	Call this from your event handler to veto action that the event is signaling.

bool	WasVetoed () const
	Returns true if event was vetoed.

Public Member Functions inherited from wxCommandEvent
	wxCommandEvent (wxEventType commandEventType=wxEVT_NULL, int id=0)
	Constructor.

void *	GetClientData () const
	Returns client data pointer for a listbox or choice selection event (not valid for a deselection).

wxClientData *	GetClientObject () const
	Returns client object pointer for a listbox or choice selection event (not valid for a deselection).

long	GetExtraLong () const
	Returns extra information dependent on the event objects type.

int	GetInt () const
	Returns the integer identifier corresponding to a listbox, choice or radiobox selection (only if the event was a selection, not a deselection), or a boolean value representing the value of a checkbox.

int	GetSelection () const
	Returns item index for a listbox or choice selection event (not valid for a deselection).

wxString	GetString () const
	Returns item string for a listbox or choice selection event.

bool	IsChecked () const
	This method can be used with checkbox and menu events: for the checkboxes, the method returns true for a selection event and false for a deselection one.

bool	IsSelection () const
	For a listbox or similar event, returns true if it is a selection, false if it is a deselection.

void	SetClientData (void *clientData)
	Sets the client data for this event.

void	SetClientObject (wxClientData *clientObject)
	Sets the client object for this event.

void	SetExtraLong (long extraLong)
	Sets the m_extraLong member.

void	SetInt (int intCommand)
	Sets the m_commandInt member.

void	SetString (const wxString &string)
	Sets the m_commandString member.

Public Member Functions inherited from wxEvent
	wxEvent (int id=0, wxEventType eventType=wxEVT_NULL)
	Constructor.

virtual wxEvent *	Clone () const =0
	Returns a copy of the event.

wxObject *	GetEventObject () const
	Returns the object (usually a window) associated with the event, if any.

wxEventType	GetEventType () const
	Returns the identifier of the given event type, such as `wxEVT_BUTTON`.

virtual wxEventCategory	GetEventCategory () const
	Returns a generic category for this event.

int	GetId () const
	Returns the identifier associated with this event, such as a button command id.

wxObject *	GetEventUserData () const
	Return the user data associated with a dynamically connected event handler.

bool	GetSkipped () const
	Returns true if the event handler should be skipped, false otherwise.

long	GetTimestamp () const
	Gets the timestamp for the event.

bool	IsCommandEvent () const
	Returns true if the event is or is derived from wxCommandEvent else it returns false.

void	ResumePropagation (int propagationLevel)
	Sets the propagation level to the given value (for example returned from an earlier call to wxEvent::StopPropagation).

void	SetEventObject (wxObject *object)
	Sets the originating object.

void	SetEventType (wxEventType type)
	Sets the event type.

void	SetId (int id)
	Sets the identifier associated with this event, such as a button command id.

void	SetTimestamp (long timeStamp=0)
	Sets the timestamp for the event.

bool	ShouldPropagate () const
	Test if this event should be propagated or not, i.e. if the propagation level is currently greater than 0.

void	Skip (bool skip=true)
	This method can be used inside an event handler to control whether further event handlers bound to this event will be called after the current one returns.

int	StopPropagation ()
	Stop the event from propagating to its parent window.

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.

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 wxEvent
int	m_propagationLevel
	Indicates how many levels the event can propagate.

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

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

unsigned int wxPropertyGridEvent::GetColumn ( ) const

Returns the column index associated with this event.

For the column dragging events, it is the column to the left of the splitter being dragged

wxPGProperty* wxPropertyGridEvent::GetMainParent ( ) const

Returns highest level non-category, non-root parent of property for which event occurred.

Useful when you have nested properties with children.

Remarks: If immediate parent is root or category, this will return the property itself.

wxPGProperty* wxPropertyGridEvent::GetProperty ( ) const

Returns property associated with this event.

Remarks: You should assume that this property can always be NULL. For instance, wxEVT_PG_SELECTED is emitted not only when a new property is selected, but also when selection is cleared by user activity.

wxString wxPropertyGridEvent::GetPropertyName ( ) const

Returns name of the associated property.

Remarks: Property name is stored in event, so it remains accessible even after the associated property or the property grid has been deleted.

wxVariant wxPropertyGridEvent::GetPropertyValue ( ) const

Returns value of the associated property.

Works for all event types, but for wxEVT_PG_CHANGING this member function returns the value that is pending, so you can call Veto() if the value is not satisfactory.

Remarks: Property value is stored in event, so it remains accessible even after the associated property or the property grid has been deleted.

See Also: GetPropertyValue()

wxPGVFBFlags wxPropertyGridEvent::GetValidationFailureBehavior ( ) const

Returns current validation failure flags.

void wxPropertyGridEvent::SetCanVeto ( bool canVeto )

Set if event can be vetoed.

void wxPropertyGridEvent::SetProperty ( wxPGProperty * p )

Changes the property associated with this event.

void wxPropertyGridEvent::SetValidationFailureBehavior ( wxPGVFBFlags flags )

Set override validation failure behaviour.

Only effective if Veto() was also called, and only allowed if event type is wxEVT_PG_CHANGING.

void wxPropertyGridEvent::SetValidationFailureMessage ( const wxString & message )

Sets custom failure message for this time only.

Only applies if wxPG_VFB_SHOW_MESSAGE is set in validation failure flags.

void wxPropertyGridEvent::Veto ( bool veto = true )

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.

Remarks: Currently only wxEVT_PG_CHANGING supports vetoing.

bool wxPropertyGridEvent::WasVetoed ( ) const

Returns true if event was vetoed.

Detailed Description

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation