util/src/TclTk/tk8.6.12/doc/Inactive.3

   1 '\"
   2 '\" Copyright (c) 1998-2000 by Scriptics Corporation.
   3 '\" All rights reserved.
   4 '\"
   5 .TH Tk_GetUserInactiveTime 3 8.5 Tk "Tk Library Procedures"
   6 .so man.macros
   7 .BS
   8 .SH NAME
   9 Tk_GetUserInactiveTime, Tk_ResetUserInactiveTime \- discover user inactivity time
  10 .SH SYNOPSIS
  11 .nf
  12 \fB#include <tk.h>\fR
  13 .sp
  14 long
  15 \fBTk_GetUserInactiveTime(\fIdisplay\fB)\fR
  16 .sp
  17 \fBTk_ResetUserInactiveTime(\fIdisplay\fB)\fR
  18 .SH ARGUMENTS
  19 .AS Display *display
  20 .AP Display *display in
  21 The display on which the user inactivity timer is to be queried or
  22 reset.
  23 .BE
  24 .SH DESCRIPTION
  25 .PP
  26 \fBTk_GetUserInactiveTime\fR returns the number of milliseconds that
  27 have passed since the last user interaction (usually via keyboard or
  28 mouse) with the respective display. On systems and displays that do not
  29 support querying the user inactivity time, \fB\-1\fR is returned.
  30 \fBTk_ResetUserInactiveTime\fR resets the user inactivity timer of the
  31 given display to zero.  On windowing systems that do not support
  32 multiple displays \fIdisplay\fR can be passed as \fBNULL\fR.
  33 .SH KEYWORDS
  34 idle, inactive