gui2::tevent_executor Class Reference

Event execution calls. More...

#include <event_executor.hpp>

Inheritance diagram for gui2::tevent_executor:

List of all members.

Public Member Functions
	tevent_executor ()
virtual	~tevent_executor ()
void	set_wants_mouse_hover (const bool hover=true)
bool	wants_mouse_hover () const
void	set_wants_mouse_left_double_click (const bool click=true)
bool	wants_mouse_left_double_click () const
void	set_wants_mouse_middle_double_click (const bool click=true)
bool	wants_mouse_middle_double_click () const
tevent_executor &	set_wants_mouse_right_double_click (const bool click=true)
bool	wants_mouse_right_double_click () const
Private Attributes
bool	wants_mouse_hover_
	Does the widget want a hover event? See mouse_hover.
bool	wants_mouse_left_double_click_
	Does the widget want a left button double click? See mouse_left_button_double_click.
bool	wants_mouse_middle_double_click_
	See wants_mouse_left_double_click_.
bool	wants_mouse_right_double_click_
	See wants_mouse_left_double_click_.

---

Detailed Description

Event execution calls.

Base class with all possible events, most widgets can ignore most of these, but they are available. In order to use an event simply override the execution function and implement the wanted behaviour. The default behaviour defined here is to do nothing.

For more info about the event handling have a look at the tevent_handler class which 'translates' sdl events into 'widget' events.

Definition at line 36 of file event_executor.hpp.

---

Constructor & Destructor Documentation

gui2::tevent_executor::tevent_executor

(

)

[inline]

Definition at line 39 of file event_executor.hpp.

virtual gui2::tevent_executor::~tevent_executor

(

)

[inline, virtual]

Definition at line 46 of file event_executor.hpp.

---

Member Function Documentation

void gui2::tevent_executor::set_wants_mouse_hover

(

const bool

hover = true

)

[inline]

Definition at line 50 of file event_executor.hpp.

References wants_mouse_hover_.

Referenced by gui2::tcontrol::set_tooltip().

Here is the caller graph for this function:

void gui2::tevent_executor::set_wants_mouse_left_double_click

(

const bool

click = true

)

[inline]

Definition at line 54 of file event_executor.hpp.

References wants_mouse_left_double_click_.

Referenced by gui2::ttoggle_button::set_retval(), and gui2::ttext_box::ttext_box().

Here is the caller graph for this function:

void gui2::tevent_executor::set_wants_mouse_middle_double_click

(

const bool

click = true

)

[inline]

Definition at line 59 of file event_executor.hpp.

References wants_mouse_middle_double_click_.

tevent_executor& gui2::tevent_executor::set_wants_mouse_right_double_click

(

const bool

click = true

)

[inline]

Definition at line 64 of file event_executor.hpp.

References wants_mouse_right_double_click_.

bool gui2::tevent_executor::wants_mouse_hover

(

)

const [inline]

Definition at line 52 of file event_executor.hpp.

References wants_mouse_hover_.

bool gui2::tevent_executor::wants_mouse_left_double_click

(

)

const [inline]

Definition at line 56 of file event_executor.hpp.

References wants_mouse_left_double_click_.

bool gui2::tevent_executor::wants_mouse_middle_double_click

(

)

const [inline]

Definition at line 61 of file event_executor.hpp.

References wants_mouse_middle_double_click_.

bool gui2::tevent_executor::wants_mouse_right_double_click

(

)

const [inline]

Definition at line 66 of file event_executor.hpp.

References wants_mouse_right_double_click_.

---

Member Data Documentation

bool gui2::tevent_executor::wants_mouse_hover_ [private]

Does the widget want a hover event? See mouse_hover.

Definition at line 72 of file event_executor.hpp.

Referenced by set_wants_mouse_hover(), and wants_mouse_hover().

bool gui2::tevent_executor::wants_mouse_left_double_click_ [private]

Does the widget want a left button double click? See mouse_left_button_double_click.

Definition at line 78 of file event_executor.hpp.

Referenced by set_wants_mouse_left_double_click(), and wants_mouse_left_double_click().

bool gui2::tevent_executor::wants_mouse_middle_double_click_ [private]

See wants_mouse_left_double_click_.

Definition at line 81 of file event_executor.hpp.

Referenced by set_wants_mouse_middle_double_click(), and wants_mouse_middle_double_click().

bool gui2::tevent_executor::wants_mouse_right_double_click_ [private]

See wants_mouse_left_double_click_.

Definition at line 84 of file event_executor.hpp.

Referenced by set_wants_mouse_right_double_click(), and wants_mouse_right_double_click().

---

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

• gui/widgets/event_executor.hpp