Seth Woolley's Man Viewer

XtSetVal(3) - XtGetSubvalues, XtGetValues, XtSetSubvalues, XtSetValues, XtVaGetSubvalues, XtVaGetValues, XtVaSetSubvalues, XtVaSetValues - obtain and set widget resources - man 3 XtSetVal

([section] manual, -k keyword, -K [section] search, -f whatis)
man plain no title

XtSetValues(3Xt)                                              XtSetValues(3Xt)



NAME
       XtSetValues, XtVaSetValues, XtSetSubvalues, XtVaSetSubvalues, XtGet-
       Values, XtVaGetValues, XtGetSubvalues, XtVaGetSubvalues - obtain and
       set(7,n,1 builtins) widget resources

SYNTAX
       void XtSetValues(Widget w, ArgList args, Cardinal num_args);

       void XtVaSetValues(Widget w, ...);

       void XtSetSubvalues(XtPointer base, XtResourceList resources, Cardinal
              num_resources, ArgList args, Cardinal num_args);

       void XtVaSetSubvalues(XtPointer base, XtResourceList resources, Cardi-
              nal num_resources, ...);

       void XtGetValues(Widget w, ArgList args, Cardinal num_args);

       void XtVaGetValues(Widget w, ...);

       void XtGetSubvalues(XtPointer base, XtResourceList resources, Cardinal
              num_resources, ArgList args, Cardinal num_args);

       void XtVaGetSubvalues(XtPointer base, XtResourceList resources, Cardi-
              nal num_resources, ...);

ARGUMENTS
       and either the address into which the resource value is to be stored or
       their new values

       args      Specifies the argument list of name/address pairs that con-
                 tain the resource name.

       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(1,8) the argument list.

       resources Specifies the nonwidget resource list or values.

       num_resources
                 Specifies the number of resources in(1,8) the resource list.

       w         Specifies the widget.

       ...       Specifes the variable argument list of name/address pairs
                 that contain the resource name.

DESCRIPTION
       The XtSetValues function starts with the resources specified for the
       Core widget fields and proceeds down the subclass chain to the widget.
       At each stage, it writes the new value (if(3,n) specified by one of the
       arguments) or the existing value (if(3,n) no new value is specified) to a
       new widget data record.  XtSetValues then calls the set_values proce-
       dures for the widget in(1,8) superclass-to-subclass order.  If the widget
       has any non-NULL set_values_hook fields, these are called immediately
       after the corresponding set_values procedure.  This procedure permits
       subclasses to set(7,n,1 builtins) nonwidget data for XtSetValues.

       If the widget's parent is a subclass of constraintWidgetClass, XtSet-
       Values also updates the widget's constraints.  It starts with the con-
       straint resources specified for constraintWidgetClass and proceeds down
       the subclass 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 constraintWidgetClass
       down to the parent's class.  The constraint set_values procedures are
       called with widget arguments, as for all set_values procedures, not
       just the constraint record arguments, so that they can make adjustments
       to the desired values based on full information about the widget.

       XtSetValues determines if(3,n) 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 XtGe-
       ometryYes, XtGeometryAlmost, or XtGeometryNo.  If XtGeometryYes, XtSet-
       Values calls the widget's resize procedure.  If XtGeometryNo, XtSet-
       Values resets the geometry fields to their original values.  If XtGeom-
       etryAlmost, XtSetValues calls the set_values_almost procedure, which
       determines what should be done and writes new values for the geometry
       fields into the new widget.  XtSetValues then repeats this process,
       deciding once more whether the geometry manager should be called.

       Finally, if(3,n) any of the set_values procedures returned True, XtSetValues
       causes the widget's expose procedure to be invoked by calling the Xlib
       XClearArea function on the widget's window.

       The XtSetSubvalues function stores resources into the structure identi-
       fied by base.

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

       If the widget's parent is a subclass of constraintWidgetClass, XtGet-
       Values then fetches the values for any constraint resources requested.
       It starts with the constraint resources specified for constraintWidget-
       Class 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(1,8) any of the resource lists searched, the value at the
       corresponding address is not modified.  Finally, if(3,n) the get_values_hook
       procedures are non-NULL, they are called in(1,8) superclass-to-subclass
       order after all the resource values have been fetched by XtGetValues.
       This permits a subclass to provide nonwidget resource data to XtGet-
       Values.

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

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



XT FUNCTIONS                    __xorgversion__               XtSetValues(3Xt)

References for this manual (incoming links)