MenuScroller Class Reference

#include <menu.h>

Inheritance diagram for MenuScroller:

[legend]

Collaboration diagram for MenuScroller:

[legend]

List of all members.

Public Member Functions
	MenuScroller ()
virtual	~MenuScroller ()
virtual InputReturnValue	process_input (int key)
virtual void	render ()
virtual MenuItem *	get_active_item ()
virtual void	set_active_item (int ID)
virtual void	set_active_item (MenuItem *item)
virtual void	activate_first_item ()
virtual void	activate_last_item ()
virtual bool	select_item (int index)
virtual bool	select_item (MenuItem *item)
virtual bool	attach_item (MenuItem *item)
Protected Member Functions
virtual void	_place_items ()
virtual void	_set_active_item_by_index (int index)
virtual MenuItem *	_find_item_by_direction (int start_index, MenuObject::Direction dir)
virtual MenuItem *	_find_item_by_direction (const MenuItem *start, MenuObject::Direction dir)
Protected Attributes
int	m_topmost_visible
int	m_currently_active
int	m_items_shown

---

Detailed Description

Container that can hold any number of objects in a scroll list style. Only certain number of items are visible at the same time. Navigating the list works with ARROW_UP and ARROW_DOWN keys. Eventually it should also support scrollbars.

---

Constructor & Destructor Documentation

MenuScroller::MenuScroller

(

)

MenuScroller::~MenuScroller

(

)

[virtual]

---

Member Function Documentation

MenuObject::InputReturnValue MenuScroller::process_input

(

int

key

)

[virtual]

Implements MenuObject.

Here is the call graph for this function:

void MenuScroller::render

(

)

[virtual]

Implements MenuObject.

Here is the call graph for this function:

MenuItem * MenuScroller::get_active_item

(

)

[virtual]

Implements MenuObject.

void MenuScroller::set_active_item

(

int

ID

)

[virtual]

Implements MenuObject.

void MenuScroller::set_active_item

(

MenuItem *

item

)

[virtual]

Implements MenuObject.

Here is the call graph for this function:

void MenuScroller::activate_first_item

(

)

[virtual]

Implements MenuObject.

Here is the call graph for this function:

void MenuScroller::activate_last_item

(

)

[virtual]

Implements MenuObject.

Here is the call graph for this function:

bool MenuScroller::select_item

(

int

index

)

[virtual]

Implements MenuObject.

bool MenuScroller::select_item

(

MenuItem *

item

)

[virtual]

Implements MenuObject.

Here is the call graph for this function:

bool MenuScroller::attach_item

(

MenuItem *

item

)

[virtual]

Implements MenuObject.

Here is the call graph for this function:

void MenuScroller::_place_items

(

)

[protected, virtual]

Changes the bounds of the items that are to be visible preserves user set item heigth does not preserve width

we included our active one, ok!

Implements MenuObject.

void MenuScroller::_set_active_item_by_index

(

int

index

)

[protected, virtual]

MenuItem * MenuScroller::_find_item_by_direction	(	int	start_index,
		MenuObject::Direction	dir
	)			[protected, virtual]

virtual MenuItem* MenuScroller::_find_item_by_direction	(	const MenuItem *	start,
		MenuObject::Direction	dir
	)			[inline, protected, virtual]

Implements MenuObject.

---

Member Data Documentation

int MenuScroller::m_topmost_visible [protected]

int MenuScroller::m_currently_active [protected]

int MenuScroller::m_items_shown [protected]

---

The documentation for this class was generated from the following files:

• menu.h
• menu.cc