cursor.h File Reference

manipulation of the screens cursor More...

Go to the source code of this file.

Enumerations
enum	cursor_features { CURSOR_CAN_HIDE = (1 << 0) }
	cursor features More...
enum	cursor_mode { CURSOR_OVERWRITE =0, CURSOR_INSERT =1 }
	mode of cursor such as overwrite or insert More...

Functions
void	cursor_set_position (unsigned char const i_row, unsigned char const i_column)
	set cursor position More...
void	cursor_hide ()
	hide the cursor More...
void	cursor_underline ()
	sets the cursor shape to underline More...
void	cursor_block ()
	sets the cursor shape to a solid block More...
void	cursor_set_type (char const i_scan_start, char const i_scan_end)
	set the cursor type/shape More...
void	cursor_get_position (char *const o_scan_start, char *const o_scan_end, char *const o_row, char *const o_column)
	get cursor position and type/shape More...

Variables
unsigned int	_cursor_features
	global to hold the cursor features
enum cursor_mode	_cursor_mode
	global to hold the mode of the cursor

Detailed Description

manipulation of the screens cursor

Enumeration Type Documentation

cursor_features

enum cursor_features

cursor features

Enumerator
CURSOR_CAN_HIDE	cursor can be hidden

cursor_mode

enum cursor_mode

mode of cursor such as overwrite or insert

Enumerator
CURSOR_OVERWRITE	cursor is in overwrite mode
CURSOR_INSERT	cursor is in insert mode

Function Documentation

cursor_block()

void cursor_block

(

)

sets the cursor shape to a solid block

Returns

none

cursor_get_position()

void cursor_get_position	(	char *const	o_scan_start,
		char *const	o_scan_end,
		char *const	o_row,
		char *const	o_column
	)

get cursor position and type/shape

Parameters

[out]	o_scan_start	starting line of cursor
[out]	o_scan_end	ending line of cursor
[out]	o_row	row of current cursor position
[out]	o_column	column of current cursor position

Returns

none

cursor_hide()

void cursor_hide

(

)

hide the cursor

Returns

none

cursor_set_position()

void cursor_set_position	(	unsigned char const	i_row,
		unsigned char const	i_column
	)

set cursor position

Parameters

[in]	i_row	row position
[in]	i_column	column position

Returns

none

cursor_set_type()

void cursor_set_type	(	char const	i_scan_start,
		char const	i_scan_end
	)

set the cursor type/shape

Parameters

[in]	i_scan_start	starting line of cursor (0-7)
[in]	i_scan_end	ending line of cursor (0-7)

Returns

none

cursor_underline()

void cursor_underline

(

)

sets the cursor shape to underline

Returns

none