man/XSetTransientForHint.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 XSetTransientForHint __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
 143 .SH NAME
 144 XSetTransientForHint, XGetTransientForHint \- set or read a window's WM_TRANSIENT_FOR property
 145 .SH SYNTAX
 146 .HP
 147 int XSetTransientForHint\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^,
 148 Window \fIprop_window\fP\^);
 149 .HP
 150 Status XGetTransientForHint\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^,
 151 Window *\fIprop_window_return\fP\^);
 152 .SH ARGUMENTS
 153 .IP \fIdisplay\fP 1i
 154 Specifies the connection to the X server.
 155 .IP \fIw\fP 1i
 156 Specifies the window.
 157 .IP \fIprop_window\fP 1i
 158 Specifies the window that the WM_TRANSIENT_FOR property is to be set to.
 159 .IP \fIprop_window_return\fP 1i
 160 Returns the WM_TRANSIENT_FOR property of the specified window.
 161 .SH DESCRIPTION
 162 The
 163 .ZN XSetTransientForHint
 164 function sets the WM_TRANSIENT_FOR property of the specified window to the
 165 specified prop_window.
 166 .LP
 167 .ZN XSetTransientForHint
 168 can generate
 169 .ZN BadAlloc
 170 and
 171 .ZN BadWindow
 172 errors.
 173 .LP
 174 The
 175 .ZN XGetTransientForHint
 176 function returns the WM_TRANSIENT_FOR property for the specified window.
 177 It returns a nonzero status on success;
 178 otherwise, it returns a zero status.
 179 .LP
 180 .ZN XGetTransientForHint
 181 can generate a
 182 .ZN BadWindow
 183 error.
 184 .SH PROPERTIES
 185 .TP 1i
 186 \s-1WM_TRANSIENT_FOR\s+1
 187 Set by application programs to indicate to the window manager that a transient
 188 top-level window, such as a dialog box.
 189 .SH DIAGNOSTICS
 190 .TP 1i
 191 .ZN BadAlloc
 192 The server failed to allocate the requested resource or server memory.
 193 .TP 1i
 194 .ZN BadWindow
 195 A value for a Window argument does not name a defined Window.
 196 .SH "SEE ALSO"
 197 XAllocClassHint(__libmansuffix__),
 198 XAllocIconSize(__libmansuffix__),
 199 XAllocSizeHints(__libmansuffix__),
 200 XAllocWMHints(__libmansuffix__),
 201 XSetCommand(__libmansuffix__),
 202 XSetTextProperty(__libmansuffix__),
 203 XSetWMClientMachine(__libmansuffix__),
 204 XSetWMColormapWindows(__libmansuffix__),
 205 XSetWMIconName(__libmansuffix__),
 206 XSetWMName(__libmansuffix__),
 207 XSetWMProperties(__libmansuffix__),
 208 XSetWMProtocols(__libmansuffix__),
 209 XStringListToTextProperty(__libmansuffix__)
 210 .br
 211 \fI\*(xL\fP