home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-bin / x11r6.1 / man / cat3 / xsetwmproperties.0 < prev    next >
Encoding:
Text File  |  1996-10-17  |  9.7 KB  |  265 lines
  1.  
  2.  
  3.  
  4. XSetWMProperties(3X11)      XLIB FUNCTIONS   XSetWMProperties(3X11)
  5.  
  6.  
  7. NNAAMMEE
  8.        XSetWMProperties, XmbSetWMProperties - set standard window
  9.        properties
  10.  
  11. SSYYNNTTAAXX
  12.        void XSetWMProperties(_d_i_s_p_l_a_y, _w, _w_i_n_d_o_w___n_a_m_e, _i_c_o_n___n_a_m_e,
  13.        _a_r_g_v, _a_r_g_c, _n_o_r_m_a_l___h_i_n_t_s, _w_m___h_i_n_t_s, _c_l_a_s_s___h_i_n_t_s)
  14.          Display *_d_i_s_p_l_a_y;
  15.          Window _w;
  16.          XTextProperty *_w_i_n_d_o_w___n_a_m_e;
  17.          XTextProperty *_i_c_o_n___n_a_m_e;
  18.          char **_a_r_g_v;
  19.          int _a_r_g_c;
  20.          XSizeHints *_n_o_r_m_a_l___h_i_n_t_s;
  21.          XWMHints *_w_m___h_i_n_t_s;
  22.          XClassHint *_c_l_a_s_s___h_i_n_t_s;
  23.  
  24.        void XmbSetWMProperties(_d_i_s_p_l_a_y, _w, _w_i_n_d_o_w___n_a_m_e,
  25.        _i_c_o_n___n_a_m_e, _a_r_g_v, _a_r_g_c,
  26.                  _n_o_r_m_a_l___h_i_n_t_s, _w_m___h_i_n_t_s, _c_l_a_s_s___h_i_n_t_s)
  27.          Display *_d_i_s_p_l_a_y;
  28.          Window _w;
  29.          char *_w_i_n_d_o_w___n_a_m_e;
  30.          char *_i_c_o_n___n_a_m_e;
  31.          char *_a_r_g_v[];
  32.          int _a_r_g_c;
  33.          XSizeHints *_n_o_r_m_a_l___h_i_n_t_s;
  34.          XWMHints *_w_m___h_i_n_t_s;
  35.          XClassHint *_c_l_a_s_s___h_i_n_t_s;
  36.  
  37. AARRGGUUMMEENNTTSS
  38.        _a_r_g_c     Specifies the number of arguments.
  39.  
  40.        _a_r_g_v     Specifies the application's argument list.
  41.  
  42.        _c_l_a_s_s___h_i_n_t_s
  43.          Specifies the _X_C_l_a_s_s_H_i_n_t structure to be used.
  44.  
  45.        _d_i_s_p_l_a_y     Specifies the connection to the X server.
  46.  
  47.        _i_c_o_n___n_a_m_e Specifies the icon name, which should be a null-
  48.          terminated string.
  49.  
  50.        _n_o_r_m_a_l___h_i_n_t_s
  51.          Specifies the size hints for the window in its
  52.          normal state.
  53.  
  54.        _w     Specifies the window.
  55.  
  56.        _w_i_n_d_o_w___n_a_m_e
  57.          Specifies the window name, which should be a
  58.          null-terminated string.
  59.  
  60.        _w_m___h_i_n_t_s     Specifies the _X_W_M_H_i_n_t_s structure to be used.
  61.  
  62.  
  63.  
  64. X Version 11           Release 6.1                1
  65.  
  66.  
  67.  
  68.  
  69.  
  70. XSetWMProperties(3X11)      XLIB FUNCTIONS   XSetWMProperties(3X11)
  71.  
  72.  
  73. DDEESSCCRRIIPPTTIIOONN
  74.        The _X_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s convenience function provides a sin-
  75.        gle programming interface for setting those essential win-
  76.        dow properties that are used for communicating with other
  77.        clients (particularly window and session managers).
  78.  
  79.        If the window_name argument is non-NULL, _X_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s
  80.        calls _X_S_e_t_W_M_N_a_m_e, which in turn, sets the WM_NAME property
  81.        (see section 14.1.4).  If the icon_name argument is non-
  82.        NULL, _X_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s calls _X_S_e_t_W_M_I_c_o_n_N_a_m_e, which sets
  83.        the WM_ICON_NAME property (see section 14.1.5).    If the
  84.        argv argument is non-NULL, _X_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s calls
  85.        _X_S_e_t_C_o_m_m_a_n_d, which sets the WM_COMMAND property (see sec-
  86.        tion 14.2.1).  Note that an argc of zero is allowed to
  87.        indicate a zero-length command.    Note also that the host-
  88.        name of this machine is stored using _X_S_e_t_W_M_C_l_i_e_n_t_M_a_c_h_i_n_e
  89.        (see section 14.2.2).
  90.  
  91.        If the normal_hints argument is non-NULL, _X_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s
  92.        calls _X_S_e_t_W_M_N_o_r_m_a_l_H_i_n_t_s, which sets the WM_NORMAL_HINTS
  93.        property (see section 14.1.7).  If the wm_hints argument
  94.        is non-NULL, _X_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s calls _X_S_e_t_W_M_H_i_n_t_s, which
  95.        sets the WM_HINTS property (see section 14.1.6).
  96.  
  97.        If the class_hints argument is non-NULL, _X_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s
  98.        calls _X_S_e_t_C_l_a_s_s_H_i_n_t, which sets the WM_CLASS property (see
  99.        section 14.1.8).     If the res_name member in the _X_C_l_a_s_s_H_i_n_t
  100.        structure is set to the NULL pointer and the RESOURCE_NAME
  101.        environment variable is set, then the value of the envi-
  102.        ronment variable is substituted for res_name.  If the
  103.        res_name member is NULL, the environment variable is not
  104.        set, and argv and argv[0] are set, then the value of
  105.        argv[0], stripped of any directory prefixes, is substi-
  106.        tuted for res_name.
  107.  
  108.        The _X_m_b_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s convenience function provides a
  109.        simple programming interface for setting those essential
  110.        window properties that are used for communicating with
  111.        other clients (particularly window and session managers).
  112.  
  113.        If the window_name argument is non-NULL, _X_m_b_S_e_t_W_M_P_r_o_p_e_r_-
  114.        _t_i_e_s sets the WM_NAME property.    If the icon_name argument
  115.        is non-NULL, _X_m_b_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s sets the WM_ICON_NAME
  116.        property.  The window_name and icon_name arguments are
  117.        null-terminated strings in the encoding of the current
  118.        locale.    If the arguments can be fully converted to the
  119.        STRING encoding, the properties are created with type
  120.        ``STRING''; otherwise, the arguments are converted to Com-
  121.        pound Text, and the properties are created with type
  122.        ``COMPOUND_TEXT''.
  123.  
  124.        If the normal_hints argument is non-NULL, _X_m_b_S_e_t_W_M_P_r_o_p_e_r_-
  125.        _t_i_e_s calls _X_S_e_t_W_M_N_o_r_m_a_l_H_i_n_t_s, which sets the
  126.        WM_NORMAL_HINTS property (see section 14.1.7).  If the
  127.  
  128.  
  129.  
  130. X Version 11           Release 6.1                2
  131.  
  132.  
  133.  
  134.  
  135.  
  136. XSetWMProperties(3X11)      XLIB FUNCTIONS   XSetWMProperties(3X11)
  137.  
  138.  
  139.        wm_hints argument is non-NULL, _X_m_b_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s calls
  140.        _X_S_e_t_W_M_H_i_n_t_s, which sets the WM_HINTS property (see section
  141.        14.1.6).
  142.  
  143.        If the argv argument is non-NULL, _X_m_b_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s sets
  144.        the WM_COMMAND property from argv and argc.  An argc of
  145.        zero indicates a zero-length command.
  146.  
  147.        The hostname of the machine is stored using _X_S_e_t_W_M_C_l_i_e_n_t_-
  148.        _M_a_c_h_i_n_e (see section 14.2.2).
  149.  
  150.        If the class_hints argument is non-NULL, _X_m_b_S_e_t_W_M_P_r_o_p_e_r_-
  151.        _t_i_e_s sets the WM_CLASS property.     If the res_name member
  152.        in the _X_C_l_a_s_s_H_i_n_t structure is set to the NULL pointer and
  153.        the RESOURCE_NAME environment variable is set, the value
  154.        of the environment variable is substituted for res_name.
  155.        If the res_name member is NULL, the environment variable
  156.        is not set, and argv and argv[0] are set, then the value
  157.        of argv[0], stripped of any directory prefixes, is substi-
  158.        tuted for res_name.
  159.  
  160.        It is assumed that the supplied class_hints.res_name and
  161.        argv, the RESOURCE_NAME environment variable, and the
  162.        hostname of the machine are in the encoding of the locale
  163.        announced for the LC_CTYPE category (on POSIX-compliant
  164.        systems, the LC_CTYPE, else LANG environment variable).
  165.        The corresponding WM_CLASS, WM_COMMAND, and
  166.        WM_CLIENT_MACHINE properties are typed according to the
  167.        local host locale announcer.  No encoding conversion is
  168.        performed prior to storage in the properties.
  169.  
  170.        For clients that need to process the property text in a
  171.        locale, _X_m_b_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s sets the WM_LOCALE_NAME prop-
  172.        erty to be the name of the current locale.  The name is
  173.        assumed to be in the Host Portable Character Encoding and
  174.        is converted to STRING for storage in the property.
  175.  
  176.        _X_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s and _X_m_b_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s can generate
  177.        _B_a_d_A_l_l_o_c and _B_a_d_W_i_n_d_o_w errors.
  178.  
  179. PPRROOPPEERRTTIIEESS
  180.        WM_CLASS     Set by application programs to allow window and
  181.          session managers to obtain the application's
  182.          resources from the resource database.
  183.  
  184.        WM_CLIENT_MACHINE
  185.          The string name of the machine on which the
  186.          client application is running.
  187.  
  188.        WM_COMMAND
  189.          The command and arguments, null-separated, used
  190.          to invoke the application.
  191.  
  192.        WM_HINTS     Additional hints set by the client for use by
  193.  
  194.  
  195.  
  196. X Version 11           Release 6.1                3
  197.  
  198.  
  199.  
  200.  
  201.  
  202. XSetWMProperties(3X11)      XLIB FUNCTIONS   XSetWMProperties(3X11)
  203.  
  204.  
  205.          the window manager.  The C type of this property
  206.          is _X_W_M_H_i_n_t_s.
  207.  
  208.        WM_ICON_NAME
  209.          The name to be used in an icon.
  210.  
  211.        WM_NAME     The name of the application.
  212.  
  213.        WM_NORMAL_HINTS
  214.          Size hints for a window in its normal state.
  215.          The C type of this property is _X_S_i_z_e_H_i_n_t_s.
  216.  
  217. DDIIAAGGNNOOSSTTIICCSS
  218.        _B_a_d_A_l_l_o_c     The server failed to allocate the requested
  219.          resource or server memory.
  220.  
  221.        _B_a_d_W_i_n_d_o_w A value for a Window argument does not name a
  222.          defined Window.
  223.  
  224. SSEEEE AALLSSOO
  225.        XAllocClassHint(3X11), XAllocIconSize(3X11), XAllocSize-
  226.        Hints(3X11), XAllocWMHints(3X11), XParseGeometry(3X11),
  227.        XSetCommand(3X11), XSetTransientForHint(3X11), XSet-
  228.        TextProperty(3X11), XSetWMClientMachine(3X11), XSetWMCol-
  229.        ormapWindows(3X11), XSetWMIconName(3X11), XSetWM-
  230.        Name(3X11), XSetWMProtocols(3X11), XStringListToTextProp-
  231.        erty(3X11), XTextListToTextProperty(3X11)
  232.        _X_l_i_b _- _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262. X Version 11           Release 6.1                4
  263.  
  264.  
  265.