The listbox class. More...

#include <listbox.hpp>

Inheritance diagram for gui2::listbox:

Classes
struct	sort_helper

Public Member Functions
	listbox (const implementation::builder_listbox_base &builder)
	Constructor. More...

grid &	add_row (const widget_item &item, const int index=-1)
	When an item in the list is selected by the user we need to update the state. More...

grid &	add_row (const widget_data &data, const int index=-1)
	Adds single row to the grid. More...

void	remove_row (const unsigned row, unsigned count=1)
	Removes a row in the listbox. More...

void	clear ()
	Removes all the rows in the listbox, clearing it. More...

unsigned	get_item_count () const
	Returns the number of items in the listbox. More...

void	set_row_active (const unsigned row, const bool active)
	Makes a row active or inactive. More...

void	set_row_shown (const unsigned row, const bool shown)
	Makes a row visible or invisible. More...

void	set_row_shown (const boost::dynamic_bitset<> &shown)
	Makes a row visible or invisible. More...

std::size_t	filter_rows_by (const std::function< bool(std::size_t)> &filter)
	Hides all rows for which the given predicate returns false. More...

boost::dynamic_bitset	get_rows_shown () const
	Returns a list of visible rows. More...

const grid *	get_row_grid (const unsigned row) const
	Returns the grid of the wanted row. More...

grid *	get_row_grid (const unsigned row)
	The possibly-giving-problems nonconst version of get_row_grid. More...

bool	select_row (const unsigned row, const bool select=true)
	Selects a row. More...

bool	select_last_row (const bool select=true)
	Does exactly as advertised: selects the list's last row. More...

bool	select_row_at (const unsigned row, const bool select=true)
	Selects a row at the given position, regardless of sorting order. More...

bool	row_selected (const unsigned row)
	Check if a row is selected. More...

int	get_selected_row () const
	Returns the first selected row. More...

void	list_item_clicked (widget &caller)
	Function to call after the user clicked on a row. More...

virtual void	set_self_active (const bool active) override
	See container_base::set_self_active. More...

bool	update_content_size ()
	Request to update the size of the content after changing the content. More...

virtual void	place (const point &origin, const point &size) override
	See widget::place. More...

void	order_by (const generator_base::order_func &func)

template<typename Func >
void	set_single_sorter (std::string_view id, const Func &f)
	Registers a single sorting control by ID. More...

template<typename... Args>
void	set_sorters (Args &&... functors)
	Registers sorting controls using magic index IDs. More...

void	set_active_sorter (std::string_view id, sort_order::type order, bool select_first=false)
	Sorts the listbox by a pre-set sorting option. More...

std::pair< widget *, sort_order::type >	get_active_sorter () const
	Returns a widget pointer to the active sorter, along with its corresponding order. More...

void	mark_as_unsorted ()
	Deactivates all sorting toggle buttons at the top, making the list look like it's not sorted. More...

void	set_callback_order_change (std::function< void(unsigned, sort_order::type)> callback)
	Registers a callback to be called when the active sorting option changes. More...

Public Member Functions inherited from gui2::scrollbar_container
	scrollbar_container (const implementation::builder_scrollbar_container &builder, const std::string &control_type)

virtual	~scrollbar_container ()

virtual void	layout_initialize (const bool full_initialization) override
	See widget::layout_initialize. More...

virtual void	request_reduce_height (const unsigned maximum_height) override
	See widget::request_reduce_height. More...

virtual void	request_reduce_width (const unsigned maximum_width) override
	See widget::request_reduce_width. More...

virtual bool	can_wrap () const override
	See widget::can_wrap. More...

virtual void	set_origin (const point &origin) override
	See widget::set_origin. More...

virtual void	set_visible_rectangle (const SDL_Rect &rectangle) override
	See widget::set_visible_rectangle. More...

virtual bool	get_active () const override
	See styled_widget::get_active. More...

virtual unsigned	get_state () const override
	See styled_widget::get_state. More...

virtual widget *	find_at (const point &coordinate, const bool must_be_active) override
	See widget::find_at. More...

virtual const widget *	find_at (const point &coordinate, const bool must_be_active) const override
	See widget::find_at. More...

widget *	find (const std::string_view id, const bool must_be_active) override
	See widget::find. More...

const widget *	find (const std::string_view id, const bool must_be_active) const override
	See widget::find. More...

bool	disable_click_dismiss () const override
	See widget::disable_click_dismiss. More...

virtual iteration::walker_ptr	create_walker () override
	See widget::create_walker. More...

void	set_vertical_scrollbar_mode (const scrollbar_mode scrollbar_mode)

scrollbar_mode	get_vertical_scrollbar_mode () const

void	set_horizontal_scrollbar_mode (const scrollbar_mode scrollbar_mode)

scrollbar_mode	get_horizontal_scrollbar_mode () const

grid *	content_grid ()

const grid *	content_grid () const

const SDL_Rect &	content_visible_area () const

bool	vertical_scrollbar_at_end ()

unsigned	get_vertical_scrollbar_item_position () const
	Returns current position of the vertical scrollbar. More...

void	set_vertical_scrollbar_item_position (const unsigned position)
	Move the vertical scrollbar to a position. More...

unsigned	get_horizontal_scrollbar_item_position () const
	Returns current position of the horizontal scrollbar. More...

void	set_horizontal_scrollbar_item_position (const unsigned position)
	Move the horizontal scrollbar to a position. More...

void	scroll_vertical_scrollbar (const scrollbar_base::scroll_mode scroll)
	Scrolls the vertical scrollbar. More...

void	scroll_horizontal_scrollbar (const scrollbar_base::scroll_mode scroll)
	Scrolls the horizontal scrollbar. More...

void	scroll_vertical_scrollbar_by (const int pixels)
	Scrolls the vertical scrollbar by pixel. More...

void	scroll_horizontal_scrollbar_by (const int pixels)
	Scrolls the horizontal scrollbar by pixel. More...

void	vertical_scrollbar_moved ()
	Callback when the scrollbar moves (NOTE maybe only one callback needed). More...

void	horizontal_scrollbar_moved ()

void	move_viewport (const int pixels_x, const int pixels_y)
	To be called after the scollbar moves manually (by pixel) to move the viewport. More...

scrollbar_base *	horizontal_scrollbar ()

scrollbar_base *	vertical_scrollbar ()

grid *	get_horizontal_scrollbar_grid ()

grid *	get_vertical_scrollbar_grid ()

Public Member Functions inherited from gui2::container_base
	container_base (const implementation::builder_styled_widget &builder, const std::string &control_type)

virtual SDL_Rect	get_client_rect () const
	Returns the client rect. More...

void	reduce_width (const unsigned maximum_width)
	Tries to reduce the width of a container. More...

