wxStringProperty Class Reference

Basic property with string value. More...

#include <props.h>

Inheritance diagram for wxStringProperty:
wxPGProperty

List of all members.

Public Member Functions

 DECLARE_DYNAMIC_CLASS (wxStringProperty) virtual const wxPGEditor *DoGetEditorClass() const
virtual bool DoSetAttribute (const wxString &name, wxVariant &value)
 Special handling for attributes of this property.
virtual wxString GetValueAsString (int argFlags=0) const
 Returns text representation of property's value.
virtual void OnSetValue ()
 This is updated so "<composed>" special value can be handled.
virtual bool StringToValue (wxVariant &variant, const wxString &text, int argFlags=0) const
 Converts 'text' into proper value 'variant'.
 wxStringProperty (const wxString &label=(*((wxString *) NULL)), const wxString &name=(*((wxString *) NULL)), const wxString &value=wxEmptyString)

Detailed Description

Basic property with string value.

Supported special attributes:

Remarks:
  • If value "<composed>" is set, then actual value is formed (or composed) from values of child properties.

Member Function Documentation

virtual bool wxStringProperty::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 wxString wxStringProperty::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().

Parameters:
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.
Remarks:
  • Default implementation returns string composed from text representations of child properties.
  • Implementations are never called with m_value being null variant (ie. unspecified value), so you don't need to check for that. Naturally this means that unspecified value is always displayed as an empty string.
See also:
GetValueString()

Reimplemented from wxPGProperty.

virtual bool wxStringProperty::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.

Parameters:
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).
Remarks:
  • Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.
  • You might want to take into account that m_value is Null variant if property value is unspecified (which is usually only case if you explicitly enabled that sort behavior).

Reimplemented from wxPGProperty.


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

Generated on 28 Jan 2012 for wxPropertyGrid by  doxygen 1.6.1