#include </home/zeitlin/src/wx/github/interface/wx/datectrl.h>

Inheritance diagram for wxDatePickerCtrl:

Detailed Description

This control allows the user to select a date.

Unlike wxCalendarCtrl, which is a relatively big control, wxDatePickerCtrl is implemented as a small window showing the currently selected date. The control can be edited using the keyboard, and can also display a popup window for more user-friendly date selection, depending on the styles used and the platform.

It is only available if wxUSE_DATEPICKCTRL is set to 1.

Styles

This class supports the following styles:

wxDP_SPIN:
Creates a control without a month calendar drop down but with spin-control-like arrows to change individual date components. This style is not supported by the generic version.
wxDP_DROPDOWN:
Creates a control with a month calendar drop-down part from which the user can select a date. This style is not supported in OSX/Cocoa native version.
wxDP_DEFAULT:
Creates a control with the style that is best supported for the current platform (currently wxDP_SPIN under Windows and OSX/Cocoa and wxDP_DROPDOWN elsewhere).
wxDP_ALLOWNONE:
With this style, the control allows the user to not enter any valid date at all. Without it - the default - the control always has some valid date. This style is not supported in OSX/Cocoa native version.
wxDP_SHOWCENTURY:
Forces display of the century in the default date format. Without this style the century could be displayed, or not, depending on the default date representation in the system. This style is not supported in OSX/Cocoa native version currently.

As can be seen from the remarks above, most of the control style are only supported in the native MSW implementation. In portable code it's recommended to use wxDP_DEFAULT style only, possibly combined with wxDP_SHOWCENTURY (this is also the style used by default if none is specified).

Events emitted by this class

The following event handler macros redirect the events to member function handlers 'func' with prototypes like:

void handlerFuncName(wxDateEvent& event)

Event macros for events emitted by this class:

EVT_DATE_CHANGED(id, func):
This event fires when the user changes the current selection in the control.

Library: wxAdvanced

Category: Picker Controls

Appearance:


wxMSW appearance	wxGTK appearance	wxMac appearance

参照:: wxCalendarCtrl, wxDateEvent

Public Member Functions
	wxDatePickerCtrl ()
	Default constructor.
	wxDatePickerCtrl (wxWindow *parent, wxWindowID id, const wxDateTime &dt=wxDefaultDateTime, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDP_DEFAULT\|wxDP_SHOWCENTURY, const wxValidator &validator=wxDefaultValidator, const wxString &name="datectrl")
	Initializes the object and calls Create() with all the parameters.
bool	Create (wxWindow *parent, wxWindowID id, const wxDateTime &dt=wxDefaultDateTime, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDP_DEFAULT\|wxDP_SHOWCENTURY, const wxValidator &validator=wxDefaultValidator, const wxString &name="datectrl")
	Create the control window.
virtual bool	GetRange (wxDateTime dt1, wxDateTime dt2) const
	If the control had been previously limited to a range of dates using SetRange(), returns the lower and upper bounds of this range.
virtual wxDateTime	GetValue () const
	Returns the currently entered date.
virtual void	SetRange (const wxDateTime &dt1, const wxDateTime &dt2)
	Sets the valid range for the date selection.
virtual void	SetValue (const wxDateTime &dt)
	Changes the current value of the control.

List of all members.

Constructor & Destructor Documentation

wxDatePickerCtrl::wxDatePickerCtrl ( )

Default constructor.

wxDatePickerCtrl::wxDatePickerCtrl	(	wxWindow *	parent,
		wxWindowID	id,
		const wxDateTime &	dt = `wxDefaultDateTime`,
		const wxPoint &	pos = `wxDefaultPosition`,
		const wxSize &	size = `wxDefaultSize`,
		long	style = `wxDP_DEFAULT\|wxDP_SHOWCENTURY`,
		const wxValidator &	validator = `wxDefaultValidator`,
		const wxString &	name = `"datectrl"`
	)

Initializes the object and calls Create() with all the parameters.

Member Function Documentation

bool wxDatePickerCtrl::Create	(	wxWindow *	parent,
		wxWindowID	id,
		const wxDateTime &	dt = `wxDefaultDateTime`,
		const wxPoint &	pos = `wxDefaultPosition`,
		const wxSize &	size = `wxDefaultSize`,
		long	style = `wxDP_DEFAULT\|wxDP_SHOWCENTURY`,
		const wxValidator &	validator = `wxDefaultValidator`,
		const wxString &	name = `"datectrl"`
	)

Create the control window.

This method should only be used for objects created using default constructor.

Parameters:

parent	Parent window, must not be non-NULL.
id	The identifier for the control.
dt	The initial value of the control, if an invalid date (such as the default value) is used, the control is set to today.
pos	Initial position.
size	Initial size. If left at default value, the control chooses its own best size by using the height approximately equal to a text control and width large enough to show the date string fully.
style	The window style, see the description of the styles in the class documentation.
validator	Validator which can be used for additional date checks.
name	Control name.

Returns:: true if the control was successfully created or false if creation failed.

virtual bool wxDatePickerCtrl::GetRange	(	wxDateTime *	dt1,
		wxDateTime *	dt2
	)		const `[virtual]`

If the control had been previously limited to a range of dates using SetRange(), returns the lower and upper bounds of this range.

If no range is set (or only one of the bounds is set), dt1 and/or dt2 are set to be invalid.

Notice that when using a native MSW implementation of this control the lower range is always set, even if SetRange() hadn't been called explicitly, as the native control only supports dates later than year 1601.

Parameters:

dt1	Pointer to the object which receives the lower range limit or becomes invalid if it is not set. May be NULL if the caller is not interested in lower limit.
dt2	Same as above but for the upper limit.

Returns:: false if no range limits are currently set, true if at least one bound is set.

virtual wxDateTime wxDatePickerCtrl::GetValue ( ) const [virtual]

Returns the currently entered date.

For a control with wxDP_ALLOWNONE style the returned value may be invalid if no date is entered, otherwise it is always valid.

virtual void wxDatePickerCtrl::SetRange	(	const wxDateTime &	dt1,
		const wxDateTime &	dt2
	)		`[virtual]`

Sets the valid range for the date selection.

If dt1 is valid, it becomes the earliest date (inclusive) accepted by the control. If dt2 is valid, it becomes the latest possible date.

注意:: If the current value of the control is outside of the newly set range bounds, the behaviour is undefined.

virtual void wxDatePickerCtrl::SetValue ( const wxDateTime & dt ) [virtual]

Changes the current value of the control.

The date should be valid unless the control was created with wxDP_ALLOWNONE style and included in the currently selected range, if any.

Calling this method does not result in a date change event.

Detailed Description

Styles

Events emitted by this class

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation