Property representing wxDateTime. More...

#include <advprops.h>

Inheritance diagram for wxDateProperty:

Public Member Functions
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())
Public Member Functions inherited from wxPGProperty
wxPGCell *	AcquireCell (unsigned int column)
	Returns wxPGCell of given column, NULL if none.
void	ActualChildChanged (wxVariant &thisValue, int childIndex, wxVariant &childValue) const
bool	ActualIntToValue (wxVariant &variant, int number, int argFlags=0) const
bool	ActualStringToValue (wxVariant &variant, const wxString &text, int argFlags=0) const
bool	ActualValidateValue (wxVariant &value, wxPGValidationInfo &validationInfo) const
void	AdaptListToValue (wxVariant &list, wxVariant *value) const
	Adapts list variant into proper value using consequtive ChildChanged-calls.
void	AddPrivateChild (wxPGProperty *prop)
	Call this to add sub-properties which will become private, fixed children.
wxPGProperty *	AppendChild (wxPGProperty *prop)
	Appends a new child property.
int	AppendChoice (const wxString &label, int value=INT_MAX)
	Adds entry to property's wxPGChoices and editor control (if it is active).
bool	AreAllChildrenSpecified (wxVariant *pendingList=NULL) const
	Determines, recursively, if all children are not unspecified.
bool	AreChildrenComponents () const
	Returns true if children of this property are component values (for instance, points size, face name, and is_underlined are component values of a font).
