.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2017 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.propgrid.StringProperty:
==========================================================================================================================================
|phoenix_title| **wx.propgrid.StringProperty**
==========================================================================================================================================
Basic property with string value.
**Supported special attributes:**
- "Password": set to 1 in order to enable ``wx.TE_PASSWORD`` on the editor.
.. note::
- If value "" is set, then actual value is formed (or composed) from values of child properties.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
Inheritance diagram for class
StringProperty:
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.propgrid.StringProperty.__init__`
:meth:`~wx.propgrid.StringProperty.DoSetAttribute` Reimplement this member function to add special handling for attributes of this property.
:meth:`~wx.propgrid.StringProperty.OnSetValue` This is updated so "" special value can be handled.
:meth:`~wx.propgrid.StringProperty.StringToValue` Converts text into `Variant` value appropriate for this property.
:meth:`~wx.propgrid.StringProperty.ValueToString` Converts property value into a text representation.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.propgrid.StringProperty(PGProperty)
**Possible constructors**::
StringProperty(label=PG_LABEL, name=PG_LABEL, value="")
Basic property with string value.
.. method:: __init__(self, label=PG_LABEL, name=PG_LABEL, value="")
:param `label`:
:type `label`: string
:param `name`:
:type `name`: string
:param `value`:
:type `value`: string
.. method:: DoSetAttribute(self, name, value)
Reimplement this member function to add special handling for attributes of this property.
:param `name`:
:type `name`: string
:param `value`:
:type `value`: PGVariant
:rtype: `bool`
:returns:
Return ``False`` to have the attribute automatically stored in m_attributes. Default implementation simply does that and nothing else.
.. note::
To actually set property attribute values from the application, use :meth:`wx.propgrid.PGProperty.SetAttribute` instead.
.. method:: OnSetValue(self)
This is updated so "" special value can be handled.
.. method:: StringToValue(self, variant, text, argFlags=0)
Converts text into `Variant` value appropriate for this property.
:param `variant`: On function entry this is the old value (should not be NullVariant in normal cases). Translated value must be assigned back to it.
:type `variant`: PGVariant
:param `text`: Text to be translated into variant.
:type `text`: string
:param `argFlags`: If ``wx.propgrid.PG_FULL_VALUE`` is set, returns complete, storable value instead of displayable one (they may be different). If ``wx.propgrid.PG_COMPOSITE_FRAGMENT`` is set, text is interpreted as a part of composite property string value (as generated by :meth:`ValueToString` called with this same flag).
:type `argFlags`: int
:rtype: `bool`
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 behaviour).
:returns:
Returns ``True`` if resulting `Variant` value was different.
.. note::
Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.
.. method:: ValueToString(self, value, argFlags=0)
Converts property value into a text representation.
:param `value`: Value to be converted.
:type `value`: PGVariant
:param `argFlags`: If 0 (default value), then displayed string is returned. If ``wx.propgrid.PG_FULL_VALUE`` is set, returns complete, storable string value instead of displayable. If ``wx.propgrid.PG_EDITABLE_VALUE`` is set, returns string value that must be editable in textctrl. If ``wx.propgrid.PG_COMPOSITE_FRAGMENT`` is set, returns text that is appropriate to display as a part of string property's composite text representation.
:type `argFlags`: int
:rtype: `string`
.. note::
Default implementation calls :meth:`~wx.propgrid.PGProperty.GenerateComposedValue` .