blob: 5d38ec1127b714fcf79bdcb6cab3640bbd808849 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
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>gtkunixprint Functions</refname>
<refpurpose>the built-in functions of the gtkunixprint
module</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<programlisting><methodsynopsis language="python">
<methodname><link linkend="function-unixprint--enumerate-printers">gtkunixprint.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>gtkunixprint.enumerate_printers</title>
<programlisting><methodsynopsis language="python">
<methodname>gtkunixprint.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> :</term>
<listitem><simpara>a function to call for each
printer</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">data</parameter> :</term>
<listitem><simpara>user data to pass to
<parameter>func</parameter></simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">wait</parameter> :</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>gtkunixprint.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>gtkunixprint.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>
|
