X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=specs%2FlibX11%2FCH14.xml;h=6dc947a9c922dafbce8ce6543a0d7452eebebafa;hb=165509f249f634f2e37dd6370df6a22cfb6b8851;hp=78d0e3fe4a64f7bfd7e5e8a861a6eec249eeb7c4;hpb=828837f9255761206ec5af41fc0388fce8af6517;p=framework%2Fuifw%2Fxorg%2Flib%2Flibx11.git diff --git a/specs/libX11/CH14.xml b/specs/libX11/CH14.xml old mode 100755 new mode 100644 index 78d0e3f..6dc947a --- a/specs/libX11/CH14.xml +++ b/specs/libX11/CH14.xml @@ -1,24 +1,28 @@ - + Inter-Client Communication Functions -The Inter-Client Communication Conventions Manual, hereafter referred to as the ICCCM, +The Inter-Client Communication Conventions Manual, +hereafter referred to as the ICCCM, details the X Consortium approved conventions that govern inter-client communications. These conventions ensure peer-to-peer client cooperation in the use of selections, cut buffers, and shared -resources as well as client cooperation with window and session managers. For further informa- -tion, see the Inter-Client Communication Conventions Manual. +resources as well as client cooperation with window and session managers. For further information, +see the Inter-Client Communication Conventions Manual. -Xlib provides a number of standard properties and programming interfaces that are ICCCM com- -pliant. The predefined atoms for some of these properties are defined in the <X11/Xatom.h> -header file, where to avoid name conflicts with user symbols their #define name has an XA_ pre- -fix. For further information about atoms and properties, see section 4.3. +Xlib provides a number of standard properties and programming interfaces that are ICCCM +compliant. The predefined atoms for some of these properties are defined in the <X11/Xatom.h> +header file, where to avoid name conflicts with user symbols their #define name has an XA_ prefix. +For further information about atoms and properties, +see section 4.3. Xlib’s selection and cut buffer mechanisms provide the primary programming interfaces by which -peer client applications communicate with each other (see sections 4.5 and 16.6). The functions +peer client applications communicate with each other +(see sections 4.5 and +16.6). The functions discussed in this chapter provide the primary programming interfaces by which client applications communicate with their window and session managers as well as share standard colormaps. @@ -27,14 +31,15 @@ The standard properties that are of special interest for communicating with wind managers are: - - - - - - + + + + + + + - + Name Type Format @@ -57,8 +62,7 @@ managers are: TEXT The string name of the machine on - which the client application is run- - ning. + which the client application is running. @@ -74,7 +78,7 @@ managers are: WM_COMMAND TEXT - The command and arguments, null- + The command and arguments, null separated, used to invoke the application. @@ -134,8 +138,7 @@ managers are: WM_STATE 32 Intended for communication - between window and session man- - agers only. + between window and session managers only. @@ -250,16 +253,18 @@ of top-level windows (that is, those that were created as children of the root window). Note that the subwindows that you create are ignored by window managers. Therefore, -you should use the basic window functions described in chapter 3 +you should use the basic window functions described in +chapter 3 to manipulate your application's subwindows. To request that a top-level window be iconified, use -XIconifyWindow. +. + XIconifyWindow - + Status XIconifyWindow Display *display @@ -300,18 +305,18 @@ Specifies the appropriate screen number on the host server. - The -XIconifyWindow + function sends a WM_CHANGE_STATE ClientMessage event with a format of 32 and a first data element of IconicState -(as described in section 4.1.4 of the -Inter-Client Communication Conventions Manual) +(as described in section 4.1.4 of the +Inter-Client Communication Conventions Manual) and a window of w to the root window of the specified screen with an event mask set to @@ -321,7 +326,7 @@ Window managers may elect to receive this message and if the window is in its normal state, may treat it as a request to change the window's state from normal to iconic. If the WM_CHANGE_STATE property cannot be interned, -XIconifyWindow + does not send a message and returns a zero status. It returns a nonzero status if the client message is sent successfully; otherwise, it returns a zero status. @@ -330,10 +335,11 @@ otherwise, it returns a zero status. To request that a top-level window be withdrawn, use -XWithdrawWindow. +. + XWithdrawWindow - + Status XWithdrawWindow Display *display @@ -374,12 +380,11 @@ Specifies the appropriate screen number on the host server. - The -XWithdrawWindow + function unmaps the specified window and sends a synthetic UnmapNotify @@ -395,7 +400,7 @@ otherwise, it returns a zero status. -XWithdrawWindow + can generate a BadWindow error. @@ -404,10 +409,11 @@ error. To request that a top-level window be reconfigured, use -XReconfigureWMWindow. +. + XReconfigureWMWindow - + Status XReconfigureWMWindow Display *display @@ -474,12 +480,11 @@ structure. - The -XReconfigureWMWindow + function issues a ConfigureWindow request on the specified top-level window. @@ -497,7 +502,7 @@ otherwise, it returns a zero status. -XReconfigureWMWindow + can generate BadValue and @@ -575,13 +580,14 @@ typedef enum { To convert a list of text strings to an XTextProperty structure, use -XmbTextListToTextProperty + or -XwcTextListToTextProperty. +. + XmbTextListToTextProperty XwcTextListToTextProperty - + int XmbTextListToTextProperty Display *display @@ -592,7 +598,7 @@ or - + int XwcTextListToTextProperty Display *display @@ -657,14 +663,13 @@ structure. - The -XmbTextListToTextProperty + and -XwcTextListToTextProperty + functions set the specified XTextProperty value to a set of null-separated elements representing the concatenation @@ -729,7 +734,7 @@ is guaranteed. To free the storage for the value field, use -XFree. +. @@ -737,13 +742,14 @@ To free the storage for the value field, use To obtain a list of text strings from an XTextProperty structure, use -XmbTextPropertyToTextList + or -XwcTextPropertyToTextList. +. + XmbTextPropertyToTextList XwcTextPropertyToTextList - + int XmbTextPropertyToTextList Display *display @@ -753,7 +759,7 @@ or - + int XwcTextPropertyToTextList Display *display @@ -808,14 +814,13 @@ Returns the number of (Cn. - The -XmbTextPropertyToTextList + and -XwcTextPropertyToTextList + functions return a list of text strings in the current locale representing the null-separated elements of the specified XTextProperty @@ -832,9 +837,9 @@ any terminating null should not be included in text_prop.nitems. If insufficient memory is available for the list and its elements, -XmbTextPropertyToTextList + and -XwcTextPropertyToTextList + return XNoMemory. If the current locale is not supported, @@ -859,9 +864,9 @@ the functions do not set any return values. Otherwise, -XmbTextPropertyToTextList + and -XwcTextPropertyToTextList + return the list of null-terminated text strings to list_return and the number of text strings to count_return. @@ -876,32 +881,33 @@ To obtain the value of this string, use XDefaultString. Otherwise, -XmbTextPropertyToTextList + and -XwcTextPropertyToTextList + return Success. To free the storage for the list and its contents returned by -XmbTextPropertyToTextList, +, use -XFreeStringList. +. To free the storage for the list and its contents returned by -XwcTextPropertyToTextList, +, use -XwcFreeStringList. +. To free the in-memory data associated with the specified wide character string list, use -XwcFreeStringList. +. + XwcFreeStringList - + void XwcFreeStringList wchar_t **list @@ -920,14 +926,13 @@ Specifies the list of strings to be freed. - The -XwcFreeStringList + function frees memory allocated by -XwcTextPropertyToTextList. +. @@ -944,7 +949,7 @@ The XDefaultString function returns the default string used by Xlib for text conversion (for example, in -XmbTextPropertyToTextList). +). The default string is the string in the current locale that is output when an unconvertible character is found during text conversion. If the string returned by @@ -960,7 +965,7 @@ The string returned by XDefaultString is independent of the default string for text drawing; see -XCreateFontSet + to obtain the default string for an XFontSet. @@ -982,10 +987,11 @@ Until freed, it will not be modified by Xlib. To set the specified list of strings in the STRING encoding to a XTextProperty structure, use -XStringListToTextProperty. +. + XStringListToTextProperty - + Status XStringListToTextProperty char **list @@ -1029,12 +1035,11 @@ structure. - The -XStringListToTextProperty + function sets the specified XTextProperty to be of type STRING (format 8) with a value representing the @@ -1043,13 +1048,13 @@ An extra null byte (which is not included in the nitems member) is stored at the end of the value field of text_prop_return. The strings are assumed (without verification) to be in the STRING encoding. If insufficient memory is available for the new value string, -XStringListToTextProperty + does not set any fields in the XTextProperty structure and returns a zero status. Otherwise, it returns a nonzero status. To free the storage for the value field, use -XFree. +. @@ -1057,10 +1062,11 @@ To free the storage for the value field, use To obtain a list of strings from a specified XTextProperty structure in the STRING encoding, use -XTextPropertyToStringList. +. + XTextPropertyToStringList - + Status XTextPropertyToStringList XTextProperty *text_prop @@ -1104,12 +1110,11 @@ Returns the number of (Cn. - The -XTextPropertyToStringList + function returns a list of strings representing the null-separated elements of the specified XTextProperty @@ -1120,20 +1125,21 @@ Multiple elements of the property are separated by NULL (encoding 0). The contents of the property are not null-terminated. If insufficient memory is available for the list and its elements, -XTextPropertyToStringList + sets no return values and returns a zero status. Otherwise, it returns a nonzero status. To free the storage for the list and its contents, use -XFreeStringList. +. To free the in-memory data associated with the specified string list, use -XFreeStringList. +. + XFreeStringList - + void XFreeStringList char **list @@ -1152,18 +1158,17 @@ Specifies the list of strings to be freed. - The -XFreeStringList + function releases memory allocated by -XmbTextPropertyToTextList + and -XTextPropertyToStringList + and the missing charset list allocated by -XCreateFontSet. +. @@ -1181,16 +1186,22 @@ In addition, Xlib provides separate convenience functions that you can use to set each of these properties. For further information about these convenience functions, -see sections 14.1.4, 14.1.5, 14.2.1, and 14.2.2, respectively. +see sections +14.1.4, +14.1.5, +14.2.1, and +14.2.2, +respectively. To set one of a window's text properties, use -XSetTextProperty. +. + XSetTextProperty - + void XSetTextProperty Display *display @@ -1244,12 +1255,11 @@ Specifies the property name. - The -XSetTextProperty + function replaces the existing specified property for the named window with the data, type, format, and number of items determined by the value field, the encoding field, the format field, @@ -1257,12 +1267,12 @@ and the nitems field, respectively, of the specified XTextProperty structure. If the property does not already exist, -XSetTextProperty + sets it for the specified window. -XSetTextProperty + can generate BadAlloc, BadAtom, @@ -1275,10 +1285,11 @@ errors. To read one of a window's text properties, use -XGetTextProperty. +. + XGetTextProperty - + Status XGetTextProperty Display *display @@ -1332,12 +1343,11 @@ Specifies the property name. - The -XGetTextProperty + function reads the specified property from the window and stores the data in the returned XTextProperty @@ -1351,7 +1361,7 @@ is stored at the end of the value field of text_prop_return. The particular interpretation of the property's encoding and data as text is left to the calling application. If the specified property does not exist on the window, -XGetTextProperty + sets the value field to NULL, the encoding field to None, @@ -1363,13 +1373,13 @@ and the nitems field to zero. If it was able to read and store the data in the XTextProperty structure, -XGetTextProperty + returns a nonzero status; otherwise, it returns a zero status. -XGetTextProperty + can generate BadAtom and @@ -1391,10 +1401,11 @@ the WM_NAME property for a given window. To set a window's WM_NAME property with the supplied convenience function, use -XSetWMName. +. + XSetWMName - + void XSetWMName Display *display @@ -1437,24 +1448,24 @@ structure to be used. - The -XSetWMName + convenience function calls -XSetTextProperty + to set the WM_NAME property. To read a window's WM_NAME property with the supplied convenience function, use -XGetWMName. +. + XGetWMName - + Status XGetWMName Display *display @@ -1497,14 +1508,13 @@ structure. - The -XGetWMName + convenience function calls -XGetTextProperty + to obtain the WM_NAME property. It returns a nonzero status on success; otherwise, it returns a zero status. @@ -1512,9 +1522,9 @@ otherwise, it returns a zero status. The following two functions have been superseded by -XSetWMName + and -XGetWMName, +, respectively. You can use these additional convenience functions for window names that are encoded as STRING properties. @@ -1523,11 +1533,12 @@ for window names that are encoded as STRING properties. To assign a name to a window, use -XStoreName. +. + Windowname XStoreName - + XStoreName Display *display @@ -1569,12 +1580,11 @@ which should be a null-terminated string. - The -XStoreName + function assigns the name passed to window_name to the specified window. A window manager can display the window name in some prominent place, such as the title bar, to allow users to identify windows easily. @@ -1586,7 +1596,7 @@ the result is implementation-dependent. -XStoreName + can generate BadAlloc and @@ -1597,10 +1607,11 @@ errors. To get the name of a window, use -XFetchName. +. + XFetchName - + Status XFetchName Display *display @@ -1641,30 +1652,29 @@ Returns the window name, which is a null-terminated string. - The -XFetchName + function returns the name of the specified window. If it succeeds, it returns a nonzero status; otherwise, no name has been set for the window, and it returns zero. If the WM_NAME property has not been set for this window, -XFetchName + sets window_name_return to NULL. If the data returned by the server is in the Latin Portable Character Encoding, then the returned string is in the Host Portable Character Encoding. Otherwise, the result is implementation-dependent. When finished with it, a client must free the window name string using -XFree. +. -XFetchName + can generate a BadWindow error. @@ -1685,10 +1695,11 @@ the WM_ICON_NAME property for a given window. To set a window's WM_ICON_NAME property, use -XSetWMIconName. +. + XSetWMIconName - + void XSetWMIconName Display *display @@ -1731,14 +1742,13 @@ structure to be used. - The -XSetWMIconName + convenience function calls -XSetTextProperty + to set the WM_ICON_NAME property. @@ -1746,10 +1756,11 @@ to set the WM_ICON_NAME property. To read a window's WM_ICON_NAME property, use -XGetWMIconName. +. + XGetWMIconName - + Status XGetWMIconName Display *display @@ -1792,14 +1803,13 @@ structure. - The -XGetWMIconName + convenience function calls -XGetTextProperty + to obtain the WM_ICON_NAME property. It returns a nonzero status on success; otherwise, it returns a zero status. @@ -1807,9 +1817,9 @@ otherwise, it returns a zero status. The next two functions have been superseded by -XSetWMIconName + and -XGetWMIconName, +, respectively. You can use these additional convenience functions for window names that are encoded as STRING properties. @@ -1819,11 +1829,12 @@ for window names that are encoded as STRING properties. To set the name to be displayed in a window's icon, use -XSetIconName. +. + Windowicon name XSetIconName - + XSetIconName Display *display @@ -1865,13 +1876,12 @@ which should be a null-terminated string. - If the string is not in the Host Portable Character Encoding, the result is implementation-dependent. -XSetIconName + can generate BadAlloc and @@ -1882,10 +1892,11 @@ errors. To get the name a window wants displayed in its icon, use -XGetIconName. +. + XGetIconName - + Status XGetIconName Display *display @@ -1927,29 +1938,28 @@ which is a null-terminated string. - The -XGetIconName + function returns the name to be displayed in the specified window's icon. If it succeeds, it returns a nonzero status; otherwise, if no icon name has been set for the window, it returns zero. If you never assigned a name to the window, -XGetIconName + sets icon_name_return to NULL. If the data returned by the server is in the Latin Portable Character Encoding, then the returned string is in the Host Portable Character Encoding. Otherwise, the result is implementation-dependent. When finished with it, a client must free the icon name string using -XFree. +. -XGetIconName + can generate a BadWindow error. @@ -2002,7 +2012,7 @@ If insufficient memory is available, returns NULL. To free the memory allocated to this structure, use -XFree. +. @@ -2120,10 +2130,11 @@ or the window to be withdrawn. To set a window's WM_HINTS property, use -XSetWMHints. +. + XSetWMHints - + XSetWMHints Display *display @@ -2166,19 +2177,18 @@ structure to be used. - The -XSetWMHints + function sets the window manager hints that include icon information and location, the initial state of the window, and whether the application relies on the window manager to get keyboard input. -XSetWMHints + can generate BadAlloc and @@ -2189,10 +2199,11 @@ errors. To read a window's WM_HINTS property, use -XGetWMHints. +. + XGetWMHints - + XWMHints *XGetWMHints Display *display @@ -2222,12 +2233,11 @@ Specifies the window. - The -XGetWMHints + function reads the window manager hints and returns NULL if no WM_HINTS property was set on the window or returns a pointer to an @@ -2235,11 +2245,11 @@ or returns a pointer to an structure if it succeeds. When finished with the data, free the space used for it by calling -XFree. +. -XGetWMHints + can generate a BadWindow error. @@ -2303,7 +2313,7 @@ If insufficient memory is available, returns NULL. To free the memory allocated to this structure, use -XFree. +. @@ -2386,10 +2396,11 @@ macro is highly discouraged. To set a window's WM_NORMAL_HINTS property, use -XSetWMNormalHints. +. + XSetWMNormalHints - + void XSetWMNormalHints Display *display @@ -2430,22 +2441,21 @@ Specifies the size hints for the window in its normal state. - The -XSetWMNormalHints + function replaces the size hints for the WM_NORMAL_HINTS property on the specified window. If the property does not already exist, -XSetWMNormalHints + sets the size hints for the WM_NORMAL_HINTS property on the specified window. The property is stored with a type of WM_SIZE_HINTS and a format of 32. -XSetWMNormalHints + can generate BadAlloc and @@ -2456,10 +2466,11 @@ errors. To read a window's WM_NORMAL_HINTS property, use -XGetWMNormalHints. +. + XGetWMNormalHints - + Status XGetWMNormalHints Display *display @@ -2511,18 +2522,17 @@ Returns the hints that were supplied by the user. - The -XGetWMNormalHints + function returns the size hints stored in the WM_NORMAL_HINTS property on the specified window. If the property is of type WM_SIZE_HINTS, is of format 32, and is long enough to contain either an old (pre-ICCCM) or new size hints structure, -XGetWMNormalHints + sets the various fields of the XSizeHints structure, sets the supplied_return argument to the list of fields @@ -2533,7 +2543,7 @@ Otherwise, it returns a zero status. If -XGetWMNormalHints + returns successfully and a pre-ICCCM size hints property is read, the supplied_return argument will contain the following bits: @@ -2558,7 +2568,7 @@ PBaseSize|PWinGravity -XGetWMNormalHints + can generate a BadWindow error. @@ -2567,10 +2577,11 @@ error. To set a window's WM_SIZE_HINTS property, use -XSetWMSizeHints. +. + XSetWMSizeHints - + void XSetWMSizeHints Display *display @@ -2624,27 +2635,26 @@ Specifies the property name. - The -XSetWMSizeHints + function replaces the size hints for the specified property on the named window. If the specified property does not already exist, -XSetWMSizeHints + sets the size hints for the specified property on the named window. The property is stored with a type of WM_SIZE_HINTS and a format of 32. To set a window's normal size hints, you can use the -XSetWMNormalHints + function. -XSetWMSizeHints + can generate BadAlloc, BadAtom, @@ -2656,10 +2666,11 @@ errors. To read a window's WM_SIZE_HINTS property, use -XGetWMSizeHints. +. + XGetWMSizeHints - + Status XGetWMSizeHints Display *display @@ -2724,18 +2735,17 @@ Specifies the property name. - The -XGetWMSizeHints + function returns the size hints stored in the specified property on the named window. If the property is of type WM_SIZE_HINTS, is of format 32, and is long enough to contain either an old (pre-ICCCM) or new size hints structure, -XGetWMSizeHints + sets the various fields of the XSizeHints structure, sets the supplied_return argument to the @@ -2745,13 +2755,13 @@ and returns a nonzero status. Otherwise, it returns a zero status. To get a window's normal size hints, you can use the -XGetWMNormalHints + function. If -XGetWMSizeHints + returns successfully and a pre-ICCCM size hints property is read, the supplied_return argument will contain the following bits: @@ -2776,7 +2786,7 @@ PBaseSize|PWinGravity -XGetWMSizeHints + can generate BadAtom and @@ -2833,7 +2843,7 @@ If insufficient memory is available, returns NULL. To free the memory allocated to this structure, use -XFree. +. @@ -2872,10 +2882,11 @@ resource database. To set a window's WM_CLASS property, use -XSetClassHint. +. + XSetClassHint - + XSetClassHint Display *display @@ -2918,19 +2929,18 @@ structure that is to be used. - The -XSetClassHint + function sets the class hint for the specified window. If the strings are not in the Host Portable Character Encoding, the result is implementation-dependent. -XSetClassHint + can generate BadAlloc and @@ -2941,10 +2951,11 @@ errors. To read a window's WM_CLASS property, use -XGetClassHint. +. + XGetClassHint - + Status XGetClassHint Display *display @@ -2987,12 +2998,11 @@ structure. - The -XGetClassHint + function returns the class hint of the specified window to the members of the supplied structure. If the data returned by the server is in the Latin Portable Character Encoding, @@ -3002,12 +3012,12 @@ It returns a nonzero status on success; otherwise, it returns a zero status. To free res_name and res_class when finished with the strings, use -XFree + on each individually. -XGetClassHint + can generate a BadWindow error. @@ -3027,10 +3037,11 @@ the WM_TRANSIENT_FOR property for a given window. To set a window's WM_TRANSIENT_FOR property, use -XSetTransientForHint. +. + XSetTransientForHint - + XSetTransientForHint Display *display @@ -3071,18 +3082,17 @@ Specifies the window that the WM_TRANSIENT_FOR property is - The -XSetTransientForHint + function sets the WM_TRANSIENT_FOR property of the specified window to the specified prop_window. -XSetTransientForHint + can generate BadAlloc and @@ -3093,10 +3103,11 @@ errors. To read a window's WM_TRANSIENT_FOR property, use -XGetTransientForHint. +. + XGetTransientForHint - + Status XGetTransientForHint Display *display @@ -3137,19 +3148,18 @@ Returns the WM_TRANSIENT_FOR property of the specified wind - The -XGetTransientForHint + function returns the WM_TRANSIENT_FOR property for the specified window. It returns a nonzero status on success; otherwise, it returns a zero status. -XGetTransientForHint + can generate a BadWindow error. @@ -3169,10 +3179,11 @@ the WM_PROTOCOLS property for a given window. To set a window's WM_PROTOCOLS property, use -XSetWMProtocols. +. + XSetWMProtocols - + Status XSetWMProtocols Display *display @@ -3225,27 +3236,26 @@ Specifies the number of (Cn. - The -XSetWMProtocols + function replaces the WM_PROTOCOLS property on the specified window with the list of atoms specified by the protocols argument. If the property does not already exist, -XSetWMProtocols + sets the WM_PROTOCOLS property on the specified window to the list of atoms specified by the protocols argument. The property is stored with a type of ATOM and a format of 32. If it cannot intern the WM_PROTOCOLS atom, -XSetWMProtocols + returns a zero status. Otherwise, it returns a nonzero status. -XSetWMProtocols + can generate BadAlloc and @@ -3256,10 +3266,11 @@ errors. To read a window's WM_PROTOCOLS property, use -XGetWMProtocols. +. + XGetWMProtocols - + Status XGetWMProtocols Display *display @@ -3312,30 +3323,29 @@ Returns the number of (Cn. - The -XGetWMProtocols + function returns the list of atoms stored in the WM_PROTOCOLS property on the specified window. These atoms describe window manager protocols in which the owner of this window is willing to participate. If the property exists, is of type ATOM, is of format 32, and the atom WM_PROTOCOLS can be interned, -XGetWMProtocols + sets the protocols_return argument to a list of atoms, sets the count_return argument to the number of elements in the list, and returns a nonzero status. Otherwise, it sets neither of the return arguments and returns a zero status. To release the list of atoms, use -XFree. +. -XGetWMProtocols + can generate a BadWindow error. @@ -3355,10 +3365,11 @@ the WM_COLORMAP_WINDOWS property for a given window. To set a window's WM_COLORMAP_WINDOWS property, use -XSetWMColormapWindows. +. + XSetWMColormapWindows - + Status XSetWMColormapWindows Display *display @@ -3411,27 +3422,26 @@ Specifies the number of (Cn. - The -XSetWMColormapWindows + function replaces the WM_COLORMAP_WINDOWS property on the specified window with the list of windows specified by the colormap_windows argument. If the property does not already exist, -XSetWMColormapWindows + sets the WM_COLORMAP_WINDOWS property on the specified window to the list of windows specified by the colormap_windows argument. The property is stored with a type of WINDOW and a format of 32. If it cannot intern the WM_COLORMAP_WINDOWS atom, -XSetWMColormapWindows + returns a zero status. Otherwise, it returns a nonzero status. -XSetWMColormapWindows + can generate BadAlloc and @@ -3442,10 +3452,11 @@ errors. To read a window's WM_COLORMAP_WINDOWS property, use -XGetWMColormapWindows. +. + XGetWMColormapWindows - + Status XGetWMColormapWindows Display *display @@ -3498,30 +3509,29 @@ Returns the number of (Cn. - The -XGetWMColormapWindows + function returns the list of window identifiers stored in the WM_COLORMAP_WINDOWS property on the specified window. These identifiers indicate the colormaps that the window manager may need to install for this window. If the property exists, is of type WINDOW, is of format 32, and the atom WM_COLORMAP_WINDOWS can be interned, -XGetWMColormapWindows + sets the windows_return argument to a list of window identifiers, sets the count_return argument to the number of elements in the list, and returns a nonzero status. Otherwise, it sets neither of the return arguments and returns a zero status. To release the list of window identifiers, use -XFree. +. -XGetWMColormapWindows + can generate a BadWindow error. @@ -3575,7 +3585,7 @@ If insufficient memory is available, returns NULL. To free the memory allocated to this structure, use -XFree. +. @@ -3607,10 +3617,11 @@ sizes (minimum to maximum) that represent the supported icon sizes. To set a window's WM_ICON_SIZE property, use -XSetIconSizes. +. + XSetIconSizes - + XSetIconSizes Display *display @@ -3662,17 +3673,16 @@ Specifies the number of items in the size list. - The -XSetIconSizes + function is used only by window managers to set the supported icon sizes. -XSetIconSizes + can generate BadAlloc and @@ -3683,10 +3693,11 @@ errors. To read a window's WM_ICON_SIZE property, use -XGetIconSizes. +. + XGetIconSizes - + Status XGetIconSizes Display *display @@ -3738,29 +3749,28 @@ Returns the number of items in the size list. - The -XGetIconSizes + function returns zero if a window manager has not set icon sizes; otherwise, it returns nonzero. -XGetIconSizes + should be called by an application that wants to find out what icon sizes would be most appreciated by the window manager under which the application is running. The application should then use -XSetWMHints + to supply the window manager with an icon pixmap or window in one of the supported sizes. To free the data allocated in size_list_return, use -XFree. +. -XGetIconSizes + can generate a BadWindow error. @@ -3774,16 +3784,17 @@ error. The -XmbSetWMProperties + function stores the standard set of window manager properties, with text properties in standard encodings for internationalized text communication. The standard window manager properties for a given window are WM_NAME, WM_ICON_NAME, WM_HINTS, WM_NORMAL_HINTS, WM_CLASS, WM_COMMAND, WM_CLIENT_MACHINE, and WM_LOCALE_NAME. + XmbSetWMProperties - + void XmbSetWMProperties Display *display @@ -3896,12 +3907,11 @@ structure to be used. - The -XmbSetWMProperties + convenience function provides a simple programming interface for setting those essential window properties that are used for communicating with other clients @@ -3910,10 +3920,10 @@ for communicating with other clients If the window_name argument is non-NULL, -XmbSetWMProperties + sets the WM_NAME property. If the icon_name argument is non-NULL, -XmbSetWMProperties + sets the WM_ICON_NAME property. The window_name and icon_name arguments are null-terminated strings in the encoding of the current locale. @@ -3925,33 +3935,35 @@ and the properties are created with type ``COMPOUND_TEXT''. If the normal_hints argument is non-NULL, -XmbSetWMProperties + calls -XSetWMNormalHints, -which sets the WM_NORMAL_HINTS property (see section 14.1.7). +, +which sets the WM_NORMAL_HINTS property +(see section 14.1.7). If the wm_hints argument is non-NULL, -XmbSetWMProperties + calls -XSetWMHints, -which sets the WM_HINTS property (see section 14.1.6). +, +which sets the WM_HINTS property +(see section 14.1.6). If the argv argument is non-NULL, -XmbSetWMProperties + sets the WM_COMMAND property from argv and argc. An argc of zero indicates a zero-length command. The hostname of the machine is stored using -XSetWMClientMachine -(see section 14.2.2). + +(see section 14.2.2). If the class_hints argument is non-NULL, -XmbSetWMProperties + sets the WM_CLASS property. If the res_name member in the XClassHint @@ -3976,14 +3988,14 @@ No encoding conversion is performed prior to storage in the properties. For clients that need to process the property text in a locale, -XmbSetWMProperties + sets the WM_LOCALE_NAME property to be the name of the current locale. The name is assumed to be in the Host Portable Character Encoding and is converted to STRING for storage in the property. -XmbSetWMProperties + can generate BadAlloc and @@ -3995,13 +4007,14 @@ errors. To set a window's standard window manager properties with strings in client-specified encodings, use -XSetWMProperties. +. The standard window manager properties for a given window are WM_NAME, WM_ICON_NAME, WM_HINTS, WM_NORMAL_HINTS, WM_CLASS, WM_COMMAND, and WM_CLIENT_MACHINE. + XSetWMProperties - + void XSetWMProperties Display *display @@ -4114,12 +4127,11 @@ structure to be used. - The -XSetWMProperties + convenience function provides a single programming interface for setting those essential window properties that are used for communicating with other clients (particularly window and session @@ -4128,45 +4140,51 @@ managers). If the window_name argument is non-NULL, -XSetWMProperties + calls -XSetWMName, -which, in turn, sets the WM_NAME property (see section 14.1.4). +, +which, in turn, sets the WM_NAME property +(see section 14.1.4). If the icon_name argument is non-NULL, -XSetWMProperties + calls -XSetWMIconName, -which sets the WM_ICON_NAME property (see section 14.1.5). +, +which sets the WM_ICON_NAME property +(see section 14.1.5). If the argv argument is non-NULL, -XSetWMProperties + calls -XSetCommand, -which sets the WM_COMMAND property (see section 14.2.1). +, +which sets the WM_COMMAND property +(see section 14.2.1). Note that an argc of zero is allowed to indicate a zero-length command. Note also that the hostname of this machine is stored using -XSetWMClientMachine -(see section 14.2.2). + +(see section 14.2.2). If the normal_hints argument is non-NULL, -XSetWMProperties + calls -XSetWMNormalHints, -which sets the WM_NORMAL_HINTS property (see section 14.1.7). +, +which sets the WM_NORMAL_HINTS property +(see section 14.1.7). If the wm_hints argument is non-NULL, -XSetWMProperties + calls -XSetWMHints, -which sets the WM_HINTS property (see section 14.1.6). +, +which sets the WM_HINTS property +(see section 14.1.6). If the class_hints argument is non-NULL, -XSetWMProperties + calls -XSetClassHint, -which sets the WM_CLASS property (see section 14.1.8). +, +which sets the WM_CLASS property +(see section 14.1.8). If the res_name member in the XClassHint structure is set to the NULL pointer and the RESOURCE_NAME environment @@ -4180,7 +4198,7 @@ any directory prefixes, is substituted for res_name. -XSetWMProperties + can generate BadAlloc and @@ -4224,10 +4242,11 @@ the WM_COMMAND property for a given window. To set a window's WM_COMMAND property, use -XSetCommand. +. + XSetCommand - + XSetCommand Display *display @@ -4279,12 +4298,11 @@ Specifies the number of arguments. - The -XSetCommand + function sets the command and arguments used to invoke the application. (Typically, argv is the argv array of your main program.) @@ -4293,7 +4311,7 @@ the result is implementation-dependent. -XSetCommand + can generate BadAlloc and @@ -4304,10 +4322,11 @@ errors. To read a window's WM_COMMAND property, use -XGetCommand. +. + XGetCommand - + Status XGetCommand Display *display @@ -4359,18 +4378,17 @@ Returns the number of arguments returned. - The -XGetCommand + function reads the WM_COMMAND property from the specified window and returns a string list. If the WM_COMMAND property exists, it is of type STRING and format 8. If sufficient memory can be allocated to contain the string list, -XGetCommand + fills in the argv_return and argc_return arguments and returns a nonzero status. Otherwise, it returns a zero status. @@ -4378,7 +4396,7 @@ If the data returned by the server is in the Latin Portable Character Encoding, then the returned strings are in the Host Portable Character Encoding. Otherwise, the result is implementation-dependent. To free the memory allocated to the string list, use -XFreeStringList. +. @@ -4395,10 +4413,11 @@ the WM_CLIENT_MACHINE property for a given window. To set a window's WM_CLIENT_MACHINE property, use -XSetWMClientMachine. +. + XSetWMClientMachine - + void XSetWMClientMachine Display *display @@ -4441,24 +4460,24 @@ structure to be used. - The -XSetWMClientMachine + convenience function calls -XSetTextProperty + to set the WM_CLIENT_MACHINE property. To read a window's WM_CLIENT_MACHINE property, use -XGetWMClientMachine. +. + XGetWMClientMachine - + Status XGetWMClientMachine Display *display @@ -4501,14 +4520,13 @@ structure. - The -XGetWMClientMachine + convenience function performs an -XGetTextProperty + on the WM_CLIENT_MACHINE property. It returns a nonzero status on success; otherwise, it returns a zero status. @@ -4644,7 +4662,7 @@ If insufficient memory is available, returns NULL. To free the memory allocated to this structure, use -XFree. +. @@ -4677,7 +4695,7 @@ typedef struct { The colormap member is the colormap created by the -XCreateColormap + function. The red_max, green_max, and blue_max members give the maximum red, green, and blue values, respectively. @@ -4705,7 +4723,7 @@ green_mult might be 6, and blue_mult might be 1. The base_pixel member gives the base pixel value used to compose a full pixel value. Usually, the base_pixel is obtained from a call to the -XAllocColorPlanes + function. Given integer red, green, and blue coefficients in their appropriate ranges, one then can compute a corresponding pixel value by @@ -4756,7 +4774,7 @@ colormap was created. The killid member gives a resource ID that indicates whether the cells held by this standard colormap are to be released by freeing the colormap ID or by calling the -XKillClient + function on the indicated resource. (Note that this method is necessary for allocating out of an existing colormap.) @@ -4917,10 +4935,11 @@ structure. To set an XStandardColormap structure, use -XSetRGBColormaps. +. + XSetRGBColormaps - + void XSetRGBColormaps Display *display @@ -4986,16 +5005,15 @@ Specifies the property name. - The -XSetRGBColormaps + function replaces the RGB colormap definition in the specified property on the named window. If the property does not already exist, -XSetRGBColormaps + sets the RGB colormap definition in the specified property on the named window. The property is stored with a type of RGB_COLOR_MAP and a format of 32. @@ -5005,7 +5023,7 @@ restriction that only RGB_DEFAULT_MAP contain more than one definition. The -XSetRGBColormaps + function usually is only used by window or session managers. To create a standard colormap, follow this procedure: @@ -5051,7 +5069,7 @@ Allocate cells in the colormap (or create it with Call -XStoreColors + to store appropriate color values in the colormap. @@ -5070,7 +5088,7 @@ Attach the property to the root window. Use -XSetCloseDownMode + to make the resource permanent. @@ -5083,7 +5101,7 @@ Ungrab the server. -XSetRGBColormaps + can generate BadAlloc, BadAtom, @@ -5097,10 +5115,11 @@ errors. To obtain the XStandardColormap structure associated with the specified property, use -XGetRGBColormaps. +. + XGetRGBColormaps - + Status XGetRGBColormaps Display *display @@ -5166,35 +5185,34 @@ Specifies the property name. - The -XGetRGBColormaps + function returns the RGB colormap definitions stored in the specified property on the named window. If the property exists, is of type RGB_COLOR_MAP, is of format 32, and is long enough to contain a colormap definition, -XGetRGBColormaps + allocates and fills in space for the returned colormaps and returns a nonzero status. If the visualid is not present, -XGetRGBColormaps + assumes the default visual for the screen on which the window is located; if the killid is not present, None is assumed, which indicates that the resources cannot be released. Otherwise, none of the fields are set, and -XGetRGBColormaps + returns a zero status. Note that it is the caller's responsibility to honor the ICCCM restriction that only RGB_DEFAULT_MAP contain more than one definition. -XGetRGBColormaps + can generate BadAtom and