The Battle for Wesnoth  1.19.0+dev
Classes | Namespaces | Functions
general.hpp File Reference
#include "config.hpp"
#include "gui/sort_order.hpp"
#include "terrain/translation.hpp"
Include dependency graph for general.hpp:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  preferences::base_manager
 

Namespaces

 preferences
 Modify, read and display user preferences.
 

Functions

void preferences::write_preferences ()
 
void preferences::set (const std::string &key, const std::string &value)
 
void preferences::set (const std::string &key, char const *value)
 
void preferences::set (const std::string &key, bool value)
 
void preferences::set (const std::string &key, int value)
 
void preferences::set (const std::string &key, const config::attribute_value &value)
 
void preferences::clear (const std::string &key)
 
void preferences::set_child (const std::string &key, const config &val)
 
optional_const_config preferences::get_child (const std::string &key)
 
std::string preferences::get (const std::string &key)
 
std::string preferences::get (const std::string &key, const std::string &def)
 
bool preferences::get (const std::string &key, bool def)
 
config::attribute_value preferences::get_as_attribute (const std::string &key)
 
void preferences::erase (const std::string &key)
 
bool preferences::have_setting (const std::string &key)
 
void preferences::disable_preferences_save ()
 
configpreferences::get_prefs ()
 
void preferences::load_base_prefs ()
 
std::string preferences::core_id ()
 
void preferences::set_core_id (const std::string &core_id)
 
bool preferences::scroll_to_action ()
 
void preferences::set_scroll_to_action (bool ison)
 
point preferences::resolution ()
 
void preferences::set_resolution (const point &res)
 
int preferences::pixel_scale ()
 
void preferences::set_pixel_scale (const int scale)
 
bool preferences::auto_pixel_scale ()
 
void preferences::set_auto_pixel_scale (bool choice)
 
bool preferences::maximized ()
 
void preferences::set_maximized (bool ison)
 
bool preferences::fullscreen ()
 
void preferences::set_fullscreen (bool ison)
 
bool preferences::vsync ()
 
void preferences::set_vsync (bool ison)
 
bool preferences::turbo ()
 
void preferences::set_turbo (bool ison)
 
double preferences::turbo_speed ()
 
void preferences::set_turbo_speed (const double speed)
 
int preferences::font_scaling ()
 
void preferences::set_font_scaling (int scale)
 
int preferences::font_scaled (int size)
 
int preferences::keepalive_timeout ()
 
void preferences::keepalive_timeout (int seconds)
 
bool preferences::idle_anim ()
 
void preferences::set_idle_anim (const bool ison)
 
int preferences::idle_anim_rate ()
 
void preferences::set_idle_anim_rate (int rate)
 
std::string preferences::language ()
 
void preferences::set_language (const std::string &s)
 
std::string preferences::gui_theme ()
 
void preferences::set_gui_theme (const std::string &s)
 
bool preferences::sound_on ()
 
bool preferences::set_sound (bool ison)
 
unsigned int preferences::sample_rate ()
 
void preferences::save_sample_rate (const unsigned int rate)
 
std::size_t preferences::sound_buffer_size ()
 
void preferences::save_sound_buffer_size (const std::size_t size)
 
int preferences::sound_volume ()
 
void preferences::set_sound_volume (int vol)
 
int preferences::bell_volume ()
 
void preferences::set_bell_volume (int vol)
 
int preferences::UI_volume ()
 
void preferences::set_UI_volume (int vol)
 
bool preferences::music_on ()
 
bool preferences::set_music (bool ison)
 
int preferences::music_volume ()
 
void preferences::set_music_volume (int vol)
 
bool preferences::stop_music_in_background ()
 
void preferences::set_stop_music_in_background (bool ison)
 
unsigned int preferences::tile_size ()
 
void preferences::set_tile_size (const unsigned int size)
 
bool preferences::turn_bell ()
 
bool preferences::set_turn_bell (bool ison)
 
bool preferences::UI_sound_on ()
 
bool preferences::set_UI_sound (bool ison)
 
bool preferences::message_bell ()
 
void preferences::load_hotkeys ()
 
void preferences::save_hotkeys ()
 
void preferences::clear_hotkeys ()
 
void preferences::add_alias (const std::string &alias, const std::string &command)
 
optional_const_config preferences::get_alias ()
 
std::string preferences::allied_color ()
 
void preferences::set_allied_color (const std::string &color_id)
 
std::string preferences::enemy_color ()
 
void preferences::set_enemy_color (const std::string &color_id)
 
std::string preferences::unmoved_color ()
 
void preferences::set_unmoved_color (const std::string &color_id)
 
std::string preferences::partial_color ()
 
