#include <preferences_dialog.hpp>

Inheritance diagram for gui2::dialogs::preferences_dialog:

Public Member Functions
	preferences_dialog (const pref_constants::PREFERENCE_VIEW initial_view=pref_constants::VIEW_DEFAULT)

Public Member Functions inherited from gui2::dialogs::modal_dialog
	modal_dialog (const std::string &window_id)

virtual	~modal_dialog ()

bool	show (const unsigned auto_close_time=0)
	Shows the window. More...

int	get_retval () const
	Returns the cached window exit code. More...

void	set_always_save_fields (const bool always_save_fields)

void	set_allow_plugin_skip (const bool allow_plugin_skip)

void	set_show_even_without_video (const bool show_even_without_video)

Public Member Functions inherited from gui2::window
	window (const builder_window::window_resolution &definition)
	< Needs to be initialized in show. More...

virtual	~window ()

int	show (unsigned auto_close_timeout=0)
	Shows the window, running an event loop until it should close. More...

void	show_tooltip ()
	Shows the window as a tooltip. More...

void	show_non_modal ()
	Shows the window non modal. More...

void	draw ()
	Draws the window. More...

void	hide ()
	Hides the window. More...

virtual void	layout () override
	Lays out the window. More...

virtual void	render () override
	Ensure the window's internal render buffer is up-to-date. More...

virtual bool	expose (const rect &region) override
	Called by draw_manager when it believes a redraw is necessary. More...

virtual rect	screen_location () override
	The current draw location of the window, on the screen. More...

void	queue_rerender (const rect &region)
	Queue a rerender of the internal render buffer. More...

void	queue_rerender ()

void	defer_region (const rect &region)
	Defer rendering of a particular region to next frame. More...

void	close ()
	Requests to close the window. More...

bool	invalidate_layout_blocked () const
	Is invalidate_layout blocked, see invalidate_layout_blocker. More...

void	invalidate_layout ()
	Updates the size of the window. 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...

dialogs::modal_dialog *	dialog ()
	Inherited from widget. 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	does_click_dismiss () const
	Does the window close easily? More...

void	set_enter_disabled (const bool enter_disabled)
	Disable the enter key. More...

void	set_escape_disabled (const bool escape_disabled)
	Disable the escape key. More...

void	init_linked_size_group (const std::string &id, const bool fixed_width, const bool fixed_height)
	Initializes a linked size group. More...

bool	has_linked_size_group (const std::string &id)
	Is the linked size group defined for this window? More...

void	add_linked_widget (const std::string &id, widget *widget)
	Adds a widget to a linked size group. More...

void	remove_linked_widget (const std::string &id, const widget *widget)
	Removes a widget from a linked size group. More...

void	set_retval (const int retval, const bool close_window=true)
	Sets there return value of the window. More...

int	get_retval ()

void	set_owner (dialogs::modal_dialog *owner)

void	set_click_dismiss (const bool click_dismiss)

bool	get_need_layout () const

void	set_variable (const std::string &key, const wfl::variant &value)

point	get_linked_size (const std::string &linked_group_id) const

void	set_exit_hook (exit_hook mode, std::function< bool(window &)> func)
	Sets the window's exit hook. More...

const event::distributor &	get_distributor () const
	Gets a reference to the window's distributor to allow some state peeking. More...

show_mode	mode () const
	Returns the dialog mode for this window. More...

void	mouse_capture (const bool capture=true)

void	keyboard_capture (widget *widget)

void	add_to_keyboard_chain (widget *widget)
	Adds the widget to the keyboard chain. More...

void	remove_from_keyboard_chain (widget *widget)
	Remove the widget from the keyboard chain. More...

void	add_to_tab_order (widget *widget, int at=-1)
	Add the widget to the tabbing order. More...

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

virtual SDL_Rect	get_client_rect () const override
	See container_base::get_client_rect. 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...

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

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

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)

Public Member Functions inherited from gui2::top_level_drawable
virtual void	update ()
	Update state and any parameters that may effect layout, or any of the later stages. More...

Private Member Functions
virtual const std::string &	window_id () const override
	The display function – see modal_dialog for more information. More...

virtual void	pre_show () override
	Actions to be taken before showing the window. More...

virtual void	post_show () override
	Actions to be taken after the window has been shown. More...

void	initialize_callbacks ()
	Initializers. More...

void	initialize_tabs (listbox &selector)

void	set_resolution_list (menu_button &res_list)

void	set_theme_list (menu_button &theme_list)

