The Battle for Wesnoth  1.13.10+dev
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Types | Public Member Functions | Protected Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
gui2::listbox Class Reference

The listbox class. More...

#include <listbox.hpp>

Inheritance diagram for gui2::listbox:
Inheritance graph

Public Types

enum  SORT_ORDER { SORT_NONE, SORT_ASCENDING, SORT_DESCENDING }
 
using order_pair = std::pair< int, SORT_ORDER >
 
- 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  visibility { visibility::visible, visibility::hidden, visibility::invisible }
 Visibility settings done by the user. More...
 
enum  redraw_action { redraw_action::full, redraw_action::partly, redraw_action::none }
 Visibility set by the engine. More...
 
- 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  mouse_behavior { all, hit, none }
 The behavior of the mouse events. More...
 

Public Member Functions

 listbox (const implementation::builder_styled_widget &builder, const generator_base::placement placement, builder_grid_ptr list_builder, const bool has_minimum, const bool has_maximum, const bool select=true)
 Constructor. More...
 
gridadd_row (const string_map &item, const int index=-1)
 When an item in the list is selected by the user we need to update the state. More...
 
gridadd_row (const std::map< std::string, string_map > &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...
 
boost::dynamic_bitset get_rows_shown () const
 Returns a list of visible rows. More...
 
bool any_rows_shown () const
 
const gridget_row_grid (const unsigned row) const
 Returns the grid of the wanted row. More...
 
gridget_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_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...
 
virtual void layout_children () override
 See widget::layout_children. More...
 
virtual void child_populate_dirty_list (window &caller, const std::vector< widget * > &call_stack) override
 See widget::child_populate_dirty_list. More...
 
void order_by (const generator_base::order_func &func)
 
void set_column_order (unsigned col, const generator_sort_array &func)
 
template<typename Func >
void register_sorting_option (const int col, const Func &f)
 
void set_active_sorting_option (const order_pair &sort_by, const bool select_first=false)
 Sorts the listbox by a pre-set sorting option. More...
 
const order_pair get_active_sorting_option ()
 
- Public Member Functions inherited from gui2::scrollbar_container
 scrollbar_container (const implementation::builder_styled_widget &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 widgetfind_at (const point &coordinate, const bool must_be_active) override
 See widget::find_at. More...
 
virtual const widgetfind_at (const point &coordinate, const bool must_be_active) const override
 See widget::find_at. More...
 
widgetfind (const std::string &id, const bool must_be_active) override
 See widget::find. More...
 
const widgetfind (const std::string &id, const bool must_be_active) const override
 See widget::find. More...
 
bool disable_click_dismiss () const override
 See widget::disable_click_dismiss. 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
 
gridcontent_grid ()
 
const gridcontent_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 vertical_scrollbar_moved ()
 Callback when the scrollbar moves (NOTE maybe only one callback needed). More...
 
void horizontal_scrollbar_moved ()
 
scrollbar_basehorizontal_scrollbar ()
 
scrollbar_basevertical_scrollbar ()
 
gridget_horizontal_scrollbar_grid ()
 
gridget_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...
 
virtual iteration::walker_basecreate_walker () override
 See widget::create_walker. More...
 
void init_grid (const std::shared_ptr< 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 (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 gridget_grid () const
 
gridget_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 string_map &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...
 
widgetfind (const std::string &id, const bool must_be_active) override
 See widget::find. More...
 
const widgetfind (const std::string &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_stringget_label () const
 
virtual void set_label (const t_string &label)
 
virtual void set_use_markup (bool use_markup)
 
bool get_use_markup () const
 
const t_stringtooltip () const
 
void set_tooltip (const t_string &tooltip)
 
const t_stringhelp_message () const
 
void set_help_message (const t_string &help_message)
 
std::vector< canvas > & get_canvases ()
 
canvasget_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...
 
- Public Member Functions inherited from gui2::widget
 widget (const widget &)=delete
 
widgetoperator= (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
 
windowget_window ()
 Get the parent window. More...
 
const windowget_window () const
 The constant version of get_window. More...
 
gridget_parent_grid ()
 Get the parent grid. More...
 
dialogs::modal_dialogdialog ()
 Returns the top-level dialog. More...
 
void set_parent (widget *parent)
 
widgetparent ()
 
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...
 
SDL_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)
 
SDL_Rect calculate_blitting_rectangle (const int x_offset, const int y_offset)
 Calculates the blitting rectangle of the widget. More...
 
SDL_Rect calculate_clipping_rectangle (const int x_offset, const int y_offset)
 Calculates the clipping rectangle of the widget. More...
 
void draw_background (surface &frame_buffer, int x_offset, int y_offset)
 Draws the background of a widget. More...
 
void draw_children (surface &frame_buffer, int x_offset, int y_offset)
 Draws the children of a widget. More...
 
void draw_foreground (surface &frame_buffer, int x_offset, int y_offset)
 Draws the foreground of the widget. More...
 
void populate_dirty_list (window &caller, std::vector< widget * > &call_stack)
 Adds a widget to the dirty list if it is dirty. More...
 
SDL_Rect get_dirty_rectangle () const
 Gets the dirty rectangle of the widget. More...
 
void set_is_dirty (const bool is_dirty)
 
bool get_is_dirty () const
 
void set_visible (const visibility visible)
 
visibility get_visible () const
 
redraw_action get_drawing_action () const
 
void set_debug_border_mode (const unsigned debug_border_mode)
 
void set_debug_border_color (const color_t debug_border_color)
 
- 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_executorset_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...
 
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 utf8::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 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, 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>
utils::enable_if_t< has_key
< set_event, E >::value > 
connect_signal (const signal_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_event. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event, E >::value > 
disconnect_signal (const signal_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_event. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_mouse, E >::value > 
connect_signal (const signal_mouse_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_event_mouse. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_mouse, E >::value > 
disconnect_signal (const signal_mouse_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_event_mouse. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_keyboard, E >
::value > 
connect_signal (const signal_keyboard_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_event_keyboard. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_keyboard, E >
::value > 
disconnect_signal (const signal_keyboard_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_event_keyboard. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_touch, E >::value > 
connect_signal (const signal_touch_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_event_touch. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_touch, E >::value > 
disconnect_signal (const signal_touch_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_event_touch. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_notification, E >
::value > 
connect_signal (const signal_notification_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_event_notification. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_notification, E >
::value > 
disconnect_signal (const signal_notification_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_event_notification. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_message, E >
::value > 
connect_signal (const signal_message_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_event_message. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_message, E >
::value > 
disconnect_signal (const signal_message_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_event_message. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_raw_event, E >
::value > 
connect_signal (const signal_raw_event_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_raw_event. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_raw_event, E >
::value > 
disconnect_signal (const signal_raw_event_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_raw_event. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_text_input, E >
::value > 
connect_signal (const signal_text_input_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_text_input. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_text_input, E >
::value > 
disconnect_signal (const signal_text_input_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_text_input. 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...
 

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...
 
- Protected Member Functions inherited from gui2::styled_widget
resolution_definition_ptr config ()
 
resolution_definition_const_ptr 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...
 
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 void impl_draw_background (surface &frame_buffer, int x_offset, int y_offset) override
 See widget::impl_draw_background. More...
 
virtual void impl_draw_foreground (surface &frame_buffer, int x_offset, int y_offset) 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 pointlayout_size () const
 
void clear_layout_size ()
 Throws away layout_size_. More...
 

Private Types

enum  KEY_SCROLL_DIRECTION { KEY_VERTICAL, KEY_HORIZONTAL }
 
typedef std::vector< std::pair
< selectable_item
*, generator_sort_array > > 
torder_list
 

Private Member Functions

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 finalize (builder_grid_const_ptr header, builder_grid_const_ptr footer, const std::vector< std::map< std::string, string_map >> &list_data)
 Finishes the building initialization of the widget. 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 layout_children (const bool force)
 Layouts the children if needed. 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_basegenerator_
 Contains a pointer to the generator. More...
 
const bool is_horizontal_
 
builder_grid_const_ptr list_builder_
 Contains the builder for the new items. More...
 
bool need_layout_
 
torder_list orders_
 

Friends

struct implementation::builder_listbox
 
struct implementation::builder_horizontal_listbox
 
struct implementation::builder_grid_listbox
 
class debug_layout_graph
 

Detailed Description

The listbox class.

Definition at line 41 of file listbox.hpp.

Member Typedef Documentation

using gui2::listbox::order_pair = std::pair<int, SORT_ORDER>

Definition at line 274 of file listbox.hpp.

typedef std::vector<std::pair<selectable_item*, generator_sort_array> > gui2::listbox::torder_list
private

Definition at line 355 of file listbox.hpp.

Member Enumeration Documentation

Enumerator
KEY_VERTICAL 
KEY_HORIZONTAL 

Definition at line 310 of file listbox.hpp.

Enumerator
SORT_NONE 
SORT_ASCENDING 
SORT_DESCENDING 

Definition at line 268 of file listbox.hpp.

Constructor & Destructor Documentation

gui2::listbox::listbox ( const implementation::builder_styled_widget builder,
const generator_base::placement  placement,
builder_grid_ptr  list_builder,
const bool  has_minimum,
const bool  has_maximum,
const bool  select = true 
)

Constructor.

Parameters
builderThe builder for the appropriate listbox variant.
placementHow are the items placed.
list_builderGrid builder for the listbox definition grid.
has_minimumDoes the listbox need to have one item selected.
has_maximumCan the listbox only have one item selected.
selectSelect an item when selected. If false it changes the visible state instead. Default true.

Definition at line 52 of file listbox.cpp.

Member Function Documentation

grid & gui2::listbox::add_row ( const string_map 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
itemThe data send to the set_members of the widgets.
indexThe item before which to add the new item, 0 == begin, -1 == end.

Definition at line 67 of file listbox.cpp.

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

Referenced by gui2::dialogs::statistics_dialog::add_damage_row(), gui2::dialogs::preferences_dialog::add_friend_list_entry(), gui2::dialogs::statistics_dialog::add_stat_row(), gui2::dialogs::mp_create_game::display_games_of_type(), gui2::dialogs::game_load::display_savegame(), gui2::chatbox::find_or_create_window(), gui2::dialogs::file_dialog::on_bookmark_add_cmd(), gui2::dialogs::statistics_dialog::on_primary_list_select(), gui2::dialogs::preferences_dialog::post_build(), gui2::dialogs::language_selection::pre_show(), gui2::dialogs::unit_advance::pre_show(), gui2::dialogs::unit_recruit::pre_show(), gui2::dialogs::mp_change_control::pre_show(), gui2::dialogs::label_settings::pre_show(), gui2::dialogs::unit_attack::pre_show(), gui2::dialogs::log_settings::pre_show(), gui2::dialogs::editor_set_starting_position::pre_show(), gui2::dialogs::game_load::pre_show(), gui2::dialogs::core_selection::pre_show(), gui2::dialogs::editor_generate_map::pre_show(), gui2::dialogs::addon_uninstall_list::pre_show(), gui2::dialogs::mp_create_game::pre_show(), gui2::dialogs::depcheck_select_new::pre_show(), gui2::dialogs::theme_list::pre_show(), gui2::dialogs::campaign_difficulty::pre_show(), gui2::dialogs::unit_list::pre_show(), gui2::dialogs::game_stats::pre_show(), gui2::dialogs::unit_recall::pre_show(), gui2::dialogs::unit_create::pre_show(), gui2::dialogs::game_version::pre_show(), gui2::dialogs::drop_down_menu::pre_show(), gui2::dialogs::simple_item_selector::pre_show(), gui2::dialogs::wml_message_base::pre_show(), gui2::dialogs::file_dialog::pre_show(), gui2::dialogs::file_dialog::push_fileview_row(), gui2::addon_list::set_addons(), gui2::dialogs::preferences_dialog::setup_hotkey_list(), gui2::dialogs::mp_lobby::update_gamelist(), gui2::dialogs::mp_lobby::update_gamelist_diff(), gui2::dialogs::mp_join_game::update_player_list(), and gui2::dialogs::mp_staging::update_player_list().

grid & gui2::listbox::add_row ( const std::map< std::string, string_map > &  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
dataThe 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.
indexThe item before which to add the new item, 0 == begin, -1 == end.

Definition at line 77 of file listbox.cpp.

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

bool gui2::listbox::any_rows_shown ( ) const
point gui2::listbox::calculate_best_size ( ) const
overrideprivatevirtual
void gui2::listbox::child_populate_dirty_list ( window caller,
const std::vector< widget * > &  call_stack 
)
overridevirtual
void gui2::listbox::clear ( )
void gui2::listbox::finalize ( builder_grid_const_ptr  header,
builder_grid_const_ptr  footer,
const std::vector< std::map< std::string, string_map >> &  list_data 
)
private

Finishes the building initialization of the widget.

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.

Parameters
headerBuilder for the header.
footerBuilder for the footer.
list_dataThe initial data to fill the listbox with.

Definition at line 543 of file listbox.cpp.

References gui2::event::connect_signal_notify_modified(), gui2::scrollbar_container::content_grid(), gui2::generator_base::create_items(), gui2::scrollbar_container::finalize_setup(), generator_, gui2::grid::get_cols(), gui2::container_base::get_grid(), gui2::grid::get_rows(), i, list_builder_, list_item_clicked(), order_by_column(), orders_, p, and gui2::swap_grid().

Referenced by gui2::implementation::builder_listbox::build(), gui2::implementation::builder_horizontal_listbox::build(), and gui2::implementation::builder_grid_listbox::build().

const listbox::order_pair gui2::listbox::get_active_sorting_option ( )

Definition at line 646 of file listbox.cpp.

References gui2::selectable_item::get_value(), orders_, SORT_NONE, and w.

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

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

Inherited from styled_widget, implemented by REGISTER_WIDGET.

Reimplemented from gui2::scrollbar_container.

unsigned gui2::listbox::get_item_count ( ) const

Returns the number of items in the listbox.

Definition at line 132 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(), any_rows_shown(), gui2::dialogs::game_load::delete_button_callback(), gui2::dialogs::unit_recall::dismiss_unit(), gui2::dialogs::mp_create_game::display_games_of_type(), gui2::dialogs::game_load::filter_text_changed(), gui2::dialogs::unit_recall::filter_text_changed(), gui2::dialogs::unit_create::filter_text_changed(), gui2::dialogs::drop_down_menu::get_toggle_states(), gui2::dialogs::mp_create_game::on_filter_change(), gui2::dialogs::preferences_dialog::post_build(), gui2::dialogs::addon_uninstall_list::post_show(), gui2::dialogs::language_selection::pre_show(), gui2::dialogs::unit_attack::pre_show(), gui2::dialogs::editor_generate_map::pre_show(), gui2::dialogs::mp_create_game::pre_show(), gui2::dialogs::theme_list::pre_show(), gui2::dialogs::campaign_difficulty::pre_show(), gui2::dialogs::unit_create::pre_show(), gui2::dialogs::game_version::pre_show(), gui2::dialogs::drop_down_menu::pre_show(), gui2::dialogs::simple_item_selector::pre_show(), gui2::dialogs::file_dialog::push_fileview_row(), remove_row(), gui2::addon_list::select_addon(), set_row_shown(), gui2::dialogs::file_dialog::sync_bookmarks_bar(), gui2::dialogs::preferences_dialog::update_friends_list_controls(), gui2::dialogs::mp_lobby::update_gamelist_diff(), and gui2::dialogs::mp_lobby::update_gamelist_filter().

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

The possibly-giving-problems nonconst version of get_row_grid.

Parameters
rowThe 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 245 of file listbox.cpp.

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

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 222 of file listbox.cpp.

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

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

int gui2::listbox::get_selected_row ( ) const
void gui2::listbox::handle_key_down_arrow ( SDL_Keymod  modifier,
bool &  handled 
)
overrideprotectedvirtual
void gui2::listbox::handle_key_left_arrow ( SDL_Keymod  modifier,
bool &  handled 
)
overrideprotectedvirtual
void gui2::listbox::handle_key_right_arrow ( SDL_Keymod  modifier,
bool &  handled 
)
overrideprotectedvirtual
void gui2::listbox::handle_key_up_arrow ( SDL_Keymod  modifier,
bool &  handled 
)
overrideprotectedvirtual
void gui2::listbox::layout_children ( )
overridevirtual

See widget::layout_children.

Reimplemented from gui2::scrollbar_container.

Definition at line 435 of file listbox.cpp.

void gui2::listbox::layout_children ( const bool  force)
private
void gui2::listbox::list_item_clicked ( widget caller)
void gui2::listbox::order_by ( const generator_base::order_func func)
void gui2::listbox::order_by_column ( unsigned  column,
widget widget 
)
private
void gui2::listbox::place ( const point origin,
const point size 
)
overridevirtual
template<typename Func >
void gui2::listbox::register_sorting_option ( const int  col,
const Func &  f 
)
inline
void gui2::listbox::remove_row ( const unsigned  row,
unsigned  count = 1 
)
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_modificationThe wanted modification to the width:
  • negative values reduce width.
  • zero leave width as is.
  • positive values increase width.
height_modificationThe wanted modification to the height:
  • negative values reduce height.
  • zero leave height as is.
  • positive values increase height.

Definition at line 381 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, need_layout_, gui2::widget::set_is_dirty(), gui2::widget::set_size(), utf8::size(), point::x, and point::y.

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

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
rowThe new row added to the listbox.

Definition at line 414 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(), utf8::size(), point::x, and point::y.

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

Check if a row is selected.

Parameters
rowThe row to test
Returns
True if it is selected.

Definition at line 267 of file listbox.cpp.

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

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

Selects a row.

Parameters
rowThe row to select.
selectSelect or deselect the row.
Returns
True if the operation succeeded.

Definition at line 251 of file listbox.cpp.

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

Referenced by gui2::chatbox::close_window(), gui2::dialogs::mp_create_game::display_games_of_type(), gui2::dialogs::file_dialog::on_bookmark_selected(), gui2::dialogs::language_selection::pre_show(), gui2::dialogs::statistics_dialog::pre_show(), gui2::dialogs::unit_attack::pre_show(), gui2::dialogs::editor_set_starting_position::pre_show(), gui2::dialogs::core_selection::pre_show(), gui2::dialogs::editor_generate_map::pre_show(), gui2::dialogs::depcheck_select_new::pre_show(), gui2::dialogs::theme_list::pre_show(), gui2::dialogs::campaign_difficulty::pre_show(), gui2::dialogs::unit_create::pre_show(), gui2::dialogs::game_version::pre_show(), gui2::dialogs::drop_down_menu::pre_show(), gui2::dialogs::preferences_dialog::pre_show(), gui2::dialogs::simple_item_selector::pre_show(), gui2::dialogs::wml_message_base::pre_show(), gui2::dialogs::file_dialog::push_fileview_row(), gui2::dialogs::file_dialog::refresh_fileview(), gui2::addon_list::select_addon(), select_row_at(), gui2::chatbox::switch_to_window(), gui2::dialogs::file_dialog::sync_bookmarks_bar(), gui2::dialogs::preferences_dialog::update_friends_list_controls(), gui2::dialogs::mp_lobby::update_gamelist(), and gui2::dialogs::mp_lobby::update_gamelist_diff().

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
rowThe row to select.
selectSelect or deselect the row.
Returns
True if the operation succeeded.

Definition at line 261 of file listbox.cpp.

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

Referenced by set_active_sorting_option().

void gui2::listbox::set_active_sorting_option ( const order_pair sort_by,
const 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::register_sorting_option().

Parameters
sort_byPair of column index and sort direction. The column (first arguemnt) argument will be sorted in the specified direction (second argument)
select_firstIf 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 627 of file listbox.cpp.

References generator_, gui2::generator_base::get_item_count(), order_by_column(), select_row_at(), and w.

Referenced by gui2::dialogs::preferences_dialog::default_hotkey_callback(), gui2::addon_list::finalize_setup(), gui2::dialogs::preferences_dialog::post_build(), and gui2::dialogs::unit_recall::pre_show().

void gui2::listbox::set_column_order ( unsigned  col,
const generator_sort_array func 
)

Definition at line 618 of file listbox.cpp.

References orders_.

Referenced by gui2::dialogs::unit_recall::pre_show(), and register_sorting_option().

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 659 of file listbox.cpp.

References gui2::scrollbar_container::content_grid(), gui2::widget::get_best_size(), gui2::grid::place(), s, point::x, and point::y.

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
rowThe row to (de)activate.
activetrue activate, false deactivate.

Definition at line 138 of file listbox.cpp.

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

void gui2::listbox::set_row_shown ( const unsigned  row,
const bool  shown 
)
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
shownA 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 179 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::set_is_dirty(), gui2::generator_base::set_item_shown(), w, point::x, and point::y.

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

See container_base::set_self_active.

Implements gui2::container_base.

Definition at line 325 of file listbox.cpp.

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 330 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, and gui2::widget::set_is_dirty().

Referenced by clear(), and remove_row().

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

Friends And Related Function Documentation

friend class debug_layout_graph
friend

Definition at line 46 of file listbox.hpp.

Definition at line 45 of file listbox.hpp.

Definition at line 44 of file listbox.hpp.

friend struct implementation::builder_listbox
friend

Definition at line 43 of file listbox.hpp.

Member Data Documentation

generator_base* gui2::listbox::generator_
private
const bool gui2::listbox::is_horizontal_
private

Definition at line 348 of file listbox.hpp.

Referenced by remove_row().

builder_grid_const_ptr gui2::listbox::list_builder_
private

Contains the builder for the new items.

Definition at line 351 of file listbox.hpp.

Referenced by add_row(), and finalize().

bool gui2::listbox::need_layout_
private

Definition at line 353 of file listbox.hpp.

Referenced by layout_children(), order_by(), and resize_content().

torder_list gui2::listbox::orders_
private

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