home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / Xt / XtClass.z / XtClass
Encoding:
Text File  |  2002-10-03  |  6.5 KB  |  199 lines
  1.  
  2.  
  3.  
  4.      XXXXttttCCCCllllaaaassssssss((((3333XXXXtttt))))       XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))        XXXXttttCCCCllllaaaassssssss((((3333XXXXtttt))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XtClass, XtSuperclass, XtIsSubclass, XtCheckSubclass,
  10.           XtIsObject, XtIsRectObj, XtIsWidget, XtIsComposite,
  11.           XtIsConstraint, XtIsShell, XtIsOverrideShell, XtIsWMShell,
  12.           XtIsVendorShell, XtIsTransientShell, XtIsTopLevelShell,
  13.           XtIsApplicationShell, XtIsSessionShell - obtain and verify a
  14.           widget's class
  15.  
  16.      SSSSYYYYNNNNTTTTAAAAXXXX
  17.           WidgetClass XtClass(_w)
  18.                 Widget _w;
  19.  
  20.           WidgetClass XtSuperclass(_w)
  21.                 Widget _w;
  22.  
  23.           Boolean XtIsSubclass(_w, _w_i_d_g_e_t__c_l_a_s_s)
  24.                 Widget _w;
  25.                 WidgetClass _w_i_d_g_e_t__c_l_a_s_s;
  26.  
  27.           void XtCheckSubclass(_w_i_d_g_e_t, _w_i_d_g_e_t__c_l_a_s_s, _m_e_s_s_a_g_e)
  28.                 Widget _w_i_d_g_e_t;
  29.                 WidgetClass _w_i_d_g_e_t__c_l_a_s_s;
  30.                 String _m_e_s_s_a_g_e;
  31.  
  32.           Boolean XtIsObject(_w)
  33.                 Widget _w;
  34.  
  35.           Boolean XtIsRectObj(_w)
  36.                 Widget _w;
  37.  
  38.           Boolean XtIsWidget(_w)
  39.                 Widget _w;
  40.  
  41.           Boolean XtIsComposite(_w)
  42.                 Widget _w;
  43.  
  44.           Boolean XtIsConstraint(_w)
  45.                 Widget _w;
  46.  
  47.           Boolean XtIsShell(_w)
  48.                 Widget _w;
  49.  
  50.           Boolean XtIsOverrideShell(_w)
  51.                 Widget _w;
  52.  
  53.           Boolean XtIsWMShell(_w)
  54.                 Widget _w;
  55.  
  56.           Boolean XtIsVendorShell(_w)
  57.                 Widget _w;
  58.  
  59.           Boolean XtIsTransientShell(_w)
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 10/3/02)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXttttCCCCllllaaaassssssss((((3333XXXXtttt))))       XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))        XXXXttttCCCCllllaaaassssssss((((3333XXXXtttt))))
  71.  
  72.  
  73.  
  74.                 Widget _w;
  75.  
  76.           Boolean XtIsTopLevelShell(_w)
  77.                 Widget _w;
  78.  
  79.           Boolean XtIsApplicationShell(_w)
  80.                 Widget _w;
  81.  
  82.           Boolean XtIsSessionShell(_w)
  83.                 Widget _w;
  84.  
  85.      AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  86.           _w         Specifies the widget.
  87.  
  88.           _w_i_d_g_e_t__c_l_a_s_s
  89.                     Specifies the widget class.
  90.  
  91.           _m_e_s_s_a_g_e   Specifies the message that is to be used.
  92.  
  93.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  94.           The _X_t_C_l_a_s_s function returns a pointer to the widget's class
  95.           structure.
  96.  
  97.           The _X_t_S_u_p_e_r_c_l_a_s_s function returns a pointer to the widget's
  98.           superclass class structure.
  99.  
  100.           The _X_t_I_s_S_u_b_c_l_a_s_s function returns _T_r_u_e if the class of the
  101.           specified widget is equal to or is a subclass of the
  102.           specified class. The widget's class can be any number of
  103.           subclasses down the chain and need not be an immediate
  104.           subclass of the specified class. Composite widgets that need
  105.           to restrict the class of the items they contain can use
  106.           _X_t_I_s_S_u_b_c_l_a_s_s to find out if a widget belongs to the desired
  107.           class of objects.
  108.  
  109.           The _X_t_C_h_e_c_k_S_u_b_c_l_a_s_s macro determines if the class of the
  110.           specified widget is equal to or is a subclass of the
  111.           specified widget class.  The widget can be any number of
  112.           subclasses down the chain and need not be an immediate
  113.           subclass of the specified widget class.  If the specified
  114.           widget is not a subclass, _X_t_C_h_e_c_k_S_u_b_c_l_a_s_s constructs an
  115.           error message from the supplied message, the widget's actual
  116.           class, and the expected class and calls _X_t_E_r_r_o_r_M_s_g.
  117.           _X_t_C_h_e_c_k_S_u_b_c_l_a_s_s should be used at the entry point of
  118.           exported routines to ensure that the client has passed in a
  119.           valid widget class for the exported operation.
  120.  
  121.           _X_t_C_h_e_c_k_S_u_b_c_l_a_s_s is only executed when the widget has been
  122.           compiled with the compiler symbol DEBUG defined; otherwise,
  123.           it is defined as the empty string and generates no code.
  124.  
  125.           To test if a given widget belongs to a subclass of an
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 10/3/02)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXttttCCCCllllaaaassssssss((((3333XXXXtttt))))       XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))        XXXXttttCCCCllllaaaassssssss((((3333XXXXtttt))))
  137.  
  138.  
  139.  
  140.           Intrinsics-defined class, the Intrinsics defines macros or
  141.           functions equivalent to _X_t_I_s_S_u_b_c_l_a_s_s for each of the built-
  142.           in classes. These procedures are _X_t_I_s_O_b_j_e_c_t, _X_t_I_s_R_e_c_t_O_b_j,
  143.           _X_t_I_s_W_i_d_g_e_t, _X_t_I_s_C_o_m_p_o_s_i_t_e, _X_t_I_s_C_o_n_s_t_r_a_i_n_t, _X_t_I_s_S_h_e_l_l,
  144.           _X_t_I_s_O_v_e_r_r_i_d_e_S_h_e_l_l, _X_t_I_s_W_M_S_h_e_l_l, _X_t_I_s_V_e_n_d_o_r_S_h_e_l_l,
  145.           _X_t_I_s_T_r_a_n_s_i_e_n_t_S_h_e_l_l, _X_t_I_s_T_o_p_L_e_v_e_l_S_h_e_l_l, _X_t_I_s_A_p_p_l_i_c_a_t_i_o_n_S_h_e_l_l,
  146.           and ZN XtIsSessionShell .
  147.  
  148.           The
  149.  
  150.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  151.           XtAppErrorMsg(3Xt), XtDisplay(3Xt)
  152.           _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
  153.           _X_l_i_b - _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 10/3/02)
  196.  
  197.  
  198.  
  199.