#include <event.h>

Public Member Functions
	Event ()

	Event (GdkEvent *gobject, bool make_a_copy=true)

	Event (const Event &other)

Event &	operator= (const Event &other)

	~Event ()

void	swap (Event &other)

GdkEvent *	gobj ()
	Provides access to the underlying C instance. More...

const GdkEvent *	gobj () const
	Provides access to the underlying C instance. More...

GdkEvent *	gobj_copy () const
	Provides access to the underlying C instance. The caller is responsible for freeing it. Use when directly setting fields in structs. More...

void	put ()

guint32	get_time () const

bool	get_state (ModifierType &state) const

bool	get_coords (double &x_win, double &y_win) const

bool	get_root_coords (double &x_root, double &y_root) const

bool	get_axis (AxisUse axis_use, double &value) const

void	set_screen (const Glib::RefPtr< Screen > &screen)

Glib::RefPtr< Screen >	get_screen ()

Glib::RefPtr< const Screen >	get_screen () const

bool	send_client_message (NativeWindow winid)

bool	send_client_message (const Glib::RefPtr< Display > &display, NativeWindow winid)

Static Public Member Functions
static GType	get_type () G_GNUC_CONST

static Event	get ()

static Event	peek ()

static Event	get_graphics_expose (const Glib::RefPtr< Window > &window)

static bool	events_pending ()

static void	set_show_events (bool show_events)

static bool	get_show_events ()

Protected Attributes
GdkEvent *	gobject_

Related Functions
(Note that these are not member functions.)
void	swap (Event &lhs, Event &rhs)

Gdk::Event	wrap (GdkEvent *object, bool take_copy=false)

Detailed Description

Definition at line 191 of file event.h.

Constructor & Destructor Documentation

◆ Event() [1/3]

Gdk::Event::Event ( )

◆ Event() [2/3]

Gdk::Event::Event	(	GdkEvent *	gobject,
		bool	make_a_copy = `true`
	)

explicit

◆ Event() [3/3]

Gdk::Event::Event ( const Event & other )

◆ ~Event()

Gdk::Event::~Event ( )

Member Function Documentation

◆ events_pending()

static bool Gdk::Event::events_pending ( )

static

Checks if any events are ready to be processed for any display.

Returns: true if any events are pending.

◆ get()

static Event Gdk::Event::get ( )

static

Checks all open displays for a Gdk::Event to process,to be processed on, fetching events from the windowing system if necessary. See Gdk::Display::get_event().

Returns: The next Gdk::Event to be processed, or 0 if no events are pending. The returned Gdk::Event should be freed with free().

◆ get_axis()

bool Gdk::Event::get_axis	(	AxisUse	axis_use,
		double &	value
	)		const

Extract the axis value for a particular axis use from an event structure.

Parameters

axis_use	The axis use to look for.
value	Location to store the value found.

Returns: true if the specified axis was found, otherwise false.

◆ get_coords()

bool Gdk::Event::get_coords	(	double &	x_win,
		double &	y_win
	)		const

Extract the event window relative x/y coordinates from an event.

Parameters

x_win	Location to put event window x coordinate.
y_win	Location to put event window y coordinate.

Returns: true if the event delivered event window coordinates.

◆ get_graphics_expose()

static Event Gdk::Event::get_graphics_expose ( const Glib::RefPtr< Window > & window )

static

Waits for a GraphicsExpose or NoExpose event from the X server. This is used in the Gtk::Text and Gtk::CList widgets in GTK+ to make sure any GraphicsExpose events are handled before the widget is scrolled.

Deprecated: 2.18:

Parameters

window The Gdk::Window to wait for the events for.

Returns: A Gdk::EventExpose if a GraphicsExpose was received, or 0 if a NoExpose event was received.

◆ get_root_coords()

bool Gdk::Event::get_root_coords	(	double &	x_root,
		double &	y_root
	)		const

Extract the root window relative x/y coordinates from an event.

Parameters

x_root	Location to put root window x coordinate.
y_root	Location to put root window y coordinate.

Returns: true if the event delivered root window coordinates.

◆ get_screen() [1/2]

Glib::RefPtr<Screen> Gdk::Event::get_screen ( )

Returns the screen for the event. The screen is typically the screen for event->any.window, but for events such as mouse events, it is the screen where the pointer was when the event occurs - that is, the screen which has the root window to which event->motion.x_root and event->motion.y_root are relative.

Returns: The screen for the event.

◆ get_screen() [2/2]

Glib::RefPtr<const Screen> Gdk::Event::get_screen ( ) const

Returns the screen for the event. The screen is typically the screen for event->any.window, but for events such as mouse events, it is the screen where the pointer was when the event occurs - that is, the screen which has the root window to which event->motion.x_root and event->motion.y_root are relative.

