1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
|
/////////////////////////////////////////////////////////////////////////////
// Name: wx/timectrl.h
// Purpose: interface of wxTimePickerCtrl
// Author: Vadim Zeitlin
// Created: 2011-09-22
// Copyright: (c) 2011 Vadim Zeitlin <vadim@wxwidgets.org>
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
Styles used with wxTimePickerCtrl.
Currently no special styles are defined for this object.
@library{wxadv}
@category{pickers}
@since 2.9.3
*/
enum
{
wxTP_DEFAULT = 0
};
/**
@class wxTimePickerCtrl
This control allows the user to enter time.
It is similar to wxDatePickerCtrl but is used for time, and not date,
selection. While GetValue() and SetValue() still work with values of type
wxDateTime (because wxWidgets doesn't provide a time-only class), their
date part is ignored by this control.
It is only available if @c wxUSE_TIMEPICKCTRL is set to 1.
This control currently doesn't have any specific flags.
@beginEventEmissionTable{wxDateEvent}
@event{EVT_TIME_CHANGED(id, func)}
This event fires when the user changes the current selection in the
control.
@endEventTable
@library{wxadv}
@category{pickers}
@appearance{timepickerctrl}
@see wxDatePickerCtrl, wxDateEvent
@since 2.9.3
*/
class wxTimePickerCtrl : public wxControl
{
public:
/**
Default constructor.
*/
wxTimePickerCtrl();
/**
Initializes the object and calls Create() with all the parameters.
*/
wxTimePickerCtrl(wxWindow* parent, wxWindowID id,
const wxDateTime& dt = wxDefaultDateTime,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxTP_DEFAULT,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = "timectrl");
/**
Create the control window.
This method should only be used for objects created using default
constructor.
@param parent
Parent window, must not be non-@NULL.
@param id
The identifier for the control.
@param dt
The initial value of the control, if an invalid date (such as the
default value) is used, the control is set to current time.
@param pos
Initial position.
@param 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 time fully.
@param style
The window style, should be left at 0 as there are no special
styles for this control in this version.
@param validator
Validator which can be used for additional checks.
@param name
Control name.
@return @true if the control was successfully created or @false if
creation failed.
*/
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 = "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.
The date part of the returned wxDateTime object is always set to today
and should be ignored, only the time part is relevant.
*/
virtual wxDateTime GetValue() const;
/**
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);
};
|