void	set_gui2_theme_list (menu_button &theme_list)

listbox &	setup_hotkey_list ()

template<bool()() toggle_getter, bool()(bool) toggle_setter, int()() vol_getter, void()(int) vol_setter>
void	initialize_sound_option_group (const std::string &id_suffix)

void	apply_pixel_scale ()

widget_data	get_friends_list_row_data (const preferences::acquaintance &entry)

void	add_friend_list_entry (const bool is_friend, text_box &textbox)

void	remove_friend_list_entry (listbox &friends_list, text_box &textbox)

void	on_friends_list_select (listbox &list, text_box &textbox)

void	update_friends_list_controls (listbox &list)

void	set_visible_page (unsigned int page, const std::string &pager_id)

void	on_page_select ()
	Callback for selection changes. More...

void	on_tab_select ()

void	on_advanced_prefs_list_select (listbox &tree)

void	handle_res_select ()
	Special callback functions. More...

void	handle_theme_select ()

void	handle_gui2_theme_select ()

void	fullscreen_toggle_callback ()

void	add_hotkey_callback (listbox &hotkeys)

void	remove_hotkey_callback (listbox &hotkeys)

void	default_hotkey_callback ()

void	hotkey_filter_callback ()

Private Attributes
group< pref_constants::lobby_joins >	lobby_joins_group

std::vector< point >	resolutions_

std::vector< theme_info >	themes_

std::vector< std::string >	gui2_themes_

int	last_selected_item_

unsigned	current_gui_theme_

std::vector< double >	accl_speeds_

std::vector< const hotkey::hotkey_command * >	visible_hotkeys_

std::set< hotkey::HOTKEY_CATEGORY >	visible_categories_

const std::pair< int, int > &	initial_index_

Additional Inherited Members
Public Types inherited from gui2::window
enum class	status { NEW , SHOWING , REQUEST_CLOSE , CLOSED }
	The status of the window. More...

enum class	exit_hook { on_all , on_ok }

enum class	show_mode { none , modal , modeless , tooltip }

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

Static Public Member Functions inherited from gui2::window
static window *	window_instance (const unsigned handle)
	Returns the instance of a window. More...

static retval	get_retval_by_id (const std::string &id)
	Gets the retval for the default buttons. More...

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::panel
static const std::string &	type ()
	Static type getter that does not rely on the widget being constructed. More...

Protected Member Functions inherited from gui2::dialogs::modal_dialog
template<typename T , typename... Args>
T *	register_field (Args &&... args)
	Creates a new field of given type with given arguments. More...

field_bool *	register_bool (const std::string &id, const bool mandatory, const std::function< bool()> &callback_load_value=nullptr, const std::function< void(bool)> &callback_save_value=nullptr, const std::function< void(widget &)> &callback_change=nullptr, const bool initial_fire=false)
	Creates a new boolean field. More...

field_bool *	register_bool (const std::string &id, const bool mandatory, bool &linked_variable, const std::function< void(widget &)> &callback_change=nullptr, const bool initial_fire=false)
	Creates a new boolean field. More...

field_integer *	register_integer (const std::string &id, const bool mandatory, const std::function< int()> &callback_load_value=nullptr, const std::function< void(int)> &callback_save_value=nullptr)
	Creates a new integer field. More...

field_integer *	register_integer (const std::string &id, const bool mandatory, int &linked_variable)
	Creates a new integer field. More...

field_text *	register_text (const std::string &id, const bool mandatory, const std::function< std::string()> &callback_load_value=nullptr, const std::function< void(const std::string &)> &callback_save_value=nullptr, const bool capture_focus=false)
	Creates a new text field. More...

field_text *	register_text (const std::string &id, const bool mandatory, std::string &linked_variable, const bool capture_focus=false)
	Creates a new text field. More...

field_label *	register_label (const std::string &id, const bool mandatory, const std::string &text, const bool use_markup=false)
	Registers a new styled_widget as a label. More...

field_label *	register_image (const std::string &id, const bool mandatory, const std::string &filename)
	Registers a new styled_widget as image. More...

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

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

Protected Member Functions inherited from gui2::top_level_drawable
	top_level_drawable ()

virtual	~top_level_drawable ()

	top_level_drawable (const top_level_drawable &)

top_level_drawable &	operator= (const top_level_drawable &)

	top_level_drawable (top_level_drawable &&)

top_level_drawable &	operator= (top_level_drawable &&)

Detailed Description

Definition at line 54 of file preferences_dialog.hpp.

Constructor & Destructor Documentation

◆ preferences_dialog()

