iPXE
Functions
winattrs.c File Reference

MuCurses window attribute functions. More...

#include <curses.h>

Go to the source code of this file.

Functions

 FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
 
chtype getbkgd (WINDOW *win)
 Get the background rendition attributes for a window. More...
 
int wattroff (WINDOW *win, int attrs)
 Turn off attributes in a window. More...
 
int wattron (WINDOW *win, int attrs)
 Turn on attributes in a window. More...
 
int wattrset (WINDOW *win, int attrs)
 Set attributes in a window. More...
 
int wattr_get (WINDOW *win, attr_t *attrs, short *pair, void *opts __unused)
 Get attributes and colour pair information. More...
 
int wattr_off (WINDOW *win, attr_t attrs, void *opts __unused)
 Turn off attributes in a window. More...
 
int wattr_on (WINDOW *win, attr_t attrs, void *opts __unused)
 Turn on attributes in a window. More...
 
int wattr_set (WINDOW *win, attr_t attrs, short cpair, void *opts __unused)
 Set attributes and colour pair information in a window. More...
 
int wcolour_set (WINDOW *win, short colour_pair_number, void *opts __unused)
 Set colour pair for a window. More...
 

Detailed Description

MuCurses window attribute functions.

Definition in file winattrs.c.

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL  )

◆ getbkgd()

chtype getbkgd ( WINDOW win)
inline

Get the background rendition attributes for a window.

Parameters
*winsubject window
Return values
chchtype rendition representation

Definition at line 17 of file winattrs.c.

17  {
18  return win->attrs;
19 }
attr_t attrs
window attributes
Definition: curses.h:93

References _curses_window::attrs.

◆ wattroff()

int wattroff ( WINDOW win,
int  attrs 
)

Turn off attributes in a window.

Parameters
winsubject window
attrsattributes to enable
Return values
rcreturn status code

Definition at line 28 of file winattrs.c.

28  {
29  win->attrs &= ~attrs;
30  return OK;
31 }
Definition: sis900.h:208
uint32_t attrs
Extended attributes (optional)
Definition: memmap.c:32
attr_t attrs
window attributes
Definition: curses.h:93

References attrs, _curses_window::attrs, and OK.

Referenced by attroff(), and wattr_off().

◆ wattron()

int wattron ( WINDOW win,
int  attrs 
)

Turn on attributes in a window.

Parameters
winsubject window
attrsattributes to enable
Return values
rcreturn status code

Definition at line 40 of file winattrs.c.

40  {
41  win->attrs |= attrs;
42  return OK;
43 }
Definition: sis900.h:208
uint32_t attrs
Extended attributes (optional)
Definition: memmap.c:32
attr_t attrs
window attributes
Definition: curses.h:93

References attrs, _curses_window::attrs, and OK.

Referenced by attron(), and wattr_on().

◆ wattrset()

int wattrset ( WINDOW win,
int  attrs 
)

Set attributes in a window.

Parameters
winsubject window
attrsattributes to enable
Return values
rcreturn status code

Definition at line 52 of file winattrs.c.

52  {
53  win->attrs = ( attrs | ( win->attrs & A_COLOR ) );
54  return OK;
55 }
Definition: sis900.h:208
uint32_t attrs
Extended attributes (optional)
Definition: memmap.c:32
attr_t attrs
window attributes
Definition: curses.h:93
#define A_COLOR
Definition: curses.h:149

References A_COLOR, attrs, _curses_window::attrs, and OK.

Referenced by _enter_slk(), attrset(), bkgdset(), wattr_set(), wbkgdset(), wstandend(), and wstandout().

◆ wattr_get()

int wattr_get ( WINDOW win,
attr_t attrs,
short *  pair,
void *opts  __unused 
)

Get attributes and colour pair information.

Parameters
*winwindow to obtain information from
*attrsaddress in which to store attributes
*pairaddress in which to store colour pair
*optsundefined (for future implementation)
Return values
rcreturn status cude

