GtkPageSetup

GtkPageSetup — Хранит информацию о настройках страницы

Функции

GtkPageSetup *	gtk_page_setup_new ()
GtkPageSetup *	gtk_page_setup_copy ()
GtkPageOrientation	gtk_page_setup_get_orientation ()
void	gtk_page_setup_set_orientation ()
GtkPaperSize *	gtk_page_setup_get_paper_size ()
void	gtk_page_setup_set_paper_size ()
gdouble	gtk_page_setup_get_top_margin ()
void	gtk_page_setup_set_top_margin ()
gdouble	gtk_page_setup_get_bottom_margin ()
void	gtk_page_setup_set_bottom_margin ()
gdouble	gtk_page_setup_get_left_margin ()
void	gtk_page_setup_set_left_margin ()
gdouble	gtk_page_setup_get_right_margin ()
void	gtk_page_setup_set_right_margin ()
void	gtk_page_setup_set_paper_size_and_default_margins ()
gdouble	gtk_page_setup_get_paper_width ()
gdouble	gtk_page_setup_get_paper_height ()
gdouble	gtk_page_setup_get_page_width ()
gdouble	gtk_page_setup_get_page_height ()
GtkPageSetup *	gtk_page_setup_new_from_file ()
GtkPageSetup *	gtk_page_setup_new_from_key_file ()
GtkPageSetup *	gtk_page_setup_new_from_gvariant ()
gboolean	gtk_page_setup_load_file ()
gboolean	gtk_page_setup_load_key_file ()
gboolean	gtk_page_setup_to_file ()
void	gtk_page_setup_to_key_file ()
GVariant *	gtk_page_setup_to_gvariant ()

Типы и значения

GtkPageSetup

Иерархия объектов

    GObject
    ╰── GtkPageSetup

Файлы заголовков

#include <gtk/gtk.h>

Описание

Объект GtkPageSetup хранит размер страницы, ориентацию и поля. Идея в том, что вы можете получить один из этих объектов из диалога настроек страницы, а затем передать его в GtkPrintOperation при печати. Преимущество отделения этого от GtkPrintSettings заключается в том, что эти параметры влияют на фактическое отображение страницы и, следовательно, должны быть установлены задолго до печати пользователем.

Поля

Указанные в этом объекте поля — это «поля печати», то есть части страницы, на которых принтер не может печатать. Они отличаются от полей макета, используемых в текстовых процессорах; они обычно используются для определения минимального размера полей макета.

Для получения GtkPageSetup используйте gtk_page_setup_new(), чтобы получить значения по умолчанию, или используйте gtk_print_run_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;
}

Поддержка печати была добавлена в GTK+ 2.10.

Функции

gtk_page_setup_new ()

GtkPageSetup *
gtk_page_setup_new (void);

Создаёт новый GtkPageSetup.

Возвращает

новый GtkPageSetup.

С версии: 2.10

gtk_page_setup_copy ()

GtkPageSetup *
gtk_page_setup_copy (GtkPageSetup *other);

Копирует GtkPageSetup.

Параметры

other

объект GtkPageSetup для копирования

Возвращает

копию other .

[transfer full]

С версии: 2.10

gtk_page_setup_get_orientation ()

GtkPageOrientation
gtk_page_setup_get_orientation (GtkPageSetup *setup);

Получает ориентацию страницы GtkPageSetup.

Параметры

setup

объект GtkPageSetup

Возвращает

ориентация страницы

С версии: 2.10

gtk_page_setup_set_orientation ()

void
gtk_page_setup_set_orientation (GtkPageSetup *setup,
                                GtkPageOrientation orientation);

Устанавливает ориентацию страницы GtkPageSetup.

Параметры

setup	объект GtkPageSetup
orientation	значение GtkPageOrientation

С версии: 2.10

gtk_page_setup_get_paper_size ()

GtkPaperSize *
gtk_page_setup_get_paper_size (GtkPageSetup *setup);

Получает размер бумаги GtkPageSetup.

Параметры

setup

объект GtkPageSetup

Возвращает

размер бумаги.

[transfer none]

С версии: 2.10

gtk_page_setup_set_paper_size ()

void
gtk_page_setup_set_paper_size (GtkPageSetup *setup,
                               GtkPaperSize *size);

Устанавливает размер бумаги GtkPageSetup, не изменяя поля. Смотрите gtk_page_setup_set_paper_size_and_default_margins().

Параметры

setup	объект GtkPageSetup
size	объект GtkPaperSize

С версии: 2.10

gtk_page_setup_get_top_margin ()

gdouble
gtk_page_setup_get_top_margin (GtkPageSetup *setup,
                               GtkUnit unit);

Получает верхнее поле в единицах unit .

Параметры

