#include <menu.hpp>

Inheritance diagram for gui::menu:

Classes
class	basic_sorter

class	imgsel_style

struct	item

class	sorter

class	style

Public Types
enum	ROW_TYPE { NORMAL_ROW, SELECTED_ROW, HEADING_ROW }

Public Member Functions
	menu (CVideo &video, const std::vector< std::string > &items, bool click_selects=false, int max_height=-1, int max_width=-1, const sorter sorter_obj=nullptr, style menu_style=nullptr, const bool auto_join=true)

	~menu ()
	Default implementation, but defined out-of-line for efficiency reasons. More...

int	selection () const

void	move_selection (size_t id)

void	move_selection_keeping_viewport (size_t id)

void	reset_selection ()

const item &	get_item (int index) const

const item &	get_selected_item () const

void	change_item (int pos1, int pos2, const std::string &str)

virtual void	erase_item (size_t index)

void	set_heading (const std::vector< std::string > &heading)

virtual void	set_items (const std::vector< std::string > &items, bool strip_spaces=true, bool keep_viewport=false)
	Set new items to show and redraw/recalculate everything. More...

void	set_max_height (const int new_max_height)
	Set a new max height for this menu. More...

void	set_max_width (const int new_max_width)

int	get_max_height ()

int	get_max_width ()

size_t	number_of_items () const

int	process ()

bool	double_clicked ()

void	set_click_selects (bool value)

void	set_numeric_keypress_selection (bool value)

void	scroll (unsigned int pos)

void	set_sorter (sorter *s)

void	sort_by (int column)

int	get_sort_by ()

bool	get_sort_reversed ()

Public Member Functions inherited from gui::scrollarea
	scrollarea (CVideo &video, bool auto_join=true)
	Create a zone with automatic handling of scrollbar. More...

virtual void	hide (bool value=true)

Public Member Functions inherited from gui::widget
SDL_Rect const &	location () const

virtual void	set_location (SDL_Rect const &rect)

void	set_location (int x, int y)

void	set_width (int w)

void	set_height (int h)

void	set_measurements (int w, int h)

int	width () const

int	height () const

bool	focus (const SDL_Event *event)

void	set_focus (bool focus)

bool	hidden () const

virtual void	enable (bool new_val=true)

bool	enabled () const

void	set_clip_rect (const SDL_Rect &rect)

void	set_volatile (bool val=true)

void	set_dirty (bool dirty=true)

bool	dirty () const

const std::string &	id () const

void	set_id (const std::string &id)

void	set_help_string (const std::string &str)

void	set_tooltip_string (const std::string &str)

virtual void	process_tooltip_string (int mousex, int mousey)

Public Member Functions inherited from events::sdl_handler
virtual void	join ()

virtual void	join (context &c)

virtual void	join_same (sdl_handler *parent)

virtual void	leave ()

virtual void	join_global ()

virtual void	leave_global ()

Static Public Attributes
static style &	default_style = menu::bluebg_style

static style	simple_style

static imgsel_style	bluebg_style

Protected Member Functions
bool	item_ends_with_image (const std::string &item) const

virtual void	handle_event (const SDL_Event &event)

void	set_inner_location (const SDL_Rect &rect)

bool	requires_event_focus (const SDL_Event *event=nullptr) const

const std::vector< int > &	column_widths () const

virtual void	draw_row (const size_t row_index, const SDL_Rect &rect, ROW_TYPE type)

int	hit (int x, int y) const

std::pair< int, int >	hit_cell (int x, int y) const

int	hit_column (int x) const

int	hit_heading (int x, int y) const

void	invalidate_row (size_t id)

void	invalidate_row_pos (size_t pos)

void	invalidate_heading ()

Protected Member Functions inherited from gui::scrollarea
virtual sdl_handler_vector	handler_members ()

virtual void	update_location (SDL_Rect const &rect)

virtual void	process_event ()

SDL_Rect	inner_location () const

unsigned	scrollbar_width () const

unsigned	get_position () const

unsigned	get_max_position () const

