1
.\" $Xorg: XtNameTWid.man,v 1.3 2000/08/17 19:42:01 cpqbld Exp $
3
.\" Copyright 1993 X Consortium
5
.\" Permission is hereby granted, free of charge, to any person obtaining
6
.\" a copy of this software and associated documentation files (the
7
.\" "Software"), to deal in the Software without restriction, including
8
.\" without limitation the rights to use, copy, modify, merge, publish,
9
.\" distribute, sublicense, and/or sell copies of the Software, and to
10
.\" permit persons to whom the Software is furnished to do so, subject to
11
.\" the following conditions:
13
.\" The above copyright notice and this permission notice shall be
14
.\" included in all copies or substantial portions of the Software.
16
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
.\" EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19
.\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
20
.\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21
.\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22
.\" OTHER DEALINGS IN THE SOFTWARE.
24
.\" Except as contained in this notice, the name of the X Consortium shall
25
.\" not be used in advertising or otherwise to promote the sale, use or
26
.\" other dealings in this Software without prior written authorization
27
.\" from the X Consortium.
29
.\" $XFree86: xc/doc/man/Xt/XtNameTWid.man,v 1.2 2001/01/27 18:20:28 dawes Exp $
32
.ds xT X Toolkit Intrinsics \- C Language Interface
34
.ds xW X Toolkit Athena Widgets \- C Language Interface
35
.ds xL Xlib \- C Language X Interface
36
.ds xC Inter-Client Communication Conventions Manual
39
.hw XtName-To-Widget XtWindow-To-Widget wid-get
46
.\".if \\n(VS>=40 .vs \\n(VSu
47
.\".if \\n(VS<=39 .vs \\n(VSp
70
.de IN \" send an index entry to the stderr
77
.\" choose appropriate monospace font
78
.\" the imagen conditional, 480,
79
.\" may be changed to L if LB is too
80
.\" heavy for your eyes...
82
.ie "\\*(.T"480" .ft L
83
.el .ie "\\*(.T"300" .ft L
84
.el .ie "\\*(.T"202" .ft PO
85
.el .ie "\\*(.T"aps" .ft CW
88
.ie \\n(VS>40 .vs \\n(VSu
96
.ie t \\$1\fB\^\\$2\^\fR\\$3
97
.el \\$1\fI\^\\$2\^\fP\\$3
100
.ie t \fB\^\\$1\^\fR\\$2
101
.el \fI\^\\$1\^\fP\\$2
106
.if \\n(.$>$1 .if !'\\$2'C' .ds NO \\$2
107
.if \\n(.$ .if !'\\$1'C' .ds NO \\$1
121
. \" Note End -- doug kraft 3/85
130
.TH XtNameToWidget 3Xt __xorgversion__ "XT FUNCTIONS"
132
XtNameToWidget, XtWindowToWidget \- translating strings to widgets or widgets to windows
134
Widget XtNameToWidget(\fIreference\fP, \fInames\fP);
136
Widget \fIreference\fP;
140
Widget XtWindowToWidget(\fIdisplay\fP, \fIwindow\fP)
142
Display *\fIdisplay\fP;
146
.ds Di \ on which the window is defined
148
Specifies the display\*(Di.
150
Specifies the fully qualified name of the desired widget.
151
.IP \fIreference\fP 1i
152
Specifies the widget from which the search is to start.
154
Specify the window for which you want the widget.
158
function looks for a widget whose name is the first component in the specified
159
names and that is a pop-up child of reference (or a normal child if reference
161
.ZN compositeWidgetClass ).
162
It then uses that widget as the new reference and repeats the search
163
after deleting the first component from the specified names.
164
If it cannot find the specified widget,
168
Note that the names argument contains the name of a widget with respect to the
169
specified reference widget and can contain more than one widget name
170
(separated by periods) for widgets that are not direct children
171
of the specified reference widget.
173
If more than one child of the reference widget matches the name,
175
can return any of the children.
176
The \*(xI do not require that all children of a widget have unique names.
177
If the specified names contain more than one component
178
and if more than one child matches the first component,
180
can return NULL if the single branch that it follows does not
181
contain the named widget.
184
does not back up and follow other matching branches of the widget tree.
188
function translates the specified window and display pointer into the
189
appropriate widget instance.