The Battle for Wesnoth  1.13.10+dev
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Classes | Typedefs | Functions | Variables
events Namespace Reference

Handling of system events. More...

Classes

class  chat_command_handler
 
class  chat_handler
 
class  cmd_arg_parser
 
struct  command_disabler
 
class  console_handler
 
class  context
 
struct  event_context
 
class  generic_event
 
class  map_command_handler
 
class  menu_handler
 
class  mouse_handler
 
class  mouse_handler_base
 
class  observer
 
struct  pump_info
 
class  pump_monitor
 
struct  save_id_matches
 
class  sdl_handler
 

Typedefs

typedef std::list< sdl_handler * > handler_list
 

Functions

void focus_handler (const sdl_handler *ptr)
 
bool has_focus (const sdl_handler *hand, const SDL_Event *event)
 
static bool remove_on_resize (const SDL_Event &a)
 
void pump ()
 
void raise_process_event ()
 
void raise_resize_event ()
 
void raise_draw_event ()
 
void raise_draw_all_event ()
 
void raise_volatile_draw_event ()
 
void raise_volatile_draw_all_event ()
 
void raise_volatile_undraw_event ()
 
void raise_help_string_event (int mousex, int mousey)
 
bool is_input (const SDL_Event &event)
 Is the event an input event? More...
 
void discard_input ()
 Discards all input events. More...
 
void peek_for_resize ()
 
void call_in_main_thread (const std::function< void(void)> &f)
 
static bool command_active ()
 

Variables

std::deque< contextevent_contexts
 
std::vector< pump_monitor * > pump_monitors
 
const Uint32 resize_timeout = 100
 
SDL_Event last_resize_event
 
bool last_resize_event_used = true
 
static const boost::thread::id main_thread = boost::this_thread::get_id()
 
int commands_disabled = 0
 

Detailed Description

Handling of system events.

System events include mouse and key events, and other events which are not domain specific. The program maintains a stack of event_context objects, the top of the stack being the active event_context.

When an object of a type inheriting from handler is instantiated, it will be associated with the active event_context (unless auto_join has been set false, in which case it can manually be instructed to join a later context). As long as its event_context remains active, and only then, it will receive all system events.

Note
Multiple handler objects will receive the same events, including key events.

Typedef Documentation

typedef std::list<sdl_handler*> events::handler_list

Definition at line 35 of file events.hpp.

Function Documentation

void events::call_in_main_thread ( const std::function< void(void)> &  f)
static bool events::command_active ( )
static
void events::discard_input ( )

Discards all input events.

Definition at line 727 of file events.cpp.

References INPUT_MAX, and INPUT_MIN.

Referenced by game_launcher::play_multiplayer(), and game_launcher::play_multiplayer_commandline().

void events::focus_handler ( const sdl_handler *  ptr)

Definition at line 330 of file events.cpp.

Referenced by gui::textbox::handle_event(), has_focus(), and gui::widget::set_focus().

bool events::has_focus ( const sdl_handler *  hand,
const SDL_Event *  event 
)

Definition at line 337 of file events.cpp.

References focus_handler(), i, and events::sdl_handler::requires_event_focus().

Referenced by gui::widget::focus().

bool events::is_input ( const SDL_Event &  event)

Is the event an input event?

Returns
Whether or not the event is an input event.

Definition at line 722 of file events.cpp.

References INPUT_MAX, and INPUT_MIN.

Referenced by pump().

void events::peek_for_resize ( )

Definition at line 732 of file events.cpp.

References CVideo::get_singleton(), i, and CVideo::update_framebuffer().

Referenced by pump().

void events::pump ( )
void events::raise_draw_all_event ( )

Definition at line 663 of file events.cpp.

References events::context::handlers.

void events::raise_draw_event ( )
void events::raise_help_string_event ( int  mousex,
int  mousey 
)

Definition at line 699 of file events.cpp.

Referenced by pump().

void events::raise_process_event ( )

Definition at line 627 of file events.cpp.

Referenced by controller_base::play_slice(), and help::show_help().

void events::raise_resize_event ( )
void events::raise_volatile_draw_all_event ( )

Definition at line 681 of file events.cpp.

References events::context::handlers.

void events::raise_volatile_draw_event ( )

Definition at line 672 of file events.cpp.

Referenced by display::flip().

void events::raise_volatile_undraw_event ( )

Definition at line 690 of file events.cpp.

Referenced by display::flip().

static bool events::remove_on_resize ( const SDL_Event &  a)
static

Definition at line 385 of file events.cpp.

References DRAW_ALL_EVENT, DRAW_EVENT, and SHOW_HELPTIP_EVENT.

Referenced by pump().

Variable Documentation

int events::commands_disabled = 0
std::deque<context> events::event_contexts

Definition at line 185 of file events.cpp.

SDL_Event events::last_resize_event

Definition at line 382 of file events.cpp.

Referenced by pump().

bool events::last_resize_event_used = true

Definition at line 383 of file events.cpp.

Referenced by pump().

const boost::thread::id events::main_thread = boost::this_thread::get_id()
static

Definition at line 407 of file events.cpp.

std::vector<pump_monitor*> events::pump_monitors

Definition at line 187 of file events.cpp.

const Uint32 events::resize_timeout = 100

Definition at line 381 of file events.cpp.

Referenced by pump().