head	1.4;
access;
symbols
	core-8-5-9:1.3
	core-8-5-8:1.3
	macosx-cocoa-merge:1.4
	macosx-cocoa-premerge:1.4
	macosx-carbon-freeze:1.4
	core-8-5-7:1.3
	core-8-5-6:1.3
	core-8-6-b1:1.4
	core-8-6-a3:1.4
	core-8-5-5:1.3
	core-8-6-a2:1.4
	core-8-5-4:1.3
	core-8-5-3:1.3
	core-8-6-a1:1.3
	core-8-5-branch:1.3.0.2
	core-8-5-2:1.3
	core-8-5-1:1.3
	core-8-5-0:1.3
	core-8-5-b3:1.2
	core-8-5-b2:1.1
	core-8-5-b1:1.1
	core-stablilizer-merge:1.1
	core-stabilizer-branch:1.1.0.2
	core-stabilizer-merge:1.3
	core-8-5-a6:1.1
	core-8-5-a5:1.1
	core-8-5-a4:1.1
	core-8-5-a3:1.1;
locks; strict;
comment	@.\" @;


1.4
date	2008.06.30.22.57.01;	author dkf;	state Exp;
branches;
next	1.3;

1.3
date	2007.12.13.15.23.43;	author dgp;	state Exp;
branches;
next	1.2;

1.2
date	2007.10.29.16.04.12;	author dkf;	state Exp;
branches;
next	1.1;

1.1
date	2005.05.31.15.24.53;	author rmax;	state Exp;
branches
	1.1.2.1;
next	;

1.1.2.1
date	2007.11.01.16.37.13;	author dgp;	state Exp;
branches;
next	;


desc
@@


1.4
log
@Minor doc updates (removing out of date changebars, improving typedef formatting,
 etc.)
@
text
@'\"
'\" Copyright (c) 1998-2000 by Scriptics Corporation.
'\" All rights reserved.
'\" 
'\" RCS: @@(#) $Id: Inactive.3,v 1.3 2007/12/13 15:23:43 dgp 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 do not
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 do not support
multiple displays \fIdisplay\fR can be passed as \fBNULL\fR.
.SH KEYWORDS
idle, inactive
@


1.3
log
@merge stable branch onto HEAD
@
text
@d5 1
a5 1
'\" RCS: @@(#) $Id: Inactive.3,v 1.1.2.1 2007/11/01 16:37:13 dgp Exp $
a25 1

a34 1

@


1.2
log
@Lots more GOOBE stuff. Now works with 'make html'!
@
text
@d5 1
a5 1
'\" RCS: @@(#) $Id: Inactive.3,v 1.1 2005/05/31 15:24:53 rmax Exp $
@


1.1
log
@* 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.
@
text
@d5 1
a5 1
'\" RCS: @@(#) $Id: GetHINSTANCE.3,v 1.2 2002/11/15 15:35:55 dkf Exp $
d31 2
a32 2
mouse) with the respective display. On systems and displays that don't
support querying the user inactiviy time, \fB-1\fR is returned.
d34 1
a34 1
given display to zero.  On windowing systems that don't support
@


1.1.2.1
log
@merge updates from HEAD
@
text
@d5 1
a5 1
'\" RCS: @@(#) $Id: Inactive.3,v 1.1 2005/05/31 15:24:53 rmax Exp $
d31 2
a32 2
mouse) with the respective display. On systems and displays that do not
support querying the user inactiviy time, \fB\-1\fR is returned.
d34 1
a34 1
given display to zero.  On windowing systems that do not support
@


