IDLitUI::RegisterWidget

IDL Reference Guide: iTools Object Classes

IDLitUI::RegisterWidget

Syntax | Return Value | Arguments | Keywords | Version History

The IDLitUI::RegisterWidget function method registers an IDL widget hierarchy with the user interface object. Once a widget has been registered with the UI object, the UI can route messages to that widget and manage visibility if the widget is registered with the FLOATING property set.

Syntax

Result = Obj->[IDLitUI::]RegisterWidget(wID, Name, Callback[, /FLOATING])

Return Value

The iTool object identifier of the user interface adaptor that links the widget specified by wID with the iTool.

Arguments

wID

A long integer containing the widget ID of the widget being registered. This value is provided to the routine specified by the Callback argument when it is called.

Name

A string containing the human readable name for the widget being registered.

Callback

A string containing the name of a callback procedure for the widget. Any notification messages sent by the iTool to this widget are sent to this callback procedure. The callback procedure should have the following calling signature:

PRO NAME, wID, strID, message, messageData

where:

NAME is the name of the callback procedure,

wID is the widget ID provided to the IDLitUI:;RegisterWidget method,

strID is a string containing the object identifier of the iTool object that triggered the message,

message is the message being sent to the callback procedure,

messageData is any data associated with the message.

Note
If this argument is set to an empty string, no callbacks will be made to this widget.

Keywords

FLOATING

Set this keyword to treat the widget as a floating element of the specified iTool user interface, to be managed by the user interface object. If this keyword is set, the widget will only be visible if the associated iTool is "current," and the widget will be destroyed when the iTool is destroyed.

Version History


6.0	Introduced

IDL Online Help (March 06, 2007)