Spec-Zone.ru › GTK 3.22

GtkPaperSize

GtkPaperSize — Поддержка именованных размеров бумаги

Функции

GtkPaperSize * gtk_paper_size_new ()
GtkPaperSize * gtk_paper_size_new_from_ppd ()
GtkPaperSize * gtk_paper_size_new_from_ipp ()
GtkPaperSize * gtk_paper_size_new_custom ()
GtkPaperSize * gtk_paper_size_copy ()
void gtk_paper_size_free ()
gboolean gtk_paper_size_is_equal ()
GList * gtk_paper_size_get_paper_sizes ()
const gchar * gtk_paper_size_get_name ()
const gchar * gtk_paper_size_get_display_name ()
const gchar * gtk_paper_size_get_ppd_name ()
gdouble gtk_paper_size_get_width ()
gdouble gtk_paper_size_get_height ()
gboolean gtk_paper_size_is_ipp ()
gboolean gtk_paper_size_is_custom ()
void gtk_paper_size_set_size ()
gdouble gtk_paper_size_get_default_top_margin ()
gdouble gtk_paper_size_get_default_bottom_margin ()
gdouble gtk_paper_size_get_default_left_margin ()
gdouble gtk_paper_size_get_default_right_margin ()
const gchar * gtk_paper_size_get_default ()
GtkPaperSize * gtk_paper_size_new_from_key_file ()
GtkPaperSize * gtk_paper_size_new_from_gvariant ()
void gtk_paper_size_to_key_file ()
GVariant * gtk_paper_size_to_gvariant ()

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

GtkPaperSize
перечисление GtkUnit
#определить GTK_UNIT_PIXEL
#определить GTK_PAPER_NAME_A3
#определить GTK_PAPER_NAME_A4
#определить GTK_PAPER_NAME_A5
#определить GTK_PAPER_NAME_B5
#определить GTK_PAPER_NAME_LETTER
#определить GTK_PAPER_NAME_EXECUTIVE
#определить GTK_PAPER_NAME_LEGAL

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

    GBoxed
    ╰── GtkPaperSize

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

#include <gtk/gtk.h>

Описание

GtkPaperSize обрабатывает размеры бумаги. Он использует стандарт PWG 5101.1-2002 PWG: Стандарт для стандартизированных имён носителей для именования размеров бумаги (и для получения данных о размерах страниц). Помимо стандартных размеров бумаги, GtkPaperSize позволяет создавать пользовательские размеры бумаги с произвольными размерами.

Объект GtkPaperSize хранит не только размеры (ширину и высоту) размера бумаги и его имя, но также предоставляет значения по умолчанию для полей печати.

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

Функции

gtk_paper_size_new ()

GtkPaperSize *
gtk_paper_size_new (const gchar *name);

Создаёт новый объект GtkPaperSize, разобрав имя формата бумаги PWG 5101.1-2002.

Если name имеет значение NULL, возвращается размер бумаги по умолчанию, см. gtk_paper_size_get_default().

Параметры

name

имя формата бумаги или NULL.

[allow-none]

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

новый объект GtkPaperSize; для освобождения используйте gtk_paper_size_free()

С версии: 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);

Создаёт новый объект GtkPaperSize на основе информации из PPD.

Если ppd_name не соответствует распознаваемому имени формата бумаги PPD, значения ppd_display_name, width и height используются для создания пользовательского объекта GtkPaperSize.

Параметры

ppd_name

имя формата бумаги PPD

ppd_display_name

соответствующее имя для отображения пользователю

width

ширина бумаги в пунктах

height

высота бумаги в пунктах

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

новый объект GtkPaperSize; для освобождения используйте gtk_paper_size_free()

С версии: 2.10

gtk_paper_size_new_from_ipp ()

GtkPaperSize *
gtk_paper_size_new_from_ipp (const gchar *ipp_name,
                             gdouble width,
                             gdouble height);

Создаёт новый объект GtkPaperSize на основе информации из IPP.

Если ipp_name не соответствует распознаваемому имени формата бумаги, значения width и height используются для создания пользовательского объекта GtkPaperSize.

Параметры

ipp_name

имя формата бумаги IPP

width

ширина бумаги в пунктах

height

высота бумаги в пунктах

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

новый объект GtkPaperSize; для освобождения используйте gtk_paper_size_free()

С версии: 3.16

gtk_paper_size_new_custom ()

GtkPaperSize *
gtk_paper_size_new_custom (const gchar *name,
                           const gchar *display_name,
                           gdouble width,
                           gdouble height,
                           GtkUnit unit);

Создаёт новый объект GtkPaperSize с заданными параметрами.