setup	объект GtkPageSetup
unit	единицы измерения для возвращаемого значения

Возвращает

верхнее поле

С версии: 2.10

gtk_page_setup_set_top_margin ()

void
gtk_page_setup_set_top_margin (GtkPageSetup *setup,
                               gdouble margin,
                               GtkUnit unit);

Устанавливает верхнее поле GtkPageSetup.

Параметры

setup	объект GtkPageSetup
margin	новое верхнее поле в единицах `unit`
unit	единицы измерения для `margin`

С версии: 2.10

gtk_page_setup_get_bottom_margin ()

gdouble
gtk_page_setup_get_bottom_margin (GtkPageSetup *setup,
                                  GtkUnit unit);

Получает нижнее поле в единицах unit .

Параметры

setup	объект GtkPageSetup
unit	единицы измерения для возвращаемого значения

Возвращает

нижнее поле

С версии: 2.10

gtk_page_setup_set_bottom_margin ()

void
gtk_page_setup_set_bottom_margin (GtkPageSetup *setup,
                                  gdouble margin,
                                  GtkUnit unit);

Устанавливает нижнее поле GtkPageSetup.

Параметры

setup	объект GtkPageSetup
margin	новое нижнее поле в единицах `unit`
unit	единицы измерения для `margin`

С версии: 2.10

gtk_page_setup_get_left_margin ()

gdouble
gtk_page_setup_get_left_margin (GtkPageSetup *setup,
                                GtkUnit unit);

Получает левое поле в единицах unit .

Параметры

setup	объект GtkPageSetup
unit	единицы измерения для возвращаемого значения

Возвращает

левое поле

С версии: 2.10

gtk_page_setup_set_left_margin ()

void
gtk_page_setup_set_left_margin (GtkPageSetup *setup,
                                gdouble margin,
                                GtkUnit unit);

Устанавливает левое поле GtkPageSetup.

Параметры

setup	объект GtkPageSetup
margin	новое левое поле в единицах `unit`
unit	единицы измерения для `margin`

С версии: 2.10

gtk_page_setup_get_right_margin ()

gdouble
gtk_page_setup_get_right_margin (GtkPageSetup *setup,
                                 GtkUnit unit);

Получает правое поле в единицах unit.

Параметры

setup	a GtkPageSetup
unit	единица измерения возвращаемого значения

Возвращаемое значение

правое поле

С: 2.10

gtk_page_setup_set_right_margin ()

void
gtk_page_setup_set_right_margin (GtkPageSetup *setup,
                                 gdouble margin,
                                 GtkUnit unit);

Устанавливает правое поле GtkPageSetup.

Параметры

setup	a GtkPageSetup
margin	новое правое поле в единицах `unit`
unit	единицы измерения для `margin`

С: 2.10

gtk_page_setup_set_paper_size_and_default_margins ()

void
gtk_page_setup_set_paper_size_and_default_margins
                               (GtkPageSetup *setup,
                                GtkPaperSize *size);

Устанавливает размер бумаги для GtkPageSetup и изменяет поля в соответствии с новым размером.

Параметры

setup	a GtkPageSetup
size	a GtkPaperSize

С: 2.10

gtk_page_setup_get_paper_width ()

gdouble
gtk_page_setup_get_paper_width (GtkPageSetup *setup,
                                GtkUnit unit);

Возвращает ширину бумаги в единицах unit.

Обратите внимание, что эта функция учитывает ориентацию, но не поля. См. gtk_page_setup_get_page_width().

Параметры

setup	a GtkPageSetup
unit	единица измерения возвращаемого значения

Возвращаемое значение

ширина бумаги.

С: 2.10

gtk_page_setup_get_paper_height ()

gdouble
gtk_page_setup_get_paper_height (GtkPageSetup *setup,
                                 GtkUnit unit);

Возвращает высоту бумаги в единицах unit.

Обратите внимание, что эта функция учитывает ориентацию, но не поля. См. gtk_page_setup_get_page_height().

Параметры

setup	a GtkPageSetup
unit	единица измерения возвращаемого значения

Возвращаемое значение

высота бумаги.

С: 2.10

gtk_page_setup_get_page_width ()

gdouble
gtk_page_setup_get_page_width (GtkPageSetup *setup,
                               GtkUnit unit);

Возвращает ширину страницы в единицах unit.

Обратите внимание, что эта функция учитывает ориентацию и поля. См. gtk_page_setup_get_paper_width().

Параметры

setup	a GtkPageSetup
unit	единица измерения возвращаемого значения

Возвращаемое значение

ширина страницы.

С: 2.10

gtk_page_setup_get_page_height ()

gdouble
gtk_page_setup_get_page_height (GtkPageSetup *setup,
                                GtkUnit unit);

