util/X86LINUX64/man/man3/Tk_DeleteAllBindings.3

   1 '\"
   2 '\" Copyright (c) 1994 The Regents of the University of California.
   3 '\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
   4 '\"
   5 '\" See the file "license.terms" for information on usage and redistribution
   6 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
   7 '\"
   8 .TH Tk_CreateBindingTable 3 4.0 Tk "Tk Library Procedures"
   9 .\" The -*- nroff -*- definitions below are for supplemental macros used
  10 .\" in Tcl/Tk manual entries.
  11 .\"
  12 .\" .AP type name in/out ?indent?
  13 .\"     Start paragraph describing an argument to a library procedure.
  14 .\"     type is type of argument (int, etc.), in/out is either "in", "out",
  15 .\"     or "in/out" to describe whether procedure reads or modifies arg,
  16 .\"     and indent is equivalent to second arg of .IP (shouldn't ever be
  17 .\"     needed;  use .AS below instead)
  18 .\"
  19 .\" .AS ?type? ?name?
  20 .\"     Give maximum sizes of arguments for setting tab stops.  Type and
  21 .\"     name are examples of largest possible arguments that will be passed
  22 .\"     to .AP later.  If args are omitted, default tab stops are used.
  23 .\"
  24 .\" .BS
  25 .\"     Start box enclosure.  From here until next .BE, everything will be
  26 .\"     enclosed in one large box.
  27 .\"
  28 .\" .BE
  29 .\"     End of box enclosure.
  30 .\"
  31 .\" .CS
  32 .\"     Begin code excerpt.
  33 .\"
  34 .\" .CE
  35 .\"     End code excerpt.
  36 .\"
  37 .\" .VS ?version? ?br?
  38 .\"     Begin vertical sidebar, for use in marking newly-changed parts
  39 .\"     of man pages.  The first argument is ignored and used for recording
  40 .\"     the version when the .VS was added, so that the sidebars can be
  41 .\"     found and removed when they reach a certain age.  If another argument
  42 .\"     is present, then a line break is forced before starting the sidebar.
  43 .\"
  44 .\" .VE
  45 .\"     End of vertical sidebar.
  46 .\"
  47 .\" .DS
  48 .\"     Begin an indented unfilled display.
  49 .\"
  50 .\" .DE
  51 .\"     End of indented unfilled display.
  52 .\"
  53 .\" .SO ?manpage?
  54 .\"     Start of list of standard options for a Tk widget. The manpage
  55 .\"     argument defines where to look up the standard options; if
  56 .\"     omitted, defaults to "options". The options follow on successive
  57 .\"     lines, in three columns separated by tabs.
  58 .\"
  59 .\" .SE
  60 .\"     End of list of standard options for a Tk widget.
  61 .\"
  62 .\" .OP cmdName dbName dbClass
  63 .\"     Start of description of a specific option.  cmdName gives the
  64 .\"     option's name as specified in the class command, dbName gives
  65 .\"     the option's name in the option database, and dbClass gives
  66 .\"     the option's class in the option database.
  67 .\"
  68 .\" .UL arg1 arg2
  69 .\"     Print arg1 underlined, then print arg2 normally.
  70 .\"
  71 .\" .QW arg1 ?arg2?
  72 .\"     Print arg1 in quotes, then arg2 normally (for trailing punctuation).
  73 .\"
  74 .\" .PQ arg1 ?arg2?
  75 .\"     Print an open parenthesis, arg1 in quotes, then arg2 normally
  76 .\"     (for trailing punctuation) and then a closing parenthesis.
  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 .BS
 277 .SH NAME
 278 Tk_CreateBindingTable, Tk_DeleteBindingTable, Tk_CreateBinding, Tk_DeleteBinding, Tk_GetBinding, Tk_GetAllBindings, Tk_DeleteAllBindings, Tk_BindEvent \- invoke scripts in response to X events
 279 .SH SYNOPSIS
 280 .nf
 281 \fB#include <tk.h>\fR
 282 .sp
 283 Tk_BindingTable
 284 \fBTk_CreateBindingTable(\fIinterp\fB)\fR
 285 .sp
 286 \fBTk_DeleteBindingTable(\fIbindingTable\fB)\fR
 287 .sp
 288 unsigned long
 289 \fBTk_CreateBinding(\fIinterp, bindingTable, object, eventString, script, append\fB)\fR
 290 .sp
 291 int
 292 \fBTk_DeleteBinding(\fIinterp, bindingTable, object, eventString\fB)\fR
 293 .sp
 294 const char *
 295 \fBTk_GetBinding(\fIinterp, bindingTable, object, eventString\fB)\fR
 296 .sp
 297 \fBTk_GetAllBindings(\fIinterp, bindingTable, object\fB)\fR
 298 .sp
 299 \fBTk_DeleteAllBindings(\fIbindingTable, object\fB)\fR
 300 .sp
 301 \fBTk_BindEvent(\fIbindingTable, eventPtr, tkwin, numObjects, objectPtr\fB)\fR
 302 .SH ARGUMENTS
 303 .AS Tk_BindingTable bindingTable
 304 .AP Tcl_Interp *interp in
 305 Interpreter to use when invoking bindings in binding table.  Also
 306 used for returning results and errors from binding procedures.
 307 .AP Tk_BindingTable bindingTable in
 308 Token for binding table;  must have been returned by some previous
 309 call to \fBTk_CreateBindingTable\fR.
 310 .AP ClientData object in
 311 Identifies object with which binding is associated.
 312 .AP "const char" *eventString in
 313 String describing event sequence.
 314 .AP "const char" *script in
 315 Tcl script to invoke when binding triggers.
 316 .AP int append in
 317 Non-zero means append \fIscript\fR to existing script for binding,
 318 if any; zero means replace existing script with new one.
 319 .AP XEvent *eventPtr in
 320 X event to match against bindings in \fIbindingTable\fR.
 321 .AP Tk_Window tkwin in
 322 Identifier for any window on the display where the event occurred.
 323 Used to find display-related information such as key maps.
 324 .AP int numObjects in
 325 Number of object identifiers pointed to by \fIobjectPtr\fR.
 326 .AP ClientData *objectPtr in
 327 Points to an array of object identifiers:  bindings will be considered
 328 for each of these objects in order from first to last.
 329 .BE
 330 .SH DESCRIPTION
 331 .PP
 332 These procedures provide a general-purpose mechanism for creating
 333 and invoking bindings.
 334 Bindings are organized in terms of \fIbinding tables\fR.
 335 A binding table consists of a collection of bindings plus a history
 336 of recent events.
 337 Within a binding table, bindings are associated with \fIobjects\fR.
 338 The meaning of an object is defined by clients of the binding package.
 339 For example, Tk keeps uses one binding table to hold all of the bindings
 340 created by the \fBbind\fR command.
 341 For this table, objects are pointers to strings such as window names, class
 342 names, or other binding tags such as \fBall\fR.
 343 Tk also keeps a separate binding table for each canvas widget, which manages
 344 bindings created by the canvas's \fBbind\fR widget command;  within
 345 this table, an object is either a pointer to the internal structure for a
 346 canvas item or a Tk_Uid identifying a tag.
 347 .PP
 348 The procedure \fBTk_CreateBindingTable\fR creates a new binding
 349 table and associates \fIinterp\fR with it (when bindings in the
 350 table are invoked, the scripts will be evaluated in \fIinterp\fR).
 351 \fBTk_CreateBindingTable\fR returns a token for the table, which
 352 must be used in calls to other procedures such as \fBTk_CreateBinding\fR
 353 or \fBTk_BindEvent\fR.
 354 .PP
 355 \fBTk_DeleteBindingTable\fR frees all of the state associated
 356 with a binding table.
 357 Once it returns the caller should not use the \fIbindingTable\fR
 358 token again.
 359 .PP
 360 \fBTk_CreateBinding\fR adds a new binding to an existing table.
 361 The \fIobject\fR argument identifies the object with which the
 362 binding is to be associated, and it may be any one-word value.
 363 Typically it is a pointer to a string or data structure.
 364 The \fIeventString\fR argument identifies the event or sequence
 365 of events for the binding;  see the documentation for the
 366 \fBbind\fR command for a description of its format.
 367 \fIscript\fR is the Tcl script to be evaluated when the binding
 368 triggers.
 369 \fIappend\fR indicates what to do if there already
 370 exists a binding for \fIobject\fR and \fIeventString\fR:  if \fIappend\fR
 371 is zero then \fIscript\fR replaces the old script;  if \fIappend\fR
 372 is non-zero then the new script is appended to the old one.
 373 \fBTk_CreateBinding\fR returns an X event mask for all the events
 374 associated with the bindings.
 375 This information may be useful to invoke \fBXSelectInput\fR to
 376 select relevant events, or to disallow the use of certain events
 377 in bindings.
 378 If an error occurred while creating the binding (e.g., \fIeventString\fR
 379 refers to a non-existent event), then 0 is returned and an error
 380 message is left as the result of interpreter \fIinterp\fR.
 381 .PP
 382 \fBTk_DeleteBinding\fR removes from \fIbindingTable\fR the
 383 binding given by \fIobject\fR and \fIeventString\fR, if
 384 such a binding exists.
 385 \fBTk_DeleteBinding\fR always returns \fBTCL_OK\fR.
 386 In some cases it may reset the interpreter result to the default
 387 empty value.
 388 .PP
 389 \fBTk_GetBinding\fR returns a pointer to the script associated
 390 with \fIeventString\fR and \fIobject\fR in \fIbindingTable\fR.
 391 If no such binding exists then NULL is returned and an error
 392 message is left as the result of interpreter \fIinterp\fR.
 393 .PP
 394 \fBTk_GetAllBindings\fR returns in \fIinterp\fR's result a list
 395 of all the event strings for which there are bindings in
 396 \fIbindingTable\fR associated with \fIobject\fR.
 397 If there are no bindings for \fIobject\fR, the result will be an empty
 398 string.
 399 .PP
 400 \fBTk_DeleteAllBindings\fR deletes all of the bindings in
 401 \fIbindingTable\fR that are associated with \fIobject\fR.
 402 .PP
 403 \fBTk_BindEvent\fR is called to process an event.
 404 It makes a copy of the event in an internal history list associated
 405 with the binding table, then it checks for bindings that match
 406 the event.
 407 \fBTk_BindEvent\fR processes each of the objects pointed to
 408 by \fIobjectPtr\fR in turn.
 409 For each object, it finds all the bindings that match the current
 410 event history, selects the most specific binding using the priority
 411 mechanism described in the documentation for \fBbind\fR,
 412 and invokes the script for that binding.
 413 If there are no matching bindings for a particular object, then
 414 the object is skipped.
 415 \fBTk_BindEvent\fR continues through all of the objects, handling
 416 exceptions such as errors, \fBbreak\fR, and \fBcontinue\fR as
 417 described in the documentation for \fBbind\fR.
 418 .SH KEYWORDS
 419 binding, event, object, script