virtual void	demand_reduce_width (const unsigned maximum_width) override
	See widget::demand_reduce_width. More...

void	reduce_height (const unsigned maximum_height)
	Tries to reduce the height of a container. More...

virtual void	demand_reduce_height (const unsigned maximum_height) override
	See widget::demand_reduce_height. More...

virtual bool	has_widget (const widget &widget) const override
	See widget::has_widget. More...

virtual void	set_active (const bool active) override
	See styled_widget::set_active. More...

void	init_grid (const builder_grid &grid_builder)
	Initializes and builds the grid. More...

grid::iterator	begin ()

grid::iterator	end ()

unsigned	add_row (const unsigned count=1)

void	set_rows (const unsigned rows)

unsigned int	get_rows () const

void	set_cols (const unsigned cols)

unsigned int	get_cols () const

void	set_rows_cols (const unsigned rows, const unsigned cols)

void	set_child (std::unique_ptr< widget > widget, const unsigned row, const unsigned col, const unsigned flags, const unsigned border_size)

void	set_row_grow_factor (const unsigned row, const unsigned factor)

void	set_column_grow_factor (const unsigned column, const unsigned factor)

const grid &	get_grid () const

grid &	get_grid ()

Public Member Functions inherited from gui2::styled_widget
	styled_widget (const implementation::builder_styled_widget &builder, const std::string &control_type)
	Constructor. More...

virtual void	set_members (const widget_item &data)
	Sets the members of the styled_widget. More...

bool	disable_click_dismiss () const override
	See widget::disable_click_dismiss. More...

point	get_config_minimum_size () const
	Gets the minimum size as defined in the config. More...

point	get_config_default_size () const
	Gets the default size as defined in the config. More...

point	get_config_maximum_size () const
	Gets the best size as defined in the config. More...

virtual unsigned	get_characters_per_line () const
	Returns the number of characters per line. More...

virtual bool	get_link_aware () const
	Returns whether the label should be link_aware, in in rendering and in searching for links with get_link. More...

virtual color_t	get_link_color () const
	Returns the color string to be used with links. More...

widget *	find (const std::string_view id, const bool must_be_active) override
	See widget::find. More...

const widget *	find (const std::string_view id, const bool must_be_active) const override
	See widget::find. More...

bool	get_use_tooltip_on_label_overflow () const

void	set_use_tooltip_on_label_overflow (const bool use_tooltip=true)

const t_string &	get_label () const

virtual void	set_label (const t_string &text)

virtual void	set_use_markup (bool use_markup)

bool	get_use_markup () const

const t_string &	tooltip () const

void	set_tooltip (const t_string &tooltip)

const t_string &	help_message () const

void	set_help_message (const t_string &help_message)

std::vector< canvas > &	get_canvases ()

canvas &	get_canvas (const unsigned index)

virtual void	set_text_alignment (const PangoAlignment text_alignment)

PangoAlignment	get_text_alignment () const

void	set_text_ellipse_mode (const PangoEllipsizeMode ellipse_mode)

PangoEllipsizeMode	get_text_ellipse_mode () const
	Get the text's ellipsize mode. More...

void	set_text_maximum_width (int max_width)
	Set how wide the text can become. More...

Public Member Functions inherited from gui2::widget
	widget (const widget &)=delete

widget &	operator= (const widget &)=delete

	widget ()

	widget (const builder_widget &builder)
	Constructor. More...

virtual	~widget () override

void	set_id (const std::string &id)

const std::string &	id () const

window *	get_window ()
	Get the parent window. More...

const window *	get_window () const
	The constant version of get_window. More...

grid *	get_parent_grid ()
	Get the parent grid. More...

const grid *	get_parent_grid () const

void	set_parent (widget *parent)

widget *	parent ()

point	get_best_size () const
	Gets the best size for the widget. More...

virtual bool	can_mouse_focus () const
	Whether the mouse move/click event go 'through' this widget. More...

virtual void	set_size (const point &size)
	Sets the size of the widget. More...

virtual void	move (const int x_offset, const int y_offset)
	Moves a widget. More...

virtual void	set_horizontal_alignment (const std::string &alignment)
	Sets the horizontal alignment of the widget within its parent grid. More...

virtual void	set_vertical_alignment (const std::string &alignment)
	Sets the horizontal alignment of the widget within its parent grid. More...

point	get_origin () const
	Returns the screen origin of the widget. More...

point	get_size () const
	Returns the size of the widget. More...

rect	get_rectangle () const
	Gets the bounding rectangle of the widget on the screen. More...

int	get_x () const

int	get_y () const

unsigned	get_width () const

unsigned	get_height () const

void	set_linked_group (const std::string &linked_group)

std::string	get_linked_group () const

SDL_Rect	calculate_blitting_rectangle () const
	Calculates the blitting rectangle of the widget. More...

SDL_Rect	calculate_clipping_rectangle () const
	Calculates the clipping rectangle of the widget. More...

bool	draw_background ()
	Draws the background of a widget. More...

void	draw_children ()
	Draws the children of a widget. More...

bool	draw_foreground ()
	Draws the foreground of the widget. More...

SDL_Rect	get_dirty_rectangle () const
	Gets the dirty rectangle of the widget. More...

void	queue_redraw ()
	Indicates that this widget should be redrawn. More...

void	queue_redraw (const rect &region)
	Indicate that specific region of the screen should be redrawn. More...

void	set_visible (const visibility visible)

visibility	get_visible () const

void	set_visible (bool visible)
	Sets widget to visible if visible is true, else invisible. More...

void	set_hidden (bool hidden)
	Sets widget to visible if hidden is true, else hidden. More...

redraw_action	get_drawing_action () const

void	set_debug_border_mode (const debug_border debug_border_mode)

void	set_debug_border_color (const color_t debug_border_color)

template<class T >
T *	find_widget (const std::string_view id, const bool must_be_active, const bool must_exist)
	Gets a widget with the wanted id. More...

template<class T >
const T *	find_widget (const std::string_view id, const bool must_be_active, const bool must_exist) const

template<class T >
T &	find_widget (const std::string_view id, const bool must_be_active=false)
	Gets a widget with the wanted id. More...

template<class T >
const T &	find_widget (const std::string_view id, const bool must_be_active=false) const

Public Member Functions inherited from gui2::event_executor
	event_executor ()

virtual	~event_executor ()

void	set_wants_mouse_hover (const bool hover=true)

bool	wants_mouse_hover () const

void	set_wants_mouse_left_double_click (const bool click=true)

bool	wants_mouse_left_double_click () const

void	set_wants_mouse_middle_double_click (const bool click=true)

bool	wants_mouse_middle_double_click () const

event_executor &	set_wants_mouse_right_double_click (const bool click=true)

bool	wants_mouse_right_double_click () const

Public Member Functions inherited from gui2::event::dispatcher
	dispatcher ()

