karm Library API Documentation

IdleTimeDetector Class Reference

Keep track of how long the computer has been idle. More...

#include <idletimedetector.h>

Inheritance diagram for IdleTimeDetector:

QObject List of all members.

Public Slots

void setMaxIdle (int maxIdle)
void startIdleDetection ()
void stopIdleDetection ()
void toggleOverAllIdleDetection (bool)

Signals

void extractTime (int minutes)
void stopAllTimers ()

Public Member Functions

 IdleTimeDetector (int maxIdle)
bool isIdleDetectionPossible ()

Protected Slots

void check ()

Detailed Description

Keep track of how long the computer has been idle.

Definition at line 26 of file idletimedetector.h.


Constructor & Destructor Documentation

IdleTimeDetector::IdleTimeDetector int  maxIdle  ) 
 

Initializes and idle test timer.

Parameters:
maxIdle minutes before the idle timer will go off.

Definition at line 10 of file idletimedetector.cpp.

References IdleTimeDetector().

Referenced by IdleTimeDetector().


Member Function Documentation

bool IdleTimeDetector::isIdleDetectionPossible  ) 
 

Returns true if it is possible to do idle detection.

Idle detection relys on a feature in the X server, which might not always be present.

Definition at line 31 of file idletimedetector.cpp.

void IdleTimeDetector::extractTime int  minutes  )  [signal]
 

Tells the listener to extract time from current timing.

The time to extract is due to the idle time since the dialog wass shown, and until the user answers the dialog.

Parameters:
minutes Minutes to extract.

void IdleTimeDetector::stopAllTimers  )  [signal]
 

Tells the listener to stop timing.

void IdleTimeDetector::setMaxIdle int  maxIdle  )  [slot]
 

Sets the maximum allowed idle.

Parameters:
maxIdle Maximum allowed idle time in minutes

Definition at line 50 of file idletimedetector.cpp.

References setMaxIdle().

Referenced by setMaxIdle().

void IdleTimeDetector::startIdleDetection  )  [slot]
 

Starts detecting idle time.

Definition at line 94 of file idletimedetector.cpp.

void IdleTimeDetector::stopIdleDetection  )  [slot]
 

Stops detecting idle time.

Definition at line 102 of file idletimedetector.cpp.

Referenced by TaskView::deleteTask(), and TaskView::stopAllTimers().

void IdleTimeDetector::toggleOverAllIdleDetection bool   )  [slot]
 

Sets whether idle detection should be done at all.

Parameters:
on If true idle detection is done based on startIdleDetection and stopIdleDetection

Definition at line 109 of file idletimedetector.cpp.

References toggleOverAllIdleDetection().

Referenced by toggleOverAllIdleDetection().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for karm Library Version 3.3.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu Oct 21 19:46:34 2004 by doxygen 1.3.7 written by Dimitri van Heesch, © 1997-2003