#include <help_button.hpp>

Inheritance diagram for help::help_button:

Public Member Functions
	help_button (CVideo &video, const std::string &help_topic)

	~help_button ()

int	action (gui::dialog_process_info &info)

std::string	topic () const

void	join ()

void	leave ()

CVideo &	get_video () override

Public Member Functions inherited from gui::dialog_button
	dialog_button (CVideo &video, const std::string &label, TYPE type=TYPE_PRESS, int simple_result=CONTINUE_DIALOG, dialog_button_action *handler=nullptr)

void	set_parent (class dialog *parent)

bool	is_option () const

Public Member Functions inherited from gui::button
	button (CVideo &video, const std::string &label, TYPE type=TYPE_PRESS, std::string button_image="", SPACE_CONSUMPTION spacing=DEFAULT_SPACE, const bool auto_join=true, std::string overlay_image="")

virtual	~button ()
	Default implementation, but defined out-of-line for efficiency reasons. More...

void	set_check (bool check)

void	set_active (bool active)

bool	checked () const

void	set_label (const std::string &val)

void	set_image (const std::string &image_file_base)

void	set_overlay (const std::string &image_file_base)

void	set_image_path_suffix (const std::string &suffix)

bool	pressed ()

bool	hit (int x, int y) const

virtual void	enable (bool new_val=true)

void	release ()

Public Member Functions inherited from gui::widget
SDL_Rect const &	location () const

virtual void	set_location (SDL_Rect const &rect)

void	set_location (int x, int y)

void	set_width (int w)

void	set_height (int h)

void	set_measurements (int w, int h)

int	width () const

int	height () const

bool	focus (const SDL_Event *event)

void	set_focus (bool focus)

virtual void	hide (bool value=true)

bool	hidden () const

bool	enabled () const

void	set_clip_rect (const SDL_Rect &rect)

void	set_volatile (bool val=true)

void	set_dirty (bool dirty=true)

bool	dirty () const

const std::string &	id () const

void	set_id (const std::string &id)

void	set_help_string (const std::string &str)

void	set_tooltip_string (const std::string &str)

virtual void	process_help_string (int mousex, int mousey)

virtual void	process_tooltip_string (int mousex, int mousey)

Public Member Functions inherited from events::sdl_handler
virtual void	process_event ()

virtual bool	requires_event_focus (const SDL_Event *=nullptr) const

virtual void	join (context &c)

virtual void	join_same (sdl_handler *parent)

virtual void	join_global ()

virtual void	leave_global ()

Public Member Functions inherited from hotkey::command_executor
virtual void	cycle_units ()

virtual void	cycle_back_units ()

virtual void	end_turn ()

virtual void	goto_leader ()

virtual void	unit_hold_position ()

virtual void	end_unit_turn ()

virtual void	undo ()

virtual void	redo ()

virtual void	terrain_description ()

virtual void	unit_description ()

virtual void	rename_unit ()

virtual void	save_game ()

virtual void	save_replay ()

virtual void	save_map ()

virtual void	load_game ()

virtual void	toggle_ellipses ()

virtual void	toggle_grid ()

virtual void	status_table ()

virtual void	recall ()

virtual void	recruit ()

virtual void	repeat_recruit ()

virtual void	speak ()

virtual void	whisper ()

virtual void	shout ()

virtual void	create_unit ()

virtual void	change_side ()

virtual void	kill_unit ()

virtual void	preferences ()

virtual void	objectives ()

virtual void	unit_list ()

virtual void	show_statistics ()

virtual void	stop_network ()

virtual void	start_network ()

virtual void	label_terrain (bool)

virtual void	clear_labels ()

virtual void	label_settings ()

virtual void	show_enemy_moves (bool)

virtual void	toggle_shroud_updates ()

virtual void	update_shroud_now ()

virtual void	continue_move ()

virtual void	search ()

virtual void	show_chat_log ()

virtual void	user_command ()

virtual void	custom_command ()

virtual void	ai_formula ()

virtual void	clear_messages ()

virtual void	change_language ()

virtual void	play_replay ()

virtual void	reset_replay ()

virtual void	stop_replay ()