virtual	~dispatcher ()

void	connect ()
	Connects the dispatcher to the event handler. More...

void	disconnect ()
	Disconnects the dispatcher from the event handler. More...

bool	is_connected () const
	Return whether the dispatcher is currently connected. More...

bool	has_event (const ui_event event, const event_queue_type event_type)

bool	fire (const ui_event event, widget &target)
	Fires an event which has no extra parameters. More...

bool	fire (const ui_event event, widget &target, const point &coordinate)
	Fires an event which takes a coordinate parameter. More...

bool	fire (const ui_event event, widget &target, const SDL_Keycode key, const SDL_Keymod modifier, const std::string &unicode)
	Fires an event which takes keyboard parameters. More...

bool	fire (const ui_event event, widget &target, const point &pos, const point &distance)
	Fires an event which takes touch-motion parameters. More...

bool	fire (const ui_event event, widget &target, const point &center, float dTheta, float dDist, uint8_t numFingers)
	Fires an event which takes touch-gesture parameters. More...

bool	fire (const ui_event event, widget &target, void *)
	Fires an event which takes notification parameters. More...

bool	fire (const ui_event event, widget &target, const message &msg)
	Fires an event which takes message parameters. More...

bool	fire (const ui_event event, widget &target, const SDL_Event &sdlevent)
	Fires an event that's a raw SDL event. More...

bool	fire (const ui_event event, widget &target, const std::string &text, int32_t start, int32_t len)
	Fires an event which takes text input parameters. More...

template<ui_event E, typename F >
void	connect_signal (const F &func, const queue_position position=back_child)
	Adds a callback to the appropriate queue based on event type. More...

template<ui_event E, typename F >
void	disconnect_signal (const F &func, const queue_position position=back_child)
	Removes a callback from the appropriate queue based on event type. More...

void	capture_mouse ()
	Captures the mouse. More...

void	release_mouse ()
	Releases the mouse capture. More...

void	set_mouse_behavior (const mouse_behavior mouse_behavior)

mouse_behavior	get_mouse_behavior () const

void	set_want_keyboard_input (const bool want_keyboard_input)

bool	get_want_keyboard_input () const

void	register_hotkey (const hotkey::HOTKEY_COMMAND id, const hotkey_function &function)
	Registers a hotkey. More...

bool	execute_hotkey (const hotkey::HOTKEY_COMMAND id)
	Executes a hotkey. More...

Public Member Functions inherited from enable_lua_ptr< widget >
	enable_lua_ptr (widget *tp)

Static Public Member Functions
static const std::string &	type ()
	Static type getter that does not rely on the widget being constructed. More...

Static Public Member Functions inherited from gui2::scrollbar_container
static const std::string &	type ()
	Static type getter that does not rely on the widget being constructed. More...

Protected Member Functions
void	handle_key_up_arrow (SDL_Keymod modifier, bool &handled) override
	Inherited from scrollbar_container. More...

void	handle_key_down_arrow (SDL_Keymod modifier, bool &handled) override
	Inherited from scrollbar_container. More...

void	handle_key_left_arrow (SDL_Keymod modifier, bool &handled) override
	Inherited from scrollbar_container. More...

void	handle_key_right_arrow (SDL_Keymod modifier, bool &handled) override
	Inherited from scrollbar_container. More...

Protected Member Functions inherited from gui2::scrollbar_container
void	show_content_rect (const SDL_Rect &rect)
	Shows a certain part of the content. More...

void	set_scrollbar_button_status ()
	Sets the status of the scrollbar buttons. More...

bool	content_resize_request (const bool force_sizing=false)
	Notification if the content of a child needs a resize. More...

bool	content_resize_request (const int width_modification, const int height_modification, const int width_modification_pos=-1, const int height_modification_pos=-1)
	Request from the content to modify the size of the container. More...

virtual void	handle_key_home (SDL_Keymod modifier, bool &handled)
	Home key pressed. More...

virtual void	handle_key_end (SDL_Keymod modifier, bool &handled)
	End key pressed. More...

virtual void	handle_key_page_up (SDL_Keymod modifier, bool &handled)
	Page up key pressed. More...

virtual void	handle_key_page_down (SDL_Keymod modifier, bool &handled)
	Page down key pressed. More...

void	finalize_setup ()
	The builder needs to call us so we do our setup. More...

Protected Member Functions inherited from gui2::styled_widget
resolution_definition_ptr	get_config ()

resolution_definition_const_ptr	get_config () const

template<typename T >
std::shared_ptr< const typename T::resolution >	cast_config_to () const
	Casts the current resolution definition config to the respective type of a derived widget. More...

void	set_config (resolution_definition_ptr config)

virtual void	update_canvas ()
	Updates the canvas(ses). More...

unsigned int	get_text_font_size () const
	Resolves and returns the text_font_size. More...

int	get_text_maximum_width () const
	Returns the maximum width available for the text. More...

int	get_text_maximum_height () const
	Returns the maximum height available for the text. More...

virtual bool	impl_draw_background () override
	See widget::impl_draw_background. More...

virtual bool	impl_draw_foreground () override
	See widget::impl_draw_foreground. More...

std::string	get_label_token (const point &position, const char *delimiters=" \n\r\t") const
	Exposes font::pango_text::get_token, for the text label of this styled_widget. More...

std::string	get_label_link (const point &position) const

Protected Member Functions inherited from gui2::widget
void	set_layout_size (const point &size)

const point &	layout_size () const

void	clear_layout_size ()
	Throws away layout_size_. More...

Private Types
enum	KEY_SCROLL_DIRECTION { KEY_VERTICAL , KEY_HORIZONTAL }

Private Member Functions
void	initialize_sorter (std::string_view id, generator_sort_array &&)
	Implementation detail of set_single_sorter. More...

template<std::size_t... Is, typename... Args>
void	set_sorters_impl (std::index_sequence< Is... >, Args &&... fs)
	Implementation detail of set_sorters. More...

virtual point	calculate_best_size () const override
	See widget::calculate_best_size. More...

void	update_visible_area_on_key_event (const KEY_SCROLL_DIRECTION direction)
	Helper to update visible area after a key event. More...

void	resize_content (const int width_modification, const int height_modification, const int width_modification_pos=-1, const int height_modification_pos=-1)
	Resizes the content. More...

void	resize_content (const widget &row)
	Resizes the content. More...

void	update_layout ()
	Updates internal layout. More...

virtual void	set_content_size (const point &origin, const point &size) override
	Inherited from scrollbar_container. More...

virtual const std::string &	get_control_type () const override
	Inherited from styled_widget, implemented by REGISTER_WIDGET. More...

void	order_by_column (unsigned column, widget &widget)

Private Attributes
generator_base *	generator_
	Contains a pointer to the generator. More...

