Spec-Zone.ru › GTK 3.20

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 ()
void gtk_paper_size_to_key_file ()

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

GtkPaperSize
перечисление GtkUnit
#define GTK_UNIT_PIXEL
#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

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

    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);

Получает удобочитаемое имя GtkPaperSize.

Параметры

size

объект GtkPaperSize

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

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

С версии: 2.10

gtk_paper_size_get_ppd_name ()

const gchar *
gtk_paper_size_get_ppd_name (GtkPaperSize *size);

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

Параметры

size

объект GtkPaperSize

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

имя PPD size

С версии: 2.10

gtk_paper_size_get_width ()

gdouble
gtk_paper_size_get_width (GtkPaperSize *size,
                          GtkUnit unit);

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

Параметры

size

объект GtkPaperSize

unit

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

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

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

С версии: 2.10

gtk_paper_size_get_height ()

gdouble
gtk_paper_size_get_height (GtkPaperSize *size,
                           GtkUnit unit);

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

Параметры

size

объект GtkPaperSize

unit

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

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

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

С версии: 2.10

gtk_paper_size_is_ipp ()

gboolean
gtk_paper_size_is_ipp (GtkPaperSize *size);

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

Параметры

size

объект GtkPaperSize

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

является ли size нестандартным форматом бумаги IPP.

gtk_paper_size_is_custom ()

gboolean
gtk_paper_size_is_custom (GtkPaperSize *size);

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

Параметры

size

объект GtkPaperSize

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

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

gtk_paper_size_set_size ()

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

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

Параметры

size

объект пользовательского GtkPaperSize

width

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

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);

Получает стандартную верхнюю границу GtkPaperSize.

Параметры

size

объект GtkPaperSize

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);

Получает стандартную нижнюю границу GtkPaperSize.

Параметры

size

объект GtkPaperSize

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);

Получает стандартную левую границу GtkPaperSize.

Параметры

size

объект GtkPaperSize

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);

Получает стандартную правую границу GtkPaperSize.

Параметры

size

объект GtkPaperSize

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_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

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

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

Spec-Zone.ru

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