diff options
| author | Johan Dahlin <johan@gnome.org> | 2008-08-01 22:52:06 +0000 |
|---|---|---|
| committer | Johan Dahlin <johan@src.gnome.org> | 2008-08-01 22:52:06 +0000 |
| commit | 0b6932cf263ac3dc68640e3f59e0d83678315aea (patch) | |
| tree | 467fa195ea553e53eca9e371ce7b59927bf1e841 /docs/reference/pygobject-mainloop.xml | |
| parent | 9e22741a4683e4184ffcdaf7382b0ba045f4a3be (diff) | |
| download | pygobject-0b6932cf263ac3dc68640e3f59e0d83678315aea.tar.gz pygobject-0b6932cf263ac3dc68640e3f59e0d83678315aea.tar.xz pygobject-0b6932cf263ac3dc68640e3f59e0d83678315aea.zip | |
Separate the glib and gobject bindings in the manual.
2008-08-02 Johan Dahlin <johan@gnome.org>
* 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
Diffstat (limited to 'docs/reference/pygobject-mainloop.xml')
| -rw-r--r-- | docs/reference/pygobject-mainloop.xml | 202 |
1 files changed, 0 insertions, 202 deletions
diff --git a/docs/reference/pygobject-mainloop.xml b/docs/reference/pygobject-mainloop.xml deleted file mode 100644 index d90f534..0000000 --- a/docs/reference/pygobject-mainloop.xml +++ /dev/null @@ -1,202 +0,0 @@ -<?xml version="1.0" standalone="no"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" - "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> - -<refentry id="class-gobjectmainloop"> - <refnamediv> - <refname>gobject.MainLoop</refname> - - <refpurpose>an object representing the main event loop of a PyGTK - application.</refpurpose> - </refnamediv> - - <refsect1> - <title>Synopsis</title> - -<classsynopsis language="python"> - <ooclass><classname>gobject.MainLoop</classname></ooclass> -<constructorsynopsis language="python"> - <methodname><link linkend="constructor-gobjectmainloop">gobject.MainLoop</link></methodname> - <methodparam><parameter>context</parameter><initializer>None</initializer></methodparam> - <methodparam><parameter>is_running</parameter><initializer>0</initializer></methodparam> - </constructorsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gobjectmainloop--get-context">get_context</link></methodname> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gobjectmainloop--is-running">is_running</link></methodname> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gobjectmainloop--quit">quit</link></methodname> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gobjectmainloop--run">run</link></methodname> - </methodsynopsis> -</classsynopsis> - -</refsect1> - - <refsect1> - <title>Ancestry</title> - -<synopsis>+-- <link linkend="class-gobjectmainloop">gobject.MainLoop</link> -</synopsis> - - </refsect1> - - <refsect1> - <title>Description</title> - - <para><link -linkend="class-gobjectmainloop"><classname>gobject.MainLoop</classname></link> -represents a main event loop. A <link -linkend="class-gobjectmainloop"><classname>gobject.MainLoop</classname></link> -is created with the <link -linkend="constructor-gobjectmainloop">gobject.MainLoop</link>() -constructor. After adding the initial event sources, the <link -linkend="method-gobjectmainloop--run"><methodname>run</methodname>()</link> -method is called. This continuously checks for new events from each of the -event sources and dispatches them. Finally, the processing of an event from -one of the sources leads to a call to the <link -linkend="method-gobjectmainloop--quit"><methodname>quit</methodname>()</link> -method to exit the main loop, and the <link -linkend="method-gobjectmainloop--run"><methodname>run</methodname>()</link> -method returns.</para> - - <para>It is possible to create new instances of <link -linkend="class-gobjectmainloop"><classname>gobject.MainLoop</classname></link> -recursively. This is often used in <literal>PyGTK</literal> applications -when showing modal dialog boxes. Note that event sources are associated with -a particular <link -linkend="class-gobjectmaincontext"><classname>gobject.MainContext</classname></link>, -and will be checked and dispatched for all main loops associated with that -<link -linkend="class-gobjectmaincontext"><classname>gobject.MainContext</classname></link>.</para> - - <para><literal>PyGTK</literal> contains wrappers of some of these -functions, e.g. the <link -linkend="function-gtk--main"><function>gtk.main</function>()</link>, <link -linkend="function-gtk--main-quit"><function>gtk.main_quit</function>()</link> -and <link -linkend="function-gtk--events-pending"><function>gtk.events_pending</function>()</link> -functions.</para> - - </refsect1> - - <refsect1 id="constructor-gobjectmainloop"> - <title>Constructor</title> - - <programlisting><constructorsynopsis language="python"> - <methodname>gobject.MainLoop</methodname> - <methodparam><parameter>context</parameter><initializer>None</initializer></methodparam> - <methodparam><parameter>is_running</parameter><initializer>None</initializer></methodparam> - </constructorsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter>context</parameter> :</term> - <listitem><simpara>a <link - linkend="class-gobjectmaincontext"><classname>gobject.MainContext</classname></link> - or <literal>None</literal> to use the default - context.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>is_running</parameter> :</term> - <listitem><simpara>if <literal>TRUE</literal> indicates that the - loop is running. This is not very important since calling the <link - linkend="method-gobjectmainloop--run"><methodname>run</methodname>()</link> - method will set this to <literal>TRUE</literal> - anyway.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a new <link - linkend="class-gobjectmainloop"><classname>gobject.MainLoop</classname></link> - object.</simpara></listitem> - </varlistentry> - </variablelist> - - <para>Creates a new <link -linkend="class-gobjectmainloop"><classname>gobject.MainLoop</classname></link> -object.</para> - - </refsect1> - - <refsect1> - <title>Methods</title> - - <refsect2 id="method-gobjectmainloop--get-context"> - <title>gobject.MainLoop.get_context</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_context</methodname> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the <link - linkend="class-gobjectmaincontext"><classname>gobject.MainContext</classname></link> - the mainloop is associated with</simpara></listitem> - </varlistentry> - </variablelist> - - <para>The <methodname>get_context</methodname>() method returns the -<link -linkend="class-gobjectmaincontext"><classname>gobject.MainContext</classname></link> -that the mainloop was created with.</para> - - </refsect2> - - <refsect2 id="method-gobjectmainloop--is-running"> - <title>gobject.MainLoop.is_running</title> - - <programlisting><methodsynopsis language="python"> - <methodname>is_running</methodname> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara><literal>TRUE</literal> if the mainloop is - currently being run.</simpara></listitem> - </varlistentry> - </variablelist> - - <para>The <methodname>is_running</methodname>() method checks to see -if the mainloop is currently being run via the <link -linkend="method-gobjectmainloop--run"><methodname>run</methodname>()</link> -method.</para> - - </refsect2> - - <refsect2 id="method-gobjectmainloop--quit"> - <title>gobject.MainLoop.quit</title> - - <programlisting><methodsynopsis language="python"> - <methodname>quit</methodname> - </methodsynopsis></programlisting> - - <para>The <methodname>quit</methodname>() method stops the mainloop -from running. Any subsequent calls to the <link -linkend="method-gobjectmainloop--run"><methodname>run</methodname>()</link> -method will return immediately.</para> - - </refsect2> - - <refsect2 id="method-gobjectmainloop--run"> - <title>gobject.MainLoop.run</title> - - <programlisting><methodsynopsis language="python"> - <methodname>run</methodname> - </methodsynopsis></programlisting> - - <para>The <methodname>run</methodname>() method runs a mainloop until -the <link -linkend="method-gobjectmainloop--quit"><methodname>quit</methodname>()</link> -method is called. If this is called for the thread of the loop's <link -linkend="class-gobjectmaincontext"><classname>gobject.MainContext</classname></link>, -it will process events from the loop, otherwise it will simply wait.</para> - - </refsect2> - - </refsect1> - -</refentry> |