generator_base::placement	placement_

builder_grid_const_ptr	list_builder_
	Contains the builder for the new items. More...

std::vector< std::pair< selectable_item *, generator_sort_array > >	orders_

std::function< void(unsigned, sort_order::type)>	callback_order_change_

Friends
struct	implementation::builder_listbox_base

class	debug_layout_graph

Additional Inherited Members
Public Types inherited from gui2::scrollbar_container
enum	scrollbar_mode { ALWAYS_VISIBLE , ALWAYS_INVISIBLE , AUTO_VISIBLE , AUTO_VISIBLE_FIRST_RUN }
	The way to handle the showing or hiding of the scrollbar. More...

Public Types inherited from gui2::widget
enum class	visibility { visible , hidden , invisible }
	Visibility settings done by the user. More...

enum class	redraw_action { full , partly , none }
	Visibility set by the engine. More...

enum class	debug_border { none , outline , fill }

Public Types inherited from gui2::event::dispatcher
enum	event_queue_type { pre = 1 , child = 2 , post = 4 }

enum	queue_position { front_pre_child , back_pre_child , front_child , back_child , front_post_child , back_post_child }
	The position where to add a new callback in the signal handler. More...

enum class	mouse_behavior { all , hit , none }
	The behavior of the mouse events. More...

Detailed Description

The listbox class.

Definition at line 40 of file listbox.hpp.

Member Enumeration Documentation

◆ KEY_SCROLL_DIRECTION

enum gui2::listbox::KEY_SCROLL_DIRECTION

private

Enumerator
KEY_VERTICAL
KEY_HORIZONTAL

Definition at line 355 of file listbox.hpp.

Constructor & Destructor Documentation

◆ listbox()

gui2::listbox::listbox ( const implementation::builder_listbox_base & builder )

Constructor.

Parameters

builder The builder for the appropriate listbox variant.

Definition at line 46 of file listbox.cpp.

References gui2::generator_base::build(), gui2::generator< minimum_selection, maximum_selection, my_placement, select_action >::create_items(), gui2::scrollbar_container::finalize_setup(), list_item_clicked(), and gui2::swap_grid().

Member Function Documentation

◆ add_row() [1/2]

grid & gui2::listbox::add_row	(	const widget_data &	data,
		const int	index = `-1`
	)

Adds single row to the grid.

This function expect a row to have multiple widgets (either multiple columns or one column with multiple widgets).

Parameters

data	The data to send to the set_members of the widgets. If the member id is not an empty string it is only send to the widget that has the wanted id (if any). If the member id is an empty string, it is send to all members. Having both empty and non-empty id's gives undefined behavior.
index	The item before which to add the new item, 0 == begin, -1 == end.

Definition at line 102 of file listbox.cpp.

References gui2::generator_base::create_item(), data, generator_, utf8::index(), list_builder_, list_item_clicked(), and resize_content().

◆ add_row() [2/2]

grid & gui2::listbox::add_row	(	const widget_item &	item,
		const int	index = `-1`
	)

When an item in the list is selected by the user we need to update the state.

We installed a callback handler which calls us.

Parameters

item	The data send to the set_members of the widgets.
index	The item before which to add the new item, 0 == begin, -1 == end.

Definition at line 92 of file listbox.cpp.

References gui2::generator_base::create_item(), generator_, utf8::index(), list_builder_, list_item_clicked(), and resize_content().

◆ calculate_best_size()

point gui2::listbox::calculate_best_size ( ) const

overrideprivatevirtual

See widget::calculate_best_size.

Reimplemented from gui2::scrollbar_container.

Definition at line 465 of file listbox.cpp.

References gui2::scrollbar_container::calculate_best_size(), and gui2::container_base::get_grid().

◆ clear()

void gui2::listbox::clear ( )

Removes all the rows in the listbox, clearing it.

Definition at line 153 of file listbox.cpp.

References gui2::generator_base::clear(), generator_, and update_content_size().

Referenced by gui2::dialogs::mp_create_game::display_games_of_type(), gui2::dialogs::game_load::display_savegame(), gui2::dialogs::game_load::display_savegame_internal(), gui2::dialogs::preferences_dialog::initialize_callbacks(), gui2::dialogs::game_load::populate_game_list(), gui2::dialogs::editor_choose_addon::populate_list(), gui2::dialogs::unit_create::pre_show(), gui2::dialogs::unit_list::pre_show(), gui2::dialogs::unit_recall::pre_show(), gui2::dialogs::file_dialog::refresh_fileview(), gui2::dialogs::achievements_dialog::set_achievements_row(), gui2::addon_list::set_addons(), gui2::dialogs::mp_match_history::update_display(), gui2::dialogs::mp_lobby::update_gamelist(), gui2::player_list_helper::update_list(), and gui2::dialogs::statistics_dialog::update_lists().

◆ filter_rows_by()

std::size_t gui2::listbox::filter_rows_by ( const std::function< bool(std::size_t)> & filter )

Hides all rows for which the given predicate returns false.

Returns: The number of rows now visible.

Definition at line 249 of file listbox.cpp.

References get_item_count(), i, and set_row_shown().

◆ get_active_sorter()

std::pair< widget *, sort_order::type > gui2::listbox::get_active_sorter ( ) const

Returns a widget pointer to the active sorter, along with its corresponding order.

Definition at line 631 of file listbox.cpp.

References _(), string_enums::enum_base< Definition >::get_enum(), orders_, and w.

Referenced by gui2::dialogs::unit_recall::post_show().

◆ get_control_type()

virtual const std::string& gui2::listbox::get_control_type ( ) const

overrideprivatevirtual

Inherited from styled_widget, implemented by REGISTER_WIDGET.

Reimplemented from gui2::scrollbar_container.

◆ get_item_count()

unsigned gui2::listbox::get_item_count ( ) const

Returns the number of items in the listbox.

Definition at line 159 of file listbox.cpp.

References generator_, and gui2::generator_base::get_item_count().

Referenced by gui2::dialogs::preferences_dialog::add_friend_list_entry(), gui2::dialogs::preferences_dialog::add_hotkey_callback(), gui2::dialogs::editor_edit_pbl::create_cfg(), gui2::dialogs::editor_edit_pbl::delete_translation(), gui2::dialogs::unit_recall::dismiss_unit(), gui2::dialogs::mp_create_game::display_games_of_type(), filter_rows_by(), gui2::dialogs::drop_down_menu::get_toggle_states(), gui2::dialogs::mp_create_game::on_filter_change(), gui2::dialogs::editor_choose_addon::populate_list(), gui2::dialogs::addon_uninstall_list::post_show(), gui2::dialogs::drop_down_menu::pre_show(), gui2::dialogs::editor_edit_pbl::pre_show(), gui2::dialogs::mp_create_game::pre_show(), gui2::dialogs::preferences_dialog::pre_show(), gui2::dialogs::server_info::pre_show(), gui2::dialogs::simple_item_selector::pre_show(), gui2::dialogs::theme_list::pre_show(), gui2::dialogs::unit_attack::pre_show(), remove_row(), gui2::addon_list::select_addon(), select_last_row(), select_row(), set_row_shown(), gui2::dialogs::file_dialog::sync_bookmarks_bar(), gui2::dialogs::mp_match_history::tab_switch_callback(), gui2::dialogs::preferences_dialog::update_friends_list_controls(), gui2::dialogs::mp_lobby::update_gamelist_diff(), and gui2::dialogs::mp_lobby::update_gamelist_filter().