void	set_position (unsigned pos)

void	adjust_position (unsigned pos)

void	move_position (int dep)

void	set_shown_size (unsigned h)

void	set_full_size (unsigned h)

void	set_scroll_rate (unsigned r)

bool	has_scrollbar () const

Protected Member Functions inherited from gui::widget
	widget (widget const &o)

	widget (CVideo &video, const bool auto_join=true)

virtual	~widget ()

void	bg_register (SDL_Rect const &rect)

void	bg_restore () const

void	bg_restore (SDL_Rect const &rect) const

void	bg_update ()

void	bg_cancel ()

CVideo &	video () const

const SDL_Rect *	clip_rect () const

virtual sdl_handler_vector	member_handlers ()

virtual void	handle_window_event (SDL_Event const &event)

bool	mouse_locked () const

void	aquire_mouse_lock ()

void	free_mouse_lock ()

Protected Member Functions inherited from events::sdl_handler
	sdl_handler (const bool auto_join=true)

virtual	~sdl_handler ()

Protected Attributes
style *	style_

bool	silent_

Protected Attributes inherited from gui::widget
bool	focus_

Private Types
enum	SELECTION_MOVE_VIEWPORT { MOVE_VIEWPORT, NO_MOVE_VIEWPORT }

Private Member Functions
size_t	max_items_onscreen () const

size_t	heading_height () const

void	adjust_viewport_to_selection ()

void	key_press (SDLKey key)

void	create_help_strings ()

void	process_help_string (int mousex, int mousey)

void	column_widths_item (const std::vector< std::string > &row, std::vector< int > &widths) const

void	clear_item (int item)

void	draw_contents ()

void	draw ()

SDL_Rect	get_item_rect (int item) const

SDL_Rect	get_item_rect_internal (size_t pos) const

size_t	get_item_height_internal (const std::vector< std::string > &item) const

size_t	get_item_height (int item) const

int	items_start () const

int	items_end () const

int	items_height () const

void	update_scrollbar_grip_height ()

void	fill_items (const std::vector< std::string > &items, bool strip_spaces)
	Set new items to show. More...

void	do_sort ()

void	recalculate_pos ()

void	assert_pos ()

void	update_size ()

void	set_selection_pos (size_t pos, bool silent=false, SELECTION_MOVE_VIEWPORT move_viewport=MOVE_VIEWPORT)

void	move_selection_to (size_t id, bool silent=false, SELECTION_MOVE_VIEWPORT move_viewport=MOVE_VIEWPORT)

void	move_selection_up (size_t dep)

void	move_selection_down (size_t dep)

Private Attributes
int	max_height_

int	max_width_

int	max_items_

int	item_height_

std::vector< item >	items_

std::vector< size_t >	item_pos_

std::vector< std::string >	heading_

int	heading_height_

std::pair< int, int >	cur_help_

int	help_string_

std::vector< int >	column_widths_

size_t	selected_

bool	click_selects_

bool	out_

bool	previous_button_

bool	show_result_

bool	double_clicked_

std::map< int, SDL_Rect >	itemRects_

bool	num_selects_
	variable which determines whether a numeric keypress should select an item on the dialog More...

bool	ignore_next_doubleclick_

bool	last_was_doubleclick_

bool	use_ellipsis_

const sorter *	sorter_

int	sortby_

bool	sortreversed_

int	highlight_heading_

std::set< int >	invalid_

Friends
class	style

class	imgsel_style

Detailed Description

Definition at line 28 of file menu.hpp.

Member Enumeration Documentation

enum gui::menu::ROW_TYPE

Enumerator
NORMAL_ROW
SELECTED_ROW
HEADING_ROW

Definition at line 32 of file menu.hpp.

enum gui::menu::SELECTION_MOVE_VIEWPORT

private

Enumerator
MOVE_VIEWPORT
NO_MOVE_VIEWPORT

Definition at line 326 of file menu.hpp.

Constructor & Destructor Documentation

