#include <addon_list.hpp>

Inheritance diagram for gui2::addon_list:

Public Types
using	addon_sort_func = std::function< bool(const addon_info &, const addon_info &)>

using	addon_op_func_t = std::function< void(const addon_info &)>

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...

Public Member Functions
	addon_list (const implementation::builder_addon_list &builder)

const std::string	display_title_full_shift (const addon_info &addon) const

void	set_addons (const addons_list &addons)
	Sets the add-ons to show. More...

void	set_modified_signal_handler (const std::function< void()> &callback)
	Sets up a callback that will be called when the player selects an add-on. More...

const addon_info *	get_selected_addon () const
	Returns the selected add-on. More...

std::string	get_remote_addon_id ()
	Returns the selected add-on id, for use with remote publish/delete ops. More...

void	select_addon (const std::string &id)
	Selects the add-on with the given ID. More...

void	addon_action_wrapper (addon_op_func_t &func, const addon_info &addon, bool &handled, bool &halt)
	Helper to wrap the execution of any of the addon operation functions. More...

void	set_install_function (addon_op_func_t function)
	Sets the function to call when the player clicks the install button. More...

void	set_uninstall_function (addon_op_func_t function)
	Sets the function to call when the player clicks the uninstall button. More...

void	set_update_function (addon_op_func_t function)
	Sets the function to call when the player clicks the update button. More...

void	set_publish_function (addon_op_func_t function)
	Sets the function to upload an addon to the addons server. More...

void	set_delete_function (addon_op_func_t function)
	Sets the function to install an addon from the addons server. More...

void	set_addon_shown (boost::dynamic_bitset<> &shown)
	Filters which add-ons are visible. More...

void	set_addon_order (addon_sort_func func)

void	set_install_status_visibility (visibility visibility)
	Determines if install status of each widget is shown. More...

void	set_install_buttons_visibility (visibility visibility)
	Determines if install/uninstall buttons are shown for each widget. More...

void	add_list_to_keyboard_chain ()
	Adds the internal listbox to the keyboard event chain. More...

void	set_callback_order_change (std::function< void(unsigned, sort_order::type)> callback)
	Sets up a callback that will be called when the player changes the sorting order. More...

virtual void	set_active (const bool) override
	See styled_widget::set_active. 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...

void	select_first_addon ()
	Choose the item at the top of the list (taking account of sort order). More...

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...

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

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

virtual void	request_reduce_width (const unsigned maximum_width) override
	See widget::request_reduce_width. 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	request_reduce_height (const unsigned maximum_height) override
	See widget::request_reduce_height. More...

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

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

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

virtual bool	has_widget (const widget &widget) const override
	See widget::has_widget. 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 void	impl_draw_children () override
	See widget::impl_draw_children. 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 &id, const bool must_be_active) override
	See widget::find. More...

const widget *	find (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...

virtual iteration::walker_ptr	create_walker () override
	See widget::create_walker. 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 &id, const bool must_be_active) override
	See widget::find. More...