Параметры

name

имя формата бумаги

display_name

человеко-читаемое имя

width

ширина бумаги в единицах unit

height

высота бумаги в единицах unit

unit

единица измерения для width и height. Не GTK_UNIT_NONE.

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

новый объект GtkPaperSize; для освобождения используйте gtk_paper_size_free()

С версии: 2.10

gtk_paper_size_copy ()

GtkPaperSize *
gtk_paper_size_copy (GtkPaperSize *other);

Создаёт копию существующего объекта GtkPaperSize.

Параметры

other

объект GtkPaperSize

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

копия other

С версии: 2.10

gtk_paper_size_free ()

void
gtk_paper_size_free (GtkPaperSize *size);

Освобождает объект GtkPaperSize.

Параметры

size

объект GtkPaperSize

С версии: 2.10

gtk_paper_size_is_equal ()

gboolean
gtk_paper_size_is_equal (GtkPaperSize *size1,
                         GtkPaperSize *size2);

Сравнивает два объекта GtkPaperSize.

Параметры

size1

объект GtkPaperSize

size2

другой объект GtkPaperSize

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

TRUE, если size1 и size2 представляют один и тот же формат бумаги

С версии: 2.10

gtk_paper_size_get_paper_sizes ()

GList *
gtk_paper_size_get_paper_sizes (gboolean include_custom);

Создаёт список известных форматов бумаги.

Параметры

include_custom

включать ли пользовательские форматы бумаги, определённые в диалоге настройки страницы

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

новый выделенный список объектов GtkPaperSize.

[element-type GtkPaperSize][transfer full]

С версии: 2.12

gtk_paper_size_get_name ()

const gchar *
gtk_paper_size_get_name (GtkPaperSize *size);

Возвращает имя формата бумаги GtkPaperSize.

Параметры

size

объект GtkPaperSize

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

имя size

С версии: 2.10

gtk_paper_size_get_display_name ()

const gchar *
gtk_paper_size_get_display_name (GtkPaperSize *size);

Получает удобочитаемое имя формата бумаги.

Параметры

размер

объект формата бумаги

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

удобочитаемое имя size

С версии: 2.10

gtk_paper_size_get_ppd_name ()

const gchar *
gtk_paper_size_get_ppd_name (GtkPaperSize *size);

Получает имя PPD формата бумаги, которое может быть NULL.

Параметры

размер

объект формата бумаги

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

имя PPD size

С версии: 2.10

gtk_paper_size_get_width ()

gdouble
gtk_paper_size_get_width (GtkPaperSize *size,
                          GtkUnit unit);

Получает ширину бумаги формата бумаги в единицах unit .

Параметры

размер

объект формата бумаги

единица

единица измерения возвращаемого значения, не GTK_UNIT_NONE

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

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

С версии: 2.10

gtk_paper_size_get_height ()

gdouble
gtk_paper_size_get_height (GtkPaperSize *size,
                           GtkUnit unit);

Получает высоту бумаги формата бумаги в единицах unit .

Параметры

размер

объект формата бумаги

единица

единица измерения возвращаемого значения, не GTK_UNIT_NONE

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

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

С версии: 2.10

gtk_paper_size_is_ipp ()

gboolean
gtk_paper_size_is_ipp (GtkPaperSize *size);

Возвращает TRUE, если size — стандартный формат бумаги IPP.

Параметры

размер

объект формата бумаги

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

является ли size не пользовательским форматом бумаги IPP.

gtk_paper_size_is_custom ()

gboolean
gtk_paper_size_is_custom (GtkPaperSize *size);

Возвращает TRUE, если size — не стандартный формат бумаги.

Параметры

размер

объект формата бумаги

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

является ли size пользовательским форматом бумаги.

gtk_paper_size_set_size ()

void
gtk_paper_size_set_size (GtkPaperSize *size,
                         gdouble width,
                         gdouble height,
                         GtkUnit unit);

Изменяет размеры size на width x height .

Параметры

размер

пользовательский объект формата бумаги

ширина

новая ширина в единицах unit

высота

новая высота в единицах unit

единица

единица измерения для width и height

С версии: 2.10

gtk_paper_size_get_default_top_margin ()

gdouble
gtk_paper_size_get_default_top_margin (GtkPaperSize *size,
                                       GtkUnit unit);

Получает значение по умолчанию для верхнего отступа формата бумаги.

Параметры

размер

объект формата бумаги

единица

единица измерения возвращаемого значения, не GTK_UNIT_NONE

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

значение верхнего отступа по умолчанию

С версии: 2.10

gtk_paper_size_get_default_bottom_margin ()

