kalarm/lib

#include <timespinbox.h>

Inheritance diagram for TimeSpinBox:
SpinBox2

List of all members.

Public Slots

virtual void setValue (int minutes)
void setValue (const TQTime &t)
virtual void stepUp ()
virtual void stepDown ()

Public Member Functions

 TimeSpinBox (bool use24hour, TQWidget *parent=0, const char *name=0)
 TimeSpinBox (int minMinute, int maxMinute, TQWidget *parent=0, const char *name=0)
bool isValid () const
void setValid (bool)
TQTime time () const
virtual void setMinValue (int minutes)
virtual void setMaxValue (int minutes)
void setMaxValue (const TQTime &t)
TQTime maxTime () const
virtual TQSize sizeHint () const
virtual TQSize minimumSizeHint () const

Static Public Member Functions

static TQString shiftWhatsThis ()

Protected Member Functions

virtual TQString mapValueToText (int v)
virtual int mapTextToValue (bool *ok)

Detailed Description

Hours/minutes time entry widget.

The TimeSpinBox class provides a widget to enter a time consisting of an hours/minutes value. It can hold a time in any of 3 modes: a time of day using the 24-hour clock; a time of day using the 12-hour clock; or a length of time not restricted to 24 hours.

Derived from SpinBox2, it 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>

Definition at line 45 of file timespinbox.h.


Constructor & Destructor Documentation

TimeSpinBox::TimeSpinBox ( bool  use24hour,
TQWidget *  parent = 0,
const char *  name = 0 
) [explicit]

Constructor for a wrapping time spin box which can be used to enter a time of day.

Parameters:
use24hourTrue for entry of 24-hour clock times (range 00:00 to 23:59). False for entry of 12-hour clock times (range 12:00 to 11:59).
parentThe parent object of this widget.
nameThe name of this widget.

Definition at line 57 of file timespinbox.cpp.

TimeSpinBox::TimeSpinBox ( int  minMinute,
int  maxMinute,
TQWidget *  parent = 0,
const char *  name = 0 
)

Constructor for a non-wrapping time spin box which can be used to enter a length of time.

Parameters:
minMinuteThe minimum value which the spin box can hold, in minutes.
maxMinuteThe maximum value which the spin box can hold, in minutes.
parentThe parent object of this widget.
nameThe name of this widget.

Definition at line 79 of file timespinbox.cpp.


Member Function Documentation

bool TimeSpinBox::isValid ( ) const

Returns true if the spin box holds a valid value.

An invalid value is displayed as asterisks.

Definition at line 273 of file timespinbox.cpp.

TQTime TimeSpinBox::maxTime ( ) const [inline]

Returns the maximum value which can be held in the spin box.

Definition at line 88 of file timespinbox.h.

virtual void TimeSpinBox::setMaxValue ( int  minutes) [inline, virtual]

Sets the maximum value which can be held in the spin box.

Parameters:
minutesThe maximum value expressed in minutes.

Reimplemented from SpinBox2.

Definition at line 84 of file timespinbox.h.

void TimeSpinBox::setMaxValue ( const TQTime &  t) [inline]

Sets the maximum value which can be held in the spin box.

Definition at line 86 of file timespinbox.h.

void TimeSpinBox::setMinValue ( int  minutes) [virtual]

Sets the maximum value which can be held in the spin box.

Parameters:
minutesThe maximum value expressed in minutes.

Reimplemented from SpinBox2.

Definition at line 222 of file timespinbox.cpp.

void TimeSpinBox::setValid ( bool  valid)

Sets the spin box as holding a valid or invalid value.

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

Definition at line 200 of file timespinbox.cpp.

void TimeSpinBox::setValue ( int  minutes) [virtual, slot]

Sets the value of the spin box.

Parameters:
minutesThe new value of the spin box, expressed in minutes.

Reimplemented from SpinBox2.

Definition at line 231 of file timespinbox.cpp.

void TimeSpinBox::setValue ( const TQTime &  t) [inline, slot]

Sets the value of the spin box.

Definition at line 103 of file timespinbox.h.

TQString TimeSpinBox::shiftWhatsThis ( ) [static]

Returns a text describing use of the shift key as an accelerator for the spin buttons, designed for incorporation into WhatsThis texts.

Definition at line 94 of file timespinbox.cpp.

void TimeSpinBox::stepDown ( ) [virtual, slot]

Decrements the spin box value.

If the value was previously invalid, the spin box is set to the minimum value.

Reimplemented from SpinBox2.

Definition at line 265 of file timespinbox.cpp.

void TimeSpinBox::stepUp ( ) [virtual, slot]

Increments the spin box value.

If the value was previously invalid, the spin box is set to the minimum value.

Reimplemented from SpinBox2.

Definition at line 257 of file timespinbox.cpp.

TQTime TimeSpinBox::time ( ) const

Returns the current value held in the spin box.

If an invalid value is displayed, returns a value lower than the minimum value.

Definition at line 99 of file timespinbox.cpp.


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