sdl::event::Queue Class Reference

The event queue. More...

#include <Queue.h>

List of all members.

Public Types
typedef int(*	EventFilter )(const SDL_Event *event)
	The type of the event filter function.
Public Member Functions
void	SetFilter (EventFilter filter)
EventFilter	getFilter ()
int	getEventState (int type)
int	ignoreEvent (int type)
int	disableEvent (int type)
int	enableEvent (int type)
bool	empty ()
SDL_Event	pop ()
bool	push (SDL_Event &event)
Queue &	pump ()
SDL_Event	wait ()
Static Public Member Functions
static Queue &	instance ()

---

Detailed Description

The event queue.

Definition at line 34 of file Queue.h.

---

Member Typedef Documentation

int(* sdl::event::Queue::EventFilter)(const SDL_Event *event),

The type of the event filter function.

Parameters:

event

The event to filter.

Returns:

1 to add the event to the queue, 0 to drop the event from the queue.

Definition at line 44 of file Queue.h.

---

Member Function Documentation

int sdl::event::Queue::disableEvent

(

int

type

)

[inline]

Disables a specific event.

Parameters:

type	The type of the event to disable.

Returns:

no idea.

Definition at line 95 of file Queue.h.

bool sdl::event::Queue::empty

(

)

[inline]

Definition at line 111 of file Queue.h.

int sdl::event::Queue::enableEvent

(

int

type

)

[inline]

Enables a specific event.

Parameters:

type	The type of the event to enable.

Returns:

no idea.

Definition at line 104 of file Queue.h.

int sdl::event::Queue::getEventState

(

int

type

)

[inline]

Returns the processing state of the specified event type.

Parameters:

type	The event type.

Returns:

The event state.

Definition at line 77 of file Queue.h.

EventFilter sdl::event::Queue::getFilter

(

)

[inline]

Returns the pointer to the event filter function.

Returns:

The pointer to the event filter function.

Definition at line 68 of file Queue.h.

int sdl::event::Queue::ignoreEvent

(

int

type

)

[inline]

Definition at line 86 of file Queue.h.

static Queue& sdl::event::Queue::instance

(

)

[inline, static]

Definition at line 51 of file Queue.h.

SDL_Event sdl::event::Queue::pop

(

)

[inline]

Definition at line 120 of file Queue.h.

Queue& sdl::event::Queue::pump

(

)

[inline]

Definition at line 140 of file Queue.h.

bool sdl::event::Queue::push

(

SDL_Event &

event

)

[inline]

Definition at line 133 of file Queue.h.

void sdl::event::Queue::SetFilter

(

EventFilter

filter

)

[inline]

Sets the event filter function.

Parameters:

filter

The pointer to the event filter function.

Definition at line 61 of file Queue.h.

SDL_Event sdl::event::Queue::wait

(

)

[inline]

Definition at line 152 of file Queue.h.

---

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

• event/Queue.h