From 0b6932cf263ac3dc68640e3f59e0d83678315aea Mon Sep 17 00:00:00 2001 From: Johan Dahlin Date: Fri, 1 Aug 2008 22:52:06 +0000 Subject: Separate the glib and gobject bindings in the manual. 2008-08-02 Johan Dahlin * docs/Makefile.am: * docs/reference/pyglib-constants.xml: * docs/reference/pyglib-functions.xml: * docs/reference/pyglib-maincontext.xml: * docs/reference/pyglib-mainloop.xml: * docs/reference/pygobject-classes.xml: * docs/reference/pygobject-constants.xml: * docs/reference/pygobject-functions.xml: * docs/reference/pygobject-maincontext.xml: * docs/reference/pygobject-mainloop.xml: Separate the glib and gobject bindings in the manual. svn path=/trunk/; revision=910 --- docs/reference/pyglib-maincontext.xml | 152 ++++++++++++++++++++++++++++++++++ 1 file changed, 152 insertions(+) create mode 100644 docs/reference/pyglib-maincontext.xml (limited to 'docs/reference/pyglib-maincontext.xml') diff --git a/docs/reference/pyglib-maincontext.xml b/docs/reference/pyglib-maincontext.xml new file mode 100644 index 0000000..ccb91bb --- /dev/null +++ b/docs/reference/pyglib-maincontext.xml @@ -0,0 +1,152 @@ + + + + + + glib.MainContext + + an object representing a set of event sources to be handled +in a glib.MainLoop. + + + + Synopsis + + + glib.MainContext + + glib.MainContext + + + iteration + may_block + + + pending + + + + + + + Ancestry + ++-- glib.MainContext + + + + + + Description + + A glib.MainContext +represents a set of event sources that can be run in a single thread. File +descriptors (plain files, pipes or sockets) and timeouts are the standard +event sources for GTK and PyGTK though +others can be added. Each event source is assigned a priority. The default +priority, glib.PRIORITY_DEFAULT, is 0. Values less +than 0 denote higher priorities. Values greater than 0 denote lower +priorities. Events from high priority sources are always processed before +events from lower priority sources. Single iterations of a glib.MainContext +can be run with the iteration() +method. + + + + + Constructor + + + glib.MainContext + + + + Returns : + a new glib.MainContext + object. + + + + Creates a new glib.MainContext +object. + + + + + Methods + + + glib.MainContext.iteration + + + iteration + + + + may_block : + if TRUE the call may block + waiting for an event. + + + Returns : + TRUE if events were + dispatched. + + + + The iteration() method runs a single +iteration. This involves: + + + + checking to see if any associated event sources are ready +to be processed; + + + then if no events sources are ready and +may_block is TRUE, waiting for a +source to become ready; + + + and finally, dispatching the highest priority events +sources that are ready + + + + Note that even when may_block is +TRUE, it is still possible for +iteration() to return FALSE, +since the the wait may be interrupted for other reasons than an event source +becoming ready. + + + + + glib.MainContext.pending + + + pending + + + + Returns : + TRUE if events are + pending. + + + + The pending() method checks if any +associated sources have pending events. + + + + + + -- cgit