summaryrefslogtreecommitdiff
path: root/docs/reference/pygtk-gtkpagesetupunixdialog.xml
blob: 793d5fd46cd9d0e6d74d939672e858d964b5add4 (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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
<?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-gtkpagesetupunixdialog">

  <refnamediv>
    <refname>gtkunixprint.PageSetupUnixDialog</refname>
      <refpurpose>a dialog for setting up a printer page on Unix (new in
      PyGTK 2.10)</refpurpose>
  </refnamediv>

  <refsect1>
    <title>Synopsis</title>

    <classsynopsis language="python">
      <ooclass><classname>gtkunixprint.PageSetupUnixDialog</classname></ooclass>
      <ooclass><classname><link linkend="class-gtkdialog">gtk.Dialog</link></classname></ooclass>
      <constructorsynopsis language="python">
        <methodname><link linkend="constructor-gtkpagesetupunixdialog">gtkunixprint.PageSetupUnixDialog</link></methodname>
        <methodparam><parameter role="keyword">title</parameter><initializer>None</initializer></methodparam>
        <methodparam><parameter role="keyword">parent</parameter><initializer>None</initializer></methodparam>
      </constructorsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkpagesetupunixdialog--set-page-setup">set_page_setup</link></methodname>
        <methodparam><parameter role="keyword">page_setup</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkpagesetupunixdialog--get-page-setup">get_page_setup</link></methodname>
        <methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkpagesetupunixdialog--set-print-settings">set_print_settings</link></methodname>
        <methodparam><parameter role="keyword">print_settings</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkpagesetupunixdialog--get-print-settings">get_print_settings</link></methodname>
        <methodparam></methodparam>
      </methodsynopsis>
</classsynopsis>

  </refsect1>

  <refsect1>
    <title>Ancestry</title>

<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
  +-- <link linkend="class-gtkobject">gtk.Object</link>
    +-- <link linkend="class-gtkwidget">gtk.Widget</link>
      +-- <link linkend="class-gtkcontainer">gtk.Container</link>
        +-- <link linkend="class-gtkbin">gtk.Bin</link>
          +-- <link linkend="class-gtkwindow">gtk.Window</link>
            +-- <link linkend="class-gtkdialog">gtk.Dialog</link>
              +-- <link linkend="class-gtkpagesetupunixdialog">gtkunixprint.PageSetupUnixDialog</link>
</synopsis>

  </refsect1>

  <refsect1 id="properties-gtkpagesetupunixdialog">
    <title>gtkunixprint.PageSetupUnixDialog Properties</title>

    <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
    <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
    <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
    <para><link linkend="properties-gtkwindow">gtk.Window Properties</link></para>
    <para><link linkend="properties-gtkdialog">gtk.Dialog Properties</link></para>

  </refsect1>

  <refsect1 id="style-properties-gtkpagesetupunixdialog">
    <title>gtkunixprint.PageSetupUnixDialog Style Properties</title>

    <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
    <para><link linkend="style-properties-gtkdialog">gtk.Dialog Style Properties</link></para>

  </refsect1>

  <refsect1 id="signal-prototypes-gtkpagesetupunixdialog">
    <title>gtkunixprint.PageSetupUnixDialog Signal Prototypes</title>

    <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkwindow">gtk.Window Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkdialog">gtk.Dialog Signal Prototypes</link></para>
  </refsect1>

  <refsect1>
    <title>Description</title>

    <note>
      <para>This class is available for Unix systems in PyGTK 2.10 and
      above.</para>
    </note>

    <para>The <link
    linkend="class-gtkpagesetupunixdialog"><classname>gtkunixprint.PageSetupUnixDialog</classname></link>
    object implements a page setup dialog for platforms, like Unix, that
    don't provide a native page setup dialog. It can be used very much like
    any other PyGTK dialog, at the cost of the portability offered by the
    high-level printing API.</para>

  </refsect1>

  <refsect1>
    <title>Constructor</title>

    <refsect2 id="constructor-gtkpagesetupunixdialog">
      <title>gtkunixprint.PageSetupUnixDialog</title>

      <programlisting><constructorsynopsis language="python">
        <methodname>gtkunixprint.PageSetupUnixDialog</methodname>
        <methodparam><parameter role="keyword">title</parameter><initializer>None</initializer></methodparam>
        <methodparam><parameter role="keyword">parent</parameter><initializer>None</initializer></methodparam>
      </constructorsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">title</parameter>&nbsp;:</term>
          <listitem><simpara>the title of the dialog, or
          <literal>None</literal></simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter role="keyword">parent</parameter>&nbsp;:</term>
          <listitem><simpara>the transient parent of the dialog, or
          <literal>None</literal></simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>the new <link
          linkend="class-gtkpagesetupunixdialog"><classname>gtkunixprint.PageSetupUnixDialog</classname></link></simpara></listitem>
        </varlistentry>
      </variablelist>

      <note>
        <para>This constructor is available in PyGTK 2.10 and above.</para>
      </note>

      <para>Creates a new page setup dialog with the optional title
      specified by <parameter>title</parameter> and optionally using the
      <link
      linkend="class-gtkwindow"><classname>gtk.Window</classname></link>
      specified by <parameter>parent</parameter>.</para>

    </refsect2>

  </refsect1>

  <refsect1>
    <title>Methods</title>

    <refsect2 id="method-gtkpagesetupunixdialog--set-page-setup">
      <title>gtkunixprint.PageSetupUnixDialog.set_page_setup</title>

      <programlisting><methodsynopsis language="python">
        <methodname>set_page_setup</methodname>
        <methodparam><parameter role="keyword">page_setup</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">page_setup</parameter>&nbsp;:</term>
          <listitem><simpara>a <link
          linkend="class-gtkpagesetup"><classname>gtk.PageSetup</classname></link></simpara></listitem>
        </varlistentry>
      </variablelist>

      <note>
        <para>This method is available in PyGTK 2.10 and above.</para>
      </note>

      <para>The <methodname>set_page_setup</methodname>() method uses the
      <link
      linkend="class-gtkpagesetup"><classname>gtk.PageSetup</classname></link>
      specified by <parameter>page_setup</parameter> to set the page setup
      values for the dialog.</para>

    </refsect2>

    <refsect2 id="method-gtkpagesetupunixdialog--get-page-setup">
      <title>gtkunixprint.PageSetupUnixDialog.get_page_setup</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_page_setup</methodname>
        <methodparam></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>the current page setup</simpara></listitem>
        </varlistentry>
      </variablelist>

      <note>
        <para>This method is available in PyGTK 2.10 and above.</para>
      </note>

      <para>The <methodname>get_page_setup</methodname>() method returns the
      current page setup values from the dialog as a <link
      linkend="class-gtkpagesetup"><classname>gtk.PageSetup</classname></link>.</para>

    </refsect2>

    <refsect2 id="method-gtkpagesetupunixdialog--set-print-settings">
      <title>gtkunixprint.PageSetupUnixDialog.set_print_settings</title>

      <programlisting><methodsynopsis language="python">
        <methodname>set_print_settings</methodname>
        <methodparam><parameter role="keyword">print_settings</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">print_settings</parameter>&nbsp;:</term>
          <listitem><simpara>a <link
          linkend="class-gtkprintsettings"><classname>gtk.PrintSettings</classname></link></simpara></listitem>
        </varlistentry>
      </variablelist>

      <note>
        <para>This method is available in PyGTK 2.10 and above.</para>
      </note>

      <para>The <methodname>set_print_settings</methodname>() method
      installs the <link
      linkend="class-gtkprintsettings"><classname>gtk.PrintSettings</classname></link>
      specified by print_settings as the print settings for the
      dialog.</para>

    </refsect2>

    <refsect2 id="method-gtkpagesetupunixdialog--get-print-settings">
      <title>gtkunixprint.PageSetupUnixDialog.get_print_settings</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_print_settings</methodname>
        <methodparam></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>the current print settings</simpara></listitem>
        </varlistentry>
      </variablelist>

      <note>
        <para>This method is available in PyGTK 2.10 and above.</para>
      </note>

      <para>The <methodname>get_print_settings</methodname>() method returns
      the current print settings from the dialog.</para>

    </refsect2>

  </refsect1>

</refentry>