TPUHELP.HLB  —  GET_INFO(WIDGET)
  GET_INFO(WIDGET)

  For an overview of the GET_INFO built-in, see the HELP topic GET_INFO.

  The following strings can be used for parameter2 when parameter1 is the
  keyword WIDGET:

  Parameter 2      | Return Value  (Parameter 1 is the keyword WIDGET)
  +----------------+---------------------------------------------------------+
  "callback_       | 1 or 0       - The value 1 if the call was encountered
  parameters"      |                within a callback procedure and
                   |                if callback information is available;
                   |                0 otherwise.  The syntax of
                   |                this built-in is as follows:
                   |
                   |                GET_INFO (WIDGET, callback_parameters,
                   |                          array_variable)
                   |
                   |                The third parameter is an array
                   |                created by TPU and assigned
                   |                to "array_variable".  After TPU
                   |                executes the call, the array elements
                   |                contain the widget instance performing
                   |                the callback, the closure value,
                   |                and the callback reason.  The array
                   |                elements are indexed by the the
                   |                following strings:  "widget",
                   |                "closure", "reason_code".  If the
                   |                application has used SET (WIDGET_CALL_DATA)
                   |                to define the format of callback data
                   |                for the widget and reason code that
                   |                are returned by the current call to
                   |                GET_INFO (WIDGET, "callback_parameters"),
                   |                then the array parameter automatically
                   |                receives a fourth element.  The element
                   |                is indexed with the string "call_data"
                   |                and contains an integer-indexed array.
                   |                The number of elements in this array is
                   |                the same as the number of callback data
                   |                structure fields specified in the
                   |                corresponding SET (WIDGET_CALL_DATA) call.
                   |                Element 1 contains the event field
                   |                (for whcih the application usually
                   |                specifies an output data type of
                   |                UNSPECIFIED); subsequent elements
                   |                hold the contents of subsequent
                   |                callback data structure fields.
                   |
  "children"       | Integer      - The number of widget children controlled
                   |                by the specified widget or by TPU's
                   |                main window widget.
                   |
                   |                The syntax of this GET_INFO call
                   |                is as follows:
                   |
                   |                GET_INFO (WIDGET, "children",
                   |                          {SCREEN | widget},
                   |                          array_variable)
                   |
                   |                To specify TPU's main window widget,
                   |                use the keyword SCREEN; otherwise,
                   |                specify the widget you want.  If the
                   |                widget has any children, TPU creates
                   |                an array and assigns it to the array
                   |                variable. The array is integer-indexed;
                   |                its elements contain the children.
                   |                If the widget has no children, the
                   |                array variable is assigned the type
                   |                UNSPECIFIED.
                   |
  "menu_position"  | Array        - Returns an integer-indexed array of all
                   |  or            pop-up widgets that are set for menu
                   | NONE           positioning; returns the keyword NONE if
                   |                none are set.
                   |
                   |                The syntax of this GET_INFO call
                   |                is as follows:
                   |
                   |                GET_INFO (WIDGET, "menu_position",
                   |                          mouse_down_button)
                   |
  "widget_id"      | Widget       - The widget instance corresponding to
                   |                the widget name that you pass in as
                   |                the fourth parameter.  The widget_name
                   |                parameter can start with the name of the
                   |                root widget (for XUI compatibility), or
                   |                or it can start with the name of a child
                   |                of the root widget in the Motif
                   |                environment.  The syntax of this call is
                   |                as follows:
                   |
                   |                GET_INFO (WIDGET, "widget_id",
                   |                          {parent_widget | SCREEN},
                   |                          widget_name)
                   |
  "widget_         | Array        - An array indexed by strings that are the
  resource_types"  |                supported widget resource data types:
                   |                       "boolean", "callback", "char",
                   |                       "compound_string",
                   |                       "compound_string_table", "int",
                   |                       "short", "unsigned_short",
                   |                       "unsigned_char"
                   |                Each array element is another array,
                   |                integer-indexed from 0, containing the
                   |                names of widget resources or resource
                   |                types that are of the specified data type.
                   |                For example, the returned array element
                   |                whose index is "int" is another array
                   |                whose elements are "Int" and "Cardinal".
                   |
                   |                This built-in is valid only in the
                   |                Motif environment.
                   |
                   |                The syntax of this call is as follows:
                   |
                   |                GET_INFO (WIDGET, "widget_resource_types")
                   |
  +----------------+----------------------------------------------------------+
Close Help