hostdepend/X86MAC64/util/X86MAC64/man/man3/Tk_GetUserInactiveTime.3

   1 '\"
   2 '\" Copyright (c) 1998-2000 by Scriptics Corporation.
   3 '\" All rights reserved.
   4 '\"
   5 '\" RCS: @(#) $Id: Inactive.3,v 1.3 2007/12/13 15:23:43 dgp Exp $
   6 '\"
   7 .\" The -*- nroff -*- definitions below are for supplemental macros used
   8 .\" in Tcl/Tk manual entries.
   9 .\"
  10 .\" .AP type name in/out ?indent?
  11 .\"     Start paragraph describing an argument to a library procedure.
  12 .\"     type is type of argument (int, etc.), in/out is either "in", "out",
  13 .\"     or "in/out" to describe whether procedure reads or modifies arg,
  14 .\"     and indent is equivalent to second arg of .IP (shouldn't ever be
  15 .\"     needed;  use .AS below instead)
  16 .\"
  17 .\" .AS ?type? ?name?
  18 .\"     Give maximum sizes of arguments for setting tab stops.  Type and
  19 .\"     name are examples of largest possible arguments that will be passed
  20 .\"     to .AP later.  If args are omitted, default tab stops are used.
  21 .\"
  22 .\" .BS
  23 .\"     Start box enclosure.  From here until next .BE, everything will be
  24 .\"     enclosed in one large box.
  25 .\"
  26 .\" .BE
  27 .\"     End of box enclosure.
  28 .\"
  29 .\" .CS
  30 .\"     Begin code excerpt.
  31 .\"
  32 .\" .CE
  33 .\"     End code excerpt.
  34 .\"
  35 .\" .VS ?version? ?br?
  36 .\"     Begin vertical sidebar, for use in marking newly-changed parts
  37 .\"     of man pages.  The first argument is ignored and used for recording
  38 .\"     the version when the .VS was added, so that the sidebars can be
  39 .\"     found and removed when they reach a certain age.  If another argument
  40 .\"     is present, then a line break is forced before starting the sidebar.
  41 .\"
  42 .\" .VE
  43 .\"     End of vertical sidebar.
  44 .\"
  45 .\" .DS
  46 .\"     Begin an indented unfilled display.
  47 .\"
  48 .\" .DE
  49 .\"     End of indented unfilled display.
  50 .\"
  51 .\" .SO ?manpage?
  52 .\"     Start of list of standard options for a Tk widget. The manpage
  53 .\"     argument defines where to look up the standard options; if
  54 .\"     omitted, defaults to "options". The options follow on successive
  55 .\"     lines, in three columns separated by tabs.
  56 .\"
  57 .\" .SE
  58 .\"     End of list of standard options for a Tk widget.
  59 .\"
  60 .\" .OP cmdName dbName dbClass
  61 .\"     Start of description of a specific option.  cmdName gives the
  62 .\"     option's name as specified in the class command, dbName gives
  63 .\"     the option's name in the option database, and dbClass gives
  64 .\"     the option's class in the option database.
  65 .\"
  66 .\" .UL arg1 arg2
  67 .\"     Print arg1 underlined, then print arg2 normally.
  68 .\"
  69 .\" .QW arg1 ?arg2?
  70 .\"     Print arg1 in quotes, then arg2 normally (for trailing punctuation).
  71 .\"
  72 .\" .PQ arg1 ?arg2?
  73 .\"     Print an open parenthesis, arg1 in quotes, then arg2 normally
  74 .\"     (for trailing punctuation) and then a closing parenthesis.
  75 .\"
  76 .\" RCS: @(#) $Id: man.macros,v 1.9 2008/01/29 15:32:33 dkf Exp $
  77 .\"
  78 .\"     # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
  79 .if t .wh -1.3i ^B
  80 .nr ^l \n(.l
  81 .ad b
  82 .\"     # Start an argument description
  83 .de AP
  84 .ie !"\\$4"" .TP \\$4
  85 .el \{\
  86 .   ie !"\\$2"" .TP \\n()Cu
  87 .   el          .TP 15
  88 .\}
  89 .ta \\n()Au \\n()Bu
  90 .ie !"\\$3"" \{\
  91 \&\\$1 \\fI\\$2\\fP (\\$3)
  92 .\".b
  93 .\}
  94 .el \{\
  95 .br
  96 .ie !"\\$2"" \{\
  97 \&\\$1  \\fI\\$2\\fP
  98 .\}
  99 .el \{\
 100 \&\\fI\\$1\\fP
 101 .\}
 102 .\}
 103 ..
 104 .\"     # define tabbing values for .AP
 105 .de AS
 106 .nr )A 10n
 107 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
 108 .nr )B \\n()Au+15n
 109 .\"
 110 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
 111 .nr )C \\n()Bu+\\w'(in/out)'u+2n
 112 ..
 113 .AS Tcl_Interp Tcl_CreateInterp in/out
 114 .\"     # BS - start boxed text
 115 .\"     # ^y = starting y location
 116 .\"     # ^b = 1
 117 .de BS
 118 .br
 119 .mk ^y
 120 .nr ^b 1u
 121 .if n .nf
 122 .if n .ti 0
 123 .if n \l'\\n(.lu\(ul'
 124 .if n .fi
 125 ..
 126 .\"     # BE - end boxed text (draw box now)
 127 .de BE
 128 .nf
 129 .ti 0
 130 .mk ^t
 131 .ie n \l'\\n(^lu\(ul'
 132 .el \{\
 133 .\"     Draw four-sided box normally, but don't draw top of
 134 .\"     box if the box started on an earlier page.
 135 .ie !\\n(^b-1 \{\
 136 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 137 .\}
 138 .el \}\
 139 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 140 .\}
 141 .\}
 142 .fi
 143 .br
 144 .nr ^b 0
 145 ..
 146 .\"     # VS - start vertical sidebar
 147 .\"     # ^Y = starting y location
 148 .\"     # ^v = 1 (for troff;  for nroff this doesn't matter)
 149 .de VS
 150 .if !"\\$2"" .br
 151 .mk ^Y
 152 .ie n 'mc \s12\(br\s0
 153 .el .nr ^v 1u
 154 ..
 155 .\"     # VE - end of vertical sidebar
 156 .de VE
 157 .ie n 'mc
 158 .el \{\
 159 .ev 2
 160 .nf
 161 .ti 0
 162 .mk ^t
 163 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
 164 .sp -1
 165 .fi
 166 .ev
 167 .\}
 168 .nr ^v 0
 169 ..
 170 .\"     # Special macro to handle page bottom:  finish off current
 171 .\"     # box/sidebar if in box/sidebar mode, then invoked standard
 172 .\"     # page bottom macro.
 173 .de ^B
 174 .ev 2
 175 'ti 0
 176 'nf
 177 .mk ^t
 178 .if \\n(^b \{\
 179 .\"     Draw three-sided box if this is the box's first page,
 180 .\"     draw two sides but no top otherwise.
 181 .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
 182 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
 183 .\}
 184 .if \\n(^v \{\
 185 .nr ^x \\n(^tu+1v-\\n(^Yu
 186 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
 187 .\}
 188 .bp
 189 'fi
 190 .ev
 191 .if \\n(^b \{\
 192 .mk ^y
 193 .nr ^b 2
 194 .\}
 195 .if \\n(^v \{\
 196 .mk ^Y
 197 .\}
 198 ..
 199 .\"     # DS - begin display
 200 .de DS
 201 .RS
 202 .nf
 203 .sp
 204 ..
 205 .\"     # DE - end display
 206 .de DE
 207 .fi
 208 .RE
 209 .sp
 210 ..
 211 .\"     # SO - start of list of standard options
 212 .de SO
 213 'ie '\\$1'' .ds So \\fBoptions\\fR
 214 'el .ds So \\fB\\$1\\fR
 215 .SH "STANDARD OPTIONS"
 216 .LP
 217 .nf
 218 .ta 5.5c 11c
 219 .ft B
 220 ..
 221 .\"     # SE - end of list of standard options
 222 .de SE
 223 .fi
 224 .ft R
 225 .LP
 226 See the \\*(So manual entry for details on the standard options.
 227 ..
 228 .\"     # OP - start of full description for a single option
 229 .de OP
 230 .LP
 231 .nf
 232 .ta 4c
 233 Command-Line Name:      \\fB\\$1\\fR
 234 Database Name:  \\fB\\$2\\fR
 235 Database Class: \\fB\\$3\\fR
 236 .fi
 237 .IP
 238 ..
 239 .\"     # CS - begin code excerpt
 240 .de CS
 241 .RS
 242 .nf
 243 .ta .25i .5i .75i 1i
 244 ..
 245 .\"     # CE - end code excerpt
 246 .de CE
 247 .fi
 248 .RE
 249 ..
 250 .\"     # UL - underline word
 251 .de UL
 252 \\$1\l'|0\(ul'\\$2
 253 ..
 254 .\"     # QW - apply quotation marks to word
 255 .de QW
 256 .ie '\\*(lq'"' ``\\$1''\\$2
 257 .\"" fix emacs highlighting
 258 .el \\*(lq\\$1\\*(rq\\$2
 259 ..
 260 .\"     # PQ - apply parens and quotation marks to word
 261 .de PQ
 262 .ie '\\*(lq'"' (``\\$1''\\$2)\\$3
 263 .\"" fix emacs highlighting
 264 .el (\\*(lq\\$1\\*(rq\\$2)\\$3
 265 ..
 266 .\"     # QR - quoted range
 267 .de QR
 268 .ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3
 269 .\"" fix emacs highlighting
 270 .el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3
 271 ..
 272 .\"     # MT - "empty" string
 273 .de MT
 274 .QW ""
 275 ..
 276 .TH Tk_GetUserInactiveTime 3 8.5 Tk "Tk Library Procedures"
 277 .BS
 278 .SH NAME
 279 Tk_GetUserInactiveTime, Tk_ResetUserInactiveTime \- discover user inactivity time
 280 .SH SYNOPSIS
 281 .nf
 282 \fB#include <tk.h>\fR
 283 .sp
 284 long
 285 \fBTk_GetUserInactiveTime(\fIdisplay\fB)\fR
 286 .sp
 287 \fBTk_GetUserInactiveTime(\fIdisplay\fB)\fR
 288 .SH ARGUMENTS
 289 .AS Display *display
 290 .AP Display *display in
 291 The display on which the user inactivity timer is to be queried or
 292 reset.
 293 .BE
 294
 295 .SH DESCRIPTION
 296 .PP
 297 \fBTk_GetUserInactiveTime\fR returns the number of milliseconds that
 298 have passed since the last user interaction (usually via keyboard or
 299 mouse) with the respective display. On systems and displays that do not
 300 support querying the user inactiviy time, \fB\-1\fR is returned.
 301 \fBTk_GetUserInactiveTime\fR resets the user inactivity timer of the
 302 given display to zero.  On windowing systems that do not support
 303 multiple displays \fIdisplay\fR can be passed as \fBNULL\fR.
 304
 305 .SH KEYWORDS
 306 idle, inactive