Возвращает высоту страницы в единицах unit.

Обратите внимание, что эта функция учитывает ориентацию и поля. См. gtk_page_setup_get_paper_height().

Параметры

setup	a GtkPageSetup
unit	единица измерения возвращаемого значения

Возвращаемое значение

высота страницы.

С: 2.10

gtk_page_setup_new_from_file ()

GtkPageSetup *
gtk_page_setup_new_from_file (const gchar *file_name,
                              GError **error);

Считывает настройки страницы из файла file_name. Возвращает новый объект GtkPageSetup с восстановленными настройками страницы или NULL, если произошла ошибка. См. gtk_page_setup_to_file().

Параметры

file_name	имя файла для считывания настроек страницы.	[type filename]
error	место для возврата ошибки или `NULL`.	[allow-none]

Возвращаемое значение

восстановленный GtkPageSetup

С: 2.12

gtk_page_setup_new_from_key_file ()

GtkPageSetup *
gtk_page_setup_new_from_key_file (GKeyFile *key_file,
                                  const gchar *group_name,
                                  GError **error);

Считывает настройки страницы из группы group_name в ключевом файле key_file. Возвращает новый объект GtkPageSetup с восстановленными настройками страницы или NULL, если произошла ошибка.

Параметры

key_file	the GKeyFile to retrieve the page_setup from
group_name	имя группы в key_file для чтения, или `NULL`, чтобы использовать имя по умолчанию «Page Setup».	[allow-none]
error	место для возврата ошибки или `NULL`.	[allow-none]

Возвращаемое значение

восстановленный GtkPageSetup

С: 2.12

gtk_page_setup_new_from_gvariant ()

GtkPageSetup *
gtk_page_setup_new_from_gvariant (GVariant *variant);

Десериализует параметры страницы из варианта a{sv} в формате, созданном функцией gtk_page_setup_to_gvariant().

Параметры

variant

вариант a{sv} GVariant

Возвращаемое значение

новый объект GtkPageSetup.

[transfer full]

С: 3.22

gtk_page_setup_load_file ()

gboolean
gtk_page_setup_load_file (GtkPageSetup *setup,
                          const char *file_name,
                          GError **error);

Читает параметры страницы из файла file_name. См. gtk_page_setup_to_file().

Параметры

setup	объект GtkPageSetup
file_name	имя файла для чтения параметров страницы.	[type filename]
error	место для возврата ошибки или `NULL`.	[allow-none]

Возвращаемое значение

TRUE при успехе

С: 2.14

gtk_page_setup_load_key_file ()

gboolean
gtk_page_setup_load_key_file (GtkPageSetup *setup,
                              GKeyFile *key_file,
                              const gchar *group_name,
                              GError **error);

Читает параметры страницы из группы group_name в ключевом файле key_file.

Параметры

setup	объект GtkPageSetup
key_file	ключевой файл GKeyFile для извлечения параметров страницы
group_name	имя группы в ключевом файле для чтения или `NULL` для использования имени по умолчанию «Page Setup».	[allow-none]
error	место для возврата ошибки или `NULL`.	[allow-none]

Возвращаемое значение

TRUE при успехе

С: 2.14

gtk_page_setup_to_file ()

gboolean
gtk_page_setup_to_file (GtkPageSetup *setup,
                        const char *file_name,
                        GError **error);

Сохраняет информацию из setup в file_name.

Параметры

setup	объект GtkPageSetup
file_name	файл для сохранения.	[type filename]
error	место для возврата ошибок или `NULL`.	[allow-none]

Возвращаемое значение

TRUE при успехе

С: 2.12

gtk_page_setup_to_key_file ()

void
gtk_page_setup_to_key_file (GtkPageSetup *setup,
                            GKeyFile *key_file,
                            const gchar *group_name);

Добавляет параметры страницы из setup в key_file.

Параметры

setup	объект GtkPageSetup
key_file	ключевой файл GKeyFile для сохранения параметров страницы
group_name	группа для добавления настроек в `key_file` или `NULL` для использования имени по умолчанию «Page Setup».	[nullable]

С: 2.12

gtk_page_setup_to_gvariant ()

GVariant *
gtk_page_setup_to_gvariant (GtkPageSetup *setup);

Сериализует параметры страницы в вариант a{sv}.

Возвращаемое значение: (transfer none): новый, плавающий, GVariant

Параметры

setup

объект GtkPageSetup

С: 3.22

Типы и значения

GtkPageSetup

typedef struct _GtkPageSetup GtkPageSetup;

© 2005–2020 The GNOME Project
Licensed under the GNU Lesser General Public License version 2.1 or later.
https://developer.gnome.org/gtk3/3.24/GtkPageSetup.html