Museum

XtSetValues(3Xt)                                 XtSetValues(3Xt)



NAME
     XtSetValues, XtSetSubvalues, XtGetValues,  XtGetSubvalues  -
     set and get widget resources

SYNOPSIS
     void XtSetValues(w, args, num-args)
     Widget w;
     ArgList args;
     Cardinal num-args;

     void XtSetSubvalues(base, resources, num-resources, args,
     num-args)
     XtPointer base;
     XtResourceList resources;
     Cardinal num-resources;
     ArgList args;
     Cardinal num-args;

     void XtGetValues(w, args, num-args)
     Widget w;
     ArgList args;
     Cardinal num-args;

     void XtGetSubvalues(base, resources, num-resources, args,
     num-args)
     XtPointer base;
     XtResourceList resources;
     Cardinal num-resources;
     ArgList args;
     Cardinal num-args;

DESCRIPTION
     The XtSetValues function starts with the resources specified
     for the core widget members and proceeds down the subclass
     chain to the widget.  At each stage, it writes the new value
     (if specified by one of the arguments) or the existing value
     (if no new value is specified) to a new widget data record.
     XtSetValues then calls the set-values procedures for the
     widget in superclass-to-subclass order.  If the widget has
     any non-null set-values-hook members, these are called im-
     mediately after the corresponding set-values procedure.
     This procedure permits subclasses to set nonwidget data for
     XtSetValues.

     If the widget's parent is a subclass of
     constraintWidgetClass, XtSetValues also updates the widget's
     constraints.  It starts with the constraint resources speci-
     fied for constraintWidgetClass and proceeds down the sub-
     class chain to the parent's class.  At each stage, it writes
     the new value or the existing value to a new constraint
     record.  It then calls the constraint set-values procedures
     from



November, 1990                                                  1

XtSetValues(3Xt)                                 XtSetValues(3Xt)



     constraintWidgetClass down to the parent's class.  The con-
     straint set-values procedures are called with widget argu-
     ments, as for all set-values procedures, not just the con-
     straint record arguments, so that they can make adjustments
     to the desired values based on full information about the
     widget.

     XtSetValues determines if a geometry request is needed by
     comparing the current widget to the new widget.  If any
     geometry changes are required, it makes the request, and the
     geometry manager returns XtGeometryYes, XtGeometryAlmost, or
     XtGeometryNo.  If XtGeometryYes, XtSetValues calls the
     widget's resize procedure.  If XtGeometryNo,
     XtSetValues resets the geometry members to their original
     values.  If XtGeometryAlmost, XtSetValues calls the set-
     values-almost procedure, which determines what should be
     done and writes new values for the geometry members into the
     new widget.  XtSetValues then repeats this process, deciding
     once more whether the geometry manager should be called.

     Finally, if any of the set-values procedures returned TRUE,
     XtSetValues causes the widget's expose procedure to be in-
     voked by calling the XClearArea(3X) function on the widget's
     window.

     The XtSetSubvalues function stores resources into the struc-
     ture identified by base.

     The XtGetValues function starts with the resources specified
     for the core widget members and proceeds down the subclass
     chain to the widget.  The value member of a passed argument
     list should contain the address into which to store the
     corresponding resource value.  It is the caller's responsi-
     bility to allocate and deallocate this storage according to
     the size of the resource representation type used within the
     widget.

     If the widget's parent is a subclass of
     constraintWidgetClass, XtGetValues then fetches the values
     for any constraint resources requested.  It starts with the
     constraint resources specified for constraintWidgetClass and
     proceeds down to the subclass chain to the parent's con-
     straint resources.  If the argument list contains a resource
     name that is not found in any of the resource lists
     searched, the value at the corresponding address is not
     modified.  Finally, if the get-values-hook procedures are
     not NULL, they are called in superclass-to-subclass order
     after all the resource values have been fetched by XtGet-
     Values.  This permits a subclass to provide nonwidget
     resource data to XtGetValues.





2                                                  November, 1990

XtSetValues(3Xt)                                 XtSetValues(3Xt)



     The XtGetSubvalues function obtains resource values from the
     structure identified by base.

   Arguments
     These functions accept the following arguments:

     args    Specifies the argument list of name/address pairs
             that contain the resource name and either the ad-
             dress into which the resource value is to be stored
             or their new values.

     base    Specifies the base address of the subpart data
             structure where the resources should be retrieved or
             written.

     num-args
             Specifies the number of arguments in the argument
             list.

     resources
             Specifies the nonwidget resource list or values.

     num-resources
             Specifies the number of resources in the resource
             list.

     w       Specifies the widget.

SEE ALSO
     X Toolkit Intrinsics - C Language Interface

     Xlib - C Language Interface
























November, 1990                                                  3