clear.c File Reference

MuCurses clearing functions. More...

#include <curses.h>
#include "mucurses.h"
#include "cursor.h"

Go to the source code of this file.

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
int	wclrtobot (WINDOW *win)
	Clear a window to the bottom from current cursor position. More...
int	wclrtoeol (WINDOW *win)
	Clear a window to the end of the current line. More...
int	wdelch (WINDOW *win)
	Delete character under the cursor in a window. More...
int	wdeleteln (WINDOW *win)
	Delete line under a window's cursor. More...
int	werase (WINDOW *win)
	Completely clear a window. More...
int	erase (void)
	Completely clear the screen. More...

Detailed Description

MuCurses clearing functions.

Definition in file clear.c.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

wclrtobot()

int wclrtobot

(

WINDOW *

win

)

Clear a window to the bottom from current cursor position.

Parameters

*win	subject window

Return values

rc	return status code

Definition at line 19 of file clear.c.

                              {
        struct cursor_pos pos;

        _store_curs_pos( win, &pos );
        do {
                _wputc( win, ' ', WRAP );
        } while ( win->curs_y + win->curs_x );
        _restore_curs_pos( win, &pos );

        return OK;
}

References _restore_curs_pos(), _store_curs_pos(), _wputc(), _curses_window::curs_x, _curses_window::curs_y, OK, and WRAP.

Referenced by clrtobot(), and werase().

wclrtoeol()

int wclrtoeol

(

WINDOW *

win

)

Clear a window to the end of the current line.

Parameters

*win	subject window

Return values

rc	return status code

Definition at line 37 of file clear.c.

                              {
        struct cursor_pos pos;

        _store_curs_pos( win, &pos );
        while ( ( win->curs_y - pos.y ) == 0 ) {
                _wputc( win, ' ', WRAP );
        }
        _restore_curs_pos( win, &pos );

        return OK;
}

References _restore_curs_pos(), _store_curs_pos(), _wputc(), _curses_window::curs_y, OK, WRAP, and cursor_pos::y.

Referenced by clrtoeol(), slk_clear(), and wdeleteln().

wdelch()

int wdelch

(

WINDOW *

win

)

Delete character under the cursor in a window.

Parameters

*win	subject window

Return values

rc	return status code

Definition at line 55 of file clear.c.

                           {
        _wputc( win, ' ', NOWRAP );
        _wcursback( win );

        return OK;
}

References _wcursback(), _wputc(), NOWRAP, and OK.

Referenced by delch(), mvdelch(), mvwdelch(), wgetch(), and wgetnstr().

wdeleteln()

int wdeleteln

(

WINDOW *

win

)

Delete line under a window's cursor.

Parameters

*win	subject window

Return values

rc	return status code

Definition at line 68 of file clear.c.

                              {
        struct cursor_pos pos;

        _store_curs_pos( win, &pos );
        /* let's just set the cursor to the beginning of the line and
           let wclrtoeol do the work :) */
        wmove( win, win->curs_y, 0 );
        wclrtoeol( win );
        _restore_curs_pos( win, &pos );
        return OK;
}

References _restore_curs_pos(), _store_curs_pos(), _curses_window::curs_y, OK, wclrtoeol(), and wmove().

Referenced by deleteln().

werase()

int werase

(

WINDOW *

win

)

Completely clear a window.

Parameters

*win	subject window

Return values

rc	return status code

Definition at line 86 of file clear.c.

                           {
        wmove( win, 0, 0 );
        wclrtobot( win );
        return OK;
}

References OK, wclrtobot(), and wmove().

erase()

int erase

(

void

)

Completely clear the screen.

Return values

rc	return status code

Definition at line 97 of file clear.c.

                   {
        stdscr->scr->erase( stdscr->scr, stdscr->attrs );
        return OK;
}

References OK, and stdscr.

Referenced by draw_form(), settings_ui(), and show_menu().