gdouble
gtk_paper_size_get_default_bottom_margin
                               (GtkPaperSize *size,
                                GtkUnit unit);

Получает значение по умолчанию для нижнего отступа формата бумаги.

Параметры

размер

объект формата бумаги

единица

единица измерения возвращаемого значения, не GTK_UNIT_NONE

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

значение нижнего отступа по умолчанию

С версии: 2.10

gtk_paper_size_get_default_left_margin ()

gdouble
gtk_paper_size_get_default_left_margin
                               (GtkPaperSize *size,
                                GtkUnit unit);

Получает значение по умолчанию для левого отступа формата бумаги.

Параметры

размер

объект формата бумаги

единица

единица измерения возвращаемого значения, не GTK_UNIT_NONE

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

значение левого отступа по умолчанию

С версии: 2.10

gtk_paper_size_get_default_right_margin ()

gdouble
gtk_paper_size_get_default_right_margin
                               (GtkPaperSize *size,
                                GtkUnit unit);

Получает значение по умолчанию для правого отступа формата бумаги.

Параметры

размер

объект формата бумаги

единица

единица измерения возвращаемого значения, не GTK_UNIT_NONE

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

значение правого отступа по умолчанию

С версии: 2.10

gtk_paper_size_get_default ()

const gchar *
gtk_paper_size_get_default (void);

Возвращает имя формата бумаги по умолчанию, которое зависит от текущего языка.

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

имя формата бумаги по умолчанию. Строка принадлежит GTK+ и её нельзя изменять.

С версии: 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);

Считывает размер бумаги из группы group_name в файле ключей key_file.

Параметры

key_file

the GKeyFile для получения размера бумаги

group_name

имя группы в файле ключей для чтения, или NULL для чтения первой группы

error

место для возврата ошибки, или NULL.

[allow-none]

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

новый объект GtkPaperSize с восстановленным размером бумаги, или NULL, если произошла ошибка

С: 2.12

gtk_paper_size_new_from_gvariant ()

GtkPaperSize *
gtk_paper_size_new_from_gvariant (GVariant *variant);

Десериализация размера бумаги из варианта a{sv} в формате, созданном gtk_paper_size_to_gvariant().

Параметры

variant

a{sv} GVariant

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

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

[transfer full]

С: 3.22

gtk_paper_size_to_key_file ()

void
gtk_paper_size_to_key_file (GtkPaperSize *size,
                            GKeyFile *key_file,
                            const gchar *group_name);

Эта функция добавляет размер бумаги из size в key_file.

Параметры

size

a GtkPaperSize

key_file

the GKeyFile для сохранения размера бумаги

group_name

группа для добавления настроек в key_file

С: 2.12

gtk_paper_size_to_gvariant ()

GVariant *
gtk_paper_size_to_gvariant (GtkPaperSize *paper_size);

Сериализация размера бумаги в вариант a{sv}.

Параметры

paper_size

a GtkPaperSize

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

новый плавающий GVariant.

[transfer none]

С: 3.22

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

GtkPaperSize

typedef struct _GtkPaperSize GtkPaperSize;

перечисление GtkUnit

См. также gtk_print_settings_set_paper_width().

Элементы

GTK_UNIT_NONE

Нет единиц.

GTK_UNIT_POINTS

Размеры в пунктах.

GTK_UNIT_INCH

Размеры в дюймах.

GTK_UNIT_MM

Размеры в миллиметрах

GTK_UNIT_PIXEL

#define GTK_UNIT_PIXEL GTK_UNIT_NONE

GTK_PAPER_NAME_A3

#define GTK_PAPER_NAME_A3 "iso_a3"

Имя для размера бумаги A3.

GTK_PAPER_NAME_A4

#define GTK_PAPER_NAME_A4 "iso_a4"

Имя для размера бумаги A4.

GTK_PAPER_NAME_A5

#define GTK_PAPER_NAME_A5 "iso_a5"

Имя для размера бумаги A5.

GTK_PAPER_NAME_B5

#define GTK_PAPER_NAME_B5 "iso_b5"

Имя для размера бумаги B5.

GTK_PAPER_NAME_LETTER

#define GTK_PAPER_NAME_LETTER "na_letter"

Имя для размера бумаги Letter.

GTK_PAPER_NAME_EXECUTIVE

#define GTK_PAPER_NAME_EXECUTIVE "na_executive"

Имя для размера бумаги Executive.

GTK_PAPER_NAME_LEGAL

#define GTK_PAPER_NAME_LEGAL "na_legal"

Имя для размера бумаги Legal.

См. также

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.22/GtkPaperSize.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API