brl/mutter
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Clarify the event retrieval disable behaviour

Browse Source 
When we disable the event retrieval, we now just disable the X11 event
source, not the event selection. We need to make that clear to
applications, especially compositors, which might expect complete
control over the selection.
This commit is contained in:
Emmanuele Bassi 2010-08-03 16:30:04 +01:00
parent 609560b1cb
commit da6b2660ba
1 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
clutter/x11/clutter-backend-x11.c
View File

@ -675,15 +675,23 @@ clutter_x11_enable_xinput (void)
/**
* clutter_x11_disable_event_retrieval:
*
* Disables the internal handling of X11 events in the main loop.
* Disables the internal polling of X11 events in the main loop.
*
* Libraries or applications calling this function will be responsible of
* handling all X11 events.
* polling all X11 events.
*
* You also must call clutter_x11_handle_event() to let Clutter process
* events and maintain its internal state.
*
* <note>This function can only be called before calling clutter_init().</note>
* <warning>This function can only be called before calling
* clutter_init().</warning>
*
* <note>Even with event handling disabled, Clutter will still select
* all the events required to maintain its internal state on the stage
* Window; compositors using Clutter should not rely on an empty input
* region, and should instead clear it themselves explicitly.</note>
*
* This function should not be normally used by applications.
*
* Since: 0.8
*/