Definition at line 66 of file winattrs.c.

67  {
68  *attrs = win->attrs & A_ATTRIBUTES;
69  *pair = PAIR_NUMBER ( win->attrs );
70  return OK;
71 }
#define A_ATTRIBUTES
Definition: curses.h:146
Definition: sis900.h:208
uint32_t attrs
Extended attributes (optional)
Definition: memmap.c:32
attr_t attrs
window attributes
Definition: curses.h:93
#define PAIR_NUMBER(attrs)
Definition: curses.h:153

References A_ATTRIBUTES, attrs, _curses_window::attrs, OK, and PAIR_NUMBER.

Referenced by _enter_slk().

◆ wattr_off()

int wattr_off ( WINDOW win,
attr_t  attrs,
void *opts  __unused 
)

Turn off attributes in a window.

Parameters
*winsubject window
attrsattributes to toggle
*optsundefined (for future implementation)
Return values
rcreturn status code

Definition at line 81 of file winattrs.c.

82  {
83  wattroff( win, attrs );
84  return OK;
85 }
Definition: sis900.h:208
uint32_t attrs
Extended attributes (optional)
Definition: memmap.c:32
int wattroff(WINDOW *win, int attrs)
Turn off attributes in a window.
Definition: winattrs.c:28

References attrs, OK, and wattroff().

◆ wattr_on()

int wattr_on ( WINDOW win,
attr_t  attrs,
void *opts  __unused 
)

Turn on attributes in a window.

Parameters
*winsubject window
attrsattributes to toggle
*optsundefined (for future implementation)
Return values
rcreturn status code

Definition at line 95 of file winattrs.c.

96  {
97  wattron( win, attrs );
98  return OK;
99 }
Definition: sis900.h:208
uint32_t attrs
Extended attributes (optional)
Definition: memmap.c:32
int wattron(WINDOW *win, int attrs)
Turn on attributes in a window.
Definition: winattrs.c:40

References attrs, OK, and wattron().

◆ wattr_set()

int wattr_set ( WINDOW win,
attr_t  attrs,
short  cpair,
void *opts  __unused 
)

Set attributes and colour pair information in a window.

Parameters
*winsubject window
attrsattributes to set
cpaircolour pair to set
*optsundefined (for future implementation)
Return values
rcreturn status code

Definition at line 110 of file winattrs.c.

111  {
112  wattrset( win, attrs | COLOUR_PAIR ( cpair ) );
113  return OK;
114 }
#define COLOUR_PAIR(n)
Definition: curses.h:151
int wattrset(WINDOW *win, int attrs)
Set attributes in a window.
Definition: winattrs.c:52
Definition: sis900.h:208
uint32_t attrs
Extended attributes (optional)
Definition: memmap.c:32

References attrs, COLOUR_PAIR, OK, and wattrset().

Referenced by _leave_slk().

◆ wcolour_set()

int wcolour_set ( WINDOW win,
short  colour_pair_number,
void *opts  __unused 
)

Set colour pair for a window.

Parameters
*winsubject window
colour_pair_numbercolour pair integer
*optsundefined (for future implementation)
Return values
rcreturn status code

Definition at line 124 of file winattrs.c.

125  {
126  if ( ( unsigned short )colour_pair_number > COLOUR_PAIRS )
127  return ERR;
128 
129  win->attrs = ( ( win->attrs & A_ATTRIBUTES ) |
130  COLOUR_PAIR ( colour_pair_number ) );
131  return OK;
132 }
#define COLOUR_PAIR(n)
Definition: curses.h:151
#define COLOUR_PAIRS
Definition: curses.h:155
#define A_ATTRIBUTES
Definition: curses.h:146
Definition: sis900.h:208
#define ERR
Definition: curses.h:18
attr_t attrs
window attributes
Definition: curses.h:93

References A_ATTRIBUTES, _curses_window::attrs, COLOUR_PAIR, COLOUR_PAIRS, ERR, and OK.