gui2::dialogs::preferences_dialog::preferences_dialog ( const pref_constants::PREFERENCE_VIEW initial_view = pref_constants::VIEW_DEFAULT )

Definition at line 110 of file preferences_dialog.cpp.

Member Function Documentation

◆ add_friend_list_entry()

void gui2::dialogs::preferences_dialog::add_friend_list_entry	(	const bool	is_friend,
		text_box &	textbox
	)

private

Definition at line 251 of file preferences_dialog.cpp.

References _(), prefs::add_acquaintance(), gui2::listbox::add_row(), gui2::text_box::clear(), gui2::widget::find_widget(), prefs::get(), get_friends_list_row_data(), gui2::listbox::get_item_count(), gui2::styled_widget::get_label(), gui2::listbox::get_row_grid(), i, gui2::listbox::remove_row(), gui2::show_transient_message(), gui2::text_box_base::text(), and update_friends_list_controls().

Referenced by initialize_callbacks().

◆ add_hotkey_callback()

void gui2::dialogs::preferences_dialog::add_hotkey_callback ( listbox & hotkeys )

private

◆ apply_pixel_scale()

void gui2::dialogs::preferences_dialog::apply_pixel_scale ( )

private

Definition at line 329 of file preferences_dialog.cpp.

References prefs::get(), display::get_singleton(), gui2::slider::get_value(), gui2::selectable_item::get_value_bool(), events::raise_resize_event(), prefs::set_pixel_scale(), and video::update_buffers().

Referenced by initialize_callbacks().

◆ default_hotkey_callback()

void gui2::dialogs::preferences_dialog::default_hotkey_callback ( )

private

Definition at line 994 of file preferences_dialog.cpp.

References _(), prefs::clear_hotkeys(), prefs::get(), setup_hotkey_list(), and gui2::show_transient_message().

Referenced by initialize_callbacks().

◆ fullscreen_toggle_callback()

void gui2::dialogs::preferences_dialog::fullscreen_toggle_callback ( )

private

Definition at line 1179 of file preferences_dialog.cpp.

References gui2::menu_button::set_active(), video::set_fullscreen(), and set_resolution_list().

Referenced by initialize_callbacks().

◆ get_friends_list_row_data()

widget_data gui2::dialogs::preferences_dialog::get_friends_list_row_data ( const preferences::acquaintance & entry )

private

Definition at line 191 of file preferences_dialog.cpp.

References _(), data, preferences::acquaintance::get_nick(), preferences::acquaintance::get_notes(), preferences::acquaintance::get_status(), and markup::tag().

Referenced by add_friend_list_entry(), and initialize_callbacks().

◆ handle_gui2_theme_select()

void gui2::dialogs::preferences_dialog::handle_gui2_theme_select ( )

private

Definition at line 1214 of file preferences_dialog.cpp.

References current_gui_theme_, prefs::get(), gui2::menu_button::get_value(), gui2_themes_, gui2::dialogs::title_screen::RELOAD_UI, and gui2::window::set_retval().

Referenced by initialize_callbacks().

◆ handle_res_select()

void gui2::dialogs::preferences_dialog::handle_res_select ( )

private

Special callback functions.

Definition at line 1190 of file preferences_dialog.cpp.

References gui2::menu_button::get_value(), resolutions_, video::set_resolution(), and set_resolution_list().

Referenced by initialize_callbacks().

◆ handle_theme_select()

void gui2::dialogs::preferences_dialog::handle_theme_select ( )

private

Definition at line 1199 of file preferences_dialog.cpp.

References resources::gamedata, prefs::get(), display::get_singleton(), display::set_theme(), prefs::set_theme(), and themes_.

Referenced by initialize_callbacks().

◆ hotkey_filter_callback()

void gui2::dialogs::preferences_dialog::hotkey_filter_callback ( )

private

Definition at line 1018 of file preferences_dialog.cpp.

References translation::ci_search(), gui2::multimenu_button::get_toggle_states(), gui2::text_box_base::get_value(), h, utils::split(), visible_categories_, and visible_hotkeys_.

Referenced by initialize_callbacks().

◆ initialize_callbacks()

void gui2::dialogs::preferences_dialog::initialize_callbacks ( )

private

Initializers.

Sets up states and callbacks for each of the widgets.

Definition at line 403 of file preferences_dialog.cpp.