◆ get_row_grid() [1/2]

grid * gui2::listbox::get_row_grid ( const unsigned row )

The possibly-giving-problems nonconst version of get_row_grid.

Parameters

row	The row to get the grid from, the caller has to make sure the row is a valid row.

Returns: The grid of the wanted row.

Definition at line 274 of file listbox.cpp.

References generator_, and gui2::generator_base::item().

◆ get_row_grid() [2/2]

const grid * gui2::listbox::get_row_grid ( const unsigned row ) const

Returns the grid of the wanted row.

There's only a const version since allowing callers to modify the grid behind our backs might give problems. We return a pointer instead of a reference since dynamic casting of pointers is easier (no try catch needed).

Parameters

row	The row to get the grid from, the caller has to make sure the row is a valid row.

Returns: The grid of the wanted row.

Definition at line 267 of file listbox.cpp.

References generator_, and gui2::generator_base::item().

Referenced by gui2::chatbox::active_window_changed(), gui2::dialogs::preferences_dialog::add_friend_list_entry(), gui2::dialogs::preferences_dialog::add_hotkey_callback(), gui2::dialogs::editor_edit_pbl::create_cfg(), gui2::dialogs::mp_create_game::get_active_mods(), gui2::dialogs::drop_down_menu::get_toggle_states(), gui2::dialogs::mp_change_control::highlight_side_nick(), gui2::chatbox::increment_waiting_messages(), gui2::chatbox::increment_waiting_whispers(), gui2::dialogs::preferences_dialog::on_advanced_prefs_list_select(), gui2::dialogs::addon_uninstall_list::post_show(), gui2::dialogs::editor_choose_addon::post_show(), gui2::dialogs::log_settings::pre_show(), gui2::dialogs::preferences_dialog::remove_hotkey_callback(), gui2::dialogs::unit_recall::rename_unit(), gui2::addon_list::select_addon(), gui2::dialogs::mp_create_game::set_active_mods(), gui2::dialogs::mp_match_history::tab_switch_callback(), and gui2::dialogs::mp_lobby::update_gamelist_diff().

◆ get_rows_shown()

boost::dynamic_bitset gui2::listbox::get_rows_shown ( ) const

Returns a list of visible rows.

Returns: A mask indicating which rows are visible

Definition at line 262 of file listbox.cpp.

References generator_, and gui2::generator_base::get_items_shown().

Referenced by gui2::dialogs::mp_create_game::display_games_of_type().

◆ get_selected_row()

int gui2::listbox::get_selected_row ( ) const

Returns the first selected row.

Returns: The first selected row, or -1 if no row is selected.

Definition at line 305 of file listbox.cpp.

References generator_, and gui2::generator_base::get_selected_item().

Referenced by gui2::dialogs::preferences_dialog::add_hotkey_callback(), gui2::dialogs::game_load::delete_button_callback(), gui2::dialogs::editor_edit_pbl::delete_translation(), gui2::dialogs::unit_recall::dismiss_unit(), gui2::dialogs::editor_generate_map::do_generator_selected(), gui2::dialogs::mp_lobby::enter_selected_game(), gui2::chatbox::finalize_setup(), gui2::tab_container::get_active_tab_index(), gui2::dialogs::file_dialog::get_filelist_selection(), gui2::addon_list::get_selected_addon(), gui2::dialogs::drop_down_menu::mouse_up_callback(), gui2::dialogs::preferences_dialog::on_advanced_prefs_list_select(), gui2::dialogs::file_dialog::on_bookmark_selected(), gui2::dialogs::preferences_dialog::on_friends_list_select(), gui2::dialogs::campaign_difficulty::post_show(), gui2::dialogs::depcheck_select_new::post_show(), gui2::dialogs::editor_choose_addon::post_show(), gui2::dialogs::migrate_version_selection::post_show(), gui2::dialogs::mp_method_selection::post_show(), gui2::dialogs::theme_list::post_show(), gui2::dialogs::unit_create::post_show(), gui2::dialogs::unit_recall::post_show(), gui2::dialogs::preferences_dialog::remove_friend_list_entry(), gui2::dialogs::preferences_dialog::remove_hotkey_callback(), gui2::dialogs::unit_recall::rename_unit(), set_row_shown(), gui2::dialogs::mp_match_history::tab_switch_callback(), gui2::dialogs::server_info::tab_switch_callback(), gui2::dialogs::preferences_dialog::update_friends_list_controls(), gui2::dialogs::mp_lobby::update_gamelist(), gui2::dialogs::mp_lobby::update_gamelist_diff(), gui2::dialogs::statistics_dialog::update_lists(), and gui2::dialogs::mp_lobby::update_selected_game().

◆ handle_key_down_arrow()

void gui2::listbox::handle_key_down_arrow	(	SDL_Keymod	modifier,
		bool &	handled
	)

overrideprotectedvirtual

Inherited from scrollbar_container.

Reimplemented from gui2::scrollbar_container.

Definition at line 516 of file listbox.cpp.

References generator_, gui2::generator_base::handle_key_down_arrow(), gui2::scrollbar_container::handle_key_up_arrow(), KEY_VERTICAL, and update_visible_area_on_key_event().

◆ handle_key_left_arrow()

void gui2::listbox::handle_key_left_arrow	(	SDL_Keymod	modifier,
		bool &	handled
	)

overrideprotectedvirtual

Inherited from scrollbar_container.

Reimplemented from gui2::scrollbar_container.

Definition at line 530 of file listbox.cpp.

References generator_, gui2::scrollbar_container::handle_key_left_arrow(), gui2::generator_base::handle_key_left_arrow(), KEY_HORIZONTAL, and update_visible_area_on_key_event().

◆ handle_key_right_arrow()

void gui2::listbox::handle_key_right_arrow	(	SDL_Keymod	modifier,
		bool &	handled
	)

overrideprotectedvirtual

Inherited from scrollbar_container.

Reimplemented from gui2::scrollbar_container.

Definition at line 544 of file listbox.cpp.

