man/XtRegisterDrawable.man

   1 .\" Copyright (c) 1993, 1994  X Consortium
   2 .\"
   3 .\" Permission is hereby granted, free of charge, to any person obtaining a
   4 .\" copy of this software and associated documentation files (the "Software"),
   5 .\" to deal in the Software without restriction, including without limitation
   6 .\" the rights to use, copy, modify, merge, publish, distribute, sublicense,
   7 .\" and/or sell copies of the Software, and to permit persons to whom the
   8 .\" Software furnished to do so, subject to the following conditions:
   9 .\"
  10 .\" The above copyright notice and this permission notice shall be included in
  11 .\" all copies or substantial portions of the Software.
  12 .\"
  13 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  14 .\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  15 .\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  16 .\" THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  17 .\" WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
  18 .\" OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  19 .\" SOFTWARE.
  20 .\"
  21 .\" Except as contained in this notice, the name of the X Consortium shall not
  22 .\" be used in advertising or otherwise to promote the sale, use or other
  23 .\" dealing in this Software without prior written authorization from the
  24 .\" X Consortium.
  25 .\"
  26 .ds tk X Toolkit
  27 .ds xT X Toolkit Intrinsics \- C Language Interface
  28 .ds xI Intrinsics
  29 .ds xW X Toolkit Athena Widgets \- C Language Interface
  30 .ds xL Xlib \- C Language X Interface
  31 .ds xC Inter-Client Communication Conventions Manual
  32 .ds Rn 3
  33 .ds Vn 2.2
  34 .hw XtRegister-Drawable XtUnregister-Drawable XtWindow-To-Widget wid-get
  35 .na
  36 .de Ds
  37 .nf
  38 .\\$1D \\$2 \\$1
  39 .ft CW
  40 .ps \\n(PS
  41 .\".if \\n(VS>=40 .vs \\n(VSu
  42 .\".if \\n(VS<=39 .vs \\n(VSp
  43 ..
  44 .de De
  45 .ce 0
  46 .if \\n(BD .DF
  47 .nr BD 0
  48 .in \\n(OIu
  49 .if \\n(TM .ls 2
  50 .sp \\n(DDu
  51 .fi
  52 ..
  53 .de IN          \" send an index entry to the stderr
  54 ..
  55 .de Pn
  56 .ie t \\$1\fB\^\\$2\^\fR\\$3
  57 .el \\$1\fI\^\\$2\^\fP\\$3
  58 ..
  59 .de ZN
  60 .ie t \fB\^\\$1\^\fR\\$2
  61 .el \fI\^\\$1\^\fP\\$2
  62 ..
  63 .ny0
  64 .TH XtRegisterDrawable __libmansuffix__ __xorgversion__ "XT FUNCTIONS"
  65 .SH NAME
  66 XtRegisterDrawable \- register a drawable with the Intrinsics event dispatcher
  67 .SH SYNTAX
  68 .HP
  69 void XtRegisterDrawable(Display* \fIdisplay\fP, Drawable \fIdrawable\fP,
  70 Widget \fIwidget\fP);
  71 .HP
  72 void XtUnregisterDrawable(Display* \fIdisplay\fP, Drawable \fIdrawable\fP);
  73 .SH ARGUMENTS
  74 .IP \fIdisplay\fP 1i
  75 Specifies the drawable's display.
  76 .IP \fIdrawable\fP 1i
  77 Specifies the drawable to register.
  78 .IP \fIwidget\fP 1i
  79 Specifies the widget to register the drawable for.
  80 .SH DESCRIPTION
  81 .ZN XtRegisterDrawable
  82 associates the specified drawable with the specified widget so that
  83 future calls to
  84 .ZN XtWindowToWidget
  85 with the drawable will return the widget. The default event dispatcher
  86 will dispatch future core events that arrive with the drawable to the
  87 widget as though the event contained the widget's window, but the event
  88 itself will not be changed in any way when being passed to even handler
  89 or action procedures.
  90 .LP
  91 If the drawable is already registered with another widget, or if the
  92 drawable is the window of a widget in the client's widget tree, the
  93 results of calling
  94 .ZN XtRegisterDrawable
  95 are undefined.
  96 .LP
  97 .ZN XtUnregisterDrawable
  98 removes an association created with
  99 .ZN XtRegisterDrawable .
 100 If the drawable is the window of a widget in the client's widget tree
 101 the results of calling
 102 .ZN XtUnregisterDrawable
 103 are undefined.
 104 .SH "SEE ALSO"
 105 .br
 106 \fI\*(xT\fP
 107 .br
 108 \fI\*(xL\fP