|
|
|
GTK+ Reference Manual | |
|---|---|---|---|---|
#include <gtk/gtk.h>
GtkPageSetup;
GtkPageSetup* gtk_page_setup_new (void);
GtkPageSetup* gtk_page_setup_copy (GtkPageSetup *other);
GtkPageOrientation gtk_page_setup_get_orientation (GtkPageSetup *setup);
void gtk_page_setup_set_orientation (GtkPageSetup *setup,
GtkPageOrientation orientation);
GtkPaperSize* gtk_page_setup_get_paper_size (GtkPageSetup *setup);
void gtk_page_setup_set_paper_size (GtkPageSetup *setup,
GtkPaperSize *size);
gdouble gtk_page_setup_get_top_margin (GtkPageSetup *setup,
GtkUnit unit);
void gtk_page_setup_set_top_margin (GtkPageSetup *setup,
gdouble margin,
GtkUnit unit);
gdouble gtk_page_setup_get_bottom_margin (GtkPageSetup *setup,
GtkUnit unit);
void gtk_page_setup_set_bottom_margin (GtkPageSetup *setup,
gdouble margin,
GtkUnit unit);
gdouble gtk_page_setup_get_left_margin (GtkPageSetup *setup,
GtkUnit unit);
void gtk_page_setup_set_left_margin (GtkPageSetup *setup,
gdouble margin,
GtkUnit unit);
gdouble gtk_page_setup_get_right_margin (GtkPageSetup *setup,
GtkUnit unit);
void gtk_page_setup_set_right_margin (GtkPageSetup *setup,
gdouble margin,
GtkUnit unit);
void gtk_page_setup_set_paper_size_and_default_margins
(GtkPageSetup *setup,
GtkPaperSize *size);
gdouble gtk_page_setup_get_paper_width (GtkPageSetup *setup,
GtkUnit unit);
gdouble gtk_page_setup_get_paper_height (GtkPageSetup *setup,
GtkUnit unit);
gdouble gtk_page_setup_get_page_width (GtkPageSetup *setup,
GtkUnit unit);
gdouble gtk_page_setup_get_page_height (GtkPageSetup *setup,
GtkUnit unit);
GtkPageSetup* gtk_page_setup_new_from_file (const gchar *file_name,
GError **error);
GtkPageSetup* gtk_page_setup_new_from_key_file (GKeyFile *key_file,
const gchar *group_name,
GError **error);
gboolean gtk_page_setup_to_file (GtkPageSetup *setup,
const char *file_name,
GError **error);
void gtk_page_setup_to_key_file (GtkPageSetup *setup,
GKeyFile *key_file,
const gchar *group_name);
A GtkPageSetup object stores the page size, orientation and margins. The idea is that you can get one of these from the page setup dialog and then pass it to the GtkPrintOperation when printing. The benefit of splitting this out of the GtkPrintSettings is that these affect the actual layout of the page, and thus need to be set long before user prints.
The margins specified in this object are the "print margins", i.e. the parts of the page that the printer cannot print on. These are different from the layout margins that a word processor uses; they are typically used to determine the minimal size for the layout margins.
To obtain a GtkPageSetup use gtk_page_setup_new()
to get the defaults, or use gtk_print_run_page_setup_dialog() to show
the page setup dialog and receive the resulting page setup.
Example 41. A page setup dialog
static GtkPrintSettings *settings = NULL;
static GtkPageSetup *page_setup = NULL;
static void
do_page_setup (void)
{
GtkPageSetup *new_page_setup;
if (settings == NULL)
settings = gtk_print_settings_new ();
new_page_setup = gtk_print_run_page_setup_dialog (GTK_WINDOW (main_window),
page_setup, settings);
if (page_setup)
g_object_unref (page_setup);
page_setup = new_page_setup;
}
Printing support was added in GTK+ 2.10.
GtkPageSetup* gtk_page_setup_new (void);
Creates a new GtkPageSetup.
| Returns : | a new GtkPageSetup. |
Since 2.10
GtkPageSetup* gtk_page_setup_copy (GtkPageSetup *other);
Copies a GtkPageSetup.
other : |
the GtkPageSetup to copy |
| Returns : | a copy of other
|
Since 2.10
GtkPageOrientation gtk_page_setup_get_orientation (GtkPageSetup *setup);
Gets the page orientation of the GtkPageSetup.
setup : |
a GtkPageSetup |
| Returns : | the page orientation |
Since 2.10
void gtk_page_setup_set_orientation (GtkPageSetup *setup, GtkPageOrientation orientation);
Sets the page orientation of the GtkPageSetup.
setup : |
a GtkPageSetup |
orientation : |
a GtkPageOrientation value |
Since 2.10
GtkPaperSize* gtk_page_setup_get_paper_size (GtkPageSetup *setup);
Gets the paper size of the GtkPageSetup.
setup : |
a GtkPageSetup |
| Returns : | the paper size |
Since 2.10
void gtk_page_setup_set_paper_size (GtkPageSetup *setup, GtkPaperSize *size);
Sets the paper size of the GtkPageSetup without
changing the margins. See
gtk_page_setup_set_paper_size_and_default_margins().
setup : |
a GtkPageSetup |
size : |
a GtkPaperSize |
Since 2.10
gdouble gtk_page_setup_get_top_margin (GtkPageSetup *setup, GtkUnit unit);
Gets the top margin in units of unit.
setup : |
a GtkPageSetup |
unit : |
the unit for the return value |
| Returns : | the top margin |
Since 2.10
void gtk_page_setup_set_top_margin (GtkPageSetup *setup, gdouble margin, GtkUnit unit);
Sets the top margin of the GtkPageSetup.
setup : |
a GtkPageSetup |
margin : |
the new top margin in units of unit
|
unit : |
the units for margin
|
Since 2.10
gdouble gtk_page_setup_get_bottom_margin (GtkPageSetup *setup, GtkUnit unit);
Gets the bottom margin in units of unit.
setup : |
a GtkPageSetup |
unit : |
the unit for the return value |
| Returns : | the bottom margin |
Since 2.10
void gtk_page_setup_set_bottom_margin (GtkPageSetup *setup, gdouble margin, GtkUnit unit);
Sets the bottom margin of the GtkPageSetup.
setup : |
a GtkPageSetup |
margin : |
the new bottom margin in units of unit
|
unit : |
the units for margin
|
Since 2.10
gdouble gtk_page_setup_get_left_margin (GtkPageSetup *setup, GtkUnit unit);
Gets the left margin in units of unit.
setup : |
a GtkPageSetup |
unit : |
the unit for the return value |
| Returns : | the left margin |
Since 2.10
void gtk_page_setup_set_left_margin (GtkPageSetup *setup, gdouble margin, GtkUnit unit);
Sets the left margin of the GtkPageSetup.
setup : |
a GtkPageSetup |
margin : |
the new left margin in units of unit
|
unit : |
the units for margin
|
Since 2.10
gdouble gtk_page_setup_get_right_margin (GtkPageSetup *setup, GtkUnit unit);
Gets the right margin in units of unit.
setup : |
a GtkPageSetup |
unit : |
the unit for the return value |
| Returns : | the right margin |
Since 2.10
void gtk_page_setup_set_right_margin (GtkPageSetup *setup, gdouble margin, GtkUnit unit);
Sets the right margin of the GtkPageSetup.
setup : |
a GtkPageSetup |
margin : |
the new right margin in units of unit
|
unit : |
the units for margin
|
Since 2.10
void gtk_page_setup_set_paper_size_and_default_margins
(GtkPageSetup *setup,
GtkPaperSize *size);
Sets the paper size of the GtkPageSetup and modifies the margins according to the new paper size.
setup : |
a GtkPageSetup |
size : |
a GtkPaperSize |
Since 2.10
gdouble gtk_page_setup_get_paper_width (GtkPageSetup *setup, GtkUnit unit);
Returns the paper width in units of unit.
Note that this function takes orientation, but
not margins into consideration.
See gtk_page_setup_get_page_width().
setup : |
a GtkPageSetup |
unit : |
the unit for the return value |
| Returns : | the paper width. |
Since 2.10
gdouble gtk_page_setup_get_paper_height (GtkPageSetup *setup, GtkUnit unit);
Returns the paper height in units of unit.
Note that this function takes orientation, but
not margins into consideration.
See gtk_page_setup_get_page_height().
setup : |
a GtkPageSetup |
unit : |
the unit for the return value |
| Returns : | the paper height. |
Since 2.10
gdouble gtk_page_setup_get_page_width (GtkPageSetup *setup, GtkUnit unit);
Returns the page width in units of unit.
Note that this function takes orientation and
margins into consideration.
See gtk_page_setup_get_paper_width().
setup : |
a GtkPageSetup |
unit : |
the unit for the return value |
| Returns : | the page width. |
Since 2.10
gdouble gtk_page_setup_get_page_height (GtkPageSetup *setup, GtkUnit unit);
Returns the page height in units of unit.
Note that this function takes orientation and
margins into consideration.
See gtk_page_setup_get_paper_height().
setup : |
a GtkPageSetup |
unit : |
the unit for the return value |
| Returns : | the page height. |
Since 2.10
GtkPageSetup* gtk_page_setup_new_from_file (const gchar *file_name, GError **error);
Reads the page setup from the file file_name. Returns a
new GtkPageSetup object with the restored page setup,
or NULL if an error occurred. See gtk_page_setup_to_file().
file_name : |
the filename to read the page setup from |
error : |
return location for an error, or NULL
|
| Returns : | the restored GtkPageSetup |
Since 2.12
GtkPageSetup* gtk_page_setup_new_from_key_file (GKeyFile *key_file, const gchar *group_name, GError **error);
Reads the page setup from the group group_name in the key file
key_file. Returns a new GtkPageSetup object with the restored
page setup, or NULL if an error occurred.
key_file : |
the GKeyFile to retrieve the page_setup from |
group_name : |
the name of the group in the key_file to read, or NULL
to use the default name "Page Setup"
|
error : |
return location for an error, or NULL
|
| Returns : | the restored GtkPageSetup |
Since 2.12
gboolean gtk_page_setup_to_file (GtkPageSetup *setup, const char *file_name, GError **error);
This function saves the information from setup to file_name.
setup : |
a GtkPageSetup |
file_name : |
the file to save to |
error : |
return location for errors, or NULL
|
| Returns : | TRUE on success
|
Since 2.12
void gtk_page_setup_to_key_file (GtkPageSetup *setup, GKeyFile *key_file, const gchar *group_name);
This function adds the page setup from setup to key_file.
setup : |
a GtkPageSetup |
key_file : |
the GKeyFile to save the page setup to |
group_name : |
the group to add the settings to in key_file,
or NULL to use the default name "Page Setup"
|
Since 2.12