References generator_, gui2::scrollbar_container::handle_key_left_arrow(), gui2::generator_base::handle_key_right_arrow(), KEY_HORIZONTAL, and update_visible_area_on_key_event().

◆ handle_key_up_arrow()

void gui2::listbox::handle_key_up_arrow	(	SDL_Keymod	modifier,
		bool &	handled
	)

overrideprotectedvirtual

Inherited from scrollbar_container.

Reimplemented from gui2::scrollbar_container.

Definition at line 502 of file listbox.cpp.

References generator_, gui2::scrollbar_container::handle_key_up_arrow(), gui2::generator_base::handle_key_up_arrow(), KEY_VERTICAL, and update_visible_area_on_key_event().

◆ initialize_sorter()

void gui2::listbox::initialize_sorter	(	std::string_view	id,
		generator_sort_array &&	array
	)

private

Implementation detail of set_single_sorter.

Definition at line 558 of file listbox.cpp.

References gui2::event::connect_signal_notify_modified(), i, gui2::widget::id(), order_by_column(), and orders_.

Referenced by set_single_sorter().

◆ list_item_clicked()

void gui2::listbox::list_item_clicked ( widget & caller )

Function to call after the user clicked on a row.

Todo:: Hack to capture the keyboard focus.

Definition at line 311 of file listbox.cpp.

References gui2::scrollbar_container::content_visible_area(), gui2::event::dispatcher::fire(), generator_, gui2::generator_base::get_item_count(), gui2::widget::get_rectangle(), gui2::generator_base::get_selected_item(), gui2::selectable_item::get_value_bool(), gui2::widget::get_window(), gui2::grid::has_widget(), i, gui2::generator_base::item(), gui2::window::keyboard_capture(), gui2::event::NOTIFY_MODIFIED, rect::overlaps(), gui2::generator_base::select_item(), gui2::scrollbar_container::show_content_rect(), and gui2::generator_base::toggle_item().

Referenced by add_row(), and listbox().

◆ mark_as_unsorted()

void gui2::listbox::mark_as_unsorted ( )

Deactivates all sorting toggle buttons at the top, making the list look like it's not sorted.

Definition at line 645 of file listbox.cpp.

References _(), orders_, utils::to_underlying(), and w.

Referenced by gui2::addon_list::set_addon_order().

◆ order_by()

void gui2::listbox::order_by ( const generator_base::order_func & func )

Definition at line 600 of file listbox.cpp.

References generator_, gui2::generator_base::set_order(), and update_layout().

Referenced by order_by_column(), and gui2::addon_list::set_addon_order().

◆ order_by_column()

void gui2::listbox::order_by_column	(	unsigned	column,
		widget &	widget
	)

private

Definition at line 574 of file listbox.cpp.

References _(), callback_order_change_, string_enums::enum_base< Definition >::get_enum(), gui2::selectable_item::get_value(), order_by(), orders_, utils::to_underlying(), w, and gui2::widget::widget().

Referenced by initialize_sorter().

◆ place()

void gui2::listbox::place	(	const point &	origin,
		const point &	size
	)

overridevirtual

See widget::place.

Reimplemented from gui2::scrollbar_container.

Definition at line 381 of file listbox.cpp.

References gui2::scrollbar_container::content_visible_area(), generator_, gui2::scrollbar_container::get_horizontal_scrollbar_item_position(), gui2::widget::get_origin(), gui2::widget::get_rectangle(), gui2::generator_base::get_selected_item(), gui2::scrollbar_container::get_vertical_scrollbar_item_position(), gui2::generator_base::item(), LOG_GUI_L, LOG_HEADER, gui2::scrollbar_container::place(), gui2::scrollbar_container::set_horizontal_scrollbar_item_position(), gui2::scrollbar_container::set_vertical_scrollbar_item_position(), gui2::scrollbar_container::show_content_rect(), and utf8::size().

◆ remove_row()

void gui2::listbox::remove_row	(	const unsigned	row,
		unsigned	count = `1`
	)

Removes a row in the listbox.

Parameters

row	The row to remove, when not in range the function is ignored.
count	The number of rows to remove, 0 means all rows (starting from row).

Definition at line 112 of file listbox.cpp.

References gui2::scrollbar_container::content_grid_, gui2::generator_base::delete_item(), generator_, gui2::widget::get_height(), get_item_count(), gui2::widget::get_visible(), gui2::widget::get_width(), gui2::widget::get_y(), gui2::generator_base::horizontal_list, gui2::widget::invisible, gui2::generator_base::item(), placement_, resize_content(), and update_content_size().

Referenced by gui2::dialogs::preferences_dialog::add_friend_list_entry(), gui2::chatbox::close_window(), gui2::dialogs::game_load::delete_button_callback(), gui2::dialogs::editor_edit_pbl::delete_translation(), gui2::dialogs::unit_recall::dismiss_unit(), gui2::dialogs::file_dialog::on_bookmark_del_cmd(), gui2::dialogs::preferences_dialog::remove_friend_list_entry(), and gui2::dialogs::mp_lobby::update_gamelist_diff().

◆ resize_content() [1/2]

void gui2::listbox::resize_content	(	const int	width_modification,
		const int	height_modification,
		const int	width_modification_pos = `-1`,
		const int	height_modification_pos = `-1`
	)

private

Resizes the content.

The resize either happens due to resizing the content or invalidate the layout of the window.

Parameters

width_modification	The wanted modification to the width: negative values reduce width. zero leave width as is. positive values increase width.
height_modification	The wanted modification to the height: negative values reduce height. zero leave height as is. positive values increase height.
width_modification_pos
height_modification_pos

Definition at line 413 of file listbox.cpp.

References gui2::scrollbar_container::content_grid(), gui2::scrollbar_container::content_resize_request(), DBG_GUI_L, gui2::widget::get_size(), LOG_HEADER, gui2::widget::queue_redraw(), gui2::widget::set_size(), utf8::size(), and update_layout().

Referenced by add_row(), remove_row(), and resize_content().

◆ resize_content() [2/2]

void gui2::listbox::resize_content ( const widget & row )

private

Resizes the content.

The resize happens when a new row is added to the contents.

Parameters

row	The new row added to the listbox.

Definition at line 444 of file listbox.cpp.

References gui2::scrollbar_container::content_grid(), DBG_GUI_L, gui2::widget::get_best_size(), gui2::widget::get_size(), gui2::widget::get_visible(), gui2::widget::invisible, LOG_HEADER, resize_content(), and utf8::size().

◆ row_selected()

bool gui2::listbox::row_selected ( const unsigned row )

Check if a row is selected.

Parameters

row	The row to test

Returns: True if it is selected.

Definition at line 299 of file listbox.cpp.

References generator_, and gui2::generator_base::is_selected().

◆ select_last_row()

bool gui2::listbox::select_last_row ( const bool select = true )

inline

