XtClass()

NAME

XtClass(), XtSuperClass(), XtIsSubclass(), XtCheckSubclass(), XtIsComposite(), XtIsManaged() - obtain and verify a widget's class

SYNOPSIS

WidgetClass XtClass (Widget w)
WidgetClass XtSuperclass (Widget w)
Boolean XtIsSubclass (Widget w, WidgetClass widget_class)
void XtCheckSubclass (Widget w, WidgetClass widget_class,
					String message)
Boolean XtIsComposite (Widget w)
Boolean XtIsManaged (Widget w)

ARGUMENTS

w
Specifies the widget.
widget_class
Specifies the widget class.
message
Specifies the message that is to be used.

DESCRIPTION

The XtClass(3) function returns a pointer to the widget's class structure.

The XtSuperclass(3) function returns a pointer to the widget's superclass class structure.

The XtIsSubclass(3) function returns True if the class of the specified widget is equal to or is a subclass of the specified widget class. The specified widget can be any number of subclasses down the chain and need not be an immediate subclass of the specified widget class. Composite widgets that need to restrict the class of the items they contain can use XtIsSubclass(3) to find out if a widget belongs to the desired class of objects.

The XtCheckSubclass(3) macro determines if the class of the specified widget is equal to or is a subclass of the specified widget class. The widget can be any number of subclasses down the chain and need not be an immediate subclass of the specified widget class. If the specified widget is not a subclass, XtCheckSubclass(3) constructs an error message from the supplied message, the widget's actual class, and the expected class and calls XtErrorMsg(). XtCheckSubclass(3) should be used at the entry point of exported routines to ensure that the client has passed in a valid widget class for the exported operation.

XtCheckSubclass(3) is only executed when the widget has been compiled with the compiler symbol DEBUG defined; otherwise, it is defined as the empty string and generates no code.

The XtIsComposite(3) function is a convenience function that is equivalent to XtIsSubclass(3) with compositeWidgetClass specified.

The XtIsManaged(3) macro (for widget programmers) or function (for application programmers) returns True if the specified child widget is managed or False if it is not.

SEE ALSO

XtAppErrorMsg()

XtDisplay()

X Toolkit Intrinsics - C Language Interface

Xlib - C Language X Interface