gui::menu::menu	(	CVideo &	video,
		const std::vector< std::string > &	items,
		bool	click_selects = `false`,
		int	max_height = `-1`,
		int	max_width = `-1`,
		const sorter *	sorter_obj = `nullptr`,
		style *	menu_style = `nullptr`,
		const bool	auto_join = `true`
	)

Definition at line 195 of file menu.cpp.

References default_style, fill_items(), gui::menu::style::init(), and style_.

gui::menu::~menu ( )

Default implementation, but defined out-of-line for efficiency reasons.

Definition at line 216 of file menu.cpp.

Member Function Documentation

void gui::menu::adjust_viewport_to_selection ( )

private

Definition at line 519 of file menu.cpp.

References gui::scrollarea::adjust_position(), click_selects_, and selected_.

Referenced by erase_item(), set_items(), and set_selection_pos().

void gui::menu::assert_pos ( )

private

Definition at line 307 of file menu.cpp.

References item_pos_, and items_.

Referenced by erase_item(), and recalculate_pos().

void gui::menu::change_item	(	int	pos1,
		int	pos2,
		const std::string &	str
	)

Definition at line 395 of file menu.cpp.

References item_pos_, items_, and gui::widget::set_dirty().

void gui::menu::clear_item ( int item )

private

Definition at line 931 of file menu.cpp.

References gui::widget::bg_restore(), and get_item_rect().

Referenced by erase_item().

const std::vector< int > & gui::menu::column_widths ( ) const

protected

Definition at line 919 of file menu.cpp.

References column_widths_, column_widths_item(), heading_, and items_.

Referenced by draw_row(), hit_column(), and update_size().

void gui::menu::column_widths_item	(	const std::vector< std::string > &	row,
		std::vector< int > &	widths
	)		const

private

Definition at line 898 of file menu.cpp.

References gui::menu::style::get_cell_padding(), item_ends_with_image(), gui::menu::style::item_size(), and style_.

Referenced by column_widths().

void gui::menu::create_help_strings ( )

private

Definition at line 316 of file menu.cpp.

References gui2::event::find(), HELP_STRING_SEPARATOR, i, mp_ui_alerts::items, items_, and utils::split().

Referenced by fill_items().

void gui::menu::do_sort ( )

private

Definition at line 277 of file menu.cpp.

References gui::menu::sorter::column_sortable(), item_pos_, items_, move_selection_to(), NO_MOVE_VIEWPORT, recalculate_pos(), selection(), gui::widget::set_dirty(), sortby_, sorter_, and sortreversed_.

Referenced by fill_items(), and sort_by().

bool gui::menu::double_clicked ( )

Definition at line 749 of file menu.cpp.

References double_clicked_.

Referenced by mp::ui::handle_event(), gui::dialog::process(), and mp::create::process_event().

void gui::menu::draw ( )

privatevirtual

Reimplemented from gui::widget.

Definition at line 1116 of file menu.cpp.

References gui::widget::bg_restore(), gui::widget::clip_rect(), gui::widget::dirty(), draw_contents(), gui::menu::style::draw_row(), get_item_rect(), heading_height(), HEADING_ROW, gui::widget::hidden(), i, gui::scrollarea::inner_location(), invalid_, item_pos_, gui::widget::location(), NORMAL_ROW, out_, pos, selected_, SELECTED_ROW, gui::widget::set_dirty(), style_, update_rect(), and gui::widget::video().

void gui::menu::draw_contents ( )

privatevirtual

Reimplemented from gui::widget.

Definition at line 1104 of file menu.cpp.

References gui::menu::style::draw_row(), get_item_rect(), heading_height(), HEADING_ROW, i, gui::scrollarea::inner_location(), item_pos_, NORMAL_ROW, out_, selected_, SELECTED_ROW, and style_.

Referenced by draw().

void gui::menu::draw_row	(	const size_t	row_index,
		const SDL_Rect &	rect,
		ROW_TYPE	type
	)

protectedvirtual

Reimplemented in mp::gamebrowser, and gui::multimenu.

Definition at line 939 of file menu.cpp.