References accl_speeds_, add_friend_list_entry(), add_hotkey_callback(), gui2::group< T >::add_member(), gui2::listbox::add_row(), apply_pixel_scale(), config::child_range(), gui2::listbox::clear(), preferences::option::COMBO, gui2::event::connect_signal_mouse_left_click(), gui2::event::connect_signal_mouse_left_release(), gui2::event::connect_signal_notify_modified(), default_hotkey_callback(), utils::find(), gui2::widget::find_widget(), fullscreen_toggle_callback(), prefs::get(), preferences_dialog_friend::get(), get_friends_list_row_data(), prefs::get_lobby_joins(), hotkey::get_names(), gui2::slider::get_value(), gui2::selectable_item::get_value_bool(), handle_gui2_theme_select(), handle_res_select(), handle_theme_select(), gui2::widget::hidden, hotkey_filter_callback(), i, gui2::widget::invisible, lobby_joins_group, on_advanced_prefs_list_select(), on_friends_list_select(), prefs::pixel_scale(), gui2::dialogs::modal_dialog::register_bool(), gui2::dialogs::modal_dialog::register_integer(), prefs::remember_password(), remove_friend_list_entry(), remove_hotkey_callback(), hotkey::SCOPE_EDITOR, hotkey::SCOPE_GAME, hotkey::SCOPE_MAIN_MENU, prefs::scroll_speed(), game_config::images::selected, preferences_dialog_friend::set(), gui2::button::set_active(), gui2::menu_button::set_active(), gui2::group< T >::set_callback_on_value_change(), set_gui2_theme_list(), gui2::styled_widget::set_label(), prefs::set_lobby_joins(), gui2::group< T >::set_member_states(), prefs::set_pixel_scale(), prefs::set_remember_password(), set_resolution_list(), prefs::set_scroll_speed(), prefs::set_show_standing_animations(), gui2::text_box_base::set_text_changed_callback(), set_theme_list(), prefs::set_turbo(), gui2::styled_widget::set_use_markup(), gui2::slider::set_value(), gui2::toggle_button::set_value(), gui2::menu_button::set_values(), gui2::widget::set_visible(), setup_hotkey_list(), pref_constants::show_all, pref_constants::show_friends, pref_constants::show_none, prefs::show_standing_animations(), prefs::show_wesnothd_server_search(), preferences::option::SLIDER, markup::span_color(), preferences::option::SPECIAL, gui2::grid::swap_child(), preferences::option::TOGGLE, video::toggle_fullscreen(), prefs::turbo(), update_friends_list_controls(), gui2::widget::visible, visible_hotkeys_, and w.

◆ initialize_sound_option_group()

template<bool(*)() toggle_getter, bool(*)(bool) toggle_setter, int(*)() vol_getter, void(*)(int) vol_setter>

void gui2::dialogs::preferences_dialog::initialize_sound_option_group ( const std::string & id_suffix )

private

Definition at line 353 of file preferences_dialog.cpp.

References gui2::event::connect_signal_notify_modified(), gui2::dialogs::modal_dialog::register_bool(), and gui2::dialogs::modal_dialog::register_integer().

◆ initialize_tabs()

void gui2::dialogs::preferences_dialog::initialize_tabs ( listbox & selector )

private

Definition at line 1103 of file preferences_dialog.cpp.

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

Referenced by pre_show().

◆ on_advanced_prefs_list_select()

void gui2::dialogs::preferences_dialog::on_advanced_prefs_list_select ( listbox & tree )

private

Definition at line 1071 of file preferences_dialog.cpp.

References gui2::widget::find_widget(), prefs::get(), prefs::get_advanced_preferences(), gui2::listbox::get_row_grid(), gui2::listbox::get_selected_row(), gui2::widget::invisible, last_selected_item_, gui2::widget::set_visible(), preferences::option::SPECIAL, preferences::option::TOGGLE, gui2::widget::visible, and WRN_GUI_L.

Referenced by initialize_callbacks().

◆ on_friends_list_select()

void gui2::dialogs::preferences_dialog::on_friends_list_select	(	listbox &	list,
		text_box &	textbox
	)

private

Definition at line 223 of file preferences_dialog.cpp.

References prefs::get(), prefs::get_acquaintances(), gui2::listbox::get_selected_row(), and gui2::text_box_base::set_value().

Referenced by initialize_callbacks().

◆ on_page_select()

void gui2::dialogs::preferences_dialog::on_page_select ( )

private

Callback for selection changes.

Definition at line 1225 of file preferences_dialog.cpp.

References set_visible_page().

Referenced by pre_show().

◆ on_tab_select()

void gui2::dialogs::preferences_dialog::on_tab_select ( )

