<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en_US" xml:lang="en_US"> <head> <title>karm: IdleTimeDetector Class Reference (karm)</title> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta http-equiv="Content-Style-Type" content="text/css" /> <meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" comment "ICRAonline DE v2.0" l gen true for "http://www.kde.org" r (nz 1 vz 1 lz 1 oz 1 cb 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://www.kde.org" r (n 0 s 0 v 0 l 0))' /> <meta name="trademark" content="KDE e.V." /> <meta name="description" content="K Desktop Environment Homepage, KDE.org" /> <meta name="MSSmartTagsPreventParsing" content="true" /> <meta name="robots" content="all" /> <link rel="shortcut icon" href="../../favicon.ico" /> <link rel="stylesheet" media="screen" type="text/css" title="APIDOX" href="doxygen.css" /> <style type="text/css"> <!-- hr { display: none; } #content h2 { margin-left: 0px; } table.mdTable { background-color: #f8f8f8; border: .2em solid #d7d7d7; } td.mdRow { padding: 8px 20px; } td.md { font-weight: bold; } td.mdname1 { font-weight: bold; color: #602020; } td.mdname { font-weight: bold; color: #602020; } --> </style> </head> <body> <div id="nav_header_top" align="right"> <a href="#content" class="doNotDisplay" accesskey="2">Skip to main content ::</a> <a href="../.."><img id="nav_header_logo" alt="Home" align="left" src="../../kde_gear_64.png" border="0" /></a> <span class="doNotDisplay">::</span> <img id="nav_header_logo_right" alt="" align="right" src="../../pimlogo.png" border="0" /> <div id="nav_header_title" align="left">KDE PIM API Reference</div> </div> <div id="nav_header_bottom" align="right"> <span class="doNotDisplay">:: <a href="#navigation" accesskey="5">Skip to Link Menu</a><br/></span> <div id="nav_header_bottom_left" style="text-align: left;"> / <a href="../../">API Reference</a> / <a href=".">karm</a> </div> </div> <table id="main" border="0" cellpadding="0" cellspacing="0" width="100%"> <tr> <td valign="top" class="menuheader" height="0"></td> <td id="contentcolumn" valign="top" rowspan="2" > <div id="content" style="padding-top: 0px;"><div style="width:100%; margin: 0px; padding: 0px;"> <h2><a name="content"></a>karm</h2> <!-- Generated by Doxygen 1.5.5 --> <div class="contents"> <h1>IdleTimeDetector Class Reference</h1><!-- doxytag: class="IdleTimeDetector" --><!-- doxytag: inherits="QObject" --><code>#include <<a class="el" href="idletimedetector_8h-source.html">idletimedetector.h</a>></code> <p> Inherits QObject. <p> <p> <a href="classIdleTimeDetector-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> Keep track of how long the computer has been idle. <p>Definition at line <a class="el" href="idletimedetector_8h-source.html#l00028">28</a> of file <a class="el" href="idletimedetector_8h-source.html">idletimedetector.h</a>.</p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Public Slots</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIdleTimeDetector.html#ee5929bd06be255ea09790bf474ff3ff">setMaxIdle</a> (int maxIdle)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIdleTimeDetector.html#1ee14e6756fd95ca2b1ea00f89b4e97d">startIdleDetection</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIdleTimeDetector.html#d5e53c7ecaa371791e484473efd8953f">stopIdleDetection</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIdleTimeDetector.html#be788ab718c6bfcfabefb28f717a8387">toggleOverAllIdleDetection</a> (bool on)</td></tr> <tr><td colspan="2"><br><h2>Signals</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIdleTimeDetector.html#1c14010a08c5234c668493135c98ab92">extractTime</a> (int minutes)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIdleTimeDetector.html#3fe06c02ea71ec3d891059b5d88b337f">stopAllTimers</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIdleTimeDetector.html#087f9fa07f3001090cdaf9732a01f65c">stopAllTimersAt</a> (QDateTime qdt)</td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIdleTimeDetector.html#4057503bac5d04834a74f11b42c9802d">IdleTimeDetector</a> (int maxIdle)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classIdleTimeDetector.html#ef350c1a3ab19b9f8e18e8565e976086">isIdleDetectionPossible</a> ()</td></tr> <tr><td colspan="2"><br><h2>Protected Slots</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="083bfabd0b11c2dcdfdb8477accae956"></a><!-- doxytag: member="IdleTimeDetector::check" ref="083bfabd0b11c2dcdfdb8477accae956" args="()" --> void </td><td class="memItemRight" valign="bottom"><b>check</b> ()</td></tr> </table> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="4057503bac5d04834a74f11b42c9802d"></a><!-- doxytag: member="IdleTimeDetector::IdleTimeDetector" ref="4057503bac5d04834a74f11b42c9802d" args="(int maxIdle)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">IdleTimeDetector::IdleTimeDetector </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> <em>maxIdle</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Initializes and idle test timer. <p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>maxIdle</em> </td><td>minutes before the idle timer will go off. </td></tr> </table> </dl> <p>Definition at line <a class="el" href="idletimedetector_8cpp-source.html#l00010">10</a> of file <a class="el" href="idletimedetector_8cpp-source.html">idletimedetector.cpp</a>.</p> </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="ef350c1a3ab19b9f8e18e8565e976086"></a><!-- doxytag: member="IdleTimeDetector::isIdleDetectionPossible" ref="ef350c1a3ab19b9f8e18e8565e976086" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool IdleTimeDetector::isIdleDetectionPossible </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Returns true if it is possible to do idle detection. <p> Idle detection relys on a feature in the X server, which might not always be present. <p>Definition at line <a class="el" href="idletimedetector_8cpp-source.html#l00033">33</a> of file <a class="el" href="idletimedetector_8cpp-source.html">idletimedetector.cpp</a>.</p> </div> </div><p> <a class="anchor" name="1c14010a08c5234c668493135c98ab92"></a><!-- doxytag: member="IdleTimeDetector::extractTime" ref="1c14010a08c5234c668493135c98ab92" args="(int minutes)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void IdleTimeDetector::extractTime </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> <em>minutes</em> </td> <td> ) </td> <td width="100%"><code> [signal]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Tells the listener to extract time from current timing. <p> The time to extract is due to the idle time since the dialog wass shown, and until the user answers the dialog. <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>minutes</em> </td><td>Minutes to extract. </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="3fe06c02ea71ec3d891059b5d88b337f"></a><!-- doxytag: member="IdleTimeDetector::stopAllTimers" ref="3fe06c02ea71ec3d891059b5d88b337f" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void IdleTimeDetector::stopAllTimers </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [signal]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Tells the listener to stop timing. <p> </div> </div><p> <a class="anchor" name="087f9fa07f3001090cdaf9732a01f65c"></a><!-- doxytag: member="IdleTimeDetector::stopAllTimersAt" ref="087f9fa07f3001090cdaf9732a01f65c" args="(QDateTime qdt)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void IdleTimeDetector::stopAllTimersAt </td> <td>(</td> <td class="paramtype">QDateTime </td> <td class="paramname"> <em>qdt</em> </td> <td> ) </td> <td width="100%"><code> [signal]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Tells the listener to stop timing for QDateTime. <p> </div> </div><p> <a class="anchor" name="ee5929bd06be255ea09790bf474ff3ff"></a><!-- doxytag: member="IdleTimeDetector::setMaxIdle" ref="ee5929bd06be255ea09790bf474ff3ff" args="(int maxIdle)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void IdleTimeDetector::setMaxIdle </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> <em>maxIdle</em> </td> <td> ) </td> <td width="100%"><code> [slot]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Sets the maximum allowed idle. <p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>maxIdle</em> </td><td>Maximum allowed idle time in minutes </td></tr> </table> </dl> <p>Definition at line <a class="el" href="idletimedetector_8cpp-source.html#l00053">53</a> of file <a class="el" href="idletimedetector_8cpp-source.html">idletimedetector.cpp</a>.</p> </div> </div><p> <a class="anchor" name="1ee14e6756fd95ca2b1ea00f89b4e97d"></a><!-- doxytag: member="IdleTimeDetector::startIdleDetection" ref="1ee14e6756fd95ca2b1ea00f89b4e97d" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void IdleTimeDetector::startIdleDetection </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [slot]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Starts detecting idle time. <p> <p>Definition at line <a class="el" href="idletimedetector_8cpp-source.html#l00101">101</a> of file <a class="el" href="idletimedetector_8cpp-source.html">idletimedetector.cpp</a>.</p> </div> </div><p> <a class="anchor" name="d5e53c7ecaa371791e484473efd8953f"></a><!-- doxytag: member="IdleTimeDetector::stopIdleDetection" ref="d5e53c7ecaa371791e484473efd8953f" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void IdleTimeDetector::stopIdleDetection </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [slot]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Stops detecting idle time. <p> <p>Definition at line <a class="el" href="idletimedetector_8cpp-source.html#l00111">111</a> of file <a class="el" href="idletimedetector_8cpp-source.html">idletimedetector.cpp</a>.</p> </div> </div><p> <a class="anchor" name="be788ab718c6bfcfabefb28f717a8387"></a><!-- doxytag: member="IdleTimeDetector::toggleOverAllIdleDetection" ref="be788ab718c6bfcfabefb28f717a8387" args="(bool on)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void IdleTimeDetector::toggleOverAllIdleDetection </td> <td>(</td> <td class="paramtype">bool </td> <td class="paramname"> <em>on</em> </td> <td> ) </td> <td width="100%"><code> [slot]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Sets whether idle detection should be done at all. <p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>on</em> </td><td>If true idle detection is done based on startIdleDetection and <a class="el" href="classIdleTimeDetector.html#d5e53c7ecaa371791e484473efd8953f">stopIdleDetection</a> </td></tr> </table> </dl> <p>Definition at line <a class="el" href="idletimedetector_8cpp-source.html#l00118">118</a> of file <a class="el" href="idletimedetector_8cpp-source.html">idletimedetector.cpp</a>.</p> </div> </div><p> <hr>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="idletimedetector_8h-source.html">idletimedetector.h</a><li><a class="el" href="idletimedetector_8cpp-source.html">idletimedetector.cpp</a></ul> </div> </div></div> </td> </tr> <tr> <td valign="top" id="leftmenu" width="25%"> <a name="navigation"></a> <div class="menu_box"><h2>karm</h2> <div class="nav_list"> <ul><li><a href="index.html">Main Page</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="files.html">File List</a></li><li><a href="functions.html">Class Members</a></li><li><a href="pages.html">Related Pages</a></li></ul> <!-- <h2>Class Picker</h2> <div style="text-align: center;"> <form name="guideform"> <select name="guidelinks" style="width:100%;" onChange="window.location=document.guideform.guidelinks.options[document.guideform.guidelinks.selectedIndex].value"> <option value="annotated.html">-- Choose --</option> <option value="classDesktopTracker.html">desktoptracker</option>, <option value="classEditTaskDialog.html">edittaskdialog</option>, <option value="classHistoryEvent.html">historyevent</option>, <option value="classIdleTimeDetector.html">idletimedetector</option>, <option value="classKAccelMenuWatch.html">kaccelmenuwatch</option>, <option value="classKarmDCOPIface.html">karmdcopiface</option>, <option value="classKarmStorage.html">karmstorage</option>, <option value="classKArmTimeWidget.html">karmtimewidget</option>, <option value="classMainWindow.html">mainwindow</option>, <option value="classMyPrinter.html">myprinter</option>, <option value="classPlannerParser.html">plannerparser</option>, <option value="classPreferences.html">preferences</option>, <option value="classReportCriteria.html">reportcriteria</option>, <option value="classTask.html">task</option>, <option value="classTaskView.html">taskview</option>, <option value="classTaskViewWhatsThis.html">taskviewwhatsthis</option>, <option value="classTimeKard.html">timekard</option>, <option value="classWeek.html">week</option>, </select> </form> </div> --> </div></div> <div class="menu_box"><h2>API Dox</h2> <div class="nav_list"> <ul> <li><a href="../../akregator/html/index.html">akregator</a></li><li> <a href="../../akregator/src/html/index.html">src</a></li><li> <a href="../../akregator/src/librss/html/index.html">librss</a></li><li><a href="../../certmanager/html/index.html">certmanager</a></li><li> <a href="../../certmanager/lib/html/index.html">lib</a></li><li><a href="../../kaddressbook/html/index.html">kaddressbook</a></li><li><a href="../../kalarm/html/index.html">kalarm</a></li><li> <a href="../../kalarm/lib/html/index.html">lib</a></li><li><a href="../../kandy/html/index.html">kandy</a></li><li><a href="../../karm/html/index.html">karm</a></li><li><a href="../../kdgantt/html/index.html">kdgantt</a></li><li><a href="../../kgantt/html/index.html">kgantt</a></li><li><a href="../../kioslaves/html/index.html">kioslaves</a></li><li> <a href="../../kioslaves/imap4/html/index.html">imap4</a></li><li> <a href="../../kioslaves/mbox/html/index.html">mbox</a></li><li><a href="../../kitchensync/html/index.html">kitchensync</a></li><li><a href="../../kmail/html/index.html">kmail</a></li><li><a href="../../knotes/html/index.html">knotes</a></li><li><a href="../../konsolekalendar/html/index.html">konsolekalendar</a></li><li><a href="../../kontact/html/index.html">kontact</a></li><li><a href="../../korganizer/html/index.html">korganizer</a></li><li><a href="../../kpilot/html/index.html">kpilot</a></li><li> <a href="../../kpilot/kpilot/html/index.html">kpilot</a></li><li> <a href="../../kpilot/lib/html/index.html">lib</a></li><li><a href="../../libemailfunctions/html/index.html">libemailfunctions</a></li><li><a href="../../libkcal/html/index.html">libkcal</a></li><li><a href="../../libkdepim/html/index.html">libkdepim</a></li><li><a href="../../libkholidays/html/index.html">libkholidays</a></li><li><a href="../../libkmime/html/index.html">libkmime</a></li><li><a href="../../libkpgp/html/index.html">libkpgp</a></li><li><a href="../../libkpimidentities/html/index.html">libkpimidentities</a></li> </ul></div></div> </td> </tr> </table> <span class="doNotDisplay"> <a href="http://www.kde.org/" accesskey="8">KDE Home</a> | <a href="http://accessibility.kde.org/" accesskey="9">KDE Accessibility Home</a> | <a href="http://www.kde.org/media/accesskeys.php" accesskey="0">Description of Access Keys</a> </span> <div style="height: 8px"></div> <div id="footer"> <div id="footer_left"> Maintained by <a href="mailto:groot@kde.org">Adriaan de Groot</a> and <a href="mailto:winter@kde.org">Allen Winter</a>. <br/> KDE and K Desktop Environment are trademarks of <a href="http://www.kde.org/areas/kde-ev/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> | <a href="http://www.kde.org/contact/impressum.php">Legal</a> </div> <div id="footer_right"><img src="/media/images/footer_right.png" style="margin: 0px" alt="" /></div> </div> <!-- WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL BE BLOCKED INSTANTLY AND PERMANENTLY! <a href="mailto:aaaatrap-425acc3b5374943f@kde.org">Block me</a> WARNING END --> </body> </html>