Pileus Git - ~andy/gtk/blob - docs/reference/gtk/tmpl/gtkprintunixdialog.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GtkPrintUnixDialog
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 A print dialog
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 GtkPrintUnixDialog implements a print dialog for platforms
  10 which don't provide a native print dialog, like Unix. It can
  11 be used very much like any other GTK+ dialog, at the cost of
  12 the portability offered by the <link
  13 linkend="gtk-High-level-Printing-API">high-level printing API</link>
  14 </para>
  15 <para>
  16 In order to print something with #GtkPrintUnixDialog, you need
  17 to use gtk_print_unix_dialog_get_selected_printer() to obtain
  18 a #GtkPrinter object and use it to construct a #GtkPrintJob using
  19 gtk_print_job_new().
  20 </para>
  21 <para>
  22 #GtkPrintUnixDialog uses the following response values:
  23 <variablelist>
  24   <varlistentry><term>%GTK_RESPONSE_OK</term>
  25     <listitem><para>for the "Print" button</para></listitem>
  26   </varlistentry>
  27   <varlistentry><term>%GTK_RESPONSE_APPLY</term>
  28     <listitem><para>for the "Preview" button</para></listitem>
  29   </varlistentry>
  30   <varlistentry><term>%GTK_RESPONSE_CANCEL</term>
  31     <listitem><para>for the "Cancel" button</para></listitem>
  32   </varlistentry>
  33 </variablelist>
  34 </para>
  35
  36 <!-- FIXME example here -->
  37
  38 <para>
  39 Printing support was added in GTK+ 2.10.
  40 </para>
  41
  42 <refsect2 id="GtkPrintUnixDialog-BUILDER-UI"><title>GtkPrintUnixDialog as GtkBuildable</title>
  43 <para>
  44 The GtkPrintUnixDialog implementation of the GtkBuildable interface exposes its
  45 @notebook internal children with the name "notebook".
  46 </para>
  47 <example>
  48 <title>A <structname>GtkPrintUnixDialog</structname> UI definition fragment.</title>
  49 <programlisting><![CDATA[
  50 <object class="GtkPrintUnixDialog" id="dialog1">
  51   <child internal-child="notebook">
  52     <object class="GtkNotebook" id="notebook">
  53       <child>
  54         <object class="GtkLabel" id="tabcontent">
  55         <property name="label">Content on notebook tab</property>
  56         </object>
  57       </child>
  58       <child type="tab">
  59         <object class="GtkLabel" id="tablabel">
  60           <property name="label">Tab label</property>
  61         </object>
  62         <packing>
  63           <property name="tab_expand">False</property>
  64           <property name="tab_fill">False</property>
  65         </packing>
  66       </child>
  67     </object>
  68   </child>
  69 </object>
  70 ]]></programlisting>
  71 </example>
  72 </refsect2>
  73
  74 <!-- ##### SECTION See_Also ##### -->
  75 <para>
  76 #GtkPageSetupUnixDialog, #GtkPrinter, #GtkPrintJob
  77 </para>
  78
  79 <!-- ##### SECTION Stability_Level ##### -->
  80
  81
  82 <!-- ##### SECTION Image ##### -->
  83
  84
  85 <!-- ##### STRUCT GtkPrintUnixDialog ##### -->
  86 <para>
  87
  88 </para>
  89
  90
  91 <!-- ##### ARG GtkPrintUnixDialog:current-page ##### -->
  92 <para>
  93
  94 </para>
  95
  96 <!-- ##### ARG GtkPrintUnixDialog:embed-page-setup ##### -->
  97 <para>
  98
  99 </para>
 100
 101 <!-- ##### ARG GtkPrintUnixDialog:has-selection ##### -->
 102 <para>
 103
 104 </para>
 105
 106 <!-- ##### ARG GtkPrintUnixDialog:manual-capabilities ##### -->
 107 <para>
 108
 109 </para>
 110
 111 <!-- ##### ARG GtkPrintUnixDialog:page-setup ##### -->
 112 <para>
 113
 114 </para>
 115
 116 <!-- ##### ARG GtkPrintUnixDialog:print-settings ##### -->
 117 <para>
 118
 119 </para>
 120
 121 <!-- ##### ARG GtkPrintUnixDialog:selected-printer ##### -->
 122 <para>
 123
 124 </para>
 125
 126 <!-- ##### ARG GtkPrintUnixDialog:support-selection ##### -->
 127 <para>
 128
 129 </para>
 130
 131 <!-- ##### FUNCTION gtk_print_unix_dialog_new ##### -->
 132 <para>
 133
 134 </para>
 135
 136 @title:
 137 @parent:
 138 @Returns:
 139
 140
 141 <!-- ##### FUNCTION gtk_print_unix_dialog_set_page_setup ##### -->
 142 <para>
 143
 144 </para>
 145
 146 @dialog:
 147 @page_setup:
 148
 149
 150 <!-- ##### FUNCTION gtk_print_unix_dialog_get_page_setup ##### -->
 151 <para>
 152
 153 </para>
 154
 155 @dialog:
 156 @Returns:
 157
 158
 159 <!-- ##### FUNCTION gtk_print_unix_dialog_set_current_page ##### -->
 160 <para>
 161
 162 </para>
 163
 164 @dialog:
 165 @current_page:
 166
 167
 168 <!-- ##### FUNCTION gtk_print_unix_dialog_get_current_page ##### -->
 169 <para>
 170
 171 </para>
 172
 173 @dialog:
 174 @Returns:
 175
 176
 177 <!-- ##### FUNCTION gtk_print_unix_dialog_set_settings ##### -->
 178 <para>
 179
 180 </para>
 181
 182 @dialog:
 183 @settings:
 184
 185
 186 <!-- ##### FUNCTION gtk_print_unix_dialog_get_settings ##### -->
 187 <para>
 188
 189 </para>
 190
 191 @dialog:
 192 @Returns:
 193
 194
 195 <!-- ##### FUNCTION gtk_print_unix_dialog_get_selected_printer ##### -->
 196 <para>
 197
 198 </para>
 199
 200 @dialog:
 201 @Returns:
 202
 203
 204 <!-- ##### FUNCTION gtk_print_unix_dialog_add_custom_tab ##### -->
 205 <para>
 206
 207 </para>
 208
 209 @dialog:
 210 @child:
 211 @tab_label:
 212
 213
 214 <!-- ##### FUNCTION gtk_print_unix_dialog_set_support_selection ##### -->
 215 <para>
 216
 217 </para>
 218
 219 @dialog:
 220 @support_selection:
 221
 222
 223 <!-- ##### FUNCTION gtk_print_unix_dialog_get_support_selection ##### -->
 224 <para>
 225
 226 </para>
 227
 228 @dialog:
 229 @Returns:
 230
 231
 232 <!-- ##### FUNCTION gtk_print_unix_dialog_set_has_selection ##### -->
 233 <para>
 234
 235 </para>
 236
 237 @dialog:
 238 @has_selection:
 239
 240
 241 <!-- ##### FUNCTION gtk_print_unix_dialog_get_has_selection ##### -->
 242 <para>
 243
 244 </para>
 245
 246 @dialog:
 247 @Returns:
 248
 249
 250 <!-- ##### FUNCTION gtk_print_unix_dialog_set_embed_page_setup ##### -->
 251 <para>
 252
 253 </para>
 254
 255 @dialog:
 256 @embed:
 257
 258
 259 <!-- ##### FUNCTION gtk_print_unix_dialog_get_embed_page_setup ##### -->
 260 <para>
 261
 262 </para>
 263
 264 @dialog:
 265 @Returns:
 266
 267
 268 <!-- ##### FUNCTION gtk_print_unix_dialog_get_page_setup_set ##### -->
 269 <para>
 270
 271 </para>
 272
 273 @dialog:
 274 @Returns:
 275
 276
 277 <!-- ##### ENUM GtkPrintCapabilities ##### -->
 278 <para>
 279 An enum for specifying which features the print dialog should offer.
 280 If neither %GTK_PRINT_CAPABILITY_GENERATE_PDF nor
 281 %GTK_PRINT_CAPABILITY_GENERATE_PS is specified, GTK+ assumes that all
 282 formats are supported.
 283 </para>
 284
 285 @GTK_PRINT_CAPABILITY_PAGE_SET: Print dialog will offer printing even/odd pages.
 286 @GTK_PRINT_CAPABILITY_COPIES: Print dialog will allow to print multiple copies.
 287 @GTK_PRINT_CAPABILITY_COLLATE: Print dialog will allow to collate multiple copies.
 288 @GTK_PRINT_CAPABILITY_REVERSE: Print dialog will allow to print pages in reverse order.
 289 @GTK_PRINT_CAPABILITY_SCALE: Print dialog will allow to scale the output.
 290 @GTK_PRINT_CAPABILITY_GENERATE_PDF: The program will send the document to
 291     the printer in PDF format
 292 @GTK_PRINT_CAPABILITY_GENERATE_PS: The program will send the document to
 293     the printer in Postscript format
 294 @GTK_PRINT_CAPABILITY_PREVIEW: Print dialog will offer a preview
 295 @GTK_PRINT_CAPABILITY_NUMBER_UP: Print dialog will offer printing multiple
 296     pages per sheet. Since 2.12
 297 @GTK_PRINT_CAPABILITY_NUMBER_UP_LAYOUT: Print dialog will allow to rearrange
 298     pages when printing multiple pages per sheet. Since 2.14
 299
 300 <!-- ##### FUNCTION gtk_print_unix_dialog_set_manual_capabilities ##### -->
 301 <para>
 302
 303 </para>
 304
 305 @dialog:
 306 @capabilities:
 307
 308
 309 <!-- ##### FUNCTION gtk_print_unix_dialog_get_manual_capabilities ##### -->
 310 <para>
 311
 312 </para>
 313
 314 @dialog:
 315 @Returns:
 316
 317