phoenix_title wx.propgrid.EditorDialogProperty

This is an abstract class which serves as a base class for the properties having a button triggering an editor dialog, like e.g.

wx.propgrid.LongStringProperty, wx.propgrid.DirProperty, wx.propgrid.FileProperty.

Supported special attributes:

  • PG_DIALOG_TITLE: Sets a specific title for the editor dialog.

New in version 4.1/wxWidgets-3.1.3.


class_hierarchy Class Hierarchy

Inheritance diagram for class EditorDialogProperty:

sub_classes Known Subclasses

wx.propgrid.ArrayStringProperty, wx.propgrid.DirProperty, wx.propgrid.FileProperty, wx.propgrid.FontProperty, wx.propgrid.LongStringProperty, wx.propgrid.MultiChoiceProperty


method_summary Methods Summary

DisplayEditorDialog

Shows editor dialog.

DoSetAttribute

Reimplement this member function to add special handling for attributes of this property.

GetEditorDialog

Returns instance of a new wx.propgrid.PGEditorDialogAdapter instance, which is used when user presses the (optional) button next to the editor control;.

__init__

Constructor is protected because wx.propgrid.EditorDialogProperty is only the base class for other property classes.


property_summary Properties Summary

EditorDialog

See GetEditorDialog


api Class API

class wx.propgrid.EditorDialogProperty(PGProperty)

Possible constructors:

EditorDialogProperty(label, name)

This is an abstract class which serves as a base class for the properties having a button triggering an editor dialog, like e.g.


Methods

DisplayEditorDialog(self, pg, value)

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.

Parameters:
  • pg (wx.propgrid.PropertyGrid) – Property grid in which property is displayed.

  • value (PGVariant) – Value to be edited.

Return type:

bool

Returns:

Returns True if editor dialog was not cancelled and value was updated.



DoSetAttribute(self, name, value)

Reimplement this member function to add special handling for attributes of this property.

Parameters:
  • name (string) –

  • value (PGVariant) –

Return type:

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 wx.propgrid.PGProperty.SetAttribute instead.



GetEditorDialog(self)

Returns instance of a new wx.propgrid.PGEditorDialogAdapter instance, which is used when user presses the (optional) button next to the editor control;.

Default implementation returns None (i.e. no action is generated when button is pressed).

Return type:

wx.propgrid.PGEditorDialogAdapter



__init__(self, label, name)

Constructor is protected because wx.propgrid.EditorDialogProperty is only the base class for other property classes.

Parameters:
  • label (string) –

  • name (string) –


Properties

EditorDialog

See GetEditorDialog