| Top | |
|
|
|
| CtkPaperSize | |
| enum | CtkUnit |
| #define | CTK_UNIT_PIXEL |
| #define | CTK_PAPER_NAME_A3 |
| #define | CTK_PAPER_NAME_A4 |
| #define | CTK_PAPER_NAME_A5 |
| #define | CTK_PAPER_NAME_B5 |
| #define | CTK_PAPER_NAME_LETTER |
| #define | CTK_PAPER_NAME_EXECUTIVE |
| #define | CTK_PAPER_NAME_LEGAL |
CtkPaperSize 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, CtkPaperSize allows to construct custom paper sizes with arbitrary dimensions.
The CtkPaperSize 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 CTK+ 2.10.
CtkPaperSize *
ctk_paper_size_new (const gchar *name);
Creates a new CtkPaperSize object by parsing a PWG 5101.1-2002 paper name.
If name
is NULL, the default paper size is returned,
see ctk_paper_size_get_default().
Since: 2.10
CtkPaperSize * ctk_paper_size_new_from_ppd (const gchar *ppd_name,const gchar *ppd_display_name,gdouble width,gdouble height);
Creates a new CtkPaperSize 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 CtkPaperSize object.
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
CtkPaperSize * ctk_paper_size_new_from_ipp (const gchar *ipp_name,gdouble width,gdouble height);
Creates a new CtkPaperSize object by using IPP information.
If ipp_name
is not a recognized paper name,
width
and height
are used to
construct a custom CtkPaperSize object.
ipp_name |
an IPP paper name |
|
width |
the paper width, in points |
|
height |
the paper height in points |
Since: 3.16
CtkPaperSize * ctk_paper_size_new_custom (const gchar *name,const gchar *display_name,gdouble width,gdouble height,CtkUnit unit);
Creates a new CtkPaperSize object with the given 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
CtkPaperSize *
ctk_paper_size_copy (CtkPaperSize *other);
Copies an existing CtkPaperSize.
Since: 2.10
void
ctk_paper_size_free (CtkPaperSize *size);
Free the given CtkPaperSize object.
Since: 2.10
gboolean ctk_paper_size_is_equal (CtkPaperSize *size1,CtkPaperSize *size2);
Compares two CtkPaperSize objects.
Since: 2.10
GList *
ctk_paper_size_get_paper_sizes (gboolean include_custom);
Creates a list of known paper sizes.
a newly allocated list of newly allocated CtkPaperSize objects.
[element-type CtkPaperSize][transfer full]
Since: 2.12
const gchar *
ctk_paper_size_get_name (CtkPaperSize *size);
Gets the name of the CtkPaperSize.
Since: 2.10
const gchar *
ctk_paper_size_get_display_name (CtkPaperSize *size);
Gets the human-readable name of the CtkPaperSize.
Since: 2.10
const gchar *
ctk_paper_size_get_ppd_name (CtkPaperSize *size);
Gets the PPD name of the CtkPaperSize, which
may be NULL.
Since: 2.10
gdouble ctk_paper_size_get_width (CtkPaperSize *size,CtkUnit unit);
Gets the paper width of the CtkPaperSize, in
units of unit
.
Since: 2.10
gdouble ctk_paper_size_get_height (CtkPaperSize *size,CtkUnit unit);
Gets the paper height of the CtkPaperSize, in
units of unit
.
Since: 2.10
gboolean
ctk_paper_size_is_ipp (CtkPaperSize *size);
Returns TRUE if size
is an IPP standard paper size.
gboolean
ctk_paper_size_is_custom (CtkPaperSize *size);
Returns TRUE if size
is not a standard paper size.
void ctk_paper_size_set_size (CtkPaperSize *size,gdouble width,gdouble height,CtkUnit unit);
Changes the dimensions of a size
to width
x height
.
size |
a custom CtkPaperSize object |
|
width |
the new width in units of |
|
height |
the new height in units of |
|
unit |
the unit for |
Since: 2.10
gdouble ctk_paper_size_get_default_top_margin (CtkPaperSize *size,CtkUnit unit);
Gets the default top margin for the CtkPaperSize.
Since: 2.10
gdouble ctk_paper_size_get_default_bottom_margin (CtkPaperSize *size,CtkUnit unit);
Gets the default bottom margin for the CtkPaperSize.
Since: 2.10
gdouble ctk_paper_size_get_default_left_margin (CtkPaperSize *size,CtkUnit unit);
Gets the default left margin for the CtkPaperSize.
Since: 2.10
gdouble ctk_paper_size_get_default_right_margin (CtkPaperSize *size,CtkUnit unit);
Gets the default right margin for the CtkPaperSize.
Since: 2.10
const gchar *
ctk_paper_size_get_default (void);
Returns the name of the default paper size, which depends on the current locale.
Since: 2.10
CtkPaperSize * ctk_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
.
key_file |
the GKeyFile to retrieve the papersize from |
|
group_name |
the name of the group in the key file to read,
or |
[nullable] |
error |
return location for an error, or |
[allow-none] |
Since: 2.12
CtkPaperSize *
ctk_paper_size_new_from_gvariant (GVariant *variant);
Deserialize a paper size from an a{sv} variant in
the format produced by ctk_paper_size_to_gvariant().
Since: 3.22
void ctk_paper_size_to_key_file (CtkPaperSize *size,GKeyFile *key_file,const gchar *group_name);
This function adds the paper size from size
to key_file
.
size |
||
key_file |
the GKeyFile to save the paper size to |
|
group_name |
the group to add the settings to in |
Since: 2.12
GVariant *
ctk_paper_size_to_gvariant (CtkPaperSize *paper_size);
Serialize a paper size to an a{sv} variant.
Since: 3.22
#define CTK_PAPER_NAME_EXECUTIVE "na_executive"
Name for the Executive paper size.