diff options
Diffstat (limited to 'libXt/man/XtGetClassExtension.man')
-rw-r--r-- | libXt/man/XtGetClassExtension.man | 166 |
1 files changed, 166 insertions, 0 deletions
diff --git a/libXt/man/XtGetClassExtension.man b/libXt/man/XtGetClassExtension.man new file mode 100644 index 000000000..d71e4cbce --- /dev/null +++ b/libXt/man/XtGetClassExtension.man @@ -0,0 +1,166 @@ +.\" $Xorg: XtGetClExt.man,v 1.3 2000/08/17 19:42:00 cpqbld Exp $ +.\" +.\" Copyright (c) 1993, 1994 X Consortium +.\" +.\" Permission is hereby granted, free of charge, to any person obtaining a +.\" copy of this software and associated documentation files (the "Software"), +.\" to deal in the Software without restriction, including without limitation +.\" the rights to use, copy, modify, merge, publish, distribute, sublicense, +.\" and/or sell copies of the Software, and to permit persons to whom the +.\" Software furnished to do so, subject to the following conditions: +.\" +.\" The above copyright notice and this permission notice shall be included in +.\" all copies or substantial portions of the Software. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +.\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +.\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL +.\" THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +.\" WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF +.\" OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +.\" SOFTWARE. +.\" +.\" Except as contained in this notice, the name of the X Consortium shall not +.\" be used in advertising or otherwise to promote the sale, use or other +.\" dealing in this Software without prior written authorization from the +.\" X Consortium. +.\" +.\" $XFree86: xc/doc/man/Xt/XtGetClExt.man,v 1.3 2001/02/09 03:47:51 tsi Exp $ +.\" +.ds tk X Toolkit +.ds xT X Toolkit Intrinsics \- C Language Interface +.ds xI Intrinsics +.ds xW X Toolkit Athena Widgets \- C Language Interface +.ds xL Xlib \- C Language X Interface +.ds xC Inter-Client Communication Conventions Manual +.ds Rn 3 +.ds Vn 2.2 +.hw XtGet-Class-Extension wid-get +.na +.de Ds +.nf +.\\$1D \\$2 \\$1 +.ft 1 +.ps \\n(PS +.\".if \\n(VS>=40 .vs \\n(VSu +.\".if \\n(VS<=39 .vs \\n(VSp +.. +.de De +.ce 0 +.if \\n(BD .DF +.nr BD 0 +.in \\n(OIu +.if \\n(TM .ls 2 +.sp \\n(DDu +.fi +.. +.de FD +.LP +.KS +.TA .5i 3i +.ta .5i 3i +.nf +.. +.de FN +.fi +.KE +.LP +.. +.de IN \" send an index entry to the stderr +.. +.de C{ +.KS +.nf +.D +.\" +.\" choose appropriate monospace font +.\" the imagen conditional, 480, +.\" may be changed to L if LB is too +.\" heavy for your eyes... +.\" +.ie "\\*(.T"480" .ft L +.el .ie "\\*(.T"300" .ft L +.el .ie "\\*(.T"202" .ft PO +.el .ie "\\*(.T"aps" .ft CW +.el .ft R +.ps \\n(PS +.ie \\n(VS>40 .vs \\n(VSu +.el .vs \\n(VSp +.. +.de C} +.DE +.R +.. +.de Pn +.ie t \\$1\fB\^\\$2\^\fR\\$3 +.el \\$1\fI\^\\$2\^\fP\\$3 +.. +.de ZN +.ie t \fB\^\\$1\^\fR\\$2 +.el \fI\^\\$1\^\fP\\$2 +.. +.de NT +.ne 7 +.ds NO Note +.if \\n(.$>$1 .if !'\\$2'C' .ds NO \\$2 +.if \\n(.$ .if !'\\$1'C' .ds NO \\$1 +.ie n .sp +.el .sp 10p +.TB +.ce +\\*(NO +.ie n .sp +.el .sp 5p +.if '\\$1'C' .ce 99 +.if '\\$2'C' .ce 99 +.in +5n +.ll -5n +.R +.. +. \" Note End -- doug kraft 3/85 +.de NE +.ce 0 +.in -5n +.ll +5n +.ie n .sp +.el .sp 10p +.. +.ny0 +.TH XtGetClassExtension __libmansuffix__ __xorgversion__ "XT FUNCTIONS" +.SH NAME +XtGetClassExtension \- locate a class extension record +.SH SYNTAX +.HP +XtPointer XtGetClassExtension(WidgetClass \fIobject_class\fP, Cardinal +\fIbyte_offset\fP, XrmQuark \fItype\fP, long \fIversion\fP, Cardinal +\fIrecord_size\fP); +.SH ARGUMENTS +.IP \fIobject_class\fP 1i +Specifies the widget class containing the extension list to be searched. +.IP \fIbyte_offset\fP 1i +Specifies the offset in bytes form the base of the widget class of the +extension field to be searched. +.IP \fItype\fP 1i +Specifies the name of the class extension to be located. +.IP \fIversion\fP 1i +Specifies the minimum acceptable version of the class extension +required for a match. +.IP \fIrecord_size\fP 1i +Specifies the minimum acceptable length of the class extension record +required for match, or 0. +.SH DESCRIPTION +The list of extension records at the specified offset in the specified +\fIwidget_class\fP will be searched for a match on the specified +\fItype\fP, a version greater than or equal to the specified \fIversion\fP, +and a record size greater than or equal the specified \fIrecord_size\fP +if it is nonzero. +.ZN XtGetClassExtension +returns a pointer to a matching extension record or NULL if no match +is found. The returned extension record is owned by the widget class +and must not be modified or freed by the caller, except possibly to +be modified by the widget class owner. +.SH "SEE ALSO" +.br +\fI\*(xT\fP +.br +\fI\*(xL\fP |