Does exactly as advertised: selects the list's last row.

Parameters

select Select or deselect the row.

Definition at line 186 of file listbox.hpp.

References get_item_count(), and select_row().

Referenced by gui2::dialogs::campaign_difficulty::pre_show(), gui2::dialogs::editor_generate_map::pre_show(), gui2::dialogs::language_selection::pre_show(), gui2::dialogs::unit_create::pre_show(), and gui2::dialogs::file_dialog::push_fileview_row().

◆ select_row()

bool gui2::listbox::select_row	(	const unsigned	row,
		const bool	select = `true`
	)

Selects a row.

Parameters

row	The row to select.
select	Select or deselect the row.

Returns: True if the operation succeeded.

Definition at line 280 of file listbox.cpp.

References generator_, get_item_count(), gui2::generator_base::get_selected_item_count(), and gui2::generator_base::select_item().

◆ select_row_at()

bool gui2::listbox::select_row_at	(	const unsigned	row,
		const bool	select = `true`
	)

Selects a row at the given position, regardless of sorting order.

When using select_row the relevant row is located by index regardless of its actual position in the list, which could differ if the list had been sorted. In that case, select_row(0) would not select the list's first row as displayed.

This function allows row selection based on position. select_row_at(0) will always select the list's first row, regardless of sorting order.

Parameters

row	The row to select.
select	Select or deselect the row.

Returns: True if the operation succeeded.

Definition at line 293 of file listbox.cpp.

References generator_, gui2::generator_base::get_item_at_ordered(), and select_row().

Referenced by gui2::addon_list::select_first_addon(), and set_active_sorter().

◆ set_active_sorter()

void gui2::listbox::set_active_sorter	(	std::string_view	id,
		sort_order::type	order,
		bool	select_first = `false`
	)

Sorts the listbox by a pre-set sorting option.

The corresponding header widget will also be toggled. The sorting option should already have been registered by listbox::set_sorters().

Parameters

id	The id of the sorter widget whose value to set.
order	The order to sort by (ascending, descending, or none).
select_first	If true, the first row post-sort will be selected. If false (default), the selected row will be maintained post-sort as per standard sorting functionality.

Definition at line 617 of file listbox.cpp.

References _(), generator_, gui2::generator_base::get_item_count(), orders_, select_row_at(), utils::to_underlying(), and w.

Referenced by gui2::addon_list::finalize_setup(), gui2::dialogs::unit_create::pre_show(), and gui2::dialogs::unit_recall::pre_show().

◆ set_callback_order_change()

void gui2::listbox::set_callback_order_change ( std::function< void(unsigned, sort_order::type)> callback )

inline

Registers a callback to be called when the active sorting option changes.

Definition at line 331 of file listbox.hpp.

References callback_order_change_.

Referenced by gui2::addon_list::set_callback_order_change().

◆ set_content_size()

void gui2::listbox::set_content_size	(	const point &	origin,
		const point &	size
	)

overrideprivatevirtual

Inherited from scrollbar_container.

Todo:: This function needs more testing.

Reimplemented from gui2::scrollbar_container.

Definition at line 654 of file listbox.cpp.

References gui2::scrollbar_container::content_grid(), gui2::widget::get_best_size(), gui2::grid::place(), s, and utf8::size().

◆ set_row_active()

void gui2::listbox::set_row_active	(	const unsigned	row,
		const bool	active
	)

Makes a row active or inactive.

NOTE this doesn't change the select status of the row.

Parameters

row	The row to (de)activate.
active	true activate, false deactivate.

Definition at line 165 of file listbox.cpp.

References generator_, gui2::generator_base::item(), and gui2::grid::set_active().

◆ set_row_shown() [1/2]

void gui2::listbox::set_row_shown ( const boost::dynamic_bitset<> & shown )

Makes a row visible or invisible.

Use this version if you want to show hide multiple items since it's optimized for that purpose, for one it calls the selection changed callback only once instead of several times.

Parameters

shown A vector with the show hide status for every row. The number of items in the vector must be equal to the number of items in the listbox.

Definition at line 206 of file listbox.cpp.

References gui2::generator_base::calculate_best_size(), gui2::scrollbar_container::content_grid_, gui2::scrollbar_container::content_resize_request(), gui2::scrollbar_container::content_visible_area(), gui2::event::dispatcher::fire(), generator_, get_item_count(), gui2::generator_base::get_items_shown(), gui2::widget::get_origin(), get_selected_row(), gui2::widget::get_window(), i, gui2::window::invalidate_layout(), LOG_GUI_G, LOG_HEADER, gui2::event::NOTIFY_MODIFIED, gui2::generator_base::place(), gui2::widget::queue_redraw(), and gui2::generator_base::set_item_shown().

◆ set_row_shown() [2/2]

void gui2::listbox::set_row_shown	(	const unsigned	row,
		const bool	shown
	)

Makes a row visible or invisible.

Parameters

row	The row to show or hide.
shown	true visible, false invisible.

Definition at line 171 of file listbox.cpp.

References gui2::generator_base::calculate_best_size(), gui2::scrollbar_container::content_grid_, gui2::scrollbar_container::content_resize_request(), gui2::scrollbar_container::content_visible_area(), gui2::event::dispatcher::fire(), generator_, gui2::widget::get_origin(), get_selected_row(), gui2::widget::get_window(), gui2::window::invalidate_layout(), gui2::event::NOTIFY_MODIFIED, gui2::generator_base::place(), gui2::widget::queue_redraw(), and gui2::generator_base::set_item_shown().

Referenced by filter_rows_by(), gui2::dialogs::mp_create_game::on_filter_change(), gui2::addon_list::set_addon_shown(), gui2::dialogs::language_selection::shown_filter_callback(), and gui2::dialogs::mp_lobby::update_visible_games().

◆ set_self_active()

void gui2::listbox::set_self_active ( const bool active )

overridevirtual

See container_base::set_self_active.

Implements gui2::container_base.

Definition at line 357 of file listbox.cpp.

◆ set_single_sorter()

template<typename Func >

void gui2::listbox::set_single_sorter	(	std::string_view	id,
		const Func &	f
	)

inline

Registers a single sorting control by ID.

Parameters

id	The ID of the selectable_item header widget to bind to.
f	Any callable whose result is sortable.

Definition at line 288 of file listbox.hpp.

References f, initialize_sorter(), gui2::listbox::sort_helper::less(), and gui2::listbox::sort_helper::more().

Referenced by set_sorters_impl().

◆ set_sorters()

template<typename... Args>

void gui2::listbox::set_sorters ( Args &&... functors )

inline

Registers sorting controls using magic index IDs.

This function accepts any callable whose result is sortable. Each callable passed will be bound to a corresponding selectable_item widget in the header, if present, whose ID is sort_N, where N is the index of the callable in the parameter pack.

