A group of check boxes. More...

#include <checkboxgroup.h>

Collaboration diagram for YAPET::UI::CheckBoxGroup:

Public Member Functions
	CheckBoxGroup (std::string t, const std::vector< std::string > &it, uint16_t o, int x, int y, int w, int h) throw (UIException)
	Constructor.
int	focus () throw (UIException)
	Focus the widget.
int	getHeight () const
uint16_t	getOptions () const
void	refresh () throw (UIException)
void	resize (int sx, int sy, int w, int h) throw (UIException)
virtual	~CheckBoxGroup ()
Protected Member Functions
void	createWindow () throw (UIException)
Private Types
enum	{ BASE_HEIGHT = 2, BASE_WIDTH = 8, MAX_ITEMS = 15 }
Private Member Functions
void	addCheckBox (int pos) throw (UIException)
	CheckBoxGroup (const CheckBoxGroup &)
void	displayItems () throw (UIException)
int	ItemsUsableHeight () const
int	ItemsUsableWidth () const
int	lastItemPos () const
	Last position of visible item.
const CheckBoxGroup &	operator= (const CheckBoxGroup &)
void	setCheckMark (int pos) throw (UIException)
	Set/unset check mark.
void	setCheckMark (int pos, bool mark) throw (UIException)
	Set/unset check mark.
void	setCursor (int pos) throw (UIException)
Private Attributes
int	height
std::vector< std::string >	items
uint16_t	options
int	start_x
int	start_y
std::string	title
	Title of the group.
int	width
WINDOW *	window

Detailed Description

Displays a group of checkboxes, where each check boc can be individually checked or unchecked. It returns a bit mask representing the checked boxes set to 1 according to their positions on the screen for the caller to find out which check boxes are marked (First checkbox has first bit set (unset), second checkbox has second bit set unset ...).

KEY_UP, 'k', KEY_DOWN, 'j', KEY_TAB are selection movement keys. KEY_ESC, KEY_RESIZE will make it loose focus. KEY_ENTER, KEY_SPACE will mark/unmark check box.

A maximum of 16 check boxes are supported.

Definition at line 74 of file checkboxgroup.h.

Member Enumeration Documentation

anonymous enum [private]

Enumerator:

BASE_HEIGHT
BASE_WIDTH
MAX_ITEMS

Definition at line 76 of file checkboxgroup.h.

Constructor & Destructor Documentation

YAPET::UI::CheckBoxGroup::CheckBoxGroup ( const CheckBoxGroup & ) [inline, private]

Definition at line 107 of file checkboxgroup.h.

CheckBoxGroup::CheckBoxGroup	(	std::string	t,
		const std::vector< std::string > &	it,
		uint16_t	o,
		int	x,
		int	y,
		int	w,
		int	h
	)			throw (UIException)

Constructor.

Parameters:

	t	the title of the group
	it	the check box items
	o	uint16_t holding the selected checkboxes. May be 0.
	x	the x start position
	y	the y start position
	w	the width of the widget
	h	the height of the widget

Definition at line 123 of file checkboxgroup.cc.

CheckBoxGroup::~CheckBoxGroup ( ) [virtual]

Definition at line 146 of file checkboxgroup.cc.

References window.

Member Function Documentation

void CheckBoxGroup::addCheckBox ( int pos ) throw (UIException) [private]

Definition at line 55 of file checkboxgroup.cc.

Referenced by displayItems().

Here is the caller graph for this function:

void CheckBoxGroup::createWindow ( ) throw (UIException) [protected]

Definition at line 110 of file checkboxgroup.cc.

References YAPET::UI::CHECKBOXGROUP, height, YAPET::UI::Colors::setcolor(), start_x, start_y, width, and window.

Here is the call graph for this function:

void CheckBoxGroup::displayItems ( ) throw (UIException) [private]

Definition at line 94 of file checkboxgroup.cc.

References addCheckBox(), items, ItemsUsableWidth(), lastItemPos(), setCheckMark(), and window.

Referenced by refresh().

Here is the call graph for this function:

Here is the caller graph for this function:

int CheckBoxGroup::focus ( ) throw (UIException)

Focus the widget.

KEY_UP, 'k', KEY_DOWN, 'j', KEY_TAB are selection movement keys. KEY_ESC, KEY_RESIZE will make it loose focus. KEY_ENTER, KEY_SPACE will mark/unmark check box.