man/XtGetActionList.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 XtGet-Action-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 XtGetActionList __libmansuffix__ __xorgversion__ "XT FUNCTIONS"
  65 .SH NAME
  66 XtGetActionList \- obtain class action list
  67 .SH SYNTAX
  68 .HP
  69 void XtGetActionList(WidgetClass \fIwidget_class\fP, XtActionList*
  70 \fIactions_return\fP, Cardinal* \fInum_actions_return\fP);
  71 .SH ARGUMENTS
  72 .IP \fIwidget_class\fP 1i
  73 Specifies the widget class whose actions are to be returned.
  74 .IP \fIactions_return\fP 1i
  75 Returns the action list.
  76 .IP \fInum_actions_return\fP 1i
  77 Returns the number of action procedures declared by the class.
  78 .SH DESCRIPTION
  79 .ZN XtGetActionList
  80 returns the action table defined by the specified widget class. This
  81 table does not include actions defined by the superclasses. If
  82 \fIwidget_class\fP is not initialized, or is not
  83 .ZN coreWidgetClass
  84 or a subclass thereof, or if the class does not define any actions,
  85 *\fIactions_return\fP will be NULL and *\fInum_actions_return\fP will
  86 be zero. If *\fIactions_return\fP is non-NULL the client is responsible
  87 for freeing the table using
  88 .ZN XtFree
  89 when it is no longer needed.
  90 .SH "SEE ALSO"
  91 .br
  92 \fI\*(xT\fP
  93 .br
  94 \fI\*(xL\fP