windows.c File Reference

MuCurses windows instance functions. More...

#include <curses.h>
#include <stddef.h>
#include <stdlib.h>
#include "mucurses.h"

Go to the source code of this file.

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
int	delwin (WINDOW *win)
	Delete a window.
WINDOW *	derwin (WINDOW *parent, int nlines, int ncols, int begin_y, int begin_x)
	Create a new derived window.
WINDOW *	dupwin (WINDOW *orig)
	Create a duplicate of the specified window.
int	mvwin (WINDOW *win, int y, int x)
	Move window origin to specified coordinates.
WINDOW *	newwin (int nlines, int ncols, int begin_y, int begin_x)
	Create new WINDOW.
WINDOW *	subwin (WINDOW *parent, int nlines, int ncols, int begin_y, int begin_x)
	Create a new sub-window.

Detailed Description

MuCurses windows instance functions.

Definition in file windows.c.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

delwin()

int delwin

(

WINDOW *

win

)

Delete a window.

Parameters

*win	pointer to window being deleted

Return values

rc	return status code

Definition at line 20 of file windows.c.

                           {
        /* I think we should blank the region covered by the window -
           ncurses doesn't do this, but they have a buffer, so they
           may just be deleting from an offscreen context whereas we
           are guaranteed to be deleting something onscreen */
        wmove( win, 0, 0 );
        chtype killch = (chtype)' ';
        do {
                _wputch( win, killch, WRAP );
        } while ( win->curs_x + win->curs_y );
 
        free( win );
 
        wmove ( stdscr, 0, 0 );
 
        return OK;
}

References _wputch(), _curses_window::curs_x, _curses_window::curs_y, free, OK, stdscr, wmove(), and WRAP.

derwin()

WINDOW * derwin	(	WINDOW *	parent,
		int	nlines,
		int	ncols,
		int	begin_y,
		int	begin_x )

Create a new derived window.

Parameters

parent	parent window
nlines	window height
ncols	window width
begin_y	window y origin (relative to parent)
begin_x	window x origin (relative to parent)

Return values

ptr	return pointer to child window

Definition at line 48 of file windows.c.

                                                            {
        WINDOW *child;
        if ( ( (unsigned)ncols > parent->width ) || 
             ( (unsigned)nlines > parent->height ) )
                return NULL;
        if ( ( child = malloc( sizeof( WINDOW ) ) ) == NULL )
                return NULL;
        child->ori_y = parent->ori_y + begin_y;
        child->ori_x = parent->ori_x + begin_x;
        child->height = nlines;
        child->width = ncols;
        child->parent = parent;
        child->scr = parent->scr;
        return child;
}

References _curses_window::height, malloc(), NULL, _curses_window::ori_x, _curses_window::ori_y, _curses_window::parent, _curses_window::scr, and _curses_window::width.

dupwin()

WINDOW * dupwin

(

WINDOW *

orig

)

Create a duplicate of the specified window.

Parameters

orig	original window

Return values

ptr	pointer to duplicate window

Definition at line 71 of file windows.c.

                                {
        WINDOW *copy;
        if ( ( copy = malloc( sizeof( WINDOW ) ) ) == NULL )
                return NULL;
        copy->scr = orig->scr;
        copy->attrs = orig->attrs;
        copy->ori_y = orig->ori_y;
        copy->ori_x = orig->ori_x;
        copy->curs_y = orig->curs_y;
        copy->curs_x = orig->curs_x;
        copy->height = orig->height;
        copy->width = orig->width;
        return copy;
}

References _curses_window::attrs, _curses_window::curs_x, _curses_window::curs_y, _curses_window::height, malloc(), NULL, _curses_window::ori_x, _curses_window::ori_y, _curses_window::scr, and _curses_window::width.

mvwin()

int mvwin	(	WINDOW *	win,
		int	y,
		int	x )

Move window origin to specified coordinates.

Parameters

*win	window to move
y	Y position
x	X position

Return values

rc	return status code

Definition at line 94 of file windows.c.

                                        {
        if ( ( ( (unsigned)y + win->height ) > LINES ) ||
             ( ( (unsigned)x + win->width ) > COLS ) )
                return ERR;
 
        win->ori_y = y;
        win->ori_x = x;
 
        return OK;
}

References COLS, ERR, _curses_window::height, LINES, OK, _curses_window::ori_x, _curses_window::ori_y, _curses_window::width, x, and y.

newwin()

WINDOW * newwin	(	int	nlines,
		int	ncols,
		int	begin_y,
		int	begin_x )

Create new WINDOW.

Parameters

nlines	number of lines
ncols	number of columns
begin_y	column origin
begin_x	line origin

Return values

*win	return pointer to new window

Definition at line 114 of file windows.c.

                                                                   {
        WINDOW *win;
        if ( ( (unsigned)( begin_y + nlines ) > stdscr->height ) &&
             ( (unsigned)( begin_x + ncols ) > stdscr->width ) )
                return NULL;
        if ( ( win = malloc( sizeof(WINDOW) ) ) == NULL )
                return NULL;
        win->ori_y = begin_y;
        win->ori_x = begin_x;
        win->height = nlines;
        win->width = ncols;
        win->scr = stdscr->scr;
        win->parent = stdscr;
        return win;
}

References _curses_window::height, malloc(), NULL, _curses_window::ori_x, _curses_window::ori_y, _curses_window::parent, _curses_window::scr, stdscr, and _curses_window::width.

Referenced by subwin().

subwin()

WINDOW * subwin	(	WINDOW *	parent,
		int	nlines,
		int	ncols,
		int	begin_y,
		int	begin_x )

Create a new sub-window.

Parameters

orig	parent window
nlines	window height
ncols	window width
begin_y	window y origin (absolute)
begin_x	window x origin (absolute)

Return values

ptr	return pointer to child window

Definition at line 140 of file windows.c.

                                                            {
        WINDOW *child;
        child = newwin( nlines, ncols, begin_y, begin_x );
        child->parent = parent;
        child->scr = parent->scr;
        return child;
}

References newwin(), _curses_window::parent, and _curses_window::scr.