References column_widths(), sdl::create_rect(), current_language_rtl(), sdl::draw_solid_tinted_rectangle(), sdl::fill_rect(), gui::menu::style::get_font_size(), gui::menu::style::get_item_image(), gui::menu::style::get_thickness(), heading_, HEADING_ROW, highlight_heading_, i, IMAGE_PREFIX, IMG_TEXT_SEPARATOR, gui::scrollarea::inner_location(), items_, font::make_text_ellipsis(), max_width_, font::NORMAL_COLOR, font::parse_markup(), pos, utils::REMOVE_EMPTY, screen_area(), sortby_, sortreversed_, utils::split(), style_, font::text_area(), use_ellipsis_, and gui::widget::video().

Referenced by gui::menu::style::draw_row(), and gui::multimenu::draw_row().

void gui::menu::erase_item ( size_t index )

virtual

Reimplemented in gui::multimenu.

Definition at line 406 of file menu.cpp.

References adjust_viewport_to_selection(), assert_pos(), clear_item(), i, item_pos_, itemRects_, items_, pos, selected_, gui::widget::set_dirty(), and update_scrollbar_grip_height().

Referenced by gui::dialog::action(), and gui::multimenu::erase_item().

void gui::menu::fill_items	(	const std::vector< std::string > &	items,
		bool	strip_spaces
	)

private

Set new items to show.

If strip_spaces is false, spaces will remain at the item edges.

Definition at line 220 of file menu.cpp.

References COLUMN_SEPARATOR, create_help_strings(), DEFAULT_ITEM, do_sort(), heading_, HEADING_PREFIX, gui::widget::id(), item_pos_, items_, itor, utils::quoted_split(), selected_, sortby_, and update_size().

Referenced by menu(), and set_items().

const menu::item & gui::menu::get_item ( int index ) const

Definition at line 385 of file menu.cpp.

References items_.

size_t gui::menu::get_item_height ( int item ) const

private

Definition at line 1279 of file menu.cpp.

References get_item_height_internal(), item_height_, and items_.

Referenced by get_item_rect_internal(), and max_items_onscreen().

size_t gui::menu::get_item_height_internal ( const std::vector< std::string > & item ) const

private

Definition at line 1259 of file menu.cpp.

References i, gui::menu::style::item_size(), and style_.

Referenced by get_item_height(), and heading_height().

SDL_Rect gui::menu::get_item_rect ( int item ) const

private

Definition at line 1210 of file menu.cpp.

References get_item_rect_internal(), and item_pos_.

Referenced by clear_item(), draw(), draw_contents(), hit(), and update_size().

SDL_Rect gui::menu::get_item_rect_internal ( size_t pos ) const

private

Definition at line 1215 of file menu.cpp.

References sdl::create_rect(), sdl::empty_rect, get_item_height(), gui::scrollarea::get_position(), heading_height(), i, gui::scrollarea::inner_location(), itemRects_, max_items_onscreen(), prev, and screen_area().

Referenced by get_item_rect().

int gui::menu::get_max_height ( )

inline

Definition at line 202 of file menu.hpp.

References max_height_.

int gui::menu::get_max_width ( )

inline

Definition at line 203 of file menu.hpp.

References max_width_.

Referenced by gui::file_menu::display_current_files().

const menu::item & gui::menu::get_selected_item ( ) const

Definition at line 390 of file menu.cpp.

References items_, and selection().

int gui::menu::get_sort_by ( )

inline

Definition at line 220 of file menu.hpp.

References sortby_.

bool gui::menu::get_sort_reversed ( )

inline

Definition at line 221 of file menu.hpp.

References sortreversed_.

void gui::menu::handle_event ( const SDL_Event & event )

protectedvirtual

Reimplemented from gui::scrollarea.

Reimplemented in mp::gamebrowser, gui::multimenu, and gui::file_menu.

Definition at line 654 of file menu.cpp.

