Navigation

phoenix_title wx.propgrid.LongStringProperty

Like wx.propgrid.StringProperty, but has a button that triggers a small text editor dialog.


class_hierarchy Class Hierarchy

Inheritance diagram for class LongStringProperty:

sub_classes Known Subclasses

wx.propgrid.DirProperty


method_summary Methods Summary

__init__

DisplayEditorDialog

OnButtonClick

OnEvent

Events received by editor widgets are processed here.

StringToValue

Converts text into Variant value appropriate for this property.

ValueToString

Converts property value into a text representation.

api Class API

class wx.propgrid.LongStringProperty(PGProperty)

Possible constructors:

LongStringProperty(label=PG_LABEL, name=PG_LABEL, value="")

Like StringProperty, but has a button that triggers a small text editor dialog.


Methods

__init__(self, label=PG_LABEL, name=PG_LABEL, value="")
Parameters

  • label (string) –

  • name (string) –

  • value (string) –


static DisplayEditorDialog(prop, propGrid, value)
Parameters
Return type

tuple

Returns

( bool, value )


OnButtonClick(self, propgrid, value)
Parameters
Return type

tuple

Returns

( bool, value )


OnEvent(self, propgrid, wnd_primary, event)

Events received by editor widgets are processed here.

Note that editor class usually processes most events. Some, such as button press events of TextCtrlAndButton class, can be handled here. Also, if custom handling for regular events is desired, then that can also be done (for example, wx.propgrid.SystemColourProperty custom handles wxEVT_CHOICE to display colour picker dialog when ‘custom’ selection is made).

If the event causes value to be changed, SetValueInEvent should be called to set the new value.

The parameter event is the associated wx.Event.

Parameters

return True if any changes in value should be reported.

Return type

bool

Note

  • If property uses choice control, and displays a dialog on some choice items, then it is preferred to display that dialog in IntToValue instead of OnEvent.


StringToValue(self, text, argFlags=0)

Converts text into Variant value appropriate for this property.

Parameters

  • text (string) – Text to be translated into variant.

  • argFlags (int) – 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 ValueToString called with this same flag).

Return type

tuple

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

( bool, variant )

Note

Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.


ValueToString(self, value, argFlags=0)

Converts property value into a text representation.

Parameters

  • value (PGVariant) – Value to be converted.

  • argFlags (int) – 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.

Return type

string

Note

Default implementation calls GenerateComposedValue .