void preferences::set_partial_color (const std::string &color_id)
 
std::string preferences::moved_color ()
 
void preferences::set_moved_color (const std::string &color_id)
 
bool preferences::show_ally_orb ()
 
void preferences::set_show_ally_orb (bool show_orb)
 
bool preferences::show_status_on_ally_orb ()
 
void preferences::set_show_status_on_ally_orb (bool show_orb)
 
bool preferences::show_enemy_orb ()
 
void preferences::set_show_enemy_orb (bool show_orb)
 
bool preferences::show_moved_orb ()
 
void preferences::set_show_moved_orb (bool show_orb)
 
bool preferences::show_unmoved_orb ()
 
void preferences::set_show_unmoved_orb (bool show_orb)
 
bool preferences::show_partial_orb ()
 
void preferences::set_show_partial_orb (bool show_orb)
 
bool preferences::show_disengaged_orb ()
 
void preferences::set_show_disengaged_orb (bool show_orb)
 
int preferences::scroll_speed ()
 
void preferences::set_scroll_speed (const int new_speed)
 
bool preferences::middle_click_scrolls ()
 
bool preferences::mouse_scroll_enabled ()
 
void preferences::enable_mouse_scroll (bool value)
 
int preferences::mouse_scroll_threshold ()
 Gets the threshold for when to scroll. More...
 
int preferences::draw_delay ()
 
void preferences::set_draw_delay (int value)
 
bool preferences::animate_map ()
 
void preferences::set_animate_map (bool value)
 
bool preferences::animate_water ()
 
void preferences::set_animate_water (bool value)
 
bool preferences::minimap_movement_coding ()
 
void preferences::toggle_minimap_movement_coding ()
 
bool preferences::minimap_terrain_coding ()
 
void preferences::toggle_minimap_terrain_coding ()
 
bool preferences::minimap_draw_units ()
 
void preferences::toggle_minimap_draw_units ()
 
bool preferences::minimap_draw_villages ()
 
void preferences::toggle_minimap_draw_villages ()
 
bool preferences::minimap_draw_terrain ()
 
void preferences::toggle_minimap_draw_terrain ()
 
bool preferences::show_fps ()
 
void preferences::set_show_fps (bool value)
 
bool preferences::ellipses ()
 
void preferences::set_ellipses (bool ison)
 
bool preferences::grid ()
 
void preferences::set_grid (bool ison)
 
bool preferences::confirm_load_save_from_different_version ()
 
bool preferences::use_twelve_hour_clock_format ()
 
void preferences::set_use_twelve_hour_clock_format (bool value)
 
bool preferences::disable_auto_moves ()
 
void preferences::set_disable_auto_moves (bool value)
 
bool preferences::damage_prediction_allow_monte_carlo_simulation ()
 
void preferences::set_damage_prediction_allow_monte_carlo_simulation (bool value)
 
std::string preferences::addon_manager_saved_order_name ()
 
void preferences::set_addon_manager_saved_order_name (const std::string &value)
 
sort_order::type preferences::addon_manager_saved_order_direction ()
 
void preferences::set_addon_manager_saved_order_direction (sort_order::type value)
 
std::string preferences::selected_achievement_group ()
 
void preferences::set_selected_achievement_group (const std::string &content_for)
 
bool preferences::achievement (const std::string &content_for, const std::string &id)
 
void preferences::set_achievement (const std::string &content_for, const std::string &id)
 Marks the specified achievement as completed. More...
 
int preferences::progress_achievement (const std::string &content_for, const std::string &id, int limit=999999, int max_progress=999999, int amount=0)
 Increments the achievement's current progress by amount if it hasn't already been completed. More...
 
bool preferences::sub_achievement (const std::string &content_for, const std::string &id, const std::string &sub_id)
 
void preferences::set_sub_achievement (const std::string &content_for, const std::string &id, const std::string &sub_id)
 Marks the specified sub-achievement as completed. More...
 
void preferences::set_editor_chosen_addon (const std::string &addon_id)
 
std::string preferences::editor_chosen_addon ()
 
void preferences::set_mp_alert_option (const std::string &id, const std::string &type, bool value)
 
bool preferences::mp_alert_option (const std::string &id, const std::string &type, bool def)
 
bool preferences::has_mp_alert_option (const std::string &id, const std::string &type)
 
void preferences::set_last_cache_cleared_version (const std::string &version)
 
std::string preferences::last_cache_cleared_version ()
 
bool preferences::get_show_deprecation (bool def)
 
bool preferences::get_scroll_when_mouse_outside (bool def)
 
void preferences::set_dir_bookmarks (const config &cfg)
 
optional_const_config preferences::dir_bookmarks ()