A help browser widget. More...

#include <help_browser.hpp>

Inheritance diagram for help::help_browser:

Public Member Functions
	help_browser (CVideo &video, const section &toplevel)

void	adjust_layout ()

void	show_topic (const std::string &topic_id)
	Display the topic with the specified identifier. More...

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

virtual void	set_location (const SDL_Rect &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

virtual void	enable (bool new_val=true)

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)

virtual void	draw ()

Public Member Functions inherited from events::sdl_handler
virtual bool	requires_event_focus (const SDL_Event *=nullptr) const

virtual void	join ()

virtual void	join (context &c)

virtual void	join_same (sdl_handler *parent)

virtual void	leave ()

virtual void	join_global ()

virtual void	leave_global ()

virtual bool	has_joined ()

virtual bool	has_joined_global ()

sdl_handler &	operator= (sdl_handler &&)=delete
	Moving would require two instances' context membership to be handled, it's simpler to delete these and require the two instances to be separately constructed / destructed. More...

	sdl_handler (sdl_handler &&)=delete

Protected Member Functions
virtual void	update_location (const SDL_Rect &rect)

virtual void	process_event ()

virtual void	handle_event (const SDL_Event &event)

Protected Member Functions inherited from gui::widget
	widget (CVideo &video, const bool auto_join=true)

virtual	~widget ()

void	bg_register (const SDL_Rect &rect)

void	bg_restore () const

void	bg_restore (const SDL_Rect &rect) const

void	bg_update ()

void	bg_cancel ()

CVideo &	video () const

virtual void	draw_contents ()

const SDL_Rect *	clip_rect () const

virtual sdl_handler_vector	member_handlers ()

virtual void	handle_window_event (const SDL_Event &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)

	sdl_handler (const sdl_handler &)

sdl_handler &	operator= (const sdl_handler &)

virtual	~sdl_handler ()

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

Private Member Functions
void	update_cursor ()
	Update the current cursor, set it to the reference cursor if mousex, mousey is over a cross-reference, otherwise, set it to the normal cursor. More...

void	show_topic (const topic &t, bool save_in_history=true)

void	move_in_history (std::deque< const topic > &from, std::deque< const topic > &to)
	Move in the topic history. More...

Private Attributes
help_menu	menu_

help_text_area	text_area_

const section &	toplevel_

bool	ref_cursor_

std::deque< const topic * >	back_topics_

std::deque< const topic * >	forward_topics_

gui::button	back_button_

gui::button	forward_button_

topic const *	shown_topic_