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 <!-- ##### STRUCT GtkPaperSize ##### -->
  35 <para>
  36
  37 </para>
  38
  39
  40 <!-- ##### ENUM GtkUnit ##### -->
  41 <para>
  42
  43 </para>
  44
  45 @GTK_UNIT_PIXEL:
  46 @GTK_UNIT_POINTS:
  47 @GTK_UNIT_INCH:
  48 @GTK_UNIT_MM:
  49
  50 <!-- ##### MACRO GTK_PAPER_NAME_A3 ##### -->
  51 <para>
  52 Name for the A4 paper size.
  53 </para>
  54
  55
  56
  57 <!-- ##### MACRO GTK_PAPER_NAME_A4 ##### -->
  58 <para>
  59 Name for the A4 paper size.
  60 </para>
  61
  62
  63
  64 <!-- ##### MACRO GTK_PAPER_NAME_A5 ##### -->
  65 <para>
  66 Name for the A5 paper size.
  67 </para>
  68
  69
  70
  71 <!-- ##### MACRO GTK_PAPER_NAME_B5 ##### -->
  72 <para>
  73 Name for the B5 paper size.
  74 </para>
  75
  76
  77
  78 <!-- ##### MACRO GTK_PAPER_NAME_LETTER ##### -->
  79 <para>
  80 Name for the Letter paper size.
  81 </para>
  82
  83
  84
  85 <!-- ##### MACRO GTK_PAPER_NAME_EXECUTIVE ##### -->
  86 <para>
  87 Name for the Executive paper size.
  88 </para>
  89
  90
  91
  92 <!-- ##### MACRO GTK_PAPER_NAME_LEGAL ##### -->
  93 <para>
  94 Name for the Legal paper size.
  95 </para>
  96
  97
  98
  99 <!-- ##### FUNCTION gtk_paper_size_new ##### -->
 100 <para>
 101
 102 </para>
 103
 104 @name:
 105 @Returns:
 106
 107
 108 <!-- ##### FUNCTION gtk_paper_size_new_from_ppd ##### -->
 109 <para>
 110
 111 </para>
 112
 113 @ppd_name:
 114 @ppd_display_name:
 115 @width:
 116 @height:
 117 @Returns:
 118
 119
 120 <!-- ##### FUNCTION gtk_paper_size_new_custom ##### -->
 121 <para>
 122
 123 </para>
 124
 125 @name:
 126 @display_name:
 127 @width:
 128 @height:
 129 @unit:
 130 @Returns:
 131
 132
 133 <!-- ##### FUNCTION gtk_paper_size_copy ##### -->
 134 <para>
 135
 136 </para>
 137
 138 @other:
 139 @Returns:
 140
 141
 142 <!-- ##### FUNCTION gtk_paper_size_free ##### -->
 143 <para>
 144
 145 </para>
 146
 147 @size:
 148
 149
 150 <!-- ##### FUNCTION gtk_paper_size_is_equal ##### -->
 151 <para>
 152
 153 </para>
 154
 155 @size1:
 156 @size2:
 157 @Returns:
 158
 159
 160 <!-- ##### FUNCTION gtk_paper_size_get_paper_sizes ##### -->
 161 <para>
 162
 163 </para>
 164
 165 @include_custom:
 166 @Returns:
 167
 168
 169 <!-- ##### FUNCTION gtk_paper_size_get_name ##### -->
 170 <para>
 171
 172 </para>
 173
 174 @size:
 175 @Returns:
 176
 177
 178 <!-- ##### FUNCTION gtk_paper_size_get_display_name ##### -->
 179 <para>
 180
 181 </para>
 182
 183 @size:
 184 @Returns:
 185
 186
 187 <!-- ##### FUNCTION gtk_paper_size_get_ppd_name ##### -->
 188 <para>
 189
 190 </para>
 191
 192 @size:
 193 @Returns:
 194
 195
 196 <!-- ##### FUNCTION gtk_paper_size_get_width ##### -->
 197 <para>
 198
 199 </para>
 200
 201 @size:
 202 @unit:
 203 @Returns:
 204
 205
 206 <!-- ##### FUNCTION gtk_paper_size_get_height ##### -->
 207 <para>
 208
 209 </para>
 210
 211 @size:
 212 @unit:
 213 @Returns:
 214
 215
 216 <!-- ##### FUNCTION gtk_paper_size_is_custom ##### -->
 217 <para>
 218
 219 </para>
 220
 221 @size:
 222 @Returns:
 223
 224
 225 <!-- ##### FUNCTION gtk_paper_size_set_size ##### -->
 226 <para>
 227
 228 </para>
 229
 230 @size:
 231 @width:
 232 @height:
 233 @unit:
 234
 235
 236 <!-- ##### FUNCTION gtk_paper_size_get_default_top_margin ##### -->
 237 <para>
 238
 239 </para>
 240
 241 @size:
 242 @unit:
 243 @Returns:
 244
 245
 246 <!-- ##### FUNCTION gtk_paper_size_get_default_bottom_margin ##### -->
 247 <para>
 248
 249 </para>
 250
 251 @size:
 252 @unit:
 253 @Returns:
 254
 255
 256 <!-- ##### FUNCTION gtk_paper_size_get_default_left_margin ##### -->
 257 <para>
 258
 259 </para>
 260
 261 @size:
 262 @unit:
 263 @Returns:
 264
 265
 266 <!-- ##### FUNCTION gtk_paper_size_get_default_right_margin ##### -->
 267 <para>
 268
 269 </para>
 270
 271 @size:
 272 @unit:
 273 @Returns:
 274
 275
 276 <!-- ##### FUNCTION gtk_paper_size_get_default ##### -->
 277 <para>
 278
 279 </para>
 280
 281 @Returns:
 282
 283
 284 <!-- ##### FUNCTION gtk_paper_size_new_from_key_file ##### -->
 285 <para>
 286
 287 </para>
 288
 289 @key_file:
 290 @group_name:
 291 @error:
 292 @Returns:
 293
 294
 295 <!-- ##### FUNCTION gtk_paper_size_to_key_file ##### -->
 296 <para>
 297
 298 </para>
 299
 300 @size:
 301 @key_file:
 302 @group_name:
 303
 304