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 <!-- ##### STRUCT GtkPrintUnixDialog ##### -->
  83 <para>
  84
  85 </para>
  86
  87
  88 <!-- ##### ARG GtkPrintUnixDialog:current-page ##### -->
  89 <para>
  90
  91 </para>
  92
  93 <!-- ##### ARG GtkPrintUnixDialog:embed-page-setup ##### -->
  94 <para>
  95
  96 </para>
  97
  98 <!-- ##### ARG GtkPrintUnixDialog:has-selection ##### -->
  99 <para>
 100
 101 </para>
 102
 103 <!-- ##### ARG GtkPrintUnixDialog:manual-capabilities ##### -->
 104 <para>
 105
 106 </para>
 107
 108 <!-- ##### ARG GtkPrintUnixDialog:page-setup ##### -->
 109 <para>
 110
 111 </para>
 112
 113 <!-- ##### ARG GtkPrintUnixDialog:print-settings ##### -->
 114 <para>
 115
 116 </para>
 117
 118 <!-- ##### ARG GtkPrintUnixDialog:selected-printer ##### -->
 119 <para>
 120
 121 </para>
 122
 123 <!-- ##### ARG GtkPrintUnixDialog:support-selection ##### -->
 124 <para>
 125
 126 </para>
 127
 128 <!-- ##### FUNCTION gtk_print_unix_dialog_new ##### -->
 129 <para>
 130
 131 </para>
 132
 133 @title:
 134 @parent:
 135 @Returns:
 136
 137
 138 <!-- ##### FUNCTION gtk_print_unix_dialog_set_page_setup ##### -->
 139 <para>
 140
 141 </para>
 142
 143 @dialog:
 144 @page_setup:
 145
 146
 147 <!-- ##### FUNCTION gtk_print_unix_dialog_get_page_setup ##### -->
 148 <para>
 149
 150 </para>
 151
 152 @dialog:
 153 @Returns:
 154
 155
 156 <!-- ##### FUNCTION gtk_print_unix_dialog_set_current_page ##### -->
 157 <para>
 158
 159 </para>
 160
 161 @dialog:
 162 @current_page:
 163
 164
 165 <!-- ##### FUNCTION gtk_print_unix_dialog_get_current_page ##### -->
 166 <para>
 167
 168 </para>
 169
 170 @dialog:
 171 @Returns:
 172
 173
 174 <!-- ##### FUNCTION gtk_print_unix_dialog_set_settings ##### -->
 175 <para>
 176
 177 </para>
 178
 179 @dialog:
 180 @settings:
 181
 182
 183 <!-- ##### FUNCTION gtk_print_unix_dialog_get_settings ##### -->
 184 <para>
 185
 186 </para>
 187
 188 @dialog:
 189 @Returns:
 190
 191
 192 <!-- ##### FUNCTION gtk_print_unix_dialog_get_selected_printer ##### -->
 193 <para>
 194
 195 </para>
 196
 197 @dialog:
 198 @Returns:
 199
 200
 201 <!-- ##### FUNCTION gtk_print_unix_dialog_add_custom_tab ##### -->
 202 <para>
 203
 204 </para>
 205
 206 @dialog:
 207 @child:
 208 @tab_label:
 209
 210
 211 <!-- ##### FUNCTION gtk_print_unix_dialog_set_support_selection ##### -->
 212 <para>
 213
 214 </para>
 215
 216 @dialog:
 217 @support_selection:
 218
 219
 220 <!-- ##### FUNCTION gtk_print_unix_dialog_get_support_selection ##### -->
 221 <para>
 222
 223 </para>
 224
 225 @dialog:
 226 @Returns:
 227
 228
 229 <!-- ##### FUNCTION gtk_print_unix_dialog_set_has_selection ##### -->
 230 <para>
 231
 232 </para>
 233
 234 @dialog:
 235 @has_selection:
 236
 237
 238 <!-- ##### FUNCTION gtk_print_unix_dialog_get_has_selection ##### -->
 239 <para>
 240
 241 </para>
 242
 243 @dialog:
 244 @Returns:
 245
 246
 247 <!-- ##### FUNCTION gtk_print_unix_dialog_set_embed_page_setup ##### -->
 248 <para>
 249
 250 </para>
 251
 252 @dialog:
 253 @embed:
 254
 255
 256 <!-- ##### FUNCTION gtk_print_unix_dialog_get_embed_page_setup ##### -->
 257 <para>
 258
 259 </para>
 260
 261 @dialog:
 262 @Returns:
 263
 264
 265 <!-- ##### FUNCTION gtk_print_unix_dialog_get_page_setup_set ##### -->
 266 <para>
 267
 268 </para>
 269
 270 @dialog:
 271 @Returns:
 272
 273
 274 <!-- ##### ENUM GtkPrintCapabilities ##### -->
 275 <para>
 276 An enum for specifying which features the print dialog should offer.
 277 If neither %GTK_PRINT_CAPABILITY_GENERATE_PDF nor
 278 %GTK_PRINT_CAPABILITY_GENERATE_PS is specified, GTK+ assumes that all
 279 formats are supported.
 280 </para>
 281
 282 @GTK_PRINT_CAPABILITY_PAGE_SET: Print dialog will offer printing even/odd pages.
 283 @GTK_PRINT_CAPABILITY_COPIES: Print dialog will allow to print multiple copies.
 284 @GTK_PRINT_CAPABILITY_COLLATE: Print dialog will allow to collate multiple copies.
 285 @GTK_PRINT_CAPABILITY_REVERSE: Print dialog will allow to print pages in reverse order.
 286 @GTK_PRINT_CAPABILITY_SCALE: Print dialog will allow to scale the output.
 287 @GTK_PRINT_CAPABILITY_GENERATE_PDF: The program will send the document to
 288     the printer in PDF format
 289 @GTK_PRINT_CAPABILITY_GENERATE_PS: The program will send the document to
 290     the printer in Postscript format
 291 @GTK_PRINT_CAPABILITY_PREVIEW: Print dialog will offer a preview
 292 @GTK_PRINT_CAPABILITY_NUMBER_UP: Print dialog will offer printing multiple
 293     pages per sheet. Since 2.12
 294 @GTK_PRINT_CAPABILITY_NUMBER_UP_LAYOUT: Print dialog will allow to rearrange
 295     pages when printing multiple pages per sheet. Since 2.14
 296
 297 <!-- ##### FUNCTION gtk_print_unix_dialog_set_manual_capabilities ##### -->
 298 <para>
 299
 300 </para>
 301
 302 @dialog:
 303 @capabilities:
 304
 305
 306 <!-- ##### FUNCTION gtk_print_unix_dialog_get_manual_capabilities ##### -->
 307 <para>
 308
 309 </para>
 310
 311 @dialog:
 312 @Returns:
 313
 314