Added wxTimePickerCtrl::GetTime() and SetTime().

These methods, taking broken down time representation, avoid the problems
arising due to DST complications when using wxDateTime to represent the time
as special care needs to be taken in this case to avoid using the date part
corresponding to a DST change date at which time is discontinuous.

Document the problem with the old functions and use the new ones in the
sample.

See #14137.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@71004 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2012-03-25 23:17:01 +00:00
parent 25d7cf54f0
commit c0795ce8ea
4 changed files with 82 additions and 8 deletions

View File

@@ -88,6 +88,18 @@ public:
const wxValidator& validator = wxDefaultValidator,
const wxString& name = "timectrl");
/**
Returns the currently entered time as hours, minutes and seconds.
All the arguments must be non-@NULL, @false is returned otherwise and
none of them is modified.
@see SetTime()
@since 2.9.4
*/
bool GetTime(int* hour, int* min, int* sec) const;
/**
Returns the currently entered time.
@@ -96,12 +108,38 @@ public:
*/
virtual wxDateTime GetValue() const = 0;
/**
Changes the current time of the control.
Calling this method does not result in a time change event.
@param hour The new hour value in 0..23 interval.
@param min The new minute value in 0..59 interval.
@param sec The new second value in 0..59 interval.
@return @true if the time was changed or @false on failure, e.g. if the
time components were invalid.
@see GetTime()
@since 2.9.4
*/
bool SetTime(int hour, int min, int sec);
/**
Changes the current value of the control.
The date part of @a dt is ignored, only the time part is displayed in
the control. The @a dt object must however be valid.
In particular notice that it is a bad idea to use default wxDateTime
constructor from hour, minute and second values as it uses the today
date for the date part which means that some times can be invalid if
today happens to be the day of DST change. For example, when switching
to summer time the time 2:00 typically doesn't exist as the clocks jump
directly to 3:00. To avoid this problem, use a fixed date on which DST
is known not to change (e.g. Jan 1, 2012) for the date part of the
argument or use SetTime().
Calling this method does not result in a time change event.
*/
virtual void SetValue(const wxDateTime& dt) = 0;