The Battle for Wesnoth: events::sdl_handler Class Reference

The Battle for Wesnoth 1.13.4+dev

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages

#include <events.hpp>

Inheritance diagram for events::sdl_handler:

Inheritance graph

Public Member Functions
virtual void	handle_event (const SDL_Event &event)=0

virtual void	handle_window_event (const SDL_Event &event)=0

virtual void	process_event ()

virtual void	draw ()

virtual void	volatile_draw ()

virtual void	volatile_undraw ()

virtual bool	requires_event_focus (const SDL_Event *=nullptr) const

virtual void	process_help_string (int, int)

virtual void	process_tooltip_string (int, int)

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 ()

Protected Member Functions
	sdl_handler (const bool auto_join=true)

virtual	~sdl_handler ()

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

Private Attributes
bool	has_joined_

bool	has_joined_global_

Detailed Description

Definition at line 62 of file events.hpp.

Constructor & Destructor Documentation

events::sdl_handler::sdl_handler ( const bool auto_join = true )

protected

Definition at line 151 of file events.cpp.

References has_joined_.

events::sdl_handler::~sdl_handler ( )

protectedvirtual

Definition at line 163 of file events.cpp.

References has_joined_, has_joined_global_, leave(), and leave_global().

Member Function Documentation

virtual void events::sdl_handler::draw ( )

inlinevirtual

Reimplemented in display, gui::menu, mp::gamebrowser, location_palette_item, gui::dialog_frame, gui::widget, editor::editor_palette< Item >, editor::editor_palette< unit_type >, editor::editor_palette< overlay >, editor::editor_palette< t_translation::t_terrain >, gui::tristate_button, gui::scrollpane, editor::common_palette, editor::location_palette, and editor::empty_palette.

Definition at line 68 of file events.hpp.

Referenced by storyscreen::part_ui::handle_event(), and gui2::event::thandler::handle_event().

virtual void events::sdl_handler::handle_event ( const SDL_Event & event )

pure virtual

virtual void events::sdl_handler::handle_window_event ( const SDL_Event & event )

pure virtual

Implemented in display, gui2::event::tdistributor::layer, CVideo::video_event_handler, hotkey::basic_handler, gui2::event::thandler, controller_base, gui::dialog_frame, gui::widget, storyscreen::part_ui, and preferences::prefs_event_handler.

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

inlineprotectedvirtual

void events::sdl_handler::join ( )

virtual

Reimplemented in help::help_button.

Definition at line 173 of file events.cpp.

Referenced by gui2::event::thandler::connect(), join_same(), mp::lobby::process_event_impl(), storyscreen::part_ui::show(), gui::dialog::show(), gui2::event::thandler::thandler(), and gui::dialog::update_widget_positions().

void events::sdl_handler::join ( context & c )

virtual

Definition at line 177 of file events.cpp.

References events::context::add_handler(), handler_members(), has_joined_, i, and leave().

void events::sdl_handler::join_global ( )

virtual

Definition at line 230 of file events.cpp.

References events::context::add_handler(), handler_members(), has_joined_global_, i, and leave_global().

Referenced by preferences::base_manager::base_manager(), and CVideo::init_window().

void events::sdl_handler::join_same ( sdl_handler * parent )

virtual

Definition at line 195 of file events.cpp.

References gui2::event::find(), has_joined_, i, join(), and leave().

void events::sdl_handler::leave ( )

virtual

Reimplemented in help::help_button.

Definition at line 212 of file events.cpp.

References handler_members(), has_joined_, and i.

Referenced by gui2::event::thandler::disconnect(), gui::dialog::get_empty_menu(), join(), join_same(), storyscreen::part_ui::show(), gui::dialog::update_widget_positions(), ~sdl_handler(), and gui2::event::thandler::~thandler().

void events::sdl_handler::leave_global ( )

virtual

Definition at line 248 of file events.cpp.

References handler_members(), has_joined_global_, i, and events::context::remove_handler().

Referenced by join_global(), and ~sdl_handler().

virtual void events::sdl_handler::process_event ( )

inlinevirtual

Reimplemented in mp::lobby, dialogs::unit_types_preview_pane, mp::ui, dialogs::units_list_preview_pane, mp::connect, dialogs::unit_preview_pane, gui::scrollbar, mp::wait::leader_preview_pane, help::help_browser, mp::configure, gui::combo_drag, mp::create, gui::scrollarea, gui::combo, and mp::wait.

Definition at line 67 of file events.hpp.

virtual void events::sdl_handler::process_help_string	(	int	,
		int
	)

inlinevirtual

Reimplemented in gui::menu, and gui::widget.

Definition at line 75 of file events.hpp.

virtual void events::sdl_handler::process_tooltip_string	(	int	,
		int
	)

inlinevirtual

Reimplemented in gui::widget.

Definition at line 76 of file events.hpp.

virtual bool events::sdl_handler::requires_event_focus ( const SDL_Event * = nullptr ) const

inlinevirtual

Reimplemented in gui::menu, gui::textbox, and gui::slider.

Definition at line 73 of file events.hpp.

Referenced by events::has_focus().

virtual void events::sdl_handler::volatile_draw ( )

inlinevirtual

Reimplemented in gui::widget.

Definition at line 70 of file events.hpp.

virtual void events::sdl_handler::volatile_undraw ( )

inlinevirtual

Reimplemented in gui::widget.

Definition at line 71 of file events.hpp.

Member Data Documentation

bool events::sdl_handler::has_joined_

private

Definition at line 95 of file events.hpp.

Referenced by join(), join_same(), leave(), sdl_handler(), and ~sdl_handler().

bool events::sdl_handler::has_joined_global_

private

Definition at line 96 of file events.hpp.

Referenced by join_global(), leave_global(), and ~sdl_handler().

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