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

   1 <!-- ##### SECTION Title ##### -->
   2 GtkPaperSize
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Support for named paper sizes
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 GtkPaperSize handles paper sizes. It uses the standard called
  10 "PWG 5101.1-2002 PWG: Standard for Media Standardized Names"
  11 <!-- FIXME link here -->
  12 to name the paper sizes (and to get the data for the page sizes).
  13 In addition to standard paper sizes, GtkPaperSize allows to
  14 construct custom paper sizes with arbitrary dimensions.
  15 </para>
  16 <para>
  17 The #GtkPaperSize object stores not only the dimensions (width
  18 and height) of a paper size and its name, it also provides
  19 default <link linkend="print-margins">print margins</link>.
  20 </para>
  21
  22 <para>
  23 Printing support has been added in GTK+ 2.10.
  24 </para>
  25
  26 <!-- ##### SECTION See_Also ##### -->
  27 <para>
  28 #GtkPageSetup
  29 </para>
  30
  31 <!-- ##### SECTION Stability_Level ##### -->
  32
  33
  34 <!-- ##### SECTION Image ##### -->
  35
  36
  37 <!-- ##### STRUCT GtkPaperSize ##### -->
  38 <para>
  39
  40 </para>
  41
  42
  43 <!-- ##### ENUM GtkUnit ##### -->
  44 <para>
  45
  46 </para>
  47
  48 @GTK_UNIT_PIXEL:
  49 @GTK_UNIT_POINTS:
  50 @GTK_UNIT_INCH:
  51 @GTK_UNIT_MM:
  52
  53 <!-- ##### MACRO GTK_PAPER_NAME_A3 ##### -->
  54 <para>
  55 Name for the A4 paper size.
  56 </para>
  57
  58
  59
  60 <!-- ##### MACRO GTK_PAPER_NAME_A4 ##### -->
  61 <para>
  62 Name for the A4 paper size.
  63 </para>
  64
  65
  66
  67 <!-- ##### MACRO GTK_PAPER_NAME_A5 ##### -->
  68 <para>
  69 Name for the A5 paper size.
  70 </para>
  71
  72
  73
  74 <!-- ##### MACRO GTK_PAPER_NAME_B5 ##### -->
  75 <para>
  76 Name for the B5 paper size.
  77 </para>
  78
  79
  80
  81 <!-- ##### MACRO GTK_PAPER_NAME_LETTER ##### -->
  82 <para>
  83 Name for the Letter paper size.
  84 </para>
  85
  86
  87
  88 <!-- ##### MACRO GTK_PAPER_NAME_EXECUTIVE ##### -->
  89 <para>
  90 Name for the Executive paper size.
  91 </para>
  92
  93
  94
  95 <!-- ##### MACRO GTK_PAPER_NAME_LEGAL ##### -->
  96 <para>
  97 Name for the Legal paper size.
  98 </para>
  99
 100
 101
 102 <!-- ##### FUNCTION gtk_paper_size_new ##### -->
 103 <para>
 104
 105 </para>
 106
 107 @name:
 108 @Returns:
 109
 110
 111 <!-- ##### FUNCTION gtk_paper_size_new_from_ppd ##### -->
 112 <para>
 113
 114 </para>
 115
 116 @ppd_name:
 117 @ppd_display_name:
 118 @width:
 119 @height:
 120 @Returns:
 121
 122
 123 <!-- ##### FUNCTION gtk_paper_size_new_custom ##### -->
 124 <para>
 125
 126 </para>
 127
 128 @name:
 129 @display_name:
 130 @width:
 131 @height:
 132 @unit:
 133 @Returns:
 134
 135
 136 <!-- ##### FUNCTION gtk_paper_size_copy ##### -->
 137 <para>
 138
 139 </para>
 140
 141 @other:
 142 @Returns:
 143
 144
 145 <!-- ##### FUNCTION gtk_paper_size_free ##### -->
 146 <para>
 147
 148 </para>
 149
 150 @size:
 151
 152
 153 <!-- ##### FUNCTION gtk_paper_size_is_equal ##### -->
 154 <para>
 155
 156 </para>
 157
 158 @size1:
 159 @size2:
 160 @Returns:
 161
 162
 163 <!-- ##### FUNCTION gtk_paper_size_get_paper_sizes ##### -->
 164 <para>
 165
 166 </para>
 167
 168 @include_custom:
 169 @Returns:
 170
 171
 172 <!-- ##### FUNCTION gtk_paper_size_get_name ##### -->
 173 <para>
 174
 175 </para>
 176
 177 @size:
 178 @Returns:
 179
 180
 181 <!-- ##### FUNCTION gtk_paper_size_get_display_name ##### -->
 182 <para>
 183
 184 </para>
 185
 186 @size:
 187 @Returns:
 188
 189
 190 <!-- ##### FUNCTION gtk_paper_size_get_ppd_name ##### -->
 191 <para>
 192
 193 </para>
 194
 195 @size:
 196 @Returns:
 197
 198
 199 <!-- ##### FUNCTION gtk_paper_size_get_width ##### -->
 200 <para>
 201
 202 </para>
 203
 204 @size:
 205 @unit:
 206 @Returns:
 207
 208
 209 <!-- ##### FUNCTION gtk_paper_size_get_height ##### -->
 210 <para>
 211
 212 </para>
 213
 214 @size:
 215 @unit:
 216 @Returns:
 217
 218
 219 <!-- ##### FUNCTION gtk_paper_size_is_custom ##### -->
 220 <para>
 221
 222 </para>
 223
 224 @size:
 225 @Returns:
 226
 227
 228 <!-- ##### FUNCTION gtk_paper_size_set_size ##### -->
 229 <para>
 230
 231 </para>
 232
 233 @size:
 234 @width:
 235 @height:
 236 @unit:
 237
 238
 239 <!-- ##### FUNCTION gtk_paper_size_get_default_top_margin ##### -->
 240 <para>
 241
 242 </para>
 243
 244 @size:
 245 @unit:
 246 @Returns:
 247
 248
 249 <!-- ##### FUNCTION gtk_paper_size_get_default_bottom_margin ##### -->
 250 <para>
 251
 252 </para>
 253
 254 @size:
 255 @unit:
 256 @Returns:
 257
 258
 259 <!-- ##### FUNCTION gtk_paper_size_get_default_left_margin ##### -->
 260 <para>
 261
 262 </para>
 263
 264 @size:
 265 @unit:
 266 @Returns:
 267
 268
 269 <!-- ##### FUNCTION gtk_paper_size_get_default_right_margin ##### -->
 270 <para>
 271
 272 </para>
 273
 274 @size:
 275 @unit:
 276 @Returns:
 277
 278
 279 <!-- ##### FUNCTION gtk_paper_size_get_default ##### -->
 280 <para>
 281
 282 </para>
 283
 284 @void:
 285 @Returns:
 286
 287
 288 <!-- ##### FUNCTION gtk_paper_size_new_from_key_file ##### -->
 289 <para>
 290
 291 </para>
 292
 293 @key_file:
 294 @group_name:
 295 @error:
 296 @Returns:
 297
 298
 299 <!-- ##### FUNCTION gtk_paper_size_to_key_file ##### -->
 300 <para>
 301
 302 </para>
 303
 304 @size:
 305 @key_file:
 306 @group_name:
 307
 308