Functions for handling events from the window system
Class GdkEvent( type )
| type | a GdkEventType |
Creates a new event of the given type. All fields are set to 0.
| Properties | |
| send_event | TRUE if the event was sent explicitly (e. |
| type | the type of the event (GdkEventType). |
| window | TODO the window which received the event. |
| Methods | |
| copy | Copies a GdkEvent, copying or incrementing the reference count of the resources associated with it (e.g. GdkWindow's and strings). |
| events_pending | Checks if any events are ready to be processed for any display. |
| get | Checks all open displays for a GdkEvent to process, to be processed on, fetching events from the windowing system if necessary. |
| get_axis | Extract the axis value for a particular axis use from an event structure. |
| get_coords | Extract the event window relative x/y coordinates from an event. |
| get_real_event | Get a copy of the event cast to its real derived-type. |
| get_root_coords | Extract the root window relative x/y coordinates from an event. |
| get_show_events | Gets whether event debugging output is enabled. |
| get_state | If the event contains a "state" field, returns it. Otherwise returns an empty state (0). |
| get_time | Returns the time stamp from event, if there is one; otherwise returns GDK_CURRENT_TIME. |
| peek | If there is an event waiting in the event queue of some open display, returns it. |
| 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 NULL. |
| set_show_events | Sets whether a trace of received events is output. |
TRUE if the event was sent explicitly (e.
TRUE if the event was sent explicitly (e.g. using XSendEvent).
the type of the event (GdkEventType).
the type of the event (GdkEventType).
TODO the window which received the event.
TODO the window which received the event.
Copies a GdkEvent, copying or incrementing the reference count of the resources associated with it (e.g. GdkWindow's and strings).
GdkEvent.copy()
| Return | a copy of the event. |
Checks if any events are ready to be processed for any display.
GdkEvent.events_pending()
| Return | TRUE if any events are pending. |
Checks all open displays for a GdkEvent to process, to be processed on, fetching events from the windowing system if necessary.
GdkEvent.get()
| Return | the next GdkEvent to be processed, or NULL if no events are pending. |
See gdk_display_get_event().
Extract the axis value for a particular axis use from an event structure.
GdkEvent.get_axis( axis_use )
| axis_use | the axis use to look for (GdkAxisUse). |
| Return | the value found or nil if the specified axis was not found. |
Extract the event window relative x/y coordinates from an event.
GdkEvent.get_coords()
| Return | an array ( window x coordinate, window y coordinate ), or nil if the event did not deliver event window coordinates. |
Get a copy of the event cast to its real derived-type.
GdkEvent.get_real_event()
| Return | one of the Gdk event types. |
Note: This is Falcon specific.
In classes already derived from GdkEvent, this is of course not of much use.
Extract the root window relative x/y coordinates from an event.
GdkEvent.get_root_coords()
| Return | an array ( window x coordinate, window y coordinate ), or nil if the event did not deliver root window coordinates |
Gets whether event debugging output is enabled.
GdkEvent.get_show_events()
| Return | TRUE if event debugging output is enabled. |
If the event contains a "state" field, returns it. Otherwise returns an empty state (0).
GdkEvent.get_state()
| Return | the state (GdkModifierType). |
Returns the time stamp from event, if there is one; otherwise returns GDK_CURRENT_TIME.
GdkEvent.get_time()
| Return | time stamp field from event |
If there is an event waiting in the event queue of some open display, returns it.
GdkEvent.peek()
| Return | the first GdkEvent on some event queue, or NULL if no events are in any queues. |
See gdk_display_peek_event().
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 NULL.
GdkEvent.put()
See gdk_display_put_event().
Sets whether a trace of received events is output.
GdkEvent.set_show_events( show_events )
| show_events | TRUE to output event debugging information. |
Note that GTK+ must be compiled with debugging (that is, configured using the --enable-debug option) to use this option.