XtWindowToWidget (3)

Leading comments

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 thi...

(The comments found at the beginning of the groff file "man3/XtWindowToWidget.3".)

NAME

XtNameToWidget, XtWindowToWidget - translating strings to widgets or widgets to windows

SYNTAX

Widget XtNameToWidget(Widget reference, String names);

Widget XtWindowToWidget(Display *display, Window window);

ARGUMENTS

display

Specifies the display on which the window is defined.

names

Specifies the fully qualified name of the desired widget.

reference

Specifies the widget from which the search is to start.

window

Specify the window for which you want the widget.

DESCRIPTION

The XtNameToWidget function looks for a widget whose name is the first component in the specified names and that is a pop-up child of reference (or a normal child if reference is a subclass of compositeWidgetClass). It then uses that widget as the new reference and repeats the search after deleting the first component from the specified names. If it cannot find the specified widget, XtNameToWidget returns NULL.

Note that the names argument contains the name of a widget with respect to the specified reference widget and can contain more than one widget name (separated by periods) for widgets that are not direct children of the specified reference widget.

If more than one child of the reference widget matches the name, XtNameToWidget can return any of the children. The Intrinsics do not require that all children of a widget have unique names. If the specified names contain more than one component and if more than one child matches the first component, XtNameToWidget can return NULL if the single branch that it follows does not contain the named widget. That is, XtNameToWidget does not back up and follow other matching branches of the widget tree.

The XtWindowToWidget function translates the specified window and display pointer into the appropriate widget instance.

SEE ALSO

X Toolkit Intrinsics - C Language Interface
Xlib - C Language X Interface