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)
	FILE_SECBOOT (PERMITTED)
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

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

getbkgd()

chtype getbkgd ( WINDOW *  win )

inline

Get the background rendition attributes for a window.

Parameters

*win	subject window

Return values

ch	chtype rendition representation

Definition at line 18 of file winattrs.c.

                                      {
        return win->attrs;
}

References _curses_window::attrs.

wattroff()

int wattroff	(	WINDOW *	win,
		int	attrs
	)

Turn off attributes in a window.

Parameters

win	subject window
attrs	attributes to enable

Return values

rc	return status code

Definition at line 29 of file winattrs.c.

                                        {
        win->attrs &= ~attrs;
        return OK;
}

References _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

win	subject window
attrs	attributes to enable

Return values

rc	return status code

Definition at line 41 of file winattrs.c.

                                       {
        win->attrs |= attrs;
        return OK;
}

References _curses_window::attrs, and OK.

Referenced by attron(), and wattr_on().

wattrset()

int wattrset	(	WINDOW *	win,
		int	attrs
	)

Set attributes in a window.

Parameters

win	subject window
attrs	attributes to enable

Return values

rc	return status code

Definition at line 53 of file winattrs.c.

                                        {
        win->attrs = ( attrs | ( win->attrs & A_COLOR ) );
        return OK;
}

References A_COLOR, _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

*win	window to obtain information from
*attrs	address in which to store attributes
*pair	address in which to store colour pair
*opts	undefined (for future implementation)

Return values

rc	return status cude

Definition at line 67 of file winattrs.c.

                                      {
        *attrs = win->attrs & A_ATTRIBUTES;
        *pair = PAIR_NUMBER ( win->attrs );
        return OK;
}

References A_ATTRIBUTES, _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

*win	subject window
attrs	attributes to toggle
*opts	undefined (for future implementation)

Return values

rc	return status code

Definition at line 82 of file winattrs.c.

                                      {
        wattroff( win, attrs );
        return OK;
}

References OK, and wattroff().

wattr_on()

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

Turn on attributes in a window.

Parameters

*win	subject window
attrs	attributes to toggle
*opts	undefined (for future implementation)

Return values

rc	return status code

Definition at line 96 of file winattrs.c.

                                     {
        wattron( win, attrs );
        return OK;
}

References 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

*win	subject window
attrs	attributes to set
cpair	colour pair to set
*opts	undefined (for future implementation)

Return values

rc	return status code

Definition at line 111 of file winattrs.c.

                                      {
        wattrset( win, attrs | COLOUR_PAIR ( cpair ) );
        return OK;
}

References 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

*win	subject window
colour_pair_number	colour pair integer
*opts	undefined (for future implementation)

Return values

rc	return status code

Definition at line 125 of file winattrs.c.

                                        {
        if ( ( unsigned short )colour_pair_number > COLOUR_PAIRS )
                return ERR;

        win->attrs = ( ( win->attrs & A_ATTRIBUTES ) |
                       COLOUR_PAIR ( colour_pair_number ) );
        return OK;
}

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