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

Inheritance diagram for class DateProperty:

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.

Properties Summary

DatePickerStyle	See GetDatePickerStyle
DateValue	See GetDateValue and SetDateValue
Format	See GetFormat and SetFormat

Class API

class wx.propgrid.DateProperty(PGProperty)

Possible constructors:

DateProperty(label=PG_LABEL, name=PG_LABEL, value=DateTime()) -> None

Property representing DateTime.

Methods

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

Parameters:

• label (string)

• name (string)

• value (wx.DateTime)

Return type:

None

---

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:

int

---

GetDateValue(self)

Return type:

DateTime

---

GetFormat(self)

Return type:

str

---

OnSetValue(self)

This virtual function is called after m_value has been set.

Return type:

None

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)

Return type:

None

---

SetFormat(self, format)

Parameters:

format (string)

Return type:

None

---

StringToValue(self, text, flags=PGPropValFormatFlags.Null)

Converts text into Variant value appropriate for this property.

Parameters:

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

• flags (PGPropValFormatFlags) – If wx.propgrid.PGPropValFormatFlags.FullValue is set, returns complete, storable value instead of displayable one (they may be different). If wx.propgrid.PGPropValFormatFlags.CompositeFragment 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[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.

---

ValueToString(self, value, flags=PGPropValFormatFlags.Null)

Converts property value into a text representation.

Parameters:

• value (PGVariant) – Value to be converted.

• flags (PGPropValFormatFlags) – If wx.propgrid.PGPropValFormatFlags.Null (default value), then displayed string is returned. If wx.propgrid.PGPropValFormatFlags.FullValue is set, returns complete, storable string value instead of displayable. If wx.propgrid.PGPropValFormatFlags.EditableValue is set, returns string value that must be editable in textctrl. If wx.propgrid.PGPropValFormatFlags.CompositeFragment is set, returns text that is appropriate to display as a part of string property’s composite text representation.

Return type:

str

Note

Default implementation calls GenerateComposedValue .

Properties

DatePickerStyle

See GetDatePickerStyle

---

DateValue

See GetDateValue and SetDateValue

---

Format

See GetFormat and SetFormat