private

Definition at line 1232 of file preferences_dialog.cpp.

References set_visible_page().

Referenced by initialize_tabs().

◆ post_show()

void gui2::dialogs::preferences_dialog::post_show ( )

overrideprivatevirtual

Actions to be taken after the window has been shown.

At this point the registered fields already stored their values (if the button with id 'ok' has been pressed).

Reimplemented from gui2::dialogs::modal_dialog.

Definition at line 1239 of file preferences_dialog.cpp.

References prefs::get(), prefs::save_hotkeys(), and prefs::write_preferences().

◆ pre_show()

void gui2::dialogs::preferences_dialog::pre_show ( )

overrideprivatevirtual

Actions to be taken before showing the window.

At this point the registered fields are registered and initialized with their initial values.

Reimplemented from gui2::dialogs::modal_dialog.

Definition at line 1112 of file preferences_dialog.cpp.

References gui2::event::connect_signal_mouse_left_click(), gui2::event::connect_signal_notify_modified(), gui2::widget::find_widget(), gui2::listbox::get_item_count(), gui2::stacked_widget::get_layer_count(), gui2::stacked_widget::get_layer_grid(), i, initial_index_, initialize_tabs(), gui2::window::keyboard_capture(), on_page_select(), gui2::stacked_widget::select_layer(), gui2::listbox::select_row(), gui2::dialogs::modal_dialog::set_always_save_fields(), gui2::stacked_widget::set_find_in_all_layers(), and VALIDATE.

◆ remove_friend_list_entry()

void gui2::dialogs::preferences_dialog::remove_friend_list_entry	(	listbox &	friends_list,
		text_box &	textbox
	)

private

Definition at line 302 of file preferences_dialog.cpp.

References _(), gui2::text_box::clear(), prefs::get(), prefs::get_acquaintances(), gui2::listbox::get_selected_row(), gui2::listbox::remove_row(), gui2::show_transient_error_message(), gui2::show_transient_message(), gui2::text_box_base::text(), and update_friends_list_controls().

Referenced by initialize_callbacks().

◆ remove_hotkey_callback()

void gui2::dialogs::preferences_dialog::remove_hotkey_callback ( listbox & hotkeys )

private

Definition at line 1005 of file preferences_dialog.cpp.

References _(), hotkey::clear_hotkeys(), gui2::widget::find_widget(), hotkey::get_names(), gui2::listbox::get_row_grid(), gui2::listbox::get_selected_row(), hotkey::hotkey_command::id, gui2::styled_widget::set_label(), gui2::show_transient_message(), and visible_hotkeys_.

Referenced by initialize_callbacks().

◆ set_gui2_theme_list()

void gui2::dialogs::preferences_dialog::set_gui2_theme_list ( menu_button & theme_list )

private

Definition at line 168 of file preferences_dialog.cpp.

References current_gui_theme_, prefs::get(), gui2_themes_, gui2::guis, and i.

Referenced by initialize_callbacks().

◆ set_resolution_list()

void gui2::dialogs::preferences_dialog::set_resolution_list ( menu_button & res_list )

private

Definition at line 126 of file preferences_dialog.cpp.

References video::current_resolution(), utils::find(), video::get_available_resolutions(), resolutions_, gui2::menu_button::set_values(), markup::span_color(), and font::unicode_multiplication_sign.

Referenced by fullscreen_toggle_callback(), handle_res_select(), and initialize_callbacks().

◆ set_theme_list()

void gui2::dialogs::preferences_dialog::set_theme_list ( menu_button & theme_list )

private

Definition at line 152 of file preferences_dialog.cpp.

References prefs::get(), theme::get_basic_theme_info(), i, and themes_.

Referenced by initialize_callbacks().

◆ set_visible_page()

void gui2::dialogs::preferences_dialog::set_visible_page	(	unsigned int	page,
		const std::string &	pager_id
	)

private

Definition at line 1173 of file preferences_dialog.cpp.

Referenced by on_page_select(), and on_tab_select().

◆ setup_hotkey_list()

listbox & gui2::dialogs::preferences_dialog::setup_hotkey_list ( )

private

Definition at line 876 of file preferences_dialog.cpp.

References _(), filesystem::file_exists(), hotkey::get_hotkey_commands(), hotkey::get_names(), hotkey::get_translatable_category_name(), game_config::path, hotkey::SCOPE_EDITOR, hotkey::SCOPE_GAME, hotkey::SCOPE_MAIN_MENU, markup::span_color(), visible_categories_, and visible_hotkeys_.