Parameters

functors Zero or more callables with the signature T(std::size_t).

Definition at line 306 of file listbox.hpp.

References set_sorters_impl().

Referenced by gui2::addon_list::finalize_setup(), gui2::dialogs::game_load::pre_show(), gui2::dialogs::game_stats::pre_show(), gui2::dialogs::unit_create::pre_show(), gui2::dialogs::unit_list::pre_show(), and gui2::dialogs::unit_recall::pre_show().

◆ set_sorters_impl()

template<std::size_t... Is, typename... Args>

void gui2::listbox::set_sorters_impl	(	std::index_sequence< Is... >	,
		Args &&...	fs
	)

inlineprivate

Implementation detail of set_sorters.

Definition at line 275 of file listbox.hpp.

References set_single_sorter().

Referenced by set_sorters().

◆ type()

static const std::string& gui2::listbox::type ( )

static

Static type getter that does not rely on the widget being constructed.

◆ update_content_size()

bool gui2::listbox::update_content_size ( )

Request to update the size of the content after changing the content.

When a resize is required the container first can try to handle it itself. If it can't honor the request the function will call window::invalidate_layout().

Note: Calling this function on a widget with size == (0, 0) results false but doesn't call invalidate_layout, the engine expects to be in build up phase with the layout already invalidated.

Returns: True if the resizing succeeded, false otherwise.

Definition at line 362 of file listbox.cpp.

References gui2::scrollbar_container::content_grid_, gui2::scrollbar_container::content_resize_request(), gui2::scrollbar_container::content_visible_area(), gui2::widget::get_size(), gui2::widget::get_visible(), gui2::widget::invisible, draw::point(), and gui2::widget::queue_redraw().

Referenced by clear(), and remove_row().

◆ update_layout()

void gui2::listbox::update_layout ( )

private

Updates internal layout.

Definition at line 665 of file listbox.cpp.

References gui2::scrollbar_container::content_grid(), gui2::scrollbar_container::content_visible_area_, gui2::widget::get_origin(), gui2::widget::get_size(), gui2::grid::place(), gui2::widget::queue_redraw(), gui2::grid::set_visible_rectangle(), and utf8::size().

Referenced by order_by(), and resize_content().

◆ update_visible_area_on_key_event()

void gui2::listbox::update_visible_area_on_key_event ( const KEY_SCROLL_DIRECTION direction )

private

Helper to update visible area after a key event.

Definition at line 481 of file listbox.cpp.

References gui2::scrollbar_container::content_visible_area(), gui2::event::dispatcher::fire(), generator_, gui2::widget::get_rectangle(), gui2::generator_base::get_selected_item(), gui2::generator_base::item(), KEY_VERTICAL, gui2::event::NOTIFY_MODIFIED, and gui2::scrollbar_container::show_content_rect().

Referenced by handle_key_down_arrow(), handle_key_left_arrow(), handle_key_right_arrow(), and handle_key_up_arrow().

Friends And Related Function Documentation

◆ debug_layout_graph

friend class debug_layout_graph

friend

Definition at line 44 of file listbox.hpp.

◆ implementation::builder_listbox_base

friend struct implementation::builder_listbox_base

friend

Definition at line 42 of file listbox.hpp.

Member Data Documentation

◆ callback_order_change_

std::function<void(unsigned, sort_order::type)> gui2::listbox::callback_order_change_

private

Definition at line 389 of file listbox.hpp.

Referenced by order_by_column(), and set_callback_order_change().

◆ generator_

generator_base* gui2::listbox::generator_

private

Contains a pointer to the generator.

Todo:

A listbox must have the following config parameters in the instantiation:

fixed row height?
fixed column width? and if so the following ways to set them
fixed depending on header ids
fixed depending on footer ids
fixed depending on first row ids
fixed depending on list (the user has to enter a list of ids)

For now it's always fixed width depending on the first row.

The pointer is not owned by this class, it's stored in the content_grid_ of the scrollbar_container super class and freed when it's grid is freed.

Definition at line 380 of file listbox.hpp.

Referenced by add_row(), clear(), get_item_count(), get_row_grid(), get_rows_shown(), get_selected_row(), handle_key_down_arrow(), handle_key_left_arrow(), handle_key_right_arrow(), handle_key_up_arrow(), list_item_clicked(), order_by(), place(), remove_row(), row_selected(), select_row(), select_row_at(), set_active_sorter(), set_row_active(), set_row_shown(), and update_visible_area_on_key_event().

◆ list_builder_

builder_grid_const_ptr gui2::listbox::list_builder_

private

Contains the builder for the new items.

Definition at line 385 of file listbox.hpp.

Referenced by add_row().

◆ orders_

std::vector<std::pair<selectable_item*, generator_sort_array> > gui2::listbox::orders_

private

Definition at line 387 of file listbox.hpp.

Referenced by get_active_sorter(), initialize_sorter(), mark_as_unsorted(), order_by_column(), and set_active_sorter().

◆ placement_

generator_base::placement gui2::listbox::placement_

private

Definition at line 382 of file listbox.hpp.

Referenced by remove_row().

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

gui/widgets/listbox.hpp
gui/widgets/listbox.cpp

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ KEY_SCROLL_DIRECTION

Constructor & Destructor Documentation

◆ listbox()

Member Function Documentation

◆ add_row() [1/2]

◆ add_row() [2/2]

◆ calculate_best_size()

◆ clear()

◆ filter_rows_by()

◆ get_active_sorter()

◆ get_control_type()

◆ get_item_count()

◆ get_row_grid() [1/2]

◆ get_row_grid() [2/2]

◆ get_rows_shown()

◆ get_selected_row()

◆ handle_key_down_arrow()

◆ handle_key_left_arrow()

◆ handle_key_right_arrow()

◆ handle_key_up_arrow()

◆ initialize_sorter()

◆ list_item_clicked()

◆ mark_as_unsorted()

◆ order_by()

◆ order_by_column()

◆ place()

◆ remove_row()

◆ resize_content() [1/2]

◆ resize_content() [2/2]

◆ row_selected()

◆ select_last_row()

◆ select_row()

◆ select_row_at()

◆ set_active_sorter()

◆ set_callback_order_change()

◆ set_content_size()

◆ set_row_active()

◆ set_row_shown() [1/2]

◆ set_row_shown() [2/2]

◆ set_self_active()

◆ set_single_sorter()

◆ set_sorters()

◆ set_sorters_impl()

◆ type()

◆ update_content_size()

◆ update_layout()

◆ update_visible_area_on_key_event()

Friends And Related Function Documentation

◆ debug_layout_graph

◆ implementation::builder_listbox_base

Member Data Documentation

◆ callback_order_change_

◆ generator_

◆ list_builder_

◆ orders_

◆ placement_