bool	CanHaveExtraChildren () const
	Returns true if extra children can be added for this property (i.e.
void	ChangeFlag (FlagType flag, bool set)
	Sets or clears given property flag(s).
virtual void	ChildChanged (wxVariant &thisValue, int childIndex, wxVariant &childValue) const
	Called after value of a child property has been altered.
void	ClearFlag (FlagType flag)
void	DeleteChildren ()
	Deletes children of the property.
void	DeleteChoice (int index)
	Removes entry from property's wxPGChoices and editor control (if it is active).
virtual wxVariant	DoGetAttribute (const wxString &name) const
	Returns value of an attribute.
virtual const wxPGEditor *	DoGetEditorClass () const
	Returns pointer to an instance of editor class.
virtual wxValidator *	DoGetValidator () const
	Returns pointer to the wxValidator that should be used with the editor of this property (NULL for no validator).
virtual wxVariant	DoGetValue () const
	Override this to return something else than m_value as the value.
virtual bool	DoSetAttribute (const wxString &name, wxVariant &value)
	Special handling for attributes of this property.
void	Empty ()
	Deletes children of the property.
void	EnableCommonValue (bool enable=true)
	Call to enable or disable usage of common value (integer value that can be selected for properties instead of their normal values) for this property.
void	FixIndexesOfChildren (unsigned int starthere=0)
void	GenerateComposedValue (wxString &text, int argFlags=0) const
	Composes text from values of child properties.
unsigned int	GetArrIndex () const
wxVariant	GetAttribute (const wxString &name) const
wxString	GetAttribute (const wxString &name, const wxString &defVal) const
	Returns named attribute, as string, if found.
double	GetAttributeAsDouble (const wxString &name, double defVal) const
	Returns named attribute, as double, if found.
long	GetAttributeAsLong (const wxString &name, long defVal) const
	Returns named attribute, as long, if found.
const wxPGAttributeStorage &	GetAttributes () const
	Returns comma-delimited string of property attributes.
wxVariant	GetAttributesAsList () const
	Returns m_attributes as list wxVariant.
const wxString &	GetBaseName () const
	Returns property's base name (ie.
wxPGCell *	GetCell (unsigned int column) const
	Returns wxPGCell of given column, NULL if none.
virtual wxPGCellRenderer *	GetCellRenderer (int column) const
	Returns used wxPGCellRenderer instance for given property column (label=0, value=1).
unsigned int	GetChildCount () const
	Returns number of child properties.
int	GetChildrenHeight (int lh, int iMax=-1) const
	Returns height of children, recursively, and by taking expanded/collapsed status into account.
unsigned int	GetChoiceCount () const
virtual int	GetChoiceInfo (wxPGChoiceInfo *choiceinfo)
	Returns current value's index to the choice control.
wxPGChoices &	GetChoices ()
const wxPGChoices &	GetChoices () const
wxString	GetChoiceString (unsigned int index)
const wxChar *	GetClassName () const
ClientDataType	GetClientData () const
const wxPGEditor *	GetColumnEditor (int column) const
	Returns editor used for given column.
int	GetCommonValue () const
	Returns common value selected for this property.
unsigned int	GetCount () const
	Returns number of child properties.
const wxPGChoiceEntry *	GetCurrentChoice () const
wxVariant	GetDefaultValue () const
unsigned int	GetDepth () const
int	GetDisplayedCommonValueCount () const
	Return number of displayed common values for this property.
wxString	GetDisplayedString () const
const wxPGEditor *	GetEditorClass () const
virtual wxPGEditorDialogAdapter *	GetEditorDialog () const
	Returns instance of a new wxPGEditorDialogAdapter instance, which is used when user presses the (optional) button next to the editor control;.
FlagType	GetFlags () const
wxString	GetFlagsAsString (FlagType flagsMask) const
	Gets flags as a'\|' delimited string.
wxPropertyGrid *	GetGrid () const
	Returns property grid where property lies.
wxPropertyGrid *	GetGridIfDisplayed () const
	Returns owner wxPropertyGrid, but only if one is currently on a page displaying this property.
const wxString &	GetHelpString () const
wxPGId	GetId ()
	Returns property id.
int	GetImageOffset (int imageWidth) const
	Converts image width into full image offset, with margins.
virtual wxSize	GetImageSize () const
unsigned int	GetIndexInParent () const
	Returns position in parent's array.
wxPGProperty *	GetItemAtY (unsigned int y, unsigned int lh, unsigned int *nextItemY) const
const wxString &	GetLabel () const
	Returns property's label.
const wxPGProperty *	GetLastVisibleSubItem () const
	Returns last visible sub-property, recursively.
wxPGProperty *	GetMainParent () const
	Returns highest level non-category, non-root parent.
int	GetMaxLength () const
wxString	GetName () const
	Returns property's name with all (non-category, non-root) parents.
wxPGCell *	GetOrCreateCell (unsigned int column)
	Returns wxPGCell of given column, creating one if necesasry.
wxPGProperty *	GetParent () const
	Return parent of property.
wxPropertyGridState *	GetParentState () const
wxPGProperty *	GetPropertyByName (const wxString &name) const
	Returns (direct) child property with given name (or NULL if not found).
wxString	GetType () const
	Returns type name of property that is compatible with CreatePropertyByType.
wxValidator *	GetValidator () const
	Gets assignable version of property's validator.
wxVariant	GetValue () const
wxVariant	GetValueAsVariant () const
	Returns value as wxVariant.
wxBitmap *	GetValueImage () const
wxVariant &	GetValueRef ()
	Returns reference to the internal stored value.
const wxVariant &	GetValueRef () const
wxString	GetValueString (int argFlags=0) const
	Same as GetValueAsString, except takes common value into account.
wxString	GetValueType () const
int	GetY () const
	Returns coordinate to the top y of the property.
FlagType	HasFlag (FlagType flag) const
	Returns non-zero if given property flag is set.
bool	HasVisibleChildren () const
	Returns true if property has even one visible child.
bool	Hide (bool hide, int flags=wxPG_RECURSE)
	Hides or reveals the property.
int	Index (const wxPGProperty *p) const
	Returns index of given sub-property.
wxPGProperty *	InsertChild (int index, wxPGProperty *childProperty)
	Use this member function to add independent (ie.
int	InsertChoice (const wxString &label, int index, int value=INT_MAX)
	Adds entry to property's wxPGChoices and editor control (if it is active).
virtual bool	IntToValue (wxVariant &value, int number, int argFlags=0) const
	Converts 'number' (including choice selection) into proper value 'variant'.
bool	IsCategory () const
	Returns true if this property is actually a wxPropertyCategory.
bool	IsEnabled () const
bool	IsExpanded () const
bool	IsFlagSet (FlagType flag) const
bool	IsRoot () const
	Returns true if this property is actually a wxRootProperty.
bool	IsSomeParent (wxPGProperty *candidate_parent) const
bool	IsSubProperty () const
	Returns true if this is a sub-property.
bool	IsTextEditable () const
	Returns true if property has editable wxTextCtrl when selected.
bool	IsValueUnspecified () const
	Returns if property value is unspecified.
bool	IsVisible () const
	Returns true if all parents expanded.
wxPGProperty *	Item (unsigned int i) const
	Returns sub-property at index i.
wxPGProperty *	Last () const
	Returns last sub-property.
virtual void	OnCustomPaint (wxDC &dc, const wxRect &rect, wxPGPaintData &paintdata)
	Override to paint an image in front of the property value text or drop-down list item (but only if wxPGProperty::OnMeasureImage is overridden as well).
virtual bool	OnEvent (wxPropertyGrid propgrid, wxWindow wnd_primary, wxEvent &event)
	Events received by editor widgets are processed here.
virtual wxSize	OnMeasureImage (int item=-1) const
	Returns size of the custom painted image in front of property.
virtual void	OnValidationFailure (wxVariant &pendingValue)
	Called whenever validation has failed with given pending value.
bool	PrepareValueForDialogEditing (wxPropertyGrid *propgrid)
	Updates property value in case there were last minute changes.
bool	RecreateEditor ()
	If property's editor is created this forces its recreation.
virtual void	RefreshChildren ()
	Refresh values of child properties.
void	RefreshEditor ()
	If property's editor is active, then update it's value.
void	SetAttribute (const wxString &name, wxVariant value)
	Sets an attribute for this property.
void	SetAttributes (const wxPGAttributeStorage &attributes)
	Sets attributes from a comma-delimited string.
void	SetCell (int column, wxPGCell *cellObj)
	Sets cell information for given column.
bool	SetChoices (wxPGChoices &choices)
	Set choices of a property to specified set of labels and values.
bool	SetChoices (const wxArrayString &labels, const wxArrayInt &values=wxArrayInt())
	Sets new set of choices for property.
void	SetChoiceSelection (int newValue, const wxPGChoiceInfo &choiceInfo)
	Changes value of a property with choices, but only works if the value type is long or string.
void	SetChoicesExclusive ()
	If property has choices and they are not yet exclusive, new such copy of them will be created.
void	SetClientData (ClientDataType clientData)
	Sets client data (void*) of a property.
void	SetCommonValue (int commonValue)
	Sets common value selected for this property.
void	SetDefaultValue (wxVariant &value)
	Set default value of a property.
void	SetEditor (const wxPGEditor *editor)
	Sets editor for a property.
void	SetEditor (const wxString &editorName)
	Sets editor for a property.
void	SetExpanded (bool expanded)
void	SetFlag (FlagType flag)
	Sets given property flag(s).
void	SetFlagRecursively (FlagType flag, bool set)
	Sets or clears given property flag(s), recursively in child properties (if any).
void	SetFlagsFromString (const wxString &str)
	Sets flags from a '\|' delimited string.
void	SetHelpString (const wxString &helpString)
void	SetLabel (const wxString &label)
	Sets property's label.
bool	SetMaxLength (int maxLen)
	Set max length of text editor.
void	SetName (const wxString &newName)
void	SetValidator (const wxValidator &validator)
	Sets wxValidator for a property.
void	SetValue (wxVariant value, wxVariant *pList=NULL, int flags=wxPG_SETVAL_REFRESH_EDITOR)
	Call this to set value of the property.
virtual bool	SetValueFromInt (long value, int flags=0)
	Converts integer to a value, and if succesfull, calls SetValue() on it.
virtual bool	SetValueFromString (const wxString &text, int flags=wxPG_PROGRAMMATIC_VALUE)
	Converts string to a value, and if succesfull, calls SetValue() on it.
void	SetValueImage (wxBitmap &bmp)
	Set wxBitmap in front of the value.
void	SetValueInEvent (wxVariant value) const
	Call in OnEvent(), OnButtonClick() etc.
void	SetValueToUnspecified ()
	Sets property value to unspecified.
void	SetWasModified (bool set=true)
	Call with 'false' in OnSetValue to cancel value changes after all (ie.
wxPGProperty *	UpdateParentValues ()
	Updates composed values of parent non-category properties, recursively.
FlagType	UsesAutoUnspecified () const
	Returns true if containing grid uses wxPG_EX_AUTO_UNSPECIFIED_VALUES.
virtual bool	ValidateValue (wxVariant &value, wxPGValidationInfo &validationInfo) const
	Implement this function in derived class to check the value.
	wxPGProperty ()
	Basic constructor.
	wxPGProperty (const wxString &label, const wxString &name)
	Constructor.
virtual	~wxPGProperty ()
	Virtual destructor.

Static Protected Member Functions
static wxString	DetermineDefaultDateFormat (bool showCentury)

Protected Attributes
long	m_dpStyle
wxString	m_format
Protected Attributes inherited from wxPGProperty
unsigned int	m_arrIndex
wxPGAttributeStorage	m_attributes
unsigned char	m_bgColIndex
wxArrayPtrVoid	m_cells
wxArrayPtrVoid	m_children
ClientDataType	m_clientData
int	m_commonValue
const wxPGEditor *	m_customEditor
unsigned char	m_depth
unsigned char	m_depthBgCol
unsigned char	m_fgColIndex
FlagType	m_flags
wxString	m_helpString
wxString	m_label
short	m_maxLen
wxString	m_name
wxPGProperty *	m_parent
wxPropertyGridState *	m_parentState
wxValidator *	m_validator
wxVariant	m_value
wxBitmap *	m_valueBitmap

Static Protected Attributes
static wxString	ms_defaultDateFormat

Additional Inherited Members
Public Types inherited from wxPGProperty
typedef void *	ClientDataType
typedef wxUint32	FlagType
Protected Member Functions inherited from wxPGProperty
void	AddChild (wxPGProperty *prop)
	Call this to add sub-properties which will become private, fixed children.
void	AddChild2 (wxPGProperty *prop, int index=-1, bool correct_mode=true)
	This is used by Insert etc.
void	DoEmpty ()
	Deletes all sub-properties.
bool	DoHide (bool hide, int flags)
void	DoSetName (const wxString &str)
wxString	GetColumnText (unsigned int col) const
	Returns text for given column.
wxPGProperty *	GetPropertyByNameWH (const wxString &name, unsigned int hintIndex) const
	Returns (direct) child property with given name (or NULL if not found), with hint index.
int	GetY2 (int lh) const
void	PrepareSubProperties ()
void	SetParentalType (int flag)
void	SetParentState (wxPropertyGridState *pstate)
void	SubPropsChanged (int oldSelInd=-1)

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

Public Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation