KDE PIM / Developers / API Docs / kalarm

TimeEdit Class Reference

Widget to enter a time of day. More...

#include <timeedit.h>

Inherits QHBox.

List of all members.

Public Slots

Signals

Public Member Functions


Detailed Description

Widget to enter a time of day.

The TimeEdit class provides a widget to enter a time of day in hours and minutes, using a 12- or 24-hour clock according to the user's locale settings.

It displays a TimeSpinBox widget to enter hours and minutes. If a 12-hour clock is being used, it also displays a combo box to select am or pm.

TimeSpinBox displays a spin box with two pairs of spin buttons, one for hours and one for minutes. It provides accelerated stepping using the spin buttons, when the shift key is held down (inherited from SpinBox2). The default shift steps are 5 minutes and 6 hours.

The widget may be set as read-only. This has the same effect as disabling it, except that its appearance is unchanged.

Author:
David Jarvie <software@astrojar.org.uk>


Constructor & Destructor Documentation

TimeEdit::TimeEdit QWidget *  parent = 0,
const char *  name = 0
[explicit]
 

Constructor.

Parameters:
parent The parent object of this widget.
name The name of this widget.

Member Function Documentation

bool TimeEdit::isReadOnly  )  const [inline]
 

Returns true if the widget is read only.

void TimeEdit::setReadOnly bool  readOnly  ) 
 

Sets whether the widget is read-only for the user.

If read-only, the time cannot be edited and the spin buttons and am/pm combo box are inactive.

Parameters:
readOnly True to set the widget read-only, false to set it read-write.

bool TimeEdit::isValid  )  const
 

Returns true if the widget contains a valid value.

void TimeEdit::setValid bool  valid  ) 
 

Sets whether the edit value is valid.

If newly invalid, the value is displayed as asterisks. If newly valid, the value is set to the minimum value.

Parameters:
valid True to set the value valid, false to set it invalid.

int TimeEdit::value  )  const
 

Returns the entered time as a value in minutes.

QTime TimeEdit::time  )  const [inline]
 

Returns the entered time as a QTime value.

bool TimeEdit::wrapping  )  const
 

Returns true if it is possible to step the value from the highest value to the lowest value and vice versa.

void TimeEdit::setWrapping bool  on  ) 
 

Sets whether it is possible to step the value from the highest value to the lowest value and vice versa.

Parameters:
on True to enable wrapping, else false.

int TimeEdit::minValue  )  const
 

Returns the minimum value of the widget in minutes.

int TimeEdit::maxValue  )  const
 

Returns the maximum value of the widget in minutes.

QTime TimeEdit::maxTime  )  const [inline]
 

Returns the maximum value of the widget as a QTime value.

void TimeEdit::setMinValue int  minutes  ) 
 

Sets the minimum value of the widget.

void TimeEdit::setMaxValue int  minutes  ) 
 

Sets the maximum value of the widget.

void TimeEdit::setMaxValue const QTime &  time  )  [inline]
 

Sets the maximum value of the widget.

void TimeEdit::setValue int  minutes  )  [virtual, slot]
 

Sets the value of the widget.

void TimeEdit::setValue const QTime &  t  )  [inline, slot]
 

Sets the value of the widget.

void TimeEdit::valueChanged int  minutes  )  [signal]
 

This signal is emitted every time the value of the widget changes (for whatever reason).

Parameters:
minutes The new value.

The documentation for this class was generated from the following files: