wxPropertyGrid
Public Member Functions | List of all members
wxPropertyGridEvent Class Reference

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

#include <propgrid.h>

Inheritance diagram for wxPropertyGridEvent:

Public Member Functions

bool CanVeto () const
 Returns true if you can veto the action that the event is signaling.
 
virtual wxEvent * Clone () const
 Copyer. More...
 
void DisableProperty ()
 Disables property. More...
 
void EnableProperty (bool enable=true)
 Enables property. More...
 
unsigned int GetColumn () const
 Returns the column index associated with this event.
 
wxPGPropertyGetMainParent () const
 
wxPGPropertyGetProperty () const
 Returns id of associated property. More...
 
wxPGProperty::ClientDataType GetPropertyClientData () const
 Returns client data of relevant property. More...
 
const wxString & GetPropertyLabel () const
 Returns label of associated property. More...
 
wxString GetPropertyName () const
 Returns global name of associated property. More...
 
wxPGPropertyGetPropertyPtr () const
 Returns pointer to associated property. More...
 
wxVariant GetPropertyValue () const
 Returns value of relevant property. More...
 
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
 
unsigned char GetValidationFailureBehavior () const
 
wxPGValidationInfoGetValidationInfo ()
 
const wxVariant & GetValue () const
 Returns value that is about to be set for wxEVT_PG_CHANGING.
 
bool HasProperty () const
 Returns true if event has associated property. More...
 
bool IsPropertyEnabled () const
 
void SetCanVeto (bool canVeto)
 
void SetColumn (unsigned int column)
 
void SetProperty (wxPGProperty *p)
 Changes the associated property. More...
 
void SetPropertyGrid (wxPropertyGrid *pg)
 
void SetupValidationInfo ()
 
void SetValidationFailureBehavior (int flags)
 Set override validation failure behavior. More...
 
void SetValidationFailureMessage (const wxString &message)
 Sets custom failure message for this time only. More...
 
void Veto (bool veto=true)
 Call this from your event handler to veto action that the event is signaling. More...
 
bool WasVetoed () const
 
 wxPropertyGridEvent (wxEventType commandType=0, int id=0)
 Constructor. More...
 
 wxPropertyGridEvent (const wxPropertyGridEvent &event)
 Copy constructor. More...
 
 ~wxPropertyGridEvent ()
 Destructor. More...
 

Detailed Description

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

Derived from

wxNotifyEvent
wxCommandEvent
wxEvent
wxObject

Include files

<wx/propertygrid/propertygrid.h>

Constructor & Destructor Documentation

◆ wxPropertyGridEvent() [1/2]

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

Constructor.

◆ wxPropertyGridEvent() [2/2]

wxPropertyGridEvent::wxPropertyGridEvent ( const wxPropertyGridEvent event)

Copy constructor.

◆ ~wxPropertyGridEvent()

wxPropertyGridEvent::~wxPropertyGridEvent ( )

Destructor.

Member Function Documentation

◆ Clone()

virtual wxEvent* wxPropertyGridEvent::Clone ( ) const
virtual

Copyer.

◆ DisableProperty()

void wxPropertyGridEvent::DisableProperty ( )

Disables property.

◆ EnableProperty()

void wxPropertyGridEvent::EnableProperty ( bool  enable = true)

Enables property.

◆ GetProperty()

wxPGProperty* wxPropertyGridEvent::GetProperty ( ) const

Returns id of associated property.

◆ GetPropertyClientData()

wxPGProperty::ClientDataType wxPropertyGridEvent::GetPropertyClientData ( ) const

Returns client data of relevant property.

◆ GetPropertyLabel()

const wxString& wxPropertyGridEvent::GetPropertyLabel ( ) const

Returns label of associated property.

◆ GetPropertyName()

wxString wxPropertyGridEvent::GetPropertyName ( ) const

Returns global name of associated property.

◆ GetPropertyPtr()

wxPGProperty* wxPropertyGridEvent::GetPropertyPtr ( ) const

Returns pointer to associated property.

Deprecated:
Since version 1.3. Use GetProperty() instead.

◆ GetPropertyValue()

wxVariant wxPropertyGridEvent::GetPropertyValue ( ) const

Returns value of relevant property.

◆ HasProperty()

bool wxPropertyGridEvent::HasProperty ( ) const

Returns true if event has associated property.

◆ SetProperty()

void wxPropertyGridEvent::SetProperty ( wxPGProperty p)

Changes the associated property.

◆ SetValidationFailureBehavior()

void wxPropertyGridEvent::SetValidationFailureBehavior ( int  flags)

Set override validation failure behavior.

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

◆ SetValidationFailureMessage()

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.

◆ Veto()

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.

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