Top |
Functions
Types and Values
GtkPaperSize | |
enum | GtkUnit |
#define | GTK_PAPER_NAME_A3 |
#define | GTK_PAPER_NAME_A4 |
#define | GTK_PAPER_NAME_A5 |
#define | GTK_PAPER_NAME_B5 |
#define | GTK_PAPER_NAME_LETTER |
#define | GTK_PAPER_NAME_EXECUTIVE |
#define | GTK_PAPER_NAME_LEGAL |
Description
GtkPaperSize handles paper sizes. It uses the standard called PWG 5101.1-2002 PWG: Standard for Media Standardized Names to name the paper sizes (and to get the data for the page sizes). In addition to standard paper sizes, GtkPaperSize allows to construct custom paper sizes with arbitrary dimensions.
The GtkPaperSize object stores not only the dimensions (width and height) of a paper size and its name, it also provides default print margins.
Printing support has been added in GTK+ 2.10.
Functions
gtk_paper_size_new ()
GtkPaperSize *
gtk_paper_size_new (const gchar *name
);
Creates a new GtkPaperSize object by parsing a PWG 5101.1-2002 paper name.
If name
is NULL
, the default paper size is returned,
see gtk_paper_size_get_default()
.
Since 2.10
gtk_paper_size_new_from_ppd ()
GtkPaperSize * gtk_paper_size_new_from_ppd (const gchar *ppd_name
,const gchar *ppd_display_name
,gdouble width
,gdouble height
);
Creates a new GtkPaperSize object by using PPD information.
If ppd_name
is not a recognized PPD paper name,
ppd_display_name
, width
and height
are used to
construct a custom GtkPaperSize object.
Parameters
ppd_name |
a PPD paper name |
|
ppd_display_name |
the corresponding human-readable name |
|
width |
the paper width, in points |
|
height |
the paper height in points |
Since 2.10
gtk_paper_size_new_custom ()
GtkPaperSize * gtk_paper_size_new_custom (const gchar *name
,const gchar *display_name
,gdouble width
,gdouble height
,GtkUnit unit
);
Creates a new GtkPaperSize object with the given parameters.
Parameters
name |
the paper name |
|
display_name |
the human-readable name |
|
width |
the paper width, in units of |
|
height |
the paper height, in units of |
|
unit |
the unit for |
Since 2.10
gtk_paper_size_copy ()
GtkPaperSize *
gtk_paper_size_copy (GtkPaperSize *other
);
Copies an existing GtkPaperSize.
Since 2.10
gtk_paper_size_free ()
void
gtk_paper_size_free (GtkPaperSize *size
);
Free the given GtkPaperSize object.
Since 2.10
gtk_paper_size_is_equal ()
gboolean gtk_paper_size_is_equal (GtkPaperSize *size1
,GtkPaperSize *size2
);
Compares two GtkPaperSize objects.
Since 2.10
gtk_paper_size_get_paper_sizes ()
GList *
gtk_paper_size_get_paper_sizes (gboolean include_custom
);
Creates a list of known paper sizes.
Returns
a newly allocated list of newly allocated GtkPaperSize objects.
[element-type GtkPaperSize][transfer full]
Since 2.12
gtk_paper_size_get_name ()
const gchar *
gtk_paper_size_get_name (GtkPaperSize *size
);
Gets the name of the GtkPaperSize.
Since 2.10
gtk_paper_size_get_display_name ()
const gchar *
gtk_paper_size_get_display_name (GtkPaperSize *size
);
Gets the human-readable name of the GtkPaperSize.
Since 2.10
gtk_paper_size_get_ppd_name ()
const gchar *
gtk_paper_size_get_ppd_name (GtkPaperSize *size
);
Gets the PPD name of the GtkPaperSize, which
may be NULL
.
Since 2.10
gtk_paper_size_get_width ()
gdouble gtk_paper_size_get_width (GtkPaperSize *size
,GtkUnit unit
);
Gets the paper width of the GtkPaperSize, in
units of unit
.
Since 2.10
gtk_paper_size_get_height ()
gdouble gtk_paper_size_get_height (GtkPaperSize *size
,GtkUnit unit
);
Gets the paper height of the GtkPaperSize, in
units of unit
.
Since 2.10
gtk_paper_size_is_custom ()
gboolean
gtk_paper_size_is_custom (GtkPaperSize *size
);
Returns TRUE
if size
is not a standard paper size.
gtk_paper_size_set_size ()
void gtk_paper_size_set_size (GtkPaperSize *size
,gdouble width
,gdouble height
,GtkUnit unit
);
Changes the dimensions of a size
to width
x height
.
Parameters
size |
a custom GtkPaperSize object |
|
width |
the new width in units of |
|
height |
the new height in units of |
|
unit |
the unit for |
Since 2.10
gtk_paper_size_get_default_top_margin ()
gdouble gtk_paper_size_get_default_top_margin (GtkPaperSize *size
,GtkUnit unit
);
Gets the default top margin for the GtkPaperSize.
Since 2.10
gtk_paper_size_get_default_bottom_margin ()
gdouble gtk_paper_size_get_default_bottom_margin (GtkPaperSize *size
,GtkUnit unit
);
Gets the default bottom margin for the GtkPaperSize.
Since 2.10
gtk_paper_size_get_default_left_margin ()
gdouble gtk_paper_size_get_default_left_margin (GtkPaperSize *size
,GtkUnit unit
);
Gets the default left margin for the GtkPaperSize.
Since 2.10
gtk_paper_size_get_default_right_margin ()
gdouble gtk_paper_size_get_default_right_margin (GtkPaperSize *size
,GtkUnit unit
);
Gets the default right margin for the GtkPaperSize.
Since 2.10
gtk_paper_size_get_default ()
const gchar *
gtk_paper_size_get_default (void
);
Returns the name of the default paper size, which depends on the current locale.
Since 2.10
gtk_paper_size_new_from_key_file ()
GtkPaperSize * gtk_paper_size_new_from_key_file (GKeyFile *key_file
,const gchar *group_name
,GError **error
);
Reads a paper size from the group group_name
in the key file
key_file
.
Since 2.12
gtk_paper_size_to_key_file ()
void gtk_paper_size_to_key_file (GtkPaperSize *size
,GKeyFile *key_file
,const gchar *group_name
);
This function adds the paper size from size
to key_file
.
Parameters
size |
||
key_file |
the GKeyFile to save the paper size to |
|
group_name |
the group to add the settings to in |
Since 2.12
Types and Values
GTK_PAPER_NAME_EXECUTIVE
#define GTK_PAPER_NAME_EXECUTIVE "na_executive"
Name for the Executive paper size.