const widget *	find (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_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

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 >
NOT_DANGLING T *	find_widget (const std::string &id, const bool must_be_active, const bool must_exist)
	Gets a widget with the wanted id. More...

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

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

template<class T >
NOT_DANGLING const T &	find_widget (const std::string &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 std::string	colorize_addon_state_string (const std::string &str, ADDON_STATUS state, bool verbose=false)
	Changes the color of an add-on state string (installed, outdated, etc.) according to the state itself. More...

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

Static Public Attributes
static const int	DEFAULT_ACTION_RETVAL = 200
	Special retval for the toggle panels in the addons list. More...

Private Member Functions
listbox &	get_listbox ()
	Returns the underlying list box. More...

void	finalize_setup ()

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

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

Static Private Member Functions
static std::string	describe_status (const addon_tracking_info &info)

Private Attributes
std::vector< const addon_info * >	addon_vector_

visibility	install_status_visibility_

visibility	install_buttons_visibility_

addon_op_func_t	install_function_

addon_op_func_t	uninstall_function_

addon_op_func_t	update_function_

addon_op_func_t	publish_function_

addon_op_func_t	delete_function_

Friends
struct	implementation::builder_addon_list

Additional Inherited Members
Protected Member Functions inherited from gui2::container_base
virtual point	calculate_best_size () const override
	See widget::calculate_best_size. More...

virtual void	layout_children () override
	See widget::layout_children. 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...

Detailed Description

Definition at line 35 of file addon_list.hpp.

Member Typedef Documentation

◆ addon_op_func_t

using gui2::addon_list::addon_op_func_t = std::function<void(const addon_info&)>

Definition at line 67 of file addon_list.hpp.

◆ addon_sort_func

using gui2::addon_list::addon_sort_func = std::function<bool(const addon_info&, const addon_info&)>

Definition at line 40 of file addon_list.hpp.

Constructor & Destructor Documentation

◆ addon_list()

gui2::addon_list::addon_list ( const implementation::builder_addon_list & builder )

explicit

Definition at line 51 of file addon_list.cpp.

Member Function Documentation

◆ add_list_to_keyboard_chain()

void gui2::addon_list::add_list_to_keyboard_chain ( )

Adds the internal listbox to the keyboard event chain.

Definition at line 367 of file addon_list.cpp.

References gui2::window::add_to_keyboard_chain(), get_listbox(), and gui2::widget::get_window().

Referenced by gui2::dialogs::addon_manager::pre_show().

◆ addon_action_wrapper()

void gui2::addon_list::addon_action_wrapper	(	addon_op_func_t &	func,
		const addon_info &	addon,
		bool &	handled,
		bool &	halt
	)

Helper to wrap the execution of any of the addon operation functions.

It catches addons_client::user_exit exceptions and halts GUI2 event execution after calling the given function.

Definition at line 135 of file addon_list.cpp.

Referenced by set_addons().

◆ colorize_addon_state_string()

std::string gui2::addon_list::colorize_addon_state_string	(	const std::string &	str,
		ADDON_STATUS	state,
		bool	verbose = `false`
	)

static

Changes the color of an add-on state string (installed, outdated, etc.) according to the state itself.

This function is here because the add-on list widget itself needs it.

Definition at line 63 of file addon_list.cpp.

References ADDON_INSTALLED, ADDON_INSTALLED_BROKEN, ADDON_INSTALLED_LOCAL_ONLY, ADDON_INSTALLED_OUTDATED, ADDON_INSTALLED_UPGRADABLE, ADDON_NONE, ADDON_NOT_TRACKED, font::BAD_COLOR, font::GOOD_COLOR, font::GRAY_COLOR, font::NORMAL_COLOR, markup::span_color(), font::weapon_details_color, and font::YELLOW_COLOR.

Referenced by describe_status(), gui2::dialogs::describe_status_verbose(), and set_addons().

◆ describe_status()

std::string gui2::addon_list::describe_status ( const addon_tracking_info & info )

staticprivate

Definition at line 96 of file addon_list.cpp.

References _(), ADDON_INSTALLED, ADDON_INSTALLED_BROKEN, ADDON_INSTALLED_LOCAL_ONLY, ADDON_INSTALLED_OUTDATED, ADDON_INSTALLED_UPGRADABLE, ADDON_NONE, ADDON_NOT_TRACKED, colorize_addon_state_string(), and lg::info().

Referenced by set_addons().

◆ display_title_full_shift()

const std::string gui2::addon_list::display_title_full_shift ( const addon_info & addon ) const

Definition at line 146 of file addon_list.cpp.

References addon_info::display_title(), addon_info::display_title_translated(), and markup::tag().

Referenced by select_addon(), and set_addons().

◆ finalize_setup()

void gui2::addon_list::finalize_setup ( )

private

Definition at line 374 of file addon_list.cpp.

References addon_vector_, get_listbox(), i, gui2::listbox::register_sorting_option(), gui2::listbox::register_translatable_sorting_option(), and gui2::listbox::set_active_sorting_option().

◆ get_active()

virtual bool gui2::addon_list::get_active ( ) const

inlineoverridevirtual

See styled_widget::get_active.

Implements gui2::styled_widget.

Definition at line 147 of file addon_list.hpp.

◆ get_control_type()

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

overrideprivatevirtual

Inherited from styled_widget, implemented by REGISTER_WIDGET.

Implements gui2::styled_widget.

◆ get_listbox()

listbox & gui2::addon_list::get_listbox ( )

private

Returns the underlying list box.

Definition at line 362 of file addon_list.cpp.

References gui2::widget::find_widget(), and gui2::container_base::get_grid().

Referenced by add_list_to_keyboard_chain(), finalize_setup(), select_addon(), select_first_addon(), set_addon_order(), set_addon_shown(), set_addons(), set_callback_order_change(), and set_modified_signal_handler().

◆ get_remote_addon_id()

std::string gui2::addon_list::get_remote_addon_id ( )

Returns the selected add-on id, for use with remote publish/delete ops.

Definition at line 321 of file addon_list.cpp.

References addon_tracking_info::can_publish, get_addon_tracking_info(), get_selected_addon(), and addon_info::id.

◆ get_selected_addon()

const addon_info * gui2::addon_list::get_selected_addon ( ) const

Returns the selected add-on.

Definition at line 310 of file addon_list.cpp.

References addon_vector_, gui2::widget::find_widget(), gui2::container_base::get_grid(), and gui2::listbox::get_selected_row().

Referenced by gui2::dialogs::addon_manager::execute_action_on_selected_addon(), and get_remote_addon_id().

◆ get_state()

virtual unsigned gui2::addon_list::get_state ( ) const

inlineoverridevirtual

See styled_widget::get_state.

Implements gui2::styled_widget.

Definition at line 153 of file addon_list.hpp.

◆ select_addon()

void gui2::addon_list::select_addon ( const std::string & id )

Selects the add-on with the given ID.

Definition at line 331 of file addon_list.cpp.

References addon_vector_, t_string::base_str(), display_title_full_shift(), gui2::widget::find_widget(), gui2::listbox::get_item_count(), gui2::styled_widget::get_label(), get_listbox(), gui2::listbox::get_row_grid(), i, lg::info(), and gui2::listbox::select_row().

◆ select_first_addon()

void gui2::addon_list::select_first_addon ( )

Choose the item at the top of the list (taking account of sort order).

Definition at line 401 of file addon_list.cpp.

References addon_vector_, get_listbox(), and gui2::listbox::select_row_at().

Referenced by set_addons().

◆ set_active()

virtual void gui2::addon_list::set_active ( const bool )

inlineoverridevirtual

See styled_widget::set_active.

Reimplemented from gui2::container_base.

Definition at line 141 of file addon_list.hpp.

◆ set_addon_order()

void gui2::addon_list::set_addon_order ( addon_sort_func func )

Definition at line 388 of file addon_list.cpp.

References addon_vector_, b, get_listbox(), gui2::listbox::mark_as_unsorted(), and gui2::listbox::order_by().

◆ set_addon_shown()

void gui2::addon_list::set_addon_shown ( boost::dynamic_bitset<> & shown )

inline

Filters which add-ons are visible.

1 = visible, 0 = hidden.

Definition at line 107 of file addon_list.hpp.

References get_listbox(), and gui2::listbox::set_row_shown().

◆ set_addons()

void gui2::addon_list::set_addons ( const addons_list & addons )

Sets the add-ons to show.

Definition at line 156 of file addon_list.cpp.

References _(), gui2::listbox::add_row(), addon_action_wrapper(), ADDON_INSTALLED_LOCAL_ONLY, ADDON_INSTALLED_OUTDATED, ADDON_INSTALLED_UPGRADABLE, addon_vector_, addon_info::author, addon_tracking_info::can_publish, gui2::listbox::clear(), colorize_addon_state_string(), gui2::event::connect_signal_mouse_left_click(), data, DEFAULT_ACTION_RETVAL, delete_function_, describe_status(), addon_info::display_icon(), display_title_full_shift(), addon_info::display_type(), addon_info::downloads, gui2::widget::find_widget(), get_addon_tracking_info(), get_listbox(), font::GOOD_COLOR, install_buttons_visibility_, install_function_, install_status_visibility_, addon_tracking_info::installed_version, is_installed_addon_status(), publish_function_, select_first_addon(), gui2::stacked_widget::select_layer(), gui2::widget::set_visible(), addon_info::size, size_display_string(), markup::span_color(), addon_tracking_info::state, version_info::str(), uninstall_function_, update_function_, and addon_info::versions.

Referenced by gui2::dialogs::addon_manager::load_addon_list().

◆ set_callback_order_change()

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

inline

Sets up a callback that will be called when the player changes the sorting order.

Definition at line 136 of file addon_list.hpp.

References get_listbox(), and gui2::listbox::set_callback_order_change().

Referenced by gui2::dialogs::addon_manager::pre_show().

◆ set_delete_function()

void gui2::addon_list::set_delete_function ( addon_op_func_t function )

inline

Sets the function to install an addon from the addons server.

Definition at line 101 of file addon_list.hpp.

References delete_function_.

Referenced by gui2::dialogs::addon_manager::pre_show().

◆ set_install_buttons_visibility()

void gui2::addon_list::set_install_buttons_visibility ( visibility visibility )

inline

Determines if install/uninstall buttons are shown for each widget.

Definition at line 127 of file addon_list.hpp.

References install_buttons_visibility_.

◆ set_install_function()

void gui2::addon_list::set_install_function ( addon_op_func_t function )

inline

Sets the function to call when the player clicks the install button.

Definition at line 77 of file addon_list.hpp.

References install_function_.

Referenced by gui2::dialogs::addon_manager::pre_show().

◆ set_install_status_visibility()

void gui2::addon_list::set_install_status_visibility ( visibility visibility )

inline

Determines if install status of each widget is shown.

Definition at line 121 of file addon_list.hpp.

References install_status_visibility_.

◆ set_modified_signal_handler()

void gui2::addon_list::set_modified_signal_handler ( const std::function< void()> & callback )

inline

Sets up a callback that will be called when the player selects an add-on.

Definition at line 53 of file addon_list.hpp.

References gui2::event::connect_signal_notify_modified(), and get_listbox().

Referenced by gui2::dialogs::addon_manager::pre_show().

◆ set_publish_function()

void gui2::addon_list::set_publish_function ( addon_op_func_t function )

inline

Sets the function to upload an addon to the addons server.

Definition at line 95 of file addon_list.hpp.

References publish_function_.

Referenced by gui2::dialogs::addon_manager::pre_show().

◆ set_self_active()

void gui2::addon_list::set_self_active ( const bool )

inlineoverrideprivatevirtual

See container_base::set_self_active.

Implements gui2::container_base.

Definition at line 190 of file addon_list.hpp.

◆ set_uninstall_function()

void gui2::addon_list::set_uninstall_function ( addon_op_func_t function )

inline

Sets the function to call when the player clicks the uninstall button.

Definition at line 83 of file addon_list.hpp.

References uninstall_function_.

Referenced by gui2::dialogs::addon_manager::pre_show().

◆ set_update_function()

void gui2::addon_list::set_update_function ( addon_op_func_t function )

inline

Sets the function to call when the player clicks the update button.

Definition at line 89 of file addon_list.hpp.

References update_function_.

Referenced by gui2::dialogs::addon_manager::pre_show().

◆ type()

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

static

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

Friends And Related Function Documentation

◆ implementation::builder_addon_list

friend struct implementation::builder_addon_list

friend

Definition at line 37 of file addon_list.hpp.

Member Data Documentation

◆ addon_vector_

std::vector<const addon_info*> gui2::addon_list::addon_vector_

private

Definition at line 159 of file addon_list.hpp.

Referenced by finalize_setup(), get_selected_addon(), select_addon(), select_first_addon(), set_addon_order(), and set_addons().

◆ DEFAULT_ACTION_RETVAL

const int gui2::addon_list::DEFAULT_ACTION_RETVAL = 200

static

Special retval for the toggle panels in the addons list.

Definition at line 45 of file addon_list.hpp.

Referenced by gui2::dialogs::addon_manager::exit_hook(), and set_addons().

◆ delete_function_

addon_op_func_t gui2::addon_list::delete_function_

private

Definition at line 169 of file addon_list.hpp.

Referenced by set_addons(), and set_delete_function().

◆ install_buttons_visibility_

visibility gui2::addon_list::install_buttons_visibility_

private

Definition at line 162 of file addon_list.hpp.

Referenced by set_addons(), and set_install_buttons_visibility().

◆ install_function_

addon_op_func_t gui2::addon_list::install_function_

private

Definition at line 164 of file addon_list.hpp.

Referenced by set_addons(), and set_install_function().

◆ install_status_visibility_

visibility gui2::addon_list::install_status_visibility_

private

Definition at line 161 of file addon_list.hpp.

Referenced by set_addons(), and set_install_status_visibility().

◆ publish_function_

addon_op_func_t gui2::addon_list::publish_function_

private

Definition at line 168 of file addon_list.hpp.

Referenced by set_addons(), and set_publish_function().

◆ uninstall_function_

addon_op_func_t gui2::addon_list::uninstall_function_

private

Definition at line 165 of file addon_list.hpp.

Referenced by set_addons(), and set_uninstall_function().

◆ update_function_

addon_op_func_t gui2::addon_list::update_function_

private

Definition at line 166 of file addon_list.hpp.

Referenced by set_addons(), and set_update_function().

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

gui/widgets/addon_list.hpp
gui/widgets/addon_list.cpp

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ addon_op_func_t

◆ addon_sort_func

Constructor & Destructor Documentation

◆ addon_list()

Member Function Documentation

◆ add_list_to_keyboard_chain()

◆ addon_action_wrapper()

◆ colorize_addon_state_string()

◆ describe_status()

◆ display_title_full_shift()

◆ finalize_setup()

◆ get_active()

◆ get_control_type()

◆ get_listbox()

◆ get_remote_addon_id()

◆ get_selected_addon()

◆ get_state()

◆ select_addon()

◆ select_first_addon()

◆ set_active()

◆ set_addon_order()

◆ set_addon_shown()

◆ set_addons()

◆ set_callback_order_change()

◆ set_delete_function()

◆ set_install_buttons_visibility()

◆ set_install_function()

◆ set_install_status_visibility()

◆ set_modified_signal_handler()

◆ set_publish_function()

◆ set_self_active()

◆ set_uninstall_function()

◆ set_update_function()

◆ type()

Friends And Related Function Documentation

◆ implementation::builder_addon_list

Member Data Documentation

◆ addon_vector_

◆ DEFAULT_ACTION_RETVAL

◆ delete_function_

◆ install_buttons_visibility_

◆ install_function_

◆ install_status_visibility_

◆ publish_function_

◆ uninstall_function_

◆ update_function_