man/XtCallCallbacks.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 XtCall-Callbacks XtHas-Callbacks XtCall-Callbacks-List 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 XtCallCallbacks __libmansuffix__ __xorgversion__ "XT FUNCTIONS"
  65 .SH NAME
  66 XtCallCallbacks, XtCallCallbackList, XtHasCallbacks \- process callbacks
  67 .SH SYNTAX
  68 .HP
  69 void XtCallCallbacks(Widget \fIw\fP, String \fIcallback_name\fP, XtPointer
  70 \fIcall_data\fP);
  71 .HP
  72 void XtCallCallbackList(Widget \fIw\fP, XtCallbackList \fIcallbacks\fP,
  73 XtPointer \fIcall_data\fP);
  74 .LP
  75 typedef enum {XtCallbackNoList, XtCallbackHasNone, XtCallbackHasSome}
  76 XtCallbackStatus;
  77 .HP
  78 XtCallbackStatus XtHasCallbacks(Widget \fIw\fP, String \fIcallback_name\fP);
  79 .SH ARGUMENTS
  80 .ds Cn \ to be executed or checked
  81 .IP \fIcallback_name\fP 1i
  82 Specifies the callback list\*(Cn.
  83 .IP \fIcall_data\fP 1i
  84 Specifies a callback-list specific data value to pass to each of the callback
  85 procedure in the list.
  86 .IP \fIcallbacks\fP 1i
  87 Specifies the callback list to be executed.
  88 .IP \fIw\fP 1i
  89 Specifies the widget.
  90 .SH DESCRIPTION
  91 The
  92 .ZN XtCallCallbacks
  93 function calls each procedure that is registered in the specified widget's
  94 callback list.
  95 .LP
  96 If \fIcallbacks\fP is not NULL,
  97 .ZN XtCallCallbackList
  98 calls each of the callback procedures in the list, passing client data
  99 and \fIcall_data\fP. The \fIcallbacks\fP parameter must specify the
 100 contents of a widget or object resource declared with representation
 101 type
 102 .ZN XtRCallback .
 103 .LP
 104 The
 105 .ZN XtHasCallbacks
 106 function first checks to see if the widget has a callback list identified
 107 by callback_name.
 108 If the callback list does not exist,
 109 .ZN XtHasCallbacks
 110 returns
 111 .ZN XtCallbackNoList .
 112 If the callback list exists but is empty,
 113 it returns
 114 .ZN XtCallbackHasNone .
 115 If the callback list exists and has at least one callback registered,
 116 it returns
 117 .ZN XtCallbackHasSome .
 118 .SH "SEE ALSO"
 119 XtAddCallback(__libmansuffix__)
 120 .br
 121 \fI\*(xT\fP
 122 .br
 123 \fI\*(xL\fP