home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-bin / x11r6.1 / man / cat3 / xtgetsubvalues.0 < prev    next >
Encoding:
Text File  |  1996-10-17  |  7.9 KB  |  199 lines
  1.  
  2.  
  3.  
  4. XtSetValues(3Xt)       XT FUNCTIONS         XtSetValues(3Xt)
  5.  
  6.  
  7. NNAAMMEE
  8.        XtSetValues, XtVaSetValues, XtSetSubvalues, XtVaSet-
  9.        Subvalues, XtGetValues, XtVaGetValues, XtGetSubvalues,
  10.        XtVaGetSubvalues - obtain and set widget resources
  11.  
  12. SSYYNNTTAAXX
  13.        void XtSetValues(_w, _a_r_g_s, _n_u_m___a_r_g_s)
  14.          Widget _w;
  15.          ArgList _a_r_g_s;
  16.          Cardinal _n_u_m___a_r_g_s;
  17.  
  18.        void XtVaSetValues(_w, _._._.)
  19.          Widget _w;
  20.  
  21.        void XtSetSubvalues(_b_a_s_e, _r_e_s_o_u_r_c_e_s, _n_u_m___r_e_s_o_u_r_c_e_s, _a_r_g_s,
  22.        _n_u_m___a_r_g_s)
  23.          XtPointer _b_a_s_e;
  24.          XtResourceList _r_e_s_o_u_r_c_e_s;
  25.          Cardinal _n_u_m___r_e_s_o_u_r_c_e_s;
  26.          ArgList _a_r_g_s;
  27.          Cardinal _n_u_m___a_r_g_s;
  28.  
  29.        void XtVaSetSubvalues(_b_a_s_e, _r_e_s_o_u_r_c_e_s, _n_u_m___r_e_s_o_u_r_c_e_s, _._._.)
  30.          XtPointer _b_a_s_e;
  31.          XtResourceList _r_e_s_o_u_r_c_e_s;
  32.          Cardinal _n_u_m___r_e_s_o_u_r_c_e_s;
  33.  
  34.        void XtGetValues(_w, _a_r_g_s, _n_u_m___a_r_g_s)
  35.          Widget _w;
  36.          ArgList _a_r_g_s;
  37.          Cardinal _n_u_m___a_r_g_s;
  38.  
  39.        void XtVaGetValues(_w, _._._.)
  40.          Widget _w;
  41.  
  42.        void XtGetSubvalues(_b_a_s_e, _r_e_s_o_u_r_c_e_s, _n_u_m___r_e_s_o_u_r_c_e_s, _a_r_g_s,
  43.        _n_u_m___a_r_g_s)
  44.          XtPointer _b_a_s_e;
  45.          XtResourceList _r_e_s_o_u_r_c_e_s;
  46.          Cardinal _n_u_m___r_e_s_o_u_r_c_e_s;
  47.          ArgList _a_r_g_s;
  48.          Cardinal _n_u_m___a_r_g_s;
  49.  
  50.        void XtVaGetSubvalues(_b_a_s_e, _r_e_s_o_u_r_c_e_s, _n_u_m___r_e_s_o_u_r_c_e_s, _._._.)
  51.          XtPointer _b_a_s_e;
  52.          XtResourceList _r_e_s_o_u_r_c_e_s;
  53.          Cardinal _n_u_m___r_e_s_o_u_r_c_e_s;
  54.  
  55. AARRGGUUMMEENNTTSS
  56.        _a_r_g_s     Specifies the argument list of name/address
  57.          pairs that contain the resource name and either
  58.          the address into which the resource value is to
  59.          be stored or their new values.
  60.  
  61.  
  62.  
  63.  
  64. X Version 11           Release 6.1                1
  65.  
  66.  
  67.  
  68.  
  69.  
  70. XtSetValues(3Xt)       XT FUNCTIONS         XtSetValues(3Xt)
  71.  
  72.  
  73.        _b_a_s_e     Specifies the base address of the subpart data
  74.          structure where the resources should be
  75.          retrieved or written.
  76.  
  77.        _n_u_m___a_r_g_s     Specifies the number of arguments in the argu-
  78.          ment list.
  79.  
  80.        _r_e_s_o_u_r_c_e_s Specifies the nonwidget resource list or values.
  81.  
  82.        _n_u_m___r_e_s_o_u_r_c_e_s
  83.          Specifies the number of resources in the
  84.          resource list.
  85.  
  86.        _w     Specifies the widget.
  87.  
  88.        _._._.     Specifes the variable argument list of
  89.          name/address pairs that contain the resource
  90.          name and either the address into which the
  91.          resource value is to be stored or their new val-
  92.          ues.
  93.  
  94. DDEESSCCRRIIPPTTIIOONN
  95.        The _X_t_S_e_t_V_a_l_u_e_s function starts with the resources speci-
  96.        fied for the _C_o_r_e widget fields and proceeds down the sub-
  97.        class chain to the widget.  At each stage, it writes the
  98.        new value (if specified by one of the arguments) or the
  99.        existing value (if no new value is specified) to a new
  100.        widget data record.  _X_t_S_e_t_V_a_l_u_e_s then calls the set_values
  101.        procedures for the widget in superclass-to-subclass order.
  102.        If the widget has any non-NULL set_values_hook fields,
  103.        these are called immediately after the corresponding
  104.        set_values procedure.  This procedure permits subclasses
  105.        to set nonwidget data for _X_t_S_e_t_V_a_l_u_e_s.
  106.  
  107.        If the widget's parent is a subclass of
  108.        _c_o_n_s_t_r_a_i_n_t_W_i_d_g_e_t_C_l_a_s_s, _X_t_S_e_t_V_a_l_u_e_s also updates the wid-
  109.        get's constraints.  It starts with the constraint
  110.        resources specified for _c_o_n_s_t_r_a_i_n_t_W_i_d_g_e_t_C_l_a_s_s and proceeds
  111.        down the subclass chain to the parent's class.  At each
  112.        stage, it writes the new value or the existing value to a
  113.        new constraint record.  It then calls the constraint
  114.        set_values procedures from _c_o_n_s_t_r_a_i_n_t_W_i_d_g_e_t_C_l_a_s_s down to
  115.        the parent's class.  The constraint set_values procedures
  116.        are called with widget arguments, as for all set_values
  117.        procedures, not just the constraint record arguments, so
  118.        that they can make adjustments to the desired values based
  119.        on full information about the widget.
  120.  
  121.        _X_t_S_e_t_V_a_l_u_e_s determines if a geometry request is needed by
  122.        comparing the current widget to the new widget.    If any
  123.        geometry changes are required, it makes the request, and
  124.        the geometry manager returns _X_t_G_e_o_m_e_t_r_y_Y_e_s,
  125.        _X_t_G_e_o_m_e_t_r_y_A_l_m_o_s_t, or _X_t_G_e_o_m_e_t_r_y_N_o.  If _X_t_G_e_o_m_e_t_r_y_Y_e_s,
  126.        _X_t_S_e_t_V_a_l_u_e_s calls the widget's resize procedure.     If
  127.  
  128.  
  129.  
  130. X Version 11           Release 6.1                2
  131.  
  132.  
  133.  
  134.  
  135.  
  136. XtSetValues(3Xt)       XT FUNCTIONS         XtSetValues(3Xt)
  137.  
  138.  
  139.        _X_t_G_e_o_m_e_t_r_y_N_o, _X_t_S_e_t_V_a_l_u_e_s resets the geometry fields to
  140.        their original values.  If _X_t_G_e_o_m_e_t_r_y_A_l_m_o_s_t, _X_t_S_e_t_V_a_l_u_e_s
  141.        calls the set_values_almost procedure, which determines
  142.        what should be done and writes new values for the geometry
  143.        fields into the new widget.  _X_t_S_e_t_V_a_l_u_e_s then repeats this
  144.        process, deciding once more whether the geometry manager
  145.        should be called.
  146.  
  147.        Finally, if any of the set_values procedures returned
  148.        _T_r_u_e, _X_t_S_e_t_V_a_l_u_e_s causes the widget's expose procedure to
  149.        be invoked by calling the Xlib _X_C_l_e_a_r_A_r_e_a function on the
  150.        widget's window.
  151.  
  152.        The _X_t_S_e_t_S_u_b_v_a_l_u_e_s function stores resources into the
  153.        structure identified by base.
  154.  
  155.        The _X_t_G_e_t_V_a_l_u_e_s function starts with the resources speci-
  156.        fied for the core widget fields and proceeds down the sub-
  157.        class chain to the widget.  The value field of a passed
  158.        argument list should contain the address into which to
  159.        store the corresponding resource value.    It is the
  160.        caller's responsibility to allocate and deallocate this
  161.        storage according to the size of the resource representa-
  162.        tion type used within the widget.
  163.  
  164.        If the widget's parent is a subclass of
  165.        _c_o_n_s_t_r_a_i_n_t_W_i_d_g_e_t_C_l_a_s_s, _X_t_G_e_t_V_a_l_u_e_s then fetches the values
  166.        for any constraint resources requested.    It starts with
  167.        the constraint resources specified for _c_o_n_s_t_r_a_i_n_t_W_i_d_g_e_t_-
  168.        _C_l_a_s_s and proceeds down to the subclass chain to the par-
  169.        ent's constraint resources.  If the argument list contains
  170.        a resource name that is not found in any of the resource
  171.        lists searched, the value at the corresponding address is
  172.        not modified.  Finally, if the get_values_hook procedures
  173.        are non-NULL, they are called in superclass-to-subclass
  174.        order after all the resource values have been fetched by
  175.        _X_t_G_e_t_V_a_l_u_e_s.  This permits a subclass to provide nonwidget
  176.        resource data to _X_t_G_e_t_V_a_l_u_e_s.
  177.  
  178.        The _X_t_G_e_t_S_u_b_v_a_l_u_e_s function obtains resource values from
  179.        the structure identified by base.
  180.  
  181. SSEEEE AALLSSOO
  182.        _X _T_o_o_l_k_i_t _I_n_t_r_i_n_s_i_c_s _- _C _L_a_n_g_u_a_g_e _I_n_t_e_r_f_a_c_e
  183.        _X_l_i_b _- _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196. X Version 11           Release 6.1                3
  197.  
  198.  
  199.