home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-bin / x11r6.1 / man / cat3 / xtsuperclass.0 < prev    next >
Encoding:
Text File  |  1996-10-17  |  4.9 KB  |  199 lines
  1.  
  2.  
  3.  
  4. XtClass(3Xt)           XT FUNCTIONS             XtClass(3Xt)
  5.  
  6.  
  7. NNAAMMEE
  8.        XtClass, XtSuperclass, XtIsSubclass, XtCheckSubclass,
  9.        XtIsObject, XtIsRectObj, XtIsWidget, XtIsComposite, XtIs-
  10.        Constraint, XtIsShell, XtIsOverrideShell, XtIsWMShell,
  11.        XtIsVendorShell, XtIsTransientShell, XtIsTopLevelShell,
  12.        XtIsApplicationShell, XtIsSessionShell - obtain and verify
  13.        a widget's class
  14.  
  15. SSYYNNTTAAXX
  16.        WidgetClass XtClass(_w)
  17.          Widget _w;
  18.  
  19.        WidgetClass XtSuperclass(_w)
  20.          Widget _w;
  21.  
  22.        Boolean XtIsSubclass(_w, _w_i_d_g_e_t___c_l_a_s_s)
  23.          Widget _w;
  24.          WidgetClass _w_i_d_g_e_t___c_l_a_s_s;
  25.  
  26.        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)
  27.          Widget _w_i_d_g_e_t;
  28.          WidgetClass _w_i_d_g_e_t___c_l_a_s_s;
  29.          String _m_e_s_s_a_g_e;
  30.  
  31.        Boolean XtIsObject(_w)
  32.          Widget _w;
  33.  
  34.        Boolean XtIsRectObj(_w)
  35.          Widget _w;
  36.  
  37.        Boolean XtIsWidget(_w)
  38.          Widget _w;
  39.  
  40.        Boolean XtIsComposite(_w)
  41.          Widget _w;
  42.  
  43.        Boolean XtIsConstraint(_w)
  44.          Widget _w;
  45.  
  46.        Boolean XtIsShell(_w)
  47.          Widget _w;
  48.  
  49.        Boolean XtIsOverrideShell(_w)
  50.          Widget _w;
  51.  
  52.        Boolean XtIsWMShell(_w)
  53.          Widget _w;
  54.  
  55.        Boolean XtIsVendorShell(_w)
  56.          Widget _w;
  57.  
  58.        Boolean XtIsTransientShell(_w)
  59.          Widget _w;
  60.  
  61.  
  62.  
  63.  
  64. X Version 11           Release 6.1                1
  65.  
  66.  
  67.  
  68.  
  69.  
  70. XtClass(3Xt)           XT FUNCTIONS             XtClass(3Xt)
  71.  
  72.  
  73.        Boolean XtIsTopLevelShell(_w)
  74.          Widget _w;
  75.  
  76.        Boolean XtIsApplicationShell(_w)
  77.          Widget _w;
  78.  
  79.        Boolean XtIsSessionShell(_w)
  80.          Widget _w;
  81.  
  82.  
  83. AARRGGUUMMEENNTTSS
  84.        _w     Specifies the widget.
  85.  
  86.        _w_i_d_g_e_t___c_l_a_s_s
  87.          Specifies the widget class.
  88.  
  89.        _m_e_s_s_a_g_e     Specifies the message that is to be used.
  90.  
  91. DDEESSCCRRIIPPTTIIOONN
  92.        The _X_t_C_l_a_s_s function returns a pointer to the widget's
  93.        class structure.
  94.  
  95.        The _X_t_S_u_p_e_r_c_l_a_s_s function returns a pointer to the wid-
  96.        get's superclass class structure.
  97.  
  98.        The _X_t_I_s_S_u_b_c_l_a_s_s function returns _T_r_u_e if the class of the
  99.        specified widget is equal to or is a subclass of the spec-
  100.        ified class. The widget's class can be any number of sub-
  101.        classes down the chain and need not be an immediate sub-
  102.        class of the specified class. Composite widgets that need
  103.        to restrict the class of the items they contain can use
  104.        _X_t_I_s_S_u_b_c_l_a_s_s to find out if a widget belongs to the
  105.        desired class of objects.
  106.  
  107.        The _X_t_C_h_e_c_k_S_u_b_c_l_a_s_s macro determines if the class of the
  108.        specified widget is equal to or is a subclass of the spec-
  109.        ified widget class.  The widget can be any number of sub-
  110.        classes down the chain and need not be an immediate sub-
  111.        class of the specified widget class.  If the specified
  112.        widget is not a subclass, _X_t_C_h_e_c_k_S_u_b_c_l_a_s_s constructs an
  113.        error message from the supplied message, the widget's
  114.        actual class, and the expected class and calls _X_t_E_r_r_o_r_M_s_g.
  115.        _X_t_C_h_e_c_k_S_u_b_c_l_a_s_s should be used at the entry point of
  116.        exported routines to ensure that the client has passed in
  117.        a valid widget class for the exported operation.
  118.  
  119.        _X_t_C_h_e_c_k_S_u_b_c_l_a_s_s is only executed when the widget has been
  120.        compiled with the compiler symbol DEBUG defined; other-
  121.        wise, it is defined as the empty string and generates no
  122.        code.
  123.  
  124.        To test if a given widget belongs to a subclass of an
  125.        Intrinsics-defined class, the Intrinsics defines macros or
  126.        functions equivalent to _X_t_I_s_S_u_b_c_l_a_s_s for each of the
  127.  
  128.  
  129.  
  130. X Version 11           Release 6.1                2
  131.  
  132.  
  133.  
  134.  
  135.  
  136. XtClass(3Xt)           XT FUNCTIONS             XtClass(3Xt)
  137.  
  138.  
  139.        built-in classes. These procedures are _X_t_I_s_O_b_j_e_c_t,
  140.        _X_t_I_s_R_e_c_t_O_b_j, _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,
  141.        _X_t_I_s_S_h_e_l_l, _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,
  142.        _X_t_I_s_V_e_n_d_o_r_S_h_e_l_l, _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,
  143.        _X_t_I_s_A_p_p_l_i_c_a_t_i_o_n_S_h_e_l_l, and ZN XtIsSessionShell .
  144.  
  145.        The
  146.  
  147. SSEEEE AALLSSOO
  148.        XtAppErrorMsg(3Xt), XtDisplay(3Xt)
  149.        _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
  150.        _X_l_i_b _- _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e
  151.  
  152.  
  153.  
  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.  
  196. X Version 11           Release 6.1                3
  197.  
  198.  
  199.