• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • tderandr
 

tderandr

KTimerDialog Class Reference

Provides a dialog that is only available for a specified amount of time, and reports the time remaining to the user. More...

#include <ktimerdialog.h>

Inherits KDialogBase.

List of all members.

Public Types

enum  TimerStyle { CountDown, CountUp, Manual }

Public Slots

int exec ()

Signals

void timerTimeout ()

Public Member Functions

 KTimerDialog (int msec, TimerStyle style=CountDown, TQWidget *parent=0, const char *name=0, bool modal=true, const TQString &caption=TQString::null, int buttonMask=Ok|Apply|Cancel, ButtonCode defaultButton=Ok, bool separator=false, const KGuiItem &user1=KGuiItem(), const KGuiItem &user2=KGuiItem(), const KGuiItem &user3=KGuiItem())
 ~KTimerDialog ()
virtual void show ()
void setRefreshInterval (int msec)
int timeoutButton () const
void setTimeoutButton (ButtonCode newButton)
int timerStyle () const
void setTimerStyle (TimerStyle newStyle)
void setMainWidget (TQWidget *widget)

Detailed Description

Provides a dialog that is only available for a specified amount of time, and reports the time remaining to the user.

The timer is capable of counting up or down, for any number of milliseconds.

The button which is activated upon timeout can be specified, as can the update interval for the dialog box.

In addition, this class retains all of the functionality of

See also:
KDialogBase .

A dialog with a time limit and corresponding UI features.

Author:
Hamish Rodda <rodda@kde.org>

Definition at line 45 of file ktimerdialog.h.


Member Enumeration Documentation

enum KTimerDialog::TimerStyle
  • CountDown - The timer counts downwards from the seconds given.
  • CountUp - The timer counts up to the number of seconds given.
  • Manual - The timer is not invoked; the caller must update the progress.

Definition at line 57 of file ktimerdialog.h.


Constructor & Destructor Documentation

KTimerDialog::KTimerDialog ( int  msec,
TimerStyle  style = CountDown,
TQWidget *  parent = 0,
const char *  name = 0,
bool  modal = true,
const TQString &  caption = TQString::null,
int  buttonMask = Ok|Apply|Cancel,
ButtonCode  defaultButton = Ok,
bool  separator = false,
const KGuiItem &  user1 = KGuiItem(),
const KGuiItem &  user2 = KGuiItem(),
const KGuiItem &  user3 = KGuiItem() 
)

Constructor for the standard mode where you must specify the main widget with setMainWidget() .

See

See also:
KDialogBase for further details.

For the rest of the arguments, See

See also:
KDialogBase .

Definition at line 38 of file ktimerdialog.cpp.

KTimerDialog::~KTimerDialog (  ) 

Destructor.

Definition at line 75 of file ktimerdialog.cpp.


Member Function Documentation

int KTimerDialog::exec (  )  [slot]

Execute the dialog modally - see.

See also:
TQDialog .

Definition at line 86 of file ktimerdialog.cpp.

void KTimerDialog::setMainWidget ( TQWidget *  widget  ) 

Overridden function which is used to set the main widget of the dialog.

See also:
KDialogBase::setMainWidget.

Definition at line 93 of file ktimerdialog.cpp.

void KTimerDialog::setRefreshInterval ( int  msec  ) 

Set the refresh interval for the timer progress.

Defaults to one second.

Definition at line 111 of file ktimerdialog.cpp.

void KTimerDialog::setTimeoutButton ( ButtonCode  newButton  ) 

Sets the ButtonCode to determine which button will be activated once the timer times out.

See also:
timeoutButton

Definition at line 123 of file ktimerdialog.cpp.

void KTimerDialog::setTimerStyle ( TimerStyle  newStyle  ) 

Sets the TimerStyle.

See also:
timerStyle

Definition at line 133 of file ktimerdialog.cpp.

void KTimerDialog::show (  )  [virtual]

Execute the dialog modelessly - see.

See also:
TQDialog .

Definition at line 79 of file ktimerdialog.cpp.

int KTimerDialog::timeoutButton (  )  const

Retrieves the ButtonCode which will be activated once the timer times out.

See also:
setTimeoutButton

Definition at line 118 of file ktimerdialog.cpp.

int KTimerDialog::timerStyle (  )  const

Retrieves the current TimerStyle.

See also:
setTimerStyle

Definition at line 128 of file ktimerdialog.cpp.

void KTimerDialog::timerTimeout (  )  [signal]

Signal which is emitted once the timer has timed out.


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

tderandr

Skip menu "tderandr"
  • Main Page
  • Alphabetical List
  • Class List
  • File List
  • Class Members
  • Related Pages

tderandr

Skip menu "tderandr"
  • arts
  • dcop
  • dnssd
  • interfaces
  •   kspeech
  •     interface
  •     library
  •   tdetexteditor
  • kate
  • kded
  • kdoctools
  • kimgio
  • kjs
  • libtdemid
  • libtdescreensaver
  • tdeabc
  • tdecmshell
  • tdecore
  • tdefx
  • tdehtml
  • tdeinit
  • tdeio
  •   bookmarks
  •   httpfilter
  •   kpasswdserver
  •   kssl
  •   tdefile
  •   tdeio
  •   tdeioexec
  • tdeioslave
  •   http
  • tdemdi
  •   tdemdi
  • tdenewstuff
  • tdeparts
  • tdeprint
  • tderandr
  • tderesources
  • tdespell2
  • tdesu
  • tdeui
  • tdeunittest
  • tdeutils
  • tdewallet
Generated for tderandr by doxygen 1.6.3
This website is maintained by Timothy Pearson.