man/XSetWMIconName.man

   1 .\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium
   2 .\"
   3 .\" Permission is hereby granted, free of charge, to any person obtaining
   4 .\" a copy of this software and associated documentation files (the
   5 .\" "Software"), to deal in the Software without restriction, including
   6 .\" without limitation the rights to use, copy, modify, merge, publish,
   7 .\" distribute, sublicense, and/or sell copies of the Software, and to
   8 .\" permit persons to whom the Software is furnished to do so, subject to
   9 .\" the following conditions:
  10 .\"
  11 .\" The above copyright notice and this permission notice shall be included
  12 .\" in all copies or substantial portions of the Software.
  13 .\"
  14 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  15 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  16 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  17 .\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
  18 .\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  19 .\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  20 .\" OTHER DEALINGS IN THE SOFTWARE.
  21 .\"
  22 .\" Except as contained in this notice, the name of the X Consortium shall
  23 .\" not be used in advertising or otherwise to promote the sale, use or
  24 .\" other dealings in this Software without prior written authorization
  25 .\" from the X Consortium.
  26 .\"
  27 .\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by
  28 .\" Digital Equipment Corporation
  29 .\"
  30 .\" Portions Copyright \(co 1990, 1991 by
  31 .\" Tektronix, Inc.
  32 .\"
  33 .\" Permission to use, copy, modify and distribute this documentation for
  34 .\" any purpose and without fee is hereby granted, provided that the above
  35 .\" copyright notice appears in all copies and that both that copyright notice
  36 .\" and this permission notice appear in all copies, and that the names of
  37 .\" Digital and Tektronix not be used in in advertising or publicity pertaining
  38 .\" to this documentation without specific, written prior permission.
  39 .\" Digital and Tektronix makes no representations about the suitability
  40 .\" of this documentation for any purpose.
  41 .\" It is provided ``as is'' without express or implied warranty.
  42 .\"
  43 .\"
  44 .ds xT X Toolkit Intrinsics \- C Language Interface
  45 .ds xW Athena X Widgets \- C Language X Toolkit Interface
  46 .ds xL Xlib \- C Language X Interface
  47 .ds xC Inter-Client Communication Conventions Manual
  48 .na
  49 .de Ds
  50 .nf
  51 .\\$1D \\$2 \\$1
  52 .ft 1
  53 .\".ps \\n(PS
  54 .\".if \\n(VS>=40 .vs \\n(VSu
  55 .\".if \\n(VS<=39 .vs \\n(VSp
  56 ..
  57 .de De
  58 .ce 0
  59 .if \\n(BD .DF
  60 .nr BD 0
  61 .in \\n(OIu
  62 .if \\n(TM .ls 2
  63 .sp \\n(DDu
  64 .fi
  65 ..
  66 .de FD
  67 .LP
  68 .KS
  69 .TA .5i 3i
  70 .ta .5i 3i
  71 .nf
  72 ..
  73 .de FN
  74 .fi
  75 .KE
  76 .LP
  77 ..
  78 .de IN          \" send an index entry to the stderr
  79 ..
  80 .de C{
  81 .KS
  82 .nf
  83 .D
  84 .\"
  85 .\"     choose appropriate monospace font
  86 .\"     the imagen conditional, 480,
  87 .\"     may be changed to L if LB is too
  88 .\"     heavy for your eyes...
  89 .\"
  90 .ie "\\*(.T"480" .ft L
  91 .el .ie "\\*(.T"300" .ft L
  92 .el .ie "\\*(.T"202" .ft PO
  93 .el .ie "\\*(.T"aps" .ft CW
  94 .el .ft R
  95 .ps \\n(PS
  96 .ie \\n(VS>40 .vs \\n(VSu
  97 .el .vs \\n(VSp
  98 ..
  99 .de C}
 100 .DE
 101 .R
 102 ..
 103 .de Pn
 104 .ie t \\$1\fB\^\\$2\^\fR\\$3
 105 .el \\$1\fI\^\\$2\^\fP\\$3
 106 ..
 107 .de ZN
 108 .ie t \fB\^\\$1\^\fR\\$2
 109 .el \fI\^\\$1\^\fP\\$2
 110 ..
 111 .de hN
 112 .ie t <\fB\\$1\fR>\\$2
 113 .el <\fI\\$1\fP>\\$2
 114 ..
 115 .de NT
 116 .ne 7
 117 .ds NO Note
 118 .if \\n(.$>$1 .if !'\\$2'C' .ds NO \\$2
 119 .if \\n(.$ .if !'\\$1'C' .ds NO \\$1
 120 .ie n .sp
 121 .el .sp 10p
 122 .TB
 123 .ce
 124 \\*(NO
 125 .ie n .sp
 126 .el .sp 5p
 127 .if '\\$1'C' .ce 99
 128 .if '\\$2'C' .ce 99
 129 .in +5n
 130 .ll -5n
 131 .R
 132 ..
 133 .               \" Note End -- doug kraft 3/85
 134 .de NE
 135 .ce 0
 136 .in -5n
 137 .ll +5n
 138 .ie n .sp
 139 .el .sp 10p
 140 ..
 141 .ny0
 142 .TH XSetWMIconName __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
 143 .SH NAME
 144 XSetWMIconName, XGetWMIconName, XSetIconName, XGetIconName \- set or read a window's WM_ICON_NAME property
 145 .SH SYNTAX
 146 .HP
 147 void XSetWMIconName\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^,
 148 XTextProperty *\fItext_prop\fP\^);
 149 .HP
 150 Status XGetWMIconName\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^,
 151 XTextProperty *\fItext_prop_return\fP\^);
 152 .HP
 153 int XSetIconName\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, char
 154 *\fIicon_name\fP\^);
 155 .HP
 156 Status XGetIconName\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, char
 157 **\fIicon_name_return\fP\^);
 158 .SH ARGUMENTS
 159 .IP \fIdisplay\fP 1i
 160 Specifies the connection to the X server.
 161 .IP \fIicon_name\fP 1i
 162 Specifies the icon name,
 163 which should be a null-terminated string.
 164 .IP \fIicon_name_return\fP 1i
 165 Returns the window's icon name,
 166 which is a null-terminated string.
 167 .IP \fItext_prop\fP 1i
 168 Specifies the
 169 .ZN XTextProperty
 170 structure to be used.
 171 .IP \fItext_prop_return\fP 1i
 172 Returns the
 173 .ZN XTextProperty
 174 structure.
 175 .IP \fIw\fP 1i
 176 Specifies the window.
 177 .SH DESCRIPTION
 178 The
 179 .ZN XSetWMIconName
 180 convenience function calls
 181 .ZN XSetTextProperty
 182 to set the WM_ICON_NAME property.
 183 .LP
 184 The
 185 .ZN XGetWMIconName
 186 convenience function calls
 187 .ZN XGetTextProperty
 188 to obtain the WM_ICON_NAME property.
 189 It returns a nonzero status on success;
 190 otherwise, it returns a zero status.
 191 .LP
 192 The
 193 .ZN XSetIconName
 194 function sets the name to be displayed in a window's icon.
 195 .LP
 196 .ZN XSetIconName
 197 can generate
 198 .ZN BadAlloc
 199 and
 200 .ZN BadWindow
 201 errors.
 202 .LP
 203 The
 204 .ZN XGetIconName
 205 function returns the name to be displayed in the specified window's icon.
 206 If it succeeds, it returns a nonzero status; otherwise,
 207 if no icon name has been set for the window,
 208 it returns zero.
 209 If you never assigned a name to the window,
 210 .ZN XGetIconName
 211 sets icon_name_return to NULL.
 212 If the data returned by the server is in the Latin Portable Character Encoding,
 213 then the returned string is in the Host Portable Character Encoding.
 214 Otherwise, the result is implementation-dependent.
 215 When finished with it, a client must free
 216 the icon name string using
 217 .ZN XFree .
 218 .LP
 219 .ZN XGetIconName
 220 can generate a
 221 .ZN BadWindow
 222 error.
 223 .SH PROPERTIES
 224 .TP 1i
 225 \s-1WM_ICON_NAME\s+1
 226 The name to be used in an icon.
 227 .SH DIAGNOSTICS
 228 .TP 1i
 229 .ZN BadAlloc
 230 The server failed to allocate the requested resource or server memory.
 231 .TP 1i
 232 .ZN BadWindow
 233 A value for a Window argument does not name a defined Window.
 234 .SH "SEE ALSO"
 235 XAllocClassHint(__libmansuffix__),
 236 XAllocIconSize(__libmansuffix__),
 237 XAllocSizeHints(__libmansuffix__),
 238 XAllocWMHints(__libmansuffix__),
 239 XFree(__libmansuffix__),
 240 XSetCommand(__libmansuffix__),
 241 XSetTransientForHint(__libmansuffix__),
 242 XSetTextProperty(__libmansuffix__),
 243 XSetWMClientMachine(__libmansuffix__),
 244 XSetWMColormapWindows(__libmansuffix__),
 245 XSetWMName(__libmansuffix__),
 246 XSetWMProperties(__libmansuffix__),
 247 XSetWMProtocols(__libmansuffix__),
 248 XStringListToTextProperty(__libmansuffix__)
 249 .br
 250 \fI\*(xL\fP