KDE 4.2 API Reference kalarm/lib
TimePeriod Class Reference
#include <timeperiod.h>
Detailed Description
Time period entry widget.The TimePeriod class provides a widget for entering a time period as a number of weeks, days, hours and minutes, or minutes.
It displays a combo box to select the time units (weeks, days, hours and minutes, or minutes) alongside a spin box to enter the number of units. The type of spin box displayed alters according to the units selection: day, week and minute values are entered in a normal spin box, while hours and minutes are entered in a time spin box (with two pairs of spin buttons, one for hours and one for minutes).
The widget may be set as read-only. This has the same effect as disabling it, except that its appearance is unchanged.
Definition at line 51 of file timeperiod.h.
Public Types | |
| enum | Units { Minutes, HoursMinutes, Days, Weeks } |
Signals | |
| void | valueChanged (const KCal::Duration &period) |
Public Member Functions | |
| bool | isReadOnly () const |
| KCal::Duration | period () const |
| void | setDateOnly (bool dateOnly) |
| void | setFocusOnCount () |
| void | setMaximum (int hourmin, int days) |
| void | setPeriod (const KCal::Duration &period, bool dateOnly, Units defaultUnits) |
| virtual void | setReadOnly (bool readOnly) |
| void | setSelectOnStep (bool select) |
| void | setWhatsThises (const QString &units, const QString &dayWeek, const QString &hourMin=QString()) |
| TimePeriod (bool allowMinute, QWidget *parent) | |
Member Enumeration Documentation
| enum TimePeriod::Units |
Units for the time period.
- Minutes - the time period is entered as a number of minutes.
- HoursMinutes - the time period is entered as an hours/minutes value.
- Days - the time period is entered as a number of days.
- Weeks - the time period is entered as a number of weeks.
Definition at line 61 of file timeperiod.h.
Constructor & Destructor Documentation
| TimePeriod::TimePeriod | ( | bool | allowMinute, | |
| QWidget * | parent | |||
| ) |
Constructor.
- Parameters:
-
allowMinute Set false to prevent hours/minutes or minutes from being allowed as units; only days and weeks can ever be used, regardless of other method calls. Set true to allow minutes, hours/minutes, days or weeks as units. parent The parent object of this widget.
Definition at line 49 of file timeperiod.cpp.
Member Function Documentation
| bool TimePeriod::isReadOnly | ( | ) | const [inline] |
| Duration TimePeriod::period | ( | ) | const |
| void TimePeriod::setDateOnly | ( | bool | dateOnly | ) | [inline] |
Enables or disables minutes and hours/minutes units in the combo box.
To disable minutes and hours/minutes, set dateOnly true; to enable minutes and hours/minutes, set dateOnly false. But note that minutes and hours/minutes cannot be enabled if it was disallowed in the constructor.
Definition at line 91 of file timeperiod.h.
| void TimePeriod::setFocusOnCount | ( | ) |
| void TimePeriod::setMaximum | ( | int | hourmin, | |
| int | days | |||
| ) |
Sets the maximum values for the minutes and hours/minutes, and days/weeks spin boxes.
Set hourmin = 0 to leave the minutes and hours/minutes maximum unchanged.
Definition at line 127 of file timeperiod.cpp.
| void TimePeriod::setPeriod | ( | const KCal::Duration & | period, | |
| bool | dateOnly, | |||
| Units | defaultUnits | |||
| ) |
Initialises the time period value.
- Parameters:
-
period The value of the time period to set. dateOnly True to restrict the units available in the combo box to days or weeks. defaultUnits The units to display initially in the combo box.
| void TimePeriod::setReadOnly | ( | bool | readOnly | ) | [virtual] |
Sets whether the widget is read-only for the user.
If read-only, the time period cannot be edited and the units combo box is inactive.
- Parameters:
-
readOnly True to set the widget read-only, false to set it read-write.
Definition at line 94 of file timeperiod.cpp.
| void TimePeriod::setSelectOnStep | ( | bool | select | ) |
Sets whether the editor text is to be selected whenever spin buttons are clicked.
The default is to select it.
Definition at line 109 of file timeperiod.cpp.
| void TimePeriod::setWhatsThises | ( | const QString & | units, | |
| const QString & | dayWeek, | |||
| const QString & | hourMin = QString() | |||
| ) |
Sets separate WhatsThis texts for the count spin boxes and the units combo box.
If hourMin is omitted, both spin boxes are set to the same WhatsThis text.
Definition at line 383 of file timeperiod.cpp.
| void TimePeriod::valueChanged | ( | const KCal::Duration & | period | ) | [signal] |
This signal is emitted whenever the value held in the widget changes.
- Parameters:
-
period The current value of the time period.
The documentation for this class was generated from the following files:
