home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-bin / x11r6.1 / man / cat3 / xclasshint.0 < prev    next >
Encoding:
Text File  |  1996-10-17  |  4.4 KB  |  133 lines
  1.  
  2.  
  3.  
  4. XAllocClassHint(3X11)      XLIB FUNCTIONS    XAllocClassHint(3X11)
  5.  
  6.  
  7. NNAAMMEE
  8.        XAllocClassHint, XSetClassHint, XGetClassHint, XClassHint
  9.        - allocate class hints structure and set or read a win-
  10.        dow's WM_CLASS property
  11.  
  12. SSYYNNTTAAXX
  13.        XClassHint *XAllocClassHint()
  14.  
  15.        XSetClassHint(_d_i_s_p_l_a_y, _w, _c_l_a_s_s___h_i_n_t_s)
  16.          Display *_d_i_s_p_l_a_y;
  17.          Window _w;
  18.          XClassHint *_c_l_a_s_s___h_i_n_t_s;
  19.  
  20.        Status XGetClassHint(_d_i_s_p_l_a_y, _w, _c_l_a_s_s___h_i_n_t_s___r_e_t_u_r_n)
  21.          Display *_d_i_s_p_l_a_y;
  22.          Window _w;
  23.          XClassHint *_c_l_a_s_s___h_i_n_t_s___r_e_t_u_r_n;
  24.  
  25. AARRGGUUMMEENNTTSS
  26.        _d_i_s_p_l_a_y     Specifies the connection to the X server.
  27.  
  28.        _c_l_a_s_s___h_i_n_t_s
  29.          Specifies the _X_C_l_a_s_s_H_i_n_t structure that is to be
  30.          used.
  31.  
  32.        _c_l_a_s_s___h_i_n_t_s___r_e_t_u_r_n
  33.          Returns the _X_C_l_a_s_s_H_i_n_t structure.
  34.  
  35.        _w     Specifies the window.
  36.  
  37. DDEESSCCRRIIPPTTIIOONN
  38.        The _X_A_l_l_o_c_C_l_a_s_s_H_i_n_t function allocates and returns a
  39.        pointer to a _X_C_l_a_s_s_H_i_n_t structure.  Note that the pointer
  40.        fields in the _X_C_l_a_s_s_H_i_n_t structure are initially set to
  41.        NULL.  If insufficient memory is available, _X_A_l_l_o_c_-
  42.        _C_l_a_s_s_H_i_n_t returns NULL.    To free the memory allocated to
  43.        this structure, use _X_F_r_e_e.
  44.  
  45.        The _X_S_e_t_C_l_a_s_s_H_i_n_t function sets the class hint for the
  46.        specified window.  If the strings are not in the Host
  47.        Portable Character Encoding, the result is implementation-
  48.        dependent.
  49.  
  50.        _X_S_e_t_C_l_a_s_s_H_i_n_t can generate _B_a_d_A_l_l_o_c and _B_a_d_W_i_n_d_o_w errors.
  51.  
  52.        The _X_G_e_t_C_l_a_s_s_H_i_n_t function returns the class hint of the
  53.        specified window to the members of the supplied structure.
  54.        If the data returned by the server is in the Latin
  55.        Portable Character Encoding, then the returned strings are
  56.        in the Host Portable Character Encoding.     Otherwise, the
  57.        result is implementation-dependent.  It returns a nonzero
  58.        status on success; otherwise, it returns a zero status.
  59.        To free res_name and res_class when finished with the
  60.        strings, use _X_F_r_e_e on each individually.
  61.  
  62.  
  63.  
  64. X Version 11           Release 6.1                1
  65.  
  66.  
  67.  
  68.  
  69.  
  70. XAllocClassHint(3X11)      XLIB FUNCTIONS    XAllocClassHint(3X11)
  71.  
  72.  
  73.        _X_G_e_t_C_l_a_s_s_H_i_n_t can generate a _B_a_d_W_i_n_d_o_w error.
  74.  
  75. PPRROOPPEERRTTIIEESS
  76.        WM_CLASS     Set by application programs to allow window and
  77.          session managers to obtain the application's
  78.          resources from the resource database.
  79.  
  80. SSTTRRUUCCTTUURREESS
  81.        The _X_C_l_a_s_s_H_i_n_t structure contains:
  82.  
  83.        typedef struct {
  84.         char *res_name;
  85.         char *res_class;
  86.        } XClassHint;
  87.  
  88.        The res_name member contains the application name, and the
  89.        res_class member contains the application class.     Note
  90.        that the name set in this property may differ from the
  91.        name set as WM_NAME.  That is, WM_NAME specifies what
  92.        should be displayed in the title bar and, therefore, can
  93.        contain temporal information (for example, the name of a
  94.        file currently in an editor's buffer).  On the other hand,
  95.        the name specified as part of WM_CLASS is the formal name
  96.        of the application that should be used when retrieving the
  97.        application's resources from the resource database.
  98.  
  99. DDIIAAGGNNOOSSTTIICCSS
  100.        _B_a_d_A_l_l_o_c     The server failed to allocate the requested
  101.          resource or server memory.
  102.  
  103.        _B_a_d_W_i_n_d_o_w A value for a Window argument does not name a
  104.          defined Window.
  105.  
  106. SSEEEE AALLSSOO
  107.        XAllocIconSize(3X11), XAllocSizeHints(3X11), XAl-
  108.        locWMHints(3X11), XFree(3X11), XSetCommand(3X11), XSet-
  109.        TransientForHint(3X11), XSetTextProperty(3X11), XSetWM-
  110.        ClientMachine(3X11), XSetWMColormapWindows(3X11), XSetWMI-
  111.        conName(3X11), XSetWMName(3X11), XSetWMProperties(3X11),
  112.        XSetWMProtocols(3X11), XStringListToTextProperty(3X11)
  113.        _X_l_i_b _- _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130. X Version 11           Release 6.1                2
  131.  
  132.  
  133.