wxDateProperty Class Reference

Property representing wxDateTime. More...

#include <advprops.h>

Inheritance diagram for wxDateProperty:

List of all members.

Public Member Functions
virtual bool	DoSetAttribute (const wxString &name, wxVariant &value)
	Special handling for attributes of this property.
long	GetDatePickerStyle () const
wxDateTime	GetDateValue () const
const wxString &	GetFormat () const
virtual wxString	GetValueAsString (int flags=0) const
	Returns text representation of property's value.
virtual void	OnSetValue ()
	This virtual function is called after m_value has been set.
void	SetDateValue (const wxDateTime &dt)
void	SetFormat (const wxString &format)
virtual bool	StringToValue (wxVariant &variant, const wxString &text, int argFlags=0) const
	Converts 'text' into proper value 'variant'.
	wxDateProperty (const wxString &label=wxPG_LABEL, const wxString &name=wxPG_LABEL, const wxDateTime &value=wxDateTime())
Static Protected Member Functions
static wxString	DetermineDefaultDateFormat (bool showCentury)
Protected Attributes
long	m_dpStyle
wxString	m_format
Static Protected Attributes
static wxString	ms_defaultDateFormat

---

Detailed Description

Property representing wxDateTime.

Supported special attributes:

• "DateFormat": Determines displayed date format.
• "PickerStyle": Determines window style used with wxDatePickerCtrl. Default is wxDP_DEFAULT | wxDP_SHOWCENTURY. Using wxDP_ALLOWNONE enables additional support for unspecified property value.

---

Member Function Documentation

virtual bool wxDateProperty::DoSetAttribute	(	const wxString &	name,
		wxVariant &	value
	)			[virtual]

Special handling for attributes of this property.

If returns false, then the attribute will be automatically stored in m_attributes.

Default implementation simply returns false.

Reimplemented from wxPGProperty.

virtual wxString wxDateProperty::GetValueAsString

(

int

argFlags = 0

)

const [virtual]

Returns text representation of property's value.

Generally this function should not be called from the application code. Instead, call GetValueString().

Parameters:

argFlags

If wxPG_FULL_VALUE is set, returns complete, storable string value instead of displayable. If wxPG_EDITABLE_VALUE is set, returns string value that must be editable in textctrl. If wxPG_COMPOSITE_FRAGMENT is set, returns text that is appropriate to display as a part of composite property string value.

Remarks:

• Default implementation returns string composed from text representations of child properties.
• Implementations are never called with m_value being null variant (ie. unspecified value), so you don't need to check for that. Naturally this means that unspecified value is always displayed as an empty string.

See also:

GetValueString()

Reimplemented from wxPGProperty.

virtual void wxDateProperty::OnSetValue

(

)

[virtual]

This virtual function is called after m_value has been set.

Remarks:

• If m_value was set to Null variant (ie. 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.

Reimplemented from wxPGProperty.

virtual bool wxDateProperty::StringToValue	(	wxVariant &	variant,
		const wxString &	text,
		int	argFlags = 0
	)			const [virtual]

Converts 'text' into proper value 'variant'.

Returns true if new (different than m_value) value could be interpreted from the text.

Parameters:

argFlags

If wxPG_FULL_VALUE is set, returns complete, storable value instead of displayable one (they may be different). If wxPG_COMPOSITE_FRAGMENT is set, text is interpreted as a part of composite property string value (as generated by GetValueAsString() called with this same flag).

Remarks:

• Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.
• 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 behavior).

Reimplemented from wxPGProperty.

---

The documentation for this class was generated from the following file:

• advprops.h