References game_config::sounds::button_press, click_selects_, gui::menu::sorter::column_sortable(), DOUBLE_CLICK_EVENT, double_clicked_, gui::widget::focus(), gui::scrollarea::handle_event(), gui::widget::height(), gui::widget::hidden(), highlight_heading_, hit(), hit_heading(), ignore_next_doubleclick_, invalidate_heading(), invalidate_row_pos(), key_press(), last_was_doubleclick_, gui::widget::mouse_locked(), move_selection_to(), out_, sound::play_UI_sound(), SDL_EVENTMASK, selected_, gui::widget::set_focus(), show_result_, silent_, sort_by(), and sorter_.

Referenced by gui::file_menu::handle_event(), and gui::multimenu::handle_event().

size_t gui::menu::heading_height ( ) const

private

Definition at line 1270 of file menu.cpp.

References get_item_height_internal(), heading_, heading_height_, int(), and max_height_.

Referenced by draw(), draw_contents(), get_item_rect_internal(), hit_heading(), max_items_onscreen(), and update_size().

int gui::menu::hit	(	int	x,
		int	y
	)		const

protected

Definition at line 1158 of file menu.cpp.

References get_item_rect(), i, gui::scrollarea::inner_location(), and items_.

Referenced by handle_event(), hit_cell(), gui::multimenu::hit_checkbox(), and process_help_string().

std::pair< int, int > gui::menu::hit_cell	(	int	x,
		int	y
	)		const

protected

Definition at line 1184 of file menu.cpp.

References hit(), and hit_column().

int gui::menu::hit_column ( int x ) const

protected

Definition at line 1172 of file menu.cpp.

References column_widths(), and gui::widget::location().

Referenced by hit_cell(), hit_heading(), and process_help_string().

int gui::menu::hit_heading	(	int	x,
		int	y
	)		const

protected

Definition at line 1199 of file menu.cpp.

References heading_height(), hit_column(), and gui::scrollarea::inner_location().

Referenced by handle_event().

void gui::menu::invalidate_heading ( )

protected

Definition at line 1340 of file menu.cpp.

References invalid_.

Referenced by handle_event().

void gui::menu::invalidate_row ( size_t id )

protected

Definition at line 1322 of file menu.cpp.

References invalid_, and items_.

Referenced by invalidate_row_pos().

void gui::menu::invalidate_row_pos ( size_t pos )

protected

Definition at line 1331 of file menu.cpp.

References invalidate_row(), and items_.

Referenced by gui::multimenu::handle_event(), handle_event(), gui::multimenu::set_active(), and set_selection_pos().

bool gui::menu::item_ends_with_image ( const std::string & item ) const

protected

Definition at line 912 of file menu.cpp.

References IMAGE_PREFIX, IMG_TEXT_SEPARATOR, and pos.

Referenced by column_widths_item().

int gui::menu::items_end ( ) const

private

int gui::menu::items_height ( ) const

private

int gui::menu::items_start ( ) const

private

void gui::menu::key_press ( SDLKey key )

private

Definition at line 587 of file menu.cpp.

References click_selects_, items_, max_items_onscreen(), move_selection_down(), move_selection_up(), num_selects_, and set_selection_pos().

Referenced by handle_event().

size_t gui::menu::max_items_onscreen ( ) const

private

Definition at line 493 of file menu.cpp.

References get_item_height(), CVideo::gety(), heading_height(), items_, max_height_, max_items_, sort(), and gui::widget::video().

Referenced by get_item_rect_internal(), key_press(), update_scrollbar_grip_height(), and update_size().

void gui::menu::move_selection ( size_t id )

Definition at line 567 of file menu.cpp.

References item_pos_, MOVE_VIEWPORT, and set_selection_pos().

Referenced by mp::create::create(), mp::create::init_level_type_changed(), mp::create::layout_children(), gui::file_menu::select_file(), mp::ui::set_selected_game(), and mp::create::synchronize_selections().

void gui::menu::move_selection_down ( size_t dep )

private

Definition at line 552 of file menu.cpp.

References items_, selected_, and set_selection_pos().

Referenced by key_press().

void gui::menu::move_selection_keeping_viewport ( size_t id )

Definition at line 575 of file menu.cpp.

