• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • kdepim
  • Sitemap
  • Contact Us
 

kalarm/lib

TimeSpinBox Class Reference

#include <timespinbox.h>

Inheritance diagram for TimeSpinBox:

Inheritance graph
[legend]

List of all members.


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.


Public Slots

void setValue (const QTime &t)
virtual void setValue (int minutes)

Public Member Functions

bool isValid () const
QTime maxTime () const
virtual QSize minimumSizeHint () const
void setMaximum (const QTime &t)
virtual void setMaximum (int minutes)
virtual void setMinimum (int minutes)
void setValid (bool)
virtual QSize sizeHint () const
virtual void stepBy (int increment)
QTime time () const
 TimeSpinBox (int minMinute, int maxMinute, QWidget *parent=0)
 TimeSpinBox (bool use24hour, QWidget *parent=0)
virtual QValidator::State validate (QString &, int &pos) const

Static Public Member Functions

static QString shiftWhatsThis ()

Protected Member Functions

virtual QString textFromValue (int v) const
virtual int valueFromText (const QString &) const

Constructor & Destructor Documentation

TimeSpinBox::TimeSpinBox ( bool  use24hour,
QWidget *  parent = 0 
) [explicit]

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

Parameters:
use24hour True 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).
parent The parent object of this widget.

Definition at line 43 of file timespinbox.cpp.

TimeSpinBox::TimeSpinBox ( int  minMinute,
int  maxMinute,
QWidget *  parent = 0 
)

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

Parameters:
minMinute The minimum value which the spin box can hold, in minutes.
maxMinute The maximum value which the spin box can hold, in minutes.
parent The parent object of this widget.

Definition at line 62 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 237 of file timespinbox.cpp.

QTime TimeSpinBox::maxTime (  )  const [inline]

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

Definition at line 87 of file timespinbox.h.

QSize TimeSpinBox::minimumSizeHint (  )  const [virtual]

Reimplemented from SpinBox2.

Definition at line 254 of file timespinbox.cpp.

void TimeSpinBox::setMaximum ( const QTime &  t  )  [inline]

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

Definition at line 85 of file timespinbox.h.

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

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

Parameters:
minutes The maximum value expressed in minutes.

Reimplemented from SpinBox2.

Definition at line 83 of file timespinbox.h.

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

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

Parameters:
minutes The maximum value expressed in minutes.

Reimplemented from SpinBox2.

Definition at line 194 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 172 of file timespinbox.cpp.

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

Sets the value of the spin box.

Definition at line 106 of file timespinbox.h.

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

Sets the value of the spin box.

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

Reimplemented from SpinBox2.

Definition at line 203 of file timespinbox.cpp.

QString 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 75 of file timespinbox.cpp.

QSize TimeSpinBox::sizeHint (  )  const [virtual]

Reimplemented from SpinBox2.

Definition at line 247 of file timespinbox.cpp.

void TimeSpinBox::stepBy ( int  increment  )  [virtual]

Called whenever the user triggers a step, to adjust the value of the spin box.

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

Reimplemented from SpinBox2.

Definition at line 229 of file timespinbox.cpp.

QString TimeSpinBox::textFromValue ( int  v  )  const [protected, virtual]

Reimplemented from SpinBox2.

Definition at line 85 of file timespinbox.cpp.

QTime 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 80 of file timespinbox.cpp.

QValidator::State TimeSpinBox::validate ( QString &  text,
int &  pos 
) const [virtual]

Determine whether the current input is valid.

Reimplemented from SpinBox2.

Definition at line 266 of file timespinbox.cpp.

int TimeSpinBox::valueFromText ( const QString &   )  const [protected, virtual]

Reimplemented from SpinBox2.

Definition at line 106 of file timespinbox.cpp.


The documentation for this class was generated from the following files:
  • timespinbox.h
  • timespinbox.cpp

kalarm/lib

Skip menu "kalarm/lib"
  • Main Page
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Class Members

kdepim

Skip menu "kdepim"
  • akonadi
  •   clients
  •   kabc
  •   kcal
  •   kcm
  • akregator
  • console
  •   kabcclient
  •   konsolekalendar
  • kaddressbook
  • kalarm
  •   lib
  • kdgantt
  • kdgantt1
  • kjots
  • kleopatra
  • kmail
  • kmobiletools
  • knode
  • knotes
  • kontact
  • kontactinterfaces
  • korganizer
  •   korgac
  • kpilot
  • ktimetracker
  • libkdepim
  • libkholidays
  • libkleo
  • libkpgp
  • maildir
Generated for kdepim by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal