quit_confirmation Class Reference

Implements a quit confirmation dialog. More...

#include <quit_confirmation.hpp>

Inheritance diagram for quit_confirmation:

Public Member Functions
	quit_confirmation (const std::function< bool()> &prompt=&quit_confirmation::default_prompt)
	~quit_confirmation ()

Static Public Member Functions
static bool	quit ()
	Shows the quit confirmation if needed. More...
static void	quit_to_title ()
static void	quit_to_desktop ()
static bool	show_prompt (const std::string &message)
static bool	default_prompt ()

Private Member Functions
	quit_confirmation (const quit_confirmation &)=delete
const quit_confirmation &	operator= (const quit_confirmation &)=delete

Private Attributes
std::function< bool()>	prompt_

Static Private Attributes
static std::vector< quit_confirmation * >	blockers_ {}
static bool	open_ = false

Detailed Description

Implements a quit confirmation dialog.

Any object of this type will prevent the game from quitting immediately. Instead, a confirmation dialog will pop up when attempting to close.

Definition at line 28 of file quit_confirmation.hpp.

Constructor & Destructor Documentation

quit_confirmation() [1/2]

quit_confirmation::quit_confirmation ( const std::function< bool()> &  prompt = &quit_confirmation::default_prompt )

inlineexplicit

Definition at line 31 of file quit_confirmation.hpp.

References blockers_.

~quit_confirmation()

quit_confirmation::~quit_confirmation ( )

inline

Definition at line 34 of file quit_confirmation.hpp.

References blockers_.

quit_confirmation() [2/2]

quit_confirmation::quit_confirmation ( const quit_confirmation &  )

privatedelete

Member Function Documentation

default_prompt()

bool quit_confirmation::default_prompt ( )

static

Definition at line 59 of file quit_confirmation.cpp.

References _(), resources::controller, gui2::dialogs::modal_dialog::get_retval(), display::get_singleton(), play_controller::get_teams(), play_controller::is_observer(), gui2::dialogs::modal_dialog::show(), show_prompt(), playmp_controller::surrender(), t, and display::viewing_team_index().

operator=()

const quit_confirmation& quit_confirmation::operator= ( const quit_confirmation &  )

privatedelete

quit()

bool quit_confirmation::quit ( )

static

Shows the quit confirmation if needed.

Exceptions

video::quit

If the user chooses to quit or no prompt was displayed.

Definition at line 26 of file quit_confirmation.cpp.

References blockers_, open_, and utils::reversed_view().

Referenced by editor::editor_controller::do_execute_command(), gui2::dialogs::mp_lobby::exit_hook(), quit_to_desktop(), and quit_to_title().

quit_to_desktop()

void quit_confirmation::quit_to_desktop ( )

static

Definition at line 48 of file quit_confirmation.cpp.

References quit().

Referenced by hotkey::command_executor::do_execute_command(), editor::editor_controller::do_execute_command(), and events::pump().

quit_to_title()

void quit_confirmation::quit_to_title ( )

static

Definition at line 43 of file quit_confirmation.cpp.

References quit(), and throw_quit_game_exception().

Referenced by hotkey::command_executor::do_execute_command(), and gui2::dialogs::synched_choice_wait::pre_show().

show_prompt()

bool quit_confirmation::show_prompt ( const std::string &  message )

static

Definition at line 53 of file quit_confirmation.cpp.

References _(), gui2::CANCEL, gui2::show_message(), and gui2::dialogs::message::yes_no_buttons.

Referenced by default_prompt(), and editor::editor_controller::quit_confirm().

Member Data Documentation

blockers_

std::vector<quit_confirmation*> quit_confirmation::blockers_ {}

inlinestaticprivate

Definition at line 54 of file quit_confirmation.hpp.

Referenced by quit(), quit_confirmation(), and ~quit_confirmation().

open_

bool quit_confirmation::open_ = false

inlinestaticprivate

Definition at line 55 of file quit_confirmation.hpp.

Referenced by quit().

prompt_

std::function<bool()> quit_confirmation::prompt_

private

Definition at line 57 of file quit_confirmation.hpp.

---

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

• quit_confirmation.hpp
• quit_confirmation.cpp