References item_pos_, NO_MOVE_VIEWPORT, and set_selection_pos().

Referenced by mp::ui::set_user_menu_items().

void gui::menu::move_selection_to	(	size_t	id,
		bool	silent = `false`,
		SELECTION_MOVE_VIEWPORT	move_viewport = `MOVE_VIEWPORT`
	)

private

Definition at line 559 of file menu.cpp.

References item_pos_, and set_selection_pos().

Referenced by do_sort(), and handle_event().

void gui::menu::move_selection_up ( size_t dep )

private

Definition at line 547 of file menu.cpp.

References selected_, and set_selection_pos().

Referenced by key_press().

size_t gui::menu::number_of_items ( ) const

inline

Definition at line 205 of file menu.hpp.

References items_.

Referenced by mp::create::layout_children(), and mp::create::update_mod_menu().

int gui::menu::process ( )

Definition at line 739 of file menu.cpp.

References selected_, and show_result_.

Referenced by gui::dialog::process().

void gui::menu::process_help_string	(	int	mousex,
		int	mousey
	)

privatevirtual

Reimplemented from gui::widget.

Definition at line 1292 of file menu.cpp.

References CVideo::clear_help_string(), cur_help_, help_string_, gui::widget::hidden(), hit(), hit_column(), item_pos_, items_, CVideo::set_help_string(), and gui::widget::video().

void gui::menu::recalculate_pos ( )

private

Definition at line 298 of file menu.cpp.

References assert_pos(), i, item_pos_, and items_.

Referenced by do_sort().

bool gui::menu::requires_event_focus ( const SDL_Event * event = nullptr ) const

protectedvirtual

Reimplemented from events::sdl_handler.

Definition at line 621 of file menu.cpp.

References click_selects_, gui::widget::focus_, gui::widget::height(), gui::widget::hidden(), num_selects_, and SDLKey.

void gui::menu::reset_selection ( )

Definition at line 582 of file menu.cpp.

References set_selection_pos().

void gui::menu::scroll ( unsigned int pos )

virtual

Implements gui::scrollarea.

Definition at line 766 of file menu.cpp.

References itemRects_, and gui::widget::set_dirty().

int gui::menu::selection ( ) const

Definition at line 369 of file menu.cpp.

References items_, and selected_.

Referenced by statistics_dialog::action(), gui::dialog_button::action(), gui::dialog::action(), mp::create::create(), do_sort(), get_selected_item(), gui::file_menu::handle_event(), mp::ui::handle_event(), mp::create::layout_children(), gui::dialog::process(), mp::create::process_event_impl(), gui::dialog::set_menu_items(), and gui::file_menu::type_a_head().

void gui::menu::set_click_selects ( bool value )

Definition at line 756 of file menu.cpp.

References click_selects_.

void gui::menu::set_heading ( const std::vector< std::string > & heading )

Definition at line 435 of file menu.cpp.

References column_widths_, heading_, itemRects_, max_items_, and gui::widget::set_dirty().

void gui::menu::set_inner_location ( const SDL_Rect & rect )

protectedvirtual

Implements gui::scrollarea.

Definition at line 378 of file menu.cpp.

References gui::widget::bg_register(), itemRects_, and update_scrollbar_grip_height().

void gui::menu::set_items	(	const std::vector< std::string > &	items,
		bool	strip_spaces = `true`,
		bool	keep_viewport = `false`
	)

virtual

Set new items to show and redraw/recalculate everything.

If strip_spaces is false, spaces will remain at the item edges. If keep_viewport is true, the menu tries to keep the selection at the same position as it were before the items were set.

Reimplemented in gui::multimenu.

Definition at line 446 of file menu.cpp.

References adjust_viewport_to_selection(), column_widths_, fill_items(), gui::scrollarea::get_max_position(), gui::scrollarea::get_position(), gui::scrollarea::has_scrollbar(), item_height_, item_pos_, itemRects_, items_, max_items_, selected_, gui::widget::set_dirty(), gui::scrollarea::set_position(), and update_scrollbar_grip_height().