Returns: The screen for the event.

◆ get_show_events()

static bool Gdk::Event::get_show_events ( )

static

Gets whether event debugging output is enabled.

Returns: true if event debugging output is enabled.

◆ get_state()

bool Gdk::Event::get_state ( ModifierType & state ) const

If the event contains a "state" field, puts that field in state. Otherwise stores an empty state (0). Returns true if there was a state field in the event. event may be 0, in which case it's treated as if the event had no state field.

Parameters

state Return location for state.

Returns: true if there was a state field in the event.

◆ get_time()

guint32 Gdk::Event::get_time ( ) const

Returns the time stamp from event, if there is one; otherwise returns Gdk::CURRENT_TIME. If event is 0, returns Gdk::CURRENT_TIME.

Returns: Time stamp field from event.

◆ get_type()

static GType Gdk::Event::get_type ( )

static

Get the GType for this class, for use with the underlying GObject type system.

◆ gobj() [1/2]

GdkEvent* Gdk::Event::gobj ( )

inline

Provides access to the underlying C instance.

Definition at line 215 of file event.h.

◆ gobj() [2/2]

const GdkEvent* Gdk::Event::gobj ( ) const

inline

Provides access to the underlying C instance.

Definition at line 218 of file event.h.

◆ gobj_copy()

GdkEvent* Gdk::Event::gobj_copy ( ) const

Provides access to the underlying C instance. The caller is responsible for freeing it. Use when directly setting fields in structs.

◆ operator=()

Event& Gdk::Event::operator= ( const Event & other )

◆ peek()

static Event Gdk::Event::peek ( )

static

If there is an event waiting in the event queue of some open display, returns a copy of it. See Gdk::Display::peek_event().

Returns: A copy of the first Gdk::Event on some event queue, or 0 if no events are in any queues. The returned Gdk::Event should be freed with free().

◆ put()

void Gdk::Event::put ( )

Appends a copy of the given event onto the front of the event queue for event->any.window's display, or the default event queue if event->any.window is 0. See Gdk::Display::put_event().

◆ send_client_message() [1/2]

bool Gdk::Event::send_client_message	(	const Glib::RefPtr< Display > &	display,
		NativeWindow	winid
	)

◆ send_client_message() [2/2]

bool Gdk::Event::send_client_message ( NativeWindow winid )

Sends an X ClientMessage event to a given window (which must be on the default Gdk::Display.) This could be used for communicating between different applications, though the amount of data is limited to 20 bytes.

Parameters

winid The window to send the X ClientMessage event to.

Returns: Non-zero on success.

◆ set_screen()

void Gdk::Event::set_screen ( const Glib::RefPtr< Screen > & screen )

Sets the screen for event to screen. The event must have been allocated by GTK+, for instance, by copy().

Parameters

screen A Gdk::Screen.

◆ set_show_events()

static void Gdk::Event::set_show_events ( bool show_events )

static

Sets whether a trace of received events is output. Note that GTK+ must be compiled with debugging (that is, configured using the –enable-debug option) to use this option.

Parameters

show_events true to output event debugging information.

◆ swap()

void Gdk::Event::swap ( Event & other )

Friends And Related Function Documentation

◆ swap()

void swap	(	Event &	lhs,
		Event &	rhs
	)

lhs	The left-hand side
rhs	The right-hand side

Definition at line 397 of file event.h.

◆ wrap()

Gdk::Event wrap	(	GdkEvent *	object,
		bool	take_copy = `false`
	)

Parameters

object	The C instance.
take_copy	False if the result should take ownership of the C instance. True if it should take a new copy or ref.

Returns: A C++ instance that wraps this C instance.

Member Data Documentation

◆ gobject_

GdkEvent* Gdk::Event::gobject_

protected

Definition at line 224 of file event.h.

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

event.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Related Functions

Detailed Description

Constructor & Destructor Documentation

◆ Event() [1/3]

◆ Event() [2/3]

◆ Event() [3/3]

◆ ~Event()

Member Function Documentation

◆ events_pending()

◆ get()

◆ get_axis()

◆ get_coords()

◆ get_graphics_expose()

◆ get_root_coords()

◆ get_screen() [1/2]

◆ get_screen() [2/2]

◆ get_show_events()

◆ get_state()

◆ get_time()

◆ get_type()

◆ gobj() [1/2]

◆ gobj() [2/2]

◆ gobj_copy()

◆ operator=()

◆ peek()

◆ put()

◆ send_client_message() [1/2]

◆ send_client_message() [2/2]

◆ set_screen()

◆ set_show_events()

◆ swap()

Friends And Related Function Documentation

◆ swap()

◆ wrap()

Member Data Documentation

◆ gobject_