Basic property with boolean value. More...
#include <props.h>
Public Member Functions | |
DECLARE_DYNAMIC_CLASS (wxBoolProperty) virtual const wxPGEditor *DoGetEditorClass() const | |
virtual bool | DoSetAttribute (const wxString &name, wxVariant &value) |
Special handling for attributes of this property. | |
virtual int | GetChoiceInfo (wxPGChoiceInfo *choiceinfo) |
Returns current value's index to the choice control. | |
virtual wxString | GetValueAsString (int argFlags=0) const |
Returns text representation of property's value. | |
virtual bool | IntToValue (wxVariant &variant, int number, int argFlags=0) const |
Converts 'number' (including choice selection) into proper value 'variant'. | |
virtual bool | StringToValue (wxVariant &variant, const wxString &text, int argFlags=0) const |
Converts 'text' into proper value 'variant'. | |
wxBoolProperty (const wxString &label=(*((wxString *) NULL)), const wxString &name=(*((wxString *) NULL)), bool value=false) |
Basic property with boolean value.
Supported special attributes:
virtual bool wxBoolProperty::DoSetAttribute | ( | const wxString & | name, | |
wxVariant & | value | |||
) | [virtual] |
Special handling for attributes of this property.
If returns false, then the attribute will be automatically stored in m_attributes.
Default implementation simply returns false.
Reimplemented from wxPGProperty.
virtual int wxBoolProperty::GetChoiceInfo | ( | wxPGChoiceInfo * | choiceinfo | ) | [virtual] |
Returns current value's index to the choice control.
May also return, through pointer arguments, strings that should be inserted to that control. Irrelevant to classes which do not employ wxPG_EDITOR(Choice) or similar.
Reimplemented from wxPGProperty.
virtual wxString wxBoolProperty::GetValueAsString | ( | int | argFlags = 0 |
) | const [virtual] |
Returns text representation of property's value.
Generally this function should not be called from the application code. Instead, call GetValueString().
argFlags | If wxPG_FULL_VALUE is set, returns complete, storable string value instead of displayable. If wxPG_EDITABLE_VALUE is set, returns string value that must be editable in textctrl. If wxPG_COMPOSITE_FRAGMENT is set, returns text that is appropriate to display as a part of composite property string value. |
Reimplemented from wxPGProperty.
virtual bool wxBoolProperty::IntToValue | ( | wxVariant & | value, | |
int | number, | |||
int | argFlags = 0 | |||
) | const [virtual] |
Converts 'number' (including choice selection) into proper value 'variant'.
Returns true if new (different than m_value) value could be interpreted from the integer.
argFlags | If wxPG_FULL_VALUE is set, returns complete, storable value instead of displayable |
Reimplemented from wxPGProperty.
virtual bool wxBoolProperty::StringToValue | ( | wxVariant & | variant, | |
const wxString & | text, | |||
int | argFlags = 0 | |||
) | const [virtual] |
Converts 'text' into proper value 'variant'.
Returns true if new (different than m_value) value could be interpreted from the text.
argFlags | If wxPG_FULL_VALUE is set, returns complete, storable value instead of displayable one (they may be different). If wxPG_COMPOSITE_FRAGMENT is set, text is interpreted as a part of composite property string value (as generated by GetValueAsString() called with this same flag). |
Reimplemented from wxPGProperty.