.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.propgrid.LongStringProperty:
==========================================================================================================================================
|phoenix_title| **wx.propgrid.LongStringProperty**
==========================================================================================================================================
Like :ref:`wx.propgrid.StringProperty`, but has a button that triggers a small text editor dialog.
**Supported special attributes:**
- ``PG_DIALOG_TITLE``: Sets a specific title for the text editor dialog (since 3.1.3).
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
LongStringProperty:
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.propgrid.LongStringProperty.__init__`
:meth:`~wx.propgrid.LongStringProperty.DisplayEditorDialog` Shows editor dialog.
:meth:`~wx.propgrid.LongStringProperty.StringToValue` Converts text into `Variant` value appropriate for this property.
:meth:`~wx.propgrid.LongStringProperty.ValueToString` Converts property value into a text representation.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.propgrid.LongStringProperty(EditorDialogProperty)
**Possible constructors**::
LongStringProperty(label: str=PG_LABEL, name: str=PG_LABEL, value:
str='') -> None
Like StringProperty, but has a button that triggers a small text
editor dialog.
.. method:: __init__(self, label: str=PG_LABEL, name: str=PG_LABEL, value: str='')
:param `label`:
:type `label`: string
:param `name`:
:type `name`: string
:param `value`:
:type `value`: string
:rtype: `None`
.. method:: DisplayEditorDialog(self, pg : PropertyGrid, value : PGVariant)
Shows editor dialog.
Value to be edited should be read from `value`, and if dialog is not cancelled, it should be stored back and ``True`` should be returned.
:param `pg`: Property grid in which property is displayed.
:type `pg`: wx.propgrid.PropertyGrid
:param `value`: Value to be edited.
:type `value`: PGVariant
:rtype: :ref:`Tuple[bool, PGVariant]`
:returns:
Returns ``True`` if editor dialog was not cancelled and `value` was updated.
.. method:: StringToValue(self, text : str, argFlags: int=0)
Converts text into `Variant` value appropriate for this property.
:param `text`: Text to be translated into variant.
:type `text`: string
:param `argFlags`: If ``PG_FULL_VALUE`` is set, returns complete, storable value instead of displayable one (they may be different). If ``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: :ref:`Tuple[bool, PGVariant]`
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 : PGVariant, argFlags: int=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 ``PG_FULL_VALUE`` is set, returns complete, storable string value instead of displayable. If ``PG_EDITABLE_VALUE`` is set, returns string value that must be editable in textctrl. If ``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: `str`
.. note::
Default implementation calls :meth:`GenerateComposedValue` .