Remove gtk_main_do_event from the docs

This commit is contained in:
Matthias Clasen 2020-02-09 10:55:37 -05:00
parent ebc24d75af
commit 057f41532b
2 changed files with 0 additions and 39 deletions

View File

@ -4424,7 +4424,6 @@ gtk_main_level
gtk_main_quit
gtk_main_iteration
gtk_main_iteration_do
gtk_main_do_event
<SUBSECTION>
gtk_grab_add

View File

@ -1866,44 +1866,6 @@ handle_dnd_event (GdkEvent *event)
return target;
}
/**
* gtk_main_do_event:
* @event: An event to process (normally passed by GDK)
*
* Processes a single GDK event.
*
* This is public only to allow filtering of events between GDK and GTK.
* You will not usually need to call this function directly.
*
* While you should not call this function directly, you might want to
* know how exactly events are handled. So here is what this function
* does with the event:
*
* 1. Compress enter/leave notify events. If the event passed build an
* enter/leave pair together with the next event (peeked from GDK), both
* events are thrown away. This is to avoid a backlog of (de-)highlighting
* widgets crossed by the pointer.
*
* 2. Find the widget which got the event. If the widget cant be determined
* the event is thrown away unless it belongs to a INCR transaction.
*
* 3. Then the event is pushed onto a stack so you can query the currently
* handled event with gtk_get_current_event().
*
* 4. The event is sent to a widget. If a grab is active all events for widgets
* that are not in the contained in the grab widget are sent to the latter
* with a few exceptions:
* - Deletion and destruction events are still sent to the event widget for
* obvious reasons.
* - Events which directly relate to the visual representation of the event
* widget.
* - Leave events are delivered to the event widget if there was an enter
* event delivered to it before without the paired leave event.
* - Drag events are not redirected because it is unclear what the semantics
* of that would be.
*
* 5. After finishing the delivery the event is popped from the event stack.
*/
void
gtk_main_do_event (GdkEvent *event)
{