Allows a user to choose a menu item from a horizontal list. More...

#include <menubar.hpp>

Inheritance diagram for menubar:

Classes
struct	item
	convenience container to hold a menu item More...

Public Member Functions
	menubar (int const i_pos_x, int const i_pos_y, unsigned int const i_len_x, unsigned int const i_len_y)
	constructor More...

virtual	~menubar ()
	destructor More...

virtual void	draw () const
	draws the widget More...

enum event_response	event_key_default (enum scancodes const i_scan)
	default scan code event handler More...

virtual enum event_response	event_key (struct event_key const &i_event)
	handle key event More...

virtual enum event_response	event_mouse (struct event_mouse const &i_event)
	handle mouse event More...

void	set_menu (struct menuitembar const *i_menu)
	sets the menu More...

Public Member Functions inherited from widget
	widget (int const i_pos_x, int const i_pos_y, unsigned int const i_len_x, unsigned int const i_len_y)
	constructor More...

virtual	~widget ()
	destructor More...

virtual void	set_damage (unsigned int const i_damage=DAMAGE_NONE)
	set the damage bits More...

virtual bool	close (bool const i_shutting_down)
	called when widget is about to be destroyed More...

bool	contains (int const i_pos_x, int const i_pos_y) const
	test if point is contained within the widget More...

bool	contains (struct box const &i_box) const
	test if rectangular region is contained within the widget More...

virtual void	focus_enter ()
	called when the widget receives focus More...

virtual void	focus_leave ()
	called when the widget looses focus More...

void	get_box (struct box &o_box) const
	gets the rectangular region this widget occupies More...

bool	get_can_focus () const
	gets whether or not the widget can receive focus More...

bool	get_enabled () const
	gets whether or not the widget is enabled More...

bool	get_has_focus () const
	gets whether or not the widget has focus More...

group *const	get_parent () const
	gets the parent widget More...

void *	get_user_data () const
	gets user defined data pointer More...

bool	get_visible () const
	gets whether or not the widget is visible More...

int	get_pos_x () const
	gets the relative x position of the widget More...

int	get_pos_y () const
	gets the relative y position of the widget More...

unsigned int	get_len_x () const
	gets the horizontal length of the widget More...

unsigned int	get_len_y () const
	gets the vertical length of the widget More...

virtual void	move (int const i_pos_x, int const i_pos_y)
	move the widget to a new position More...

virtual void	resize (unsigned int const i_len_x, unsigned int const i_len_y)
	resize the widget More...

void	set_can_close (bool const i_can_close)
	set internal indicator if widget can be closed More...

void	set_disabled ()
	disable the widget More...

void	set_enabled ()
	enable the widget

void	set_hidden ()
	hide the widget More...

virtual void	set_parent (group *const i_parent)
	sets the parent group of the widget More...

void	set_user_data (void *io_user_data)
	sets the user defined data pointer More...

void	set_visible ()
	sets the widget as visible More...

void	translate_screen (int const o_pos_x, int const o_pos_y) const
	translate a widgets relative coordinates to screen coordinates More...

Protected Attributes
unsigned	m_selected

struct item *	m_item

size_t	m_item_count

Protected Attributes inherited from widget
unsigned int	m_damage

unsigned int	m_flags

struct box	m_box

group *	m_parent

void *	m_user_data

Private Member Functions
	menubar (const menubar &)

menubar &	operator= (menubar const &)

void	draw_item (struct item const &i_item) const
	draw a menu item to the display More...

void	popup (struct item &i_item)

Additional Inherited Members
Public Types inherited from widget
enum	damage { DAMAGE_NONE = 0, DAMAGE_ALL = (1<<0), DAMAGE_LABEL = (1<<1), DAMAGE_VALUE = (1<<2), DAMAGE_SCROLL = (1<<3), DAMAGE_MOVED = (1<<4), DAMAGE_RESERVED1 = (1<<5), DAMAGE_RESERVED2 = (1<<6), DAMAGE_RESERVED3 = (1<<7) }
	bit mask indicating what needs to be redrawn More...

Protected Types inherited from widget
enum	flags { VISIBLE = (1 << 0), ENABLED = (1 << 1), CAN_FOCUS = (1 << 2), HAS_FOCUS = (1 << 3), CAN_CLOSE = (1 << 4) }

Detailed Description

Allows a user to choose a menu item from a horizontal list.

Constructor & Destructor Documentation

◆ menubar()

menubar::menubar	(	int const	i_pos_x,
		int const	i_pos_y,
		unsigned int const	i_len_x,
		unsigned int const	i_len_y
	)

constructor

Parameters

[in]	i_pos_x	x position to place widget
[in]	i_pos_y	y position to place widget
[in]	i_len_x	x length of widget
[in]	i_len_y	y length of widget

Returns: none

◆ ~menubar()

menubar::~menubar ( )

virtual

destructor

Returns: none

Member Function Documentation

◆ draw()

void menubar::draw ( ) const

virtual

draws the widget

This method should not be called directly.

See also: widget::draw for details.

Implements widget.

◆ draw_item()

void menubar::draw_item ( struct item const & i_item ) const

private

draw a menu item to the display

Returns: none

◆ event_key()

enum event_response menubar::event_key ( struct event_key const & i_event )

virtual

handle key event

Parameters

[in] i_event key event to handle

Returns: response how event was handled

Reimplemented from widget.

◆ event_key_default()

enum event_response menubar::event_key_default ( enum scancodes const i_scan )

virtual

default scan code event handler

Parameters

[in] i_scan scan code to handle

Returns: response how event was handled

This routine will scan the menubar in order, for accelerator keys. The first one encountered will get activated (either a menu is popped up or the signal is emitted).

Reimplemented from widget.

◆ event_mouse()

enum event_response menubar::event_mouse ( struct event_mouse const & i_event )

virtual

handle mouse event

Parameters

[in] i_event mouse event to handle

Returns: response how event was handled

Reimplemented from widget.

◆ set_menu()

void menubar::set_menu ( struct menuitembar const * i_menu )

sets the menu

Parameters

[in] i_menu reference to menu items

i_menu must be a valid reference to a menu data structure. This widget does not make a local copy. So, the life time of the object should survive the menu widget.

Member Data Documentation

◆ m_item

menubar::m_item

protected

array of menu items

◆ m_item_count

menubar::m_item_count

protected

number of elements in array

◆ m_selected

menubar::m_selected

protected

index of selected item

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

menubar.hpp
menubar.dox
menubar.cpp

Classes

Public Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ menubar()

◆ ~menubar()

Member Function Documentation

◆ draw()

◆ draw_item()

◆ event_key()

◆ event_key_default()

◆ event_mouse()

◆ set_menu()

Member Data Documentation

◆ m_item

◆ m_item_count

◆ m_selected