Referenced by default_hotkey_callback(), and initialize_callbacks().

◆ update_friends_list_controls()

void gui2::dialogs::preferences_dialog::update_friends_list_controls ( listbox & list )

private

Definition at line 238 of file preferences_dialog.cpp.

References gui2::listbox::get_item_count(), gui2::listbox::get_selected_row(), and gui2::listbox::select_row().

Referenced by add_friend_list_entry(), initialize_callbacks(), and remove_friend_list_entry().

◆ window_id()

virtual const std::string& gui2::dialogs::preferences_dialog::window_id ( ) const

overrideprivatevirtual

The display function – see modal_dialog for more information.

Implements gui2::dialogs::modal_dialog.

Member Data Documentation

◆ accl_speeds_

std::vector<double> gui2::dialogs::preferences_dialog::accl_speeds_

private

Definition at line 115 of file preferences_dialog.hpp.

Referenced by initialize_callbacks().

◆ current_gui_theme_

unsigned gui2::dialogs::preferences_dialog::current_gui_theme_

private

Definition at line 113 of file preferences_dialog.hpp.

Referenced by handle_gui2_theme_select(), and set_gui2_theme_list().

◆ gui2_themes_

std::vector<std::string> gui2::dialogs::preferences_dialog::gui2_themes_

private

Definition at line 110 of file preferences_dialog.hpp.

Referenced by handle_gui2_theme_select(), and set_gui2_theme_list().

◆ initial_index_

const std::pair<int, int>& gui2::dialogs::preferences_dialog::initial_index_

private

Definition at line 122 of file preferences_dialog.hpp.

Referenced by pre_show().

◆ last_selected_item_

int gui2::dialogs::preferences_dialog::last_selected_item_

private

Definition at line 112 of file preferences_dialog.hpp.

Referenced by on_advanced_prefs_list_select().

◆ lobby_joins_group

group<pref_constants::lobby_joins> gui2::dialogs::preferences_dialog::lobby_joins_group

private

Definition at line 106 of file preferences_dialog.hpp.

Referenced by initialize_callbacks().

◆ resolutions_

std::vector<point> gui2::dialogs::preferences_dialog::resolutions_

private

Definition at line 108 of file preferences_dialog.hpp.

Referenced by handle_res_select(), and set_resolution_list().

◆ themes_

std::vector<theme_info> gui2::dialogs::preferences_dialog::themes_

private

Definition at line 109 of file preferences_dialog.hpp.

Referenced by handle_theme_select(), and set_theme_list().

◆ visible_categories_

std::set<hotkey::HOTKEY_CATEGORY> gui2::dialogs::preferences_dialog::visible_categories_

private

Definition at line 119 of file preferences_dialog.hpp.

Referenced by hotkey_filter_callback(), and setup_hotkey_list().

◆ visible_hotkeys_

std::vector<const hotkey::hotkey_command*> gui2::dialogs::preferences_dialog::visible_hotkeys_

private

Definition at line 117 of file preferences_dialog.hpp.

Referenced by add_hotkey_callback(), hotkey_filter_callback(), initialize_callbacks(), remove_hotkey_callback(), and setup_hotkey_list().

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

gui/dialogs/preferences_dialog.hpp
gui/dialogs/preferences_dialog.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ preferences_dialog()

Member Function Documentation

◆ add_friend_list_entry()

◆ add_hotkey_callback()

◆ apply_pixel_scale()

◆ default_hotkey_callback()

◆ fullscreen_toggle_callback()

◆ get_friends_list_row_data()

◆ handle_gui2_theme_select()

◆ handle_res_select()

◆ handle_theme_select()

◆ hotkey_filter_callback()

◆ initialize_callbacks()

◆ initialize_sound_option_group()

◆ initialize_tabs()

◆ on_advanced_prefs_list_select()

◆ on_friends_list_select()

◆ on_page_select()

◆ on_tab_select()

◆ post_show()

◆ pre_show()

◆ remove_friend_list_entry()

◆ remove_hotkey_callback()

◆ set_gui2_theme_list()

◆ set_resolution_list()

◆ set_theme_list()

◆ set_visible_page()

◆ setup_hotkey_list()

◆ update_friends_list_controls()

◆ window_id()

Member Data Documentation

◆ accl_speeds_

◆ current_gui_theme_

◆ gui2_themes_

◆ initial_index_

◆ last_selected_item_

◆ lobby_joins_group

◆ resolutions_

◆ themes_

◆ visible_categories_

◆ visible_hotkeys_