wxPropertyGrid
Public Member Functions
wxPropertyGridEvent Class Reference

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

#include <propgrid.h>

List of all members.

Public Member Functions

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

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::wxPropertyGridEvent ( wxEventType  commandType = 0,
int  id = 0 
)

Constructor.

Copy constructor.

Destructor.


Member Function Documentation

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

Copyer.

Disables property.

void wxPropertyGridEvent::EnableProperty ( bool  enable = true)

Enables property.

Returns id of associated property.

wxPGProperty::ClientDataType wxPropertyGridEvent::GetPropertyClientData ( ) const

Returns client data of relevant property.

const wxString& wxPropertyGridEvent::GetPropertyLabel ( ) const

Returns label of associated property.

Returns global name of associated property.

Returns pointer to associated property.

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

Returns value of relevant property.

Returns true if event has associated property.

Changes the associated property.

Set override validation failure behavior.

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.

The documentation for this class was generated from the following file:
 All Classes Functions Variables Enumerations Enumerator