wxDateProperty Class Reference

#include <advprops.h>

Inheritance diagram for wxDateProperty:

wxPGProperty

List of all members.


Detailed Description

Property representing wxDateTime.

Supported special attributes:


Public Member Functions

virtual bool DoSetAttribute (const wxString &name, wxVariant &value)
long GetDatePickerStyle () const
wxDateTime GetDateValue () const
const wxString & GetFormat () const
virtual wxString GetValueAsString (int flags=0) const
void SetDateValue (const wxDateTime &dt)
void SetFormat (const wxString &format)
virtual bool StringToValue (wxVariant &variant, const wxString &text, int argFlags=0) const
 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

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.

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.

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:

Generated on Sun Nov 2 12:30:01 2008 for wxPropertyGrid by  doxygen 1.5.5