virtual void	replay_next_turn ()

virtual void	replay_next_side ()

virtual void	replay_next_move ()

virtual void	replay_show_everything ()

virtual void	replay_show_each ()

virtual void	replay_show_team1 ()

virtual void	replay_skip_animation ()

virtual void	replay_exit ()

virtual void	whiteboard_toggle ()

virtual void	whiteboard_execute_action ()

virtual void	whiteboard_execute_all_actions ()

virtual void	whiteboard_delete_action ()

virtual void	whiteboard_bump_up_action ()

virtual void	whiteboard_bump_down_action ()

virtual void	whiteboard_suppose_dead ()

virtual void	select_hex ()

virtual void	deselect_hex ()

virtual void	move_action ()

virtual void	select_and_action ()

virtual void	left_mouse_click ()

virtual void	right_mouse_click ()

virtual void	toggle_accelerated_speed ()

virtual void	scroll_up (bool)

virtual void	scroll_down (bool)

virtual void	scroll_left (bool)

virtual void	scroll_right (bool)

virtual void	lua_console ()

virtual void	zoom_in ()

virtual void	zoom_out ()

virtual void	zoom_default ()

virtual void	map_screenshot ()

virtual void	set_button_state ()

virtual void	recalculate_minimap ()

virtual std::string	get_action_image (hotkey::HOTKEY_COMMAND, int) const

virtual ACTION_STATE	get_action_state (hotkey::HOTKEY_COMMAND, int) const

std::string	get_menu_image (display &disp, const std::string &command, int index=-1) const

std::vector< std::string >	get_menu_images (display &, const std::vector< std::string > &items_arg)

virtual void	show_menu (const std::vector< std::string > &items_arg, int xloc, int yloc, bool context_menu, display &gui)

void	execute_action (const std::vector< std::string > &items_arg, int xloc, int yloc, bool context_menu, display &gui)

virtual bool	execute_command (const hotkey_command &command, int index=-1, bool press=true)

Private Member Functions
void	show_help ()

bool	can_execute_command (const hotkey::hotkey_command &command, int=-1) const

Private Attributes
CVideo &	video_

const std::string	topic_

hotkey::basic_handler *	help_hand_

Additional Inherited Members
Public Types inherited from gui::button
enum	TYPE { TYPE_PRESS, TYPE_CHECK, TYPE_TURBO, TYPE_IMAGE, TYPE_RADIO }

enum	SPACE_CONSUMPTION { DEFAULT_SPACE, MINIMUM_SPACE }

Protected Member Functions inherited from gui::dialog_button
class dialog *	dialog () const

Protected Member Functions inherited from gui::button
virtual void	handle_event (const SDL_Event &event)

virtual void	mouse_motion (const SDL_MouseMotionEvent &event)

virtual void	mouse_down (const SDL_MouseButtonEvent &event)

virtual void	mouse_up (const SDL_MouseButtonEvent &event)

virtual void	draw_contents ()

Protected Member Functions inherited from gui::widget
	widget (widget const &o)

	widget (CVideo &video, const bool auto_join=true)

virtual	~widget ()

void	bg_register (SDL_Rect const &rect)

void	bg_restore () const

void	bg_restore (SDL_Rect const &rect) const

void	bg_update ()

void	bg_cancel ()

CVideo &	video () const

virtual void	draw ()

virtual void	update_location (SDL_Rect const &rect)

const SDL_Rect *	clip_rect () const

virtual sdl_handler_vector	member_handlers ()

virtual void	handle_window_event (SDL_Event const &event)

bool	mouse_locked () const

void	aquire_mouse_lock ()

void	free_mouse_lock ()

Protected Member Functions inherited from events::sdl_handler
	sdl_handler (const bool auto_join=true)

virtual	~sdl_handler ()

virtual std::vector < sdl_handler * >	handler_members ()

Protected Member Functions inherited from hotkey::command_executor
virtual	~command_executor ()

Protected Attributes inherited from gui::dialog_button
const int	simple_result_

Protected Attributes inherited from gui::button
TYPE	type_

Protected Attributes inherited from gui::widget
bool	focus_