usr/src/man/man3xcurses/attr_get.3xcurses

   1 '\" te
   2 .\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1996, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH ATTR_GET 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 attr_get, attr_off, attr_on, attr_set, color_set, wattr_get, wattr_off,
   9 wattr_on, wattr_set, wcolor_set \- control window attributes
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e
  14 \fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ]
  15
  16 \fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ]
  17
  18 #include <curses.h>
  19
  20 \fBint\fR \fBattr_get\fR(\fBattr_t *\fR\fIattrs\fR, \fBshort *\fR\fIcolor\fR, \fBvoid *\fR\fIopts\fR);
  21 .fi
  22
  23 .LP
  24 .nf
  25 \fBint\fR \fBattr_off\fR(\fBattr_t\fR \fIattrs\fR, \fBvoid *\fR\fIopts\fR);
  26 .fi
  27
  28 .LP
  29 .nf
  30 \fBint\fR \fBattr_on\fR(\fBattr_t\fR \fIattrs\fR, \fBvoid *\fR\fIopts\fR);
  31 .fi
  32
  33 .LP
  34 .nf
  35 \fBint\fR \fBattr_set\fR(\fBattr_t\fR \fIattrs\fR, \fBshort\fR \fIcolor\fR, \fBvoid *\fR\fIopts\fR);
  36 .fi
  37
  38 .LP
  39 .nf
  40 \fBint\fR \fBcolor_set\fR(\fBshort *\fR\fIcolor\fR, \fBvoid *\fR\fIopts\fR);
  41 .fi
  42
  43 .LP
  44 .nf
  45 \fBint\fR \fBwattr_get\fR(\fBWINDOW *\fR\fIwin\fR, \fBattr_t\fR \fIattrs\fR, \fBshort *\fR\fIcolor\fR, \fBvoid *\fR\fIopts\fR);
  46 .fi
  47
  48 .LP
  49 .nf
  50 \fBint\fR \fBwattr_off\fR(\fBWINDOW *\fR\fIwin\fR, \fBattr_t\fR \fIattrs\fR, \fBvoid *\fR\fIopts\fR);
  51 .fi
  52
  53 .LP
  54 .nf
  55 \fBint\fR \fBwattr_on\fR(\fBWINDOW *\fR\fIwin\fR, \fBattr_t\fR \fIattrs\fR, \fBvoid *\fR\fIopts\fR);
  56 .fi
  57
  58 .LP
  59 .nf
  60 \fBint\fR \fBwattr_set\fR(\fBWINDOW *\fR\fIwin\fR, \fBattr_t\fR \fIattrs\fR, \fBshort\fR \fIcolor\fR, \fBvoid *\fR\fIopts\fR);
  61 .fi
  62
  63 .LP
  64 .nf
  65 \fBint\fR \fBwcolor_set\fR(\fBWINDOW *\fR\fIwin\fR, \fBshort\fR \fIcolor\fR, \fBvoid *\fR\fIopts\fR);
  66 .fi
  67
  68 .SH DESCRIPTION
  69 .sp
  70 .LP
  71 The \fBattr_get()\fR function retrieves the current rendition of \fIstdscr\fR.
  72 The \fBwattr_get()\fR function retrieves the current rendition of window
  73 \fIwin\fR.  If \fIattrs\fR or \fIcolor\fR is a null pointer, no information is
  74 retrieved.
  75 .sp
  76 .LP
  77 The \fBattr_off()\fR and \fBattr_on()\fR functions unset and set,
  78 respectively, the specified window attributes of \fBstdscr\fR.  These functions
  79 only affect the attributes specified; attributes that existed before the call
  80 are retained.
  81 .sp
  82 .LP
  83 The \fBwattr_off()\fR and \fBwattr_on()\fR functions unset or set the
  84 specified attributes for window \fIwin\fR.
  85 .sp
  86 .LP
  87 The \fBattr_set()\fR and \fBwattr_set()\fR functions change the rendition of
  88 \fBstdscr\fR and \fIwin\fR; the old values are not retained.
  89 .sp
  90 .LP
  91 The \fBcolor_set()\fR and \fBwcolor_set()\fR functions set the window color of
  92 \fBstdscr\fR and \fIwin\fR to \fIcolor\fR.
  93 .sp
  94 .LP
  95 The attributes and color pairs that can be used are specified in the
  96 \fBAttributes, Color Pairs, and Renditions\fR section of the
  97 \fBcurses\fR(3XCURSES) man page.
  98 .SH PARAMETERS
  99 .sp
 100 .ne 2
 101 .na
 102 \fB\fIattrs\fR\fR
 103 .ad
 104 .RS 9n
 105 Is a pointer to the foreground window attributes to be set or unset.
 106 .RE
 107
 108 .sp
 109 .ne 2
 110 .na
 111 \fB\fIcolor\fR\fR
 112 .ad
 113 .RS 9n
 114 Is a pointer to a color pair number .
 115 .RE
 116
 117 .sp
 118 .ne 2
 119 .na
 120 \fB\fIopts\fR\fR
 121 .ad
 122 .RS 9n
 123 Is reserved for future use.
 124 .RE
 125
 126 .sp
 127 .ne 2
 128 .na
 129 \fB\fIwin\fR\fR
 130 .ad
 131 .RS 9n
 132 Is a pointer to the window in which attribute changes are to be made.
 133 .RE
 134
 135 .SH RETURN VALUES
 136 .sp
 137 .LP
 138 These functions always return \fBOK\fR.
 139 .SH ERRORS
 140 .sp
 141 .LP
 142 None.
 143 .SH ATTRIBUTES
 144 .sp
 145 .LP
 146 See \fBattributes\fR(5) for descriptions of the following attributes:
 147 .sp
 148
 149 .sp
 150 .TS
 151 box;
 152 c | c
 153 l | l .
 154 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 155 _
 156 Interface Stability     Standard
 157 _
 158 MT-Level        Unsafe
 159 .TE
 160
 161 .SH SEE ALSO
 162 .sp
 163 .LP
 164 \fBadd_wch\fR(3XCURSES), \fBaddnwstr\fR(3XCURSES), \fBattroff\fR(3XCURSES),
 165 \fBbkgrndset\fR(3XCURSES), \fBcurses\fR(3XCURSES), \fBinit_color\fR(3XCURSES),
 166 \fBlibcurses\fR(3XCURSES), \fBstart_color\fR(3XCURSES), \fBattributes\fR(5),
 167 \fBstandards\fR(5)