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