diff options
Diffstat (limited to 'libXt/man/XtGetResourceList.man')
-rw-r--r-- | libXt/man/XtGetResourceList.man | 378 |
1 files changed, 187 insertions, 191 deletions
diff --git a/libXt/man/XtGetResourceList.man b/libXt/man/XtGetResourceList.man index 5599a558d..645b7b97f 100644 --- a/libXt/man/XtGetResourceList.man +++ b/libXt/man/XtGetResourceList.man @@ -1,191 +1,187 @@ -.\" $Xorg: XtGetRList.man,v 1.3 2000/08/17 19:42:00 cpqbld Exp $ -.\" -.\" Copyright 1993 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 is 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 dealings in this Software without prior written authorization -.\" from the X Consortium. -.\" -.\" $XFree86: xc/doc/man/Xt/XtGetRList.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-Resource-List XtGet-Constraint-Resource-List 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 XtGetResourceList __libmansuffix__ __xorgversion__ "XT FUNCTIONS" -.SH NAME -XtGetResourceList, XtGetConstraintResourceList \- obtain resource list -.SH SYNTAX -.HP -void XtGetResourceList(WidgetClass \fIclass\fP, XtResourceList -*\fIresources_return\fP, Cardinal *\fInum_resources_return\fP); -.HP -void XtGetConstraintResourceList(WidgetClass \fIclass\fP, XtResourceList -*\fIresources_return\fP, Cardinal *\fInum_resources_return\fP); -.SH ARGUMENTS -.IP \fInum_resources_return\fP 1i -Specifies a pointer to where to store the number of entries in the -resource list. -.IP \fIresources_return\fP 1i -Specifies a pointer to where to store the returned resource list. -The caller must free this storage using -.ZN XtFree -when done with it. -.ds Cl \ for which you want the list -.IP \fIwidget_class\fP 1i -Specifies the widget class\*(Wc. -.SH DESCRIPTION -If -.ZN XtGetResourceList -is called before the widget class is initialized (that is, -before the first widget of that class has been created), -.ZN XtGetResourceList -returns the resource list as specified in the widget class record. -If it is called after the widget class has been initialized, -.ZN XtGetResourceList -returns a merged resource list that contains the resources -for all superclasses. The list returned by -.ZN XtGetResourceList -should be freed using -.ZN XtFree -when it is no longer needed. -.LP -If -.ZN XtGetConstraintResourceList -is called before the widget class is initialized (that is, -before the first widget of that class has been created), -.ZN XtGetConstraintResourceList -returns the resource list as specified in the widget class Constraint -part record. If it is called after the widget class has been initialized, -.ZN XtGetConstraintResourceList -returns a merged resource list that contains the Constraint resources -for all superclasses. If the specified class is not a subclass of -.ZN constraintWidgetClass , -\fI*resources_return\fP is set to NULL and \fI*num_resources_return\fP -is set to zero. The list returned by -.ZN XtGetConstraintResourceList -should be freed using -.ZN XtFree -when it is no longer needed. -.SH "SEE ALSO" -XtGetSubresources(3Xt), -XtOffset(3Xt) -.br -\fI\*(xT\fP -.br -\fI\*(xL\fP +.\" Copyright 1993 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 is 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 dealings in this Software without prior written authorization
+.\" from the X Consortium.
+.\"
+.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-Resource-List XtGet-Constraint-Resource-List 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 XtGetResourceList __libmansuffix__ __xorgversion__ "XT FUNCTIONS"
+.SH NAME
+XtGetResourceList, XtGetConstraintResourceList \- obtain resource list
+.SH SYNTAX
+.HP
+void XtGetResourceList(WidgetClass \fIclass\fP, XtResourceList
+*\fIresources_return\fP, Cardinal *\fInum_resources_return\fP);
+.HP
+void XtGetConstraintResourceList(WidgetClass \fIclass\fP, XtResourceList
+*\fIresources_return\fP, Cardinal *\fInum_resources_return\fP);
+.SH ARGUMENTS
+.IP \fInum_resources_return\fP 1i
+Specifies a pointer to where to store the number of entries in the
+resource list.
+.IP \fIresources_return\fP 1i
+Specifies a pointer to where to store the returned resource list.
+The caller must free this storage using
+.ZN XtFree
+when done with it.
+.ds Cl \ for which you want the list
+.IP \fIwidget_class\fP 1i
+Specifies the widget class\*(Wc.
+.SH DESCRIPTION
+If
+.ZN XtGetResourceList
+is called before the widget class is initialized (that is,
+before the first widget of that class has been created),
+.ZN XtGetResourceList
+returns the resource list as specified in the widget class record.
+If it is called after the widget class has been initialized,
+.ZN XtGetResourceList
+returns a merged resource list that contains the resources
+for all superclasses. The list returned by
+.ZN XtGetResourceList
+should be freed using
+.ZN XtFree
+when it is no longer needed.
+.LP
+If
+.ZN XtGetConstraintResourceList
+is called before the widget class is initialized (that is,
+before the first widget of that class has been created),
+.ZN XtGetConstraintResourceList
+returns the resource list as specified in the widget class Constraint
+part record. If it is called after the widget class has been initialized,
+.ZN XtGetConstraintResourceList
+returns a merged resource list that contains the Constraint resources
+for all superclasses. If the specified class is not a subclass of
+.ZN constraintWidgetClass ,
+\fI*resources_return\fP is set to NULL and \fI*num_resources_return\fP
+is set to zero. The list returned by
+.ZN XtGetConstraintResourceList
+should be freed using
+.ZN XtFree
+when it is no longer needed.
+.SH "SEE ALSO"
+XtGetSubresources(__libmansuffix__),
+XtOffset(__libmansuffix__)
+.br
+\fI\*(xT\fP
+.br
+\fI\*(xL\fP
|