diff options
| author | rmax <rmax> | 2005-05-31 15:24:38 (GMT) |
|---|---|---|
| committer | rmax <rmax> | 2005-05-31 15:24:38 (GMT) |
| commit | 3c42e2dc1d71aa694730d3e243523dc60d840308 (patch) | |
| tree | 771c0c00e22d4b21a5bd9bc23d8efa7032bc658a /doc/Inactive.3 | |
| parent | 51820aae78413a2e68e732649a8f5c2d42ca4fc6 (diff) | |
| download | tk-3c42e2dc1d71aa694730d3e243523dc60d840308.zip tk-3c42e2dc1d71aa694730d3e243523dc60d840308.tar.gz tk-3c42e2dc1d71aa694730d3e243523dc60d840308.tar.bz2 | |
* doc/Inactive.3 (new file): C level API documentationn for
TIP#245 (Tk_GetUserInactiveTime, Tk_ResetUserInactiveTime).
* tests/tk.test: Added tests for the TIP#245 implementation.
Diffstat (limited to 'doc/Inactive.3')
| -rw-r--r-- | doc/Inactive.3 | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/doc/Inactive.3 b/doc/Inactive.3 new file mode 100644 index 0000000..37cd93f --- /dev/null +++ b/doc/Inactive.3 @@ -0,0 +1,38 @@ +'\" +'\" Copyright (c) 1998-2000 by Scriptics Corporation. +'\" All rights reserved. +'\" +'\" RCS: @(#) $Id: Inactive.3,v 1.1 2005/05/31 15:24:53 rmax Exp $ +'\" +.so man.macros +.TH Tk_GetUserInactiveTime 3 8.5 Tk "Tk Library Procedures" +.BS +.SH NAME +Tk_GetUserInactiveTime, Tk_ResetUserInactiveTime \- discover user inactivity time +.SH SYNOPSIS +.nf +\fB#include <tk.h>\fR +.sp +long +\fBTk_GetUserInactiveTime(\fIdisplay\fB)\fR +.sp +\fBTk_GetUserInactiveTime(\fIdisplay\fB)\fR +.SH ARGUMENTS +.AS Display *display +.AP Display *display in +The display on which the user inactivity timer is to be queried or +reset. +.BE + +.SH DESCRIPTION +.PP +\fBTk_GetUserInactiveTime\fR returns the number of milliseconds that +have passed since the last user interaction (usually via keyboard or +mouse) with the respective display. On systems and displays that don't +support querying the user inactiviy time, \fB-1\fR is returned. +\fBTk_GetUserInactiveTime\fR resets the user inactivity timer of the +given display to zero. On windowing systems that don't support +multiple displays \fIdisplay\fR can be passed as \fBNULL\fR. + +.SH KEYWORDS +idle, inactive |