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 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222
|
'\" t
.TH QTimeEdit 3qt "18 March 2002" "Trolltech AS" \" -*- nroff -*-
.\" Copyright 1992-2001 Trolltech AS. All rights reserved. See the
.\" license file included in the distribution for a complete license
.\" statement.
.\"
.ad l
.nh
.SH NAME
QTimeEdit \- Time editor
.SH SYNOPSIS
\fC#include <qdatetimeedit.h>\fR
.PP
.SS "Public Members"
.in +1c
.ti -1c
.BI "\fBQTimeEdit\fR ( QWidget * parent = 0, const char * name = 0 )"
.br
.ti -1c
.BI "\fBQTimeEdit\fR ( const QTime & time, QWidget * parent = 0, const char * name = 0 )"
.br
.ti -1c
.BI "\fB~QTimeEdit\fR ()"
.br
.ti -1c
.BI "virtual void \fBsetTime\fR ( const QTime & time )"
.br
.ti -1c
.BI "QTime \fBtime\fR () const"
.br
.ti -1c
.BI "virtual void \fBsetAutoAdvance\fR ( bool advance )"
.br
.ti -1c
.BI "bool \fBautoAdvance\fR () const"
.br
.ti -1c
.BI "virtual void \fBsetMinValue\fR ( const QTime & d )"
.br
.ti -1c
.BI "QTime \fBminValue\fR () const"
.br
.ti -1c
.BI "virtual void \fBsetMaxValue\fR ( const QTime & d )"
.br
.ti -1c
.BI "QTime \fBmaxValue\fR () const"
.br
.ti -1c
.BI "virtual void \fBsetRange\fR ( const QTime & min, const QTime & max )"
.br
.ti -1c
.BI "QString \fBseparator\fR () const"
.br
.ti -1c
.BI "virtual void \fBsetSeparator\fR ( const QString & s )"
.br
.in -1c
.SS "Signals"
.in +1c
.ti -1c
.BI "void \fBvalueChanged\fR ( const QTime & time )"
.br
.in -1c
.SS "Properties"
.in +1c
.ti -1c
.BI "bool \fBautoAdvance\fR - whether the editor automatically advances to the next section"
.br
.ti -1c
.BI "QTime \fBmaxValue\fR - the maximum time value"
.br
.ti -1c
.BI "QTime \fBminValue\fR - the minimum time value"
.br
.ti -1c
.BI "QTime \fBtime\fR - the time value of the editor"
.br
.in -1c
.SS "Protected Members"
.in +1c
.ti -1c
.BI "virtual QString \fBsectionFormattedText\fR ( int sec )"
.br
.ti -1c
.BI "virtual void \fBsetHour\fR ( int h )"
.br
.ti -1c
.BI "virtual void \fBsetMinute\fR ( int m )"
.br
.ti -1c
.BI "virtual void \fBsetSecond\fR ( int s )"
.br
.in -1c
.SS "Protected Slots"
.in +1c
.ti -1c
.BI "void \fBupdateButtons\fR ()"
.br
.in -1c
.SH DESCRIPTION
The QTimeEdit class provides a time editor.
.PP
QTimeEdit allows the user to edit times by using the keyboard or the arrow keys to increase/decrease time values. The arrow keys can be used to move from section to section within the QTimeEdit box. The user can automatically be moved to the next section once they complete a section using setAutoAdvance(). Times appear in hour, minute, second order. It is recommended that the QTimeEdit be initialised with a time, e.g.
.PP
.nf
.br
QTime timeNow = QTime::currentTime();
.br
QTimeEdit *timeEdit = new QTimeEdit( timeNow, this );
.br
timeEdit->setRange( timeNow, timeNow.addSecs( 60 * 60 ) );
.br
.fi
Here we've created a QTimeEdit widget set to the current time. We've also set the minimum value to the current time and the maximum time to one hour from now.
.PP
The maximum and minimum values for a time value in the time editor default to the maximum and minimum values for a QTime. You can change this by calling setMinValue(), setMaxValue() or setRange().
.PP
Terminology: A QTimeWidget consists of three sections, one each for the hour, minute and second. You can change the separator character using setSeparator(), by default the separator is read from the system's settings.
.PP
<center>
.ce 1
.B "[Image Omitted]"
.PP
</center>
.PP
See also QTime, QDateEdit, QDateTimeEdit, Advanced Widgets and Time and Date.
.PP
.SH MEMBER FUNCTION DOCUMENTATION
.SH "QTimeEdit::QTimeEdit ( QWidget * parent = 0, const char * name = 0 )"
Constructs an empty time edit with parent \fIparent\fR and name \fIname\fR.
.SH "QTimeEdit::QTimeEdit ( const QTime & time, QWidget * parent = 0, const char * name = 0 )"
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
.PP
Constructs a time edit with the initial time value, \fItime\fR, parent \fIparent\fR and name \fIname\fR.
.SH "QTimeEdit::~QTimeEdit ()"
Destroys the object and frees any allocated resources.
.SH "bool QTimeEdit::autoAdvance () const"
Returns TRUE if the editor automatically advances to the next section; otherwise returns FALSE. See the "autoAdvance" property for details.
.SH "QTime QTimeEdit::maxValue () const"
Returns the maximum time value. See the "maxValue" property for details.
.SH "QTime QTimeEdit::minValue () const"
Returns the minimum time value. See the "minValue" property for details.
.SH "QString QTimeEdit::sectionFormattedText ( int sec )\fC [virtual protected]\fR"
Returns the formatted number for section \fIsec\fR. This will correspond to either the hour, minute or second section, depending on \fIsec\fR.
.SH "QString QTimeEdit::separator () const"
Returns the separator for the editor.
.SH "void QTimeEdit::setAutoAdvance ( bool advance )\fC [virtual]\fR"
Sets whether the editor automatically advances to the next section to \fIadvance\fR. See the "autoAdvance" property for details.
.SH "void QTimeEdit::setHour ( int h )\fC [virtual protected]\fR"
Sets the hour to \fIh\fR, which must be a valid hour, i.e. in the range 0..24.
.SH "void QTimeEdit::setMaxValue ( const QTime & d )\fC [virtual]\fR"
Sets the maximum time value to \fId\fR. See the "maxValue" property for details.
.SH "void QTimeEdit::setMinValue ( const QTime & d )\fC [virtual]\fR"
Sets the minimum time value to \fId\fR. See the "minValue" property for details.
.SH "void QTimeEdit::setMinute ( int m )\fC [virtual protected]\fR"
Sets the minute to \fIm\fR, which must be a valid minute, i.e. in the range 0..59.
.SH "void QTimeEdit::setRange ( const QTime & min, const QTime & max )\fC [virtual]\fR"
Sets the valid input range for the editor to be from \fImin\fR to \fImax\fR inclusive. If \fImin\fR is invalid no minimum time is set. Similarly, if \fImax\fR is invalid no maximum time is set.
.SH "void QTimeEdit::setSecond ( int s )\fC [virtual protected]\fR"
Sets the second to \fIs\fR, which must be a valid second, i.e. in the range 0..59.
.SH "void QTimeEdit::setSeparator ( const QString & s )\fC [virtual]\fR"
Sets the separator to \fIs\fR. Note that currently only the first character of \fIs\fR is used.
.SH "void QTimeEdit::setTime ( const QTime & time )\fC [virtual]\fR"
Sets the time value of the editor to \fItime\fR. See the "time" property for details.
.SH "QTime QTimeEdit::time () const"
Returns the time value of the editor. See the "time" property for details.
.SH "void QTimeEdit::updateButtons ()\fC [protected slot]\fR"
Enables/disables the push buttons according to the min/max time for this widget.
.SH "void QTimeEdit::valueChanged ( const QTime & time )\fC [signal]\fR"
This signal is emitted whenever the editor's value changes. The \fItime\fR parameter is the new value.
.PP
.SS "Property Documentation"
.SH "bool autoAdvance"
This property holds whether the editor automatically advances to the next section.
.PP
If autoAdvance is TRUE, the editor will automatically advance focus to the next time section if a user has completed a section. The default is FALSE.
.PP
Set this property's value with setAutoAdvance() and get this property's value with autoAdvance().
.SH "QTime maxValue"
This property holds the maximum time value.
.PP
Setting the maximum time value is equivalent to calling QTimeEdit::setRange( minValue(), \fIt\fR ), where \fIt\fR is the maximum time. The default maximum time is 23:59:59.
.PP
Set this property's value with setMaxValue() and get this property's value with maxValue().
.SH "QTime minValue"
This property holds the minimum time value.
.PP
Setting the minimum time value is equivalent to calling QTimeEdit::setRange( \fIt\fR, maxValue() ), where \fIt\fR is the minimum time. The default minimum time is 00:00:00.
.PP
Set this property's value with setMinValue() and get this property's value with minValue().
.SH "QTime time"
This property holds the time value of the editor.
.PP
When changing the time property, if the time is less than minValue(), or is greater than maxValue(), nothing happens.
.PP
Set this property's value with setTime() and get this property's value with time().
.SH "SEE ALSO"
.BR http://doc.trolltech.com/qtimeedit.html
.BR http://www.trolltech.com/faq/tech.html
.SH COPYRIGHT
Copyright 1992-2001 Trolltech AS, http://www.trolltech.com. See the
license file included in the distribution for a complete license
statement.
.SH AUTHOR
Generated automatically from the source code.
.SH BUGS
If you find a bug in Qt, please report it as described in
.BR http://doc.trolltech.com/bughowto.html .
Good bug reports help us to help you. Thank you.
.P
The definitive Qt documentation is provided in HTML format; it is
located at $QTDIR/doc/html and can be read using Qt Assistant or with
a web browser. This man page is provided as a convenience for those
users who prefer man pages, although this format is not officially
supported by Trolltech.
.P
If you find errors in this manual page, please report them to
.BR qt-bugs@trolltech.com .
Please include the name of the manual page (qtimeedit.3qt) and the Qt
version (3.0.3).
|