MenuDescriptor Class Reference

#include <menu.h>

Inheritance diagram for MenuDescriptor:

[legend]

Collaboration diagram for MenuDescriptor:

[legend]

List of all members.

Public Member Functions
	MenuDescriptor (PrecisionMenu *parent)
virtual	~MenuDescriptor ()
void	init (const coord_def &min_coord, const coord_def &max_coord, const std::string &name)
virtual InputReturnValue	process_input (int key)
virtual void	render ()
virtual std::vector< MenuItem * >	get_selected_items ()
virtual MenuItem *	get_active_item ()
virtual bool	attach_item (MenuItem *item)
virtual void	set_active_item (int index)
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 MenuItem *	select_item_by_hotkey (int key)
virtual void	clear_selections ()
virtual void	allow_focus (bool toggle)
virtual bool	can_be_focused ()
Protected Member Functions
virtual void	_place_items ()
virtual MenuItem *	_find_item_by_mouse_coords (const coord_def &pos)
virtual MenuItem *	_find_item_by_direction (const MenuItem *start, MenuObject::Direction dir)
Protected Attributes
PrecisionMenu *	m_parent
MenuItem *	m_active_item
NoSelectTextItem	m_desc_item

---

Detailed Description

Base class for various descriptor and highlighter objects these should probably be attached last to the menu to be rendered last

---

Constructor & Destructor Documentation

MenuDescriptor::MenuDescriptor

(

PrecisionMenu *

parent

)

MenuDescriptor::~MenuDescriptor

(

)

[virtual]

---

Member Function Documentation

void MenuDescriptor::init	(	const coord_def &	min_coord,
		const coord_def &	max_coord,
		const std::string &	name
	)

Reimplemented from MenuObject.

Here is the call graph for this function:

MenuObject::InputReturnValue MenuDescriptor::process_input

(

int

key

)

[virtual]

Implements MenuObject.

void MenuDescriptor::render

(

)

[virtual]

Implements MenuObject.

Reimplemented in MenuTooltip.

Here is the call graph for this function:

std::vector< MenuItem * > MenuDescriptor::get_selected_items

(

)

[virtual]

Reimplemented from MenuObject.

virtual MenuItem* MenuDescriptor::get_active_item

(

)

[inline, virtual]

Implements MenuObject.

virtual bool MenuDescriptor::attach_item

(

MenuItem *

item

)

[inline, virtual]

Implements MenuObject.

virtual void MenuDescriptor::set_active_item

(

int

index

)

[inline, virtual]

Implements MenuObject.

virtual void MenuDescriptor::set_active_item

(

MenuItem *

item

)

[inline, virtual]

Implements MenuObject.

virtual void MenuDescriptor::activate_first_item

(

)

[inline, virtual]

Implements MenuObject.

virtual void MenuDescriptor::activate_last_item

(

)

[inline, virtual]

Implements MenuObject.

virtual bool MenuDescriptor::select_item

(

int

index

)

[inline, virtual]

Implements MenuObject.

virtual bool MenuDescriptor::select_item

(

MenuItem *

item

)

[inline, virtual]

Implements MenuObject.

virtual MenuItem* MenuDescriptor::select_item_by_hotkey

(

int

key

)

[inline, virtual]

Reimplemented from MenuObject.

virtual void MenuDescriptor::clear_selections

(

)

[inline, virtual]

Reimplemented from MenuObject.

virtual void MenuDescriptor::allow_focus

(

bool

toggle

)

[inline, virtual]

Reimplemented from MenuObject.

virtual bool MenuDescriptor::can_be_focused

(

)

[inline, virtual]

Reimplemented from MenuObject.

void MenuDescriptor::_place_items

(

)

[protected, virtual]

Implements MenuObject.

Reimplemented in MenuTooltip.

Here is the call graph for this function:

virtual MenuItem* MenuDescriptor::_find_item_by_mouse_coords

(

const coord_def &

pos

)

[inline, protected, virtual]

Reimplemented from MenuObject.

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

Implements MenuObject.

---

Member Data Documentation

PrecisionMenu* MenuDescriptor::m_parent [protected]

MenuItem* MenuDescriptor::m_active_item [protected]

NoSelectTextItem MenuDescriptor::m_desc_item [protected]

---

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

• menu.h
• menu.cc