summaryrefslogtreecommitdiff
path: root/docs/reference
diff options
context:
space:
mode:
authorJohn Finlay <finlay@src.gnome.org>2006-07-12 07:47:15 +0000
committerJohn Finlay <finlay@src.gnome.org>2006-07-12 07:47:15 +0000
commit3e5dee029c5755ec1f5f104f63f05748891f8882 (patch)
tree95e6cdec1f28c47c16f553ecb5d96100ee057b52 /docs/reference
parent6f34249487c89299fa4b5068879a0fa97fbb44f4 (diff)
downloadpygtk-3e5dee029c5755ec1f5f104f63f05748891f8882.tar.gz
Add pygtk-unixprint-functions.xml.
* pygtk-unixprint-classes.xml: Add pygtk-unixprint-functions.xml. * pygtk-unixprint-functions.xml: Add gtk.unixprint.enumerate_printers. * pygtk-gtkprinter.xml (accepts_ps, accepts_pdf): Add.
Diffstat (limited to 'docs/reference')
-rw-r--r--docs/reference/ChangeLog8
-rw-r--r--docs/reference/pygtk-gdk-functions.xml42
-rw-r--r--docs/reference/pygtk-gtkprinter.xml57
-rw-r--r--docs/reference/pygtk-unixprint-classes.xml1
-rw-r--r--docs/reference/pygtk-unixprint-functions.xml82
5 files changed, 169 insertions, 21 deletions
diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index 96618675..2d600ead 100644
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,11 @@
+2006-07-12 John Finlay <finlay@moeraki.com>
+
+ * pygtk-unixprint-classes.xml: Add pygtk-unixprint-functions.xml.
+
+ * pygtk-unixprint-functions.xml: Add gtk.unixprint.enumerate_printers.
+
+ * pygtk-gtkprinter.xml (accepts_ps, accepts_pdf): Add.
+
2006-07-07 John Finlay <finlay@moeraki.com>
* pygtk-pangofontfamily.xml (is_monospace): Fix Returns description.
diff --git a/docs/reference/pygtk-gdk-functions.xml b/docs/reference/pygtk-gdk-functions.xml
index 03bea8b6..630e0898 100644
--- a/docs/reference/pygtk-gdk-functions.xml
+++ b/docs/reference/pygtk-gdk-functions.xml
@@ -31,7 +31,7 @@ linkend="constructor-gdkatom-intern">gtk.gdk.atom_intern</link></methodname>
linkend="function-gdk--color-parse">gtk.gdk.color_parse</link></methodname>
<methodparam><parameter
role="keyword">spec</parameter></methodparam>
- </methodsynopsis></programlisting>
+ </methodsynopsis></programlisting>
</refsect2>
@@ -444,26 +444,26 @@ linkend="function-gdk--window-at-pointer">gtk.gdk.window_at_pointer</link></meth
<title>Miscellaneous Functions</title>
<programlisting><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--pointer-grab">gtk.gdk.pointer_grab</link></methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">owner_events</parameter>
- <initializer>FALSE</initializer></methodparam>
- <methodparam><parameter
- role="keyword">event_mask</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">confine_to</parameter>
- <initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">cursor</parameter>
- <initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">time</parameter>
- <initializer>0L</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
+ <methodname><link
+ linkend="function-gdk--pointer-grab">gtk.gdk.pointer_grab</link></methodname>
+ <methodparam><parameter
+ role="keyword">window</parameter></methodparam>
+ <methodparam><parameter
+ role="keyword">owner_events</parameter>
+ <initializer>FALSE</initializer></methodparam>
+ <methodparam><parameter
+ role="keyword">event_mask</parameter>
+ <initializer>0</initializer></methodparam>
+ <methodparam><parameter
+ role="keyword">confine_to</parameter>
+ <initializer>None</initializer></methodparam>
+ <methodparam><parameter
+ role="keyword">cursor</parameter>
+ <initializer>None</initializer></methodparam>
+ <methodparam><parameter
+ role="keyword">time</parameter>
+ <initializer>0L</initializer></methodparam>
+ </methodsynopsis><methodsynopsis language="python">
<methodname><link
linkend="function-gdk--pointer-ungrab">gtk.gdk.pointer_ungrab</link></methodname>
<methodparam><parameter
diff --git a/docs/reference/pygtk-gtkprinter.xml b/docs/reference/pygtk-gtkprinter.xml
index 3574725d..ea6a5cc3 100644
--- a/docs/reference/pygtk-gtkprinter.xml
+++ b/docs/reference/pygtk-gtkprinter.xml
@@ -70,6 +70,14 @@ END NOT IMPLEMENTED -->
<methodname><link linkend="method-gtkprinter--compare">compare</link></methodname>
<methodparam><parameter role="keyword">b</parameter></methodparam>
</methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkprinter--accepts-pdf">accepts_pdf</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkprinter--accepts-ps">accepts_ps</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
</classsynopsis>
</refsect1>
@@ -557,6 +565,55 @@ END NOT IMPLEMENTED -->
</refsect2>
+ <refsect2 id="method-gtkprinter--accepts-pdf">
+ <title>gtk.unixprint.Printer.accepts_pdf</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>accepts_pdf</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis>&nbsp;:</term>
+ <listitem><simpara><literal>TRUE</literal> if the printer accepts
+ PDF</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.10 and above.</para>
+ </note>
+
+ <para>Returns whether the printer accepts input in PDF format.</para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtkprinter--accepts-ps">
+ <title>gtk.unixprint.Printer.accepts_ps</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>accepts_ps</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis>&nbsp;:</term>
+ <listitem><simpara><literal>TRUE</literal> if the printer accepts
+ PostScript</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.10 and above.</para>
+ </note>
+
+ <para>Returns whether the printer accepts input in PostScript
+ format.</para>
+
+ </refsect2>
+
</refsect1>
<refsect1>
diff --git a/docs/reference/pygtk-unixprint-classes.xml b/docs/reference/pygtk-unixprint-classes.xml
index 7b2e548b..52769f61 100644
--- a/docs/reference/pygtk-unixprint-classes.xml
+++ b/docs/reference/pygtk-unixprint-classes.xml
@@ -10,6 +10,7 @@
<xi:include href="pygtk-gtkprinter.xml"/>
<xi:include href="pygtk-gtkprintjob.xml"/>
<xi:include href="pygtk-gtkprintunixdialog.xml"/>
+ <xi:include href="pygtk-unixprint-functions.xml"/>
<xi:include href="pygtk-unixprint-constants.xml"/>
</chapter>
diff --git a/docs/reference/pygtk-unixprint-functions.xml b/docs/reference/pygtk-unixprint-functions.xml
new file mode 100644
index 00000000..cff94fdc
--- /dev/null
+++ b/docs/reference/pygtk-unixprint-functions.xml
@@ -0,0 +1,82 @@
+<?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="unixprint-functions">
+
+ <refnamediv>
+ <refname>gtk.unixprint Functions</refname>
+ <refpurpose>the built-in functions of the gtk.unixprint
+ module</refpurpose>
+ </refnamediv>
+
+ <refsect1>
+ <title>Synopsis</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname><link linkend="function-unixprint--enumerate-printers">gtk.unixprint.enumerate_printers</link></methodname>
+ <methodparam><parameter role="keyword">func</parameter></methodparam>
+ <methodparam><parameter role="keyword">data</parameter><initializer>None</initializer></methodparam>
+ <methodparam><parameter role="keyword">wait</parameter><initializer>TRUE</initializer></methodparam>
+ </methodsynopsis></programlisting>
+
+ </refsect1>
+
+ <refsect1>
+ <title>Functions</title>
+
+ <refsect2 id="function-unixprint--enumerate-printers">
+ <title>gtk.unixprint.enumerate_printers</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>gtk.unixprint.enumerate_printers</methodname>
+ <methodparam><parameter role="keyword">func</parameter></methodparam>
+ <methodparam><parameter role="keyword">data</parameter><initializer>None</initializer></methodparam>
+ <methodparam><parameter role="keyword">wait</parameter><initializer>TRUE</initializer></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">func</parameter>&nbsp;:</term>
+ <listitem><simpara>a function to call for each
+ printer</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">data</parameter>&nbsp;:</term>
+ <listitem><simpara>user data to pass to
+ <parameter>func</parameter></simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">wait</parameter>&nbsp;:</term>
+ <listitem><simpara>if <literal>TRUE</literal>, wait in a recursive
+ mainloop until all printers are enumerated; otherwise return
+ early</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This function is available in PyGTK 2.10 and above.</para>
+ </note>
+
+ <para>Calls the function specified by <parameter>func</parameter> for
+ all <link
+ linkend="class-gtkprinter"><classname>gtk.unixprint.Printer</classname></link>s.
+ If <parameter>func</parameter> returns <literal>TRUE</literal>, the
+ enumeration is stopped.</para>
+
+ <para>The signature of func is:</para>
+ <programlisting>
+ def func(printer, user_data):
+ </programlisting>
+ <para>where <parameter>printer</parameter> is a <link
+ linkend="class-gtkprinter"><classname>gtk.Printer</classname></link>
+ object and <parameter>user_data</parameter> is
+ <parameter>data</parameter>. Note if <parameter>data</parameter> is
+ not specified <parameter>user_data</parameter> will not be passed to
+ func.</para>
+
+ </refsect2>
+
+ </refsect1>
+
+</refentry>