man/XSetState.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 XSetState __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
 143 .SH NAME
 144 XSetState, XSetFunction, XSetPlaneMask, XSetForeground, XSetBackground \- GC convenience routines
 145 .SH SYNTAX
 146 .HP
 147 int XSetState\^(\^Display *\fIdisplay\fP\^, GC \fIgc\fP\^, unsigned long
 148 \fIforeground\fP\^, unsigned int \fIbackground\fP\^, int \fIfunction\fP\^,
 149 unsigned long \fIplane_mask\fP\^);
 150 .HP
 151 int XSetFunction\^(\^Display *\fIdisplay\fP\^, GC \fIgc\fP\^, int
 152 \fIfunction\fP\^);
 153 .HP
 154 int XSetPlaneMask\^(\^Display *\fIdisplay\fP\^, GC \fIgc\fP\^, unsigned long
 155 \fIplane_mask\fP\^);
 156 .HP
 157 int XSetForeground\^(\^Display *\fIdisplay\fP\^, GC \fIgc\fP\^, unsigned long
 158 \fIforeground\fP\^);
 159 .HP
 160 int XSetBackground\^(\^Display *\fIdisplay\fP\^, GC \fIgc\fP\^, unsigned long
 161 \fIbackground\fP\^);
 162 .SH ARGUMENTS
 163 .IP \fIbackground\fP 1i
 164 Specifies the background you want to set for the specified GC.
 165 .IP \fIdisplay\fP 1i
 166 Specifies the connection to the X server.
 167 .IP \fIforeground\fP 1i
 168 Specifies the foreground you want to set for the specified GC.
 169 .IP \fIfunction\fP 1i
 170 Specifies the function you want to set for the specified GC.
 171 .IP \fIgc\fP 1i
 172 Specifies the GC.
 173 .IP \fIplane_mask\fP 1i
 174 Specifies the plane mask.
 175 .\" *** JIM: NEED MORE INFO FOR THIS. ***
 176 .SH DESCRIPTION
 177 The
 178 .ZN XSetState
 179 function sets the foreground, background, plane mask, and function components
 180 for the specified GC.
 181 .LP
 182 .ZN XSetState
 183 can generate
 184 .ZN BadAlloc ,
 185 .ZN BadGC ,
 186 and
 187 .ZN BadValue
 188 errors.
 189 .LP
 190 .ZN XSetFunction
 191 sets a specified value in the specified GC.
 192 .LP
 193 .ZN XSetFunction
 194 can generate
 195 .ZN BadAlloc ,
 196 .ZN BadGC ,
 197 and
 198 .ZN BadValue
 199 errors.
 200 .LP
 201 The
 202 .ZN XSetPlaneMask
 203 function sets the plane mask in the specified GC.
 204 .LP
 205 .ZN XSetPlaneMask
 206 can generate
 207 .ZN BadAlloc
 208 and
 209 .ZN BadGC
 210 errors.
 211 .LP
 212 The
 213 .ZN XSetForeground
 214 function sets the foreground in the specified GC.
 215 .LP
 216 .ZN XSetForeground
 217 can generate
 218 .ZN BadAlloc
 219 and
 220 .ZN BadGC
 221 errors.
 222 .LP
 223 The
 224 .ZN XSetBackground
 225 function sets the background in the specified GC.
 226 .LP
 227 .ZN XSetBackground
 228 can generate
 229 .ZN BadAlloc
 230 and
 231 .ZN BadGC
 232 errors.
 233 .SH DIAGNOSTICS
 234 .TP 1i
 235 .ZN BadAlloc
 236 The server failed to allocate the requested resource or server memory.
 237 .TP 1i
 238 .ZN BadGC
 239 A value for a GContext argument does not name a defined GContext.
 240 .TP 1i
 241 .ZN BadValue
 242 Some numeric value falls outside the range of values accepted by the request.
 243 Unless a specific range is specified for an argument, the full range defined
 244 by the argument's type is accepted.  Any argument defined as a set of
 245 alternatives can generate this error.
 246 .SH "SEE ALSO"
 247 XCreateGC(__libmansuffix__),
 248 XQueryBestSize(__libmansuffix__),
 249 XSetArcMode(__libmansuffix__),
 250 XSetClipOrigin(__libmansuffix__),
 251 XSetFillStyle(__libmansuffix__),
 252 XSetFont(__libmansuffix__),
 253 XSetLineAttributes(__libmansuffix__),
 254 XSetTile(__libmansuffix__)
 255 .br
 256 \fI\*(xL\fP