Navigation

phoenix_title wx.propgrid.DateProperty

Property representing wx.DateTime.

Supported special attributes:

  • PG_DATE_FORMAT: Determines displayed date format.

  • PG_DATE_PICKER_STYLE: Determines window style used with wx.adv.DatePickerCtrl. Default is DP_DEFAULT | DP_SHOWCENTURY. Using DP_ALLOWNONE enables additional support for unspecified property value.


class_hierarchy Class Hierarchy

Inheritance diagram for class DateProperty:

method_summary Methods Summary

__init__

DoSetAttribute

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

GetDatePickerStyle

GetDateValue

GetFormat

OnSetValue

This virtual function is called after m_value has been set.

SetDateValue

SetFormat

StringToValue

Converts text into Variant value appropriate for this property.

ValueToString

Converts property value into a text representation.

api Class API

class wx.propgrid.DateProperty(PGProperty)

Possible constructors:

DateProperty(label=PG_LABEL, name=PG_LABEL, value=DateTime())

Property representing DateTime.


Methods

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

  • label (string) –

  • name (string) –

  • value (wx.DateTime) –


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.


GetDatePickerStyle(self)
Return type

long


GetDateValue(self)
Return type

DateTime


GetFormat(self)
Return type

string


OnSetValue(self)

This virtual function is called after m_value has been set.

Note

  • If m_value was set to Null variant (i.e. unspecified value), OnSetValue will not be called.

  • m_value may be of any variant type. Typically properties internally support only one variant type, and as such OnSetValue provides a good opportunity to convert supported values into internal type.

  • Default implementation does nothing.


SetDateValue(self, dt)
Parameters

dt (wx.DateTime) –


SetFormat(self, format)
Parameters

format (string) –


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 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 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 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.

Return type

string

Note

Default implementation calls GenerateComposedValue .


Properties

DatePickerStyle

See GetDatePickerStyle


DateValue

See GetDateValue and SetDateValue


Format

See GetFormat and SetFormat