GtkPaperSize
GtkPaperSize — Поддержка именованных размеров бумаги
Функции
Типы и значения
| 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_paper_size_new ()
GtkPaperSize *
gtk_paper_size_new (const char *name); Создаёт новый объект GtkPaperSize, анализируя имя формата бумаги PWG 5101.1-2002.
Если name имеет значение NULL, возвращается размер по умолчанию, см. gtk_paper_size_get_default().
Параметры
name | имя формата бумаги или | [allow-none] |
Возвращаемое значение
новый объект GtkPaperSize, используйте gtk_paper_size_free() для его освобождения
gtk_paper_size_new_from_ppd ()
GtkPaperSize * gtk_paper_size_new_from_ppd (const char *ppd_name,const char *ppd_display_name,double width,double 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() для его освобождения
gtk_paper_size_new_from_ipp ()
GtkPaperSize * gtk_paper_size_new_from_ipp (const char *ipp_name,double width,double height);
Создаёт новый объект GtkPaperSize, используя информацию IPP.
Если ipp_name не является распознаваемым именем формата бумаги, width и height используются для построения пользовательского объекта GtkPaperSize.
Параметры
ipp_name | имя формата бумаги IPP | |
width | ширина бумаги в пунктах | |
height | высота бумаги в пунктах |
Возвращаемое значение
новый объект GtkPaperSize, используйте gtk_paper_size_free() для его освобождения
gtk_paper_size_new_custom ()
GtkPaperSize * gtk_paper_size_new_custom (const char *name,const char *display_name,double width,double height,GtkUnit unit);
Создаёт новый объект GtkPaperSize с заданными параметрами.
Параметры
name | имя формата бумаги | |
display_name | удобочитаемое имя | |
width | ширина бумаги в единицах | |
height | высота бумаги в единицах | |
unit | единица измерения для |
Возвращаемое значение
новый объект GtkPaperSize, используйте gtk_paper_size_free() для его освобождения
gtk_paper_size_copy ()
GtkPaperSize *
gtk_paper_size_copy (GtkPaperSize *other); Копирует существующий объект GtkPaperSize.
Параметры
other | объект GtkPaperSize |
Возвращаемое значение
копию other
gtk_paper_size_free ()
void
gtk_paper_size_free (GtkPaperSize *size); Освобождает заданный объект GtkPaperSize.
Параметры
size | объект GtkPaperSize |
gtk_paper_size_is_equal ()
gboolean gtk_paper_size_is_equal (GtkPaperSize *size1,GtkPaperSize *size2);
Сравнивает два объекта GtkPaperSize.
Параметры
size1 | объект GtkPaperSize | |
size2 | другой объект GtkPaperSize |
Возвращаемое значение
TRUE, если size1 и size2 представляют один и тот же формат бумаги
gtk_paper_size_get_paper_sizes ()
GList * gtk_paper_size_get_paper_sizes (gboolean include_custom);
Создаёт список известных форматов бумаги.
Параметры
include_custom | включать ли пользовательские форматы бумаги, определённые в диалоге настроек страницы |
Возвращаемое значение
новый динамически выделенный список объектов GtkPaperSize.
[element-type GtkPaperSize][transfer full]
gtk_paper_size_get_name ()
const char *
gtk_paper_size_get_name (GtkPaperSize *size); Возвращает имя объекта GtkPaperSize.
Параметры
size | объект GtkPaperSize |
Возвращаемое значение
имя size
gtk_paper_size_get_display_name ()
const char *
gtk_paper_size_get_display_name (GtkPaperSize *size); Возвращает удобочитаемое имя объекта GtkPaperSize.
Параметры
size | объект GtkPaperSize |
Возвращаемое значение
удобочитаемое имя size
gtk_paper_size_get_ppd_name ()
const char *
gtk_paper_size_get_ppd_name (GtkPaperSize *size); Получает имя PPD для GtkPaperSize, которое может быть NULL.
Параметры
size | объект GtkPaperSize |
Возвращает
имя PPD для size
gtk_paper_size_get_width ()
double gtk_paper_size_get_width (GtkPaperSize *size,GtkUnit unit);
Получает ширину листа бумаги GtkPaperSize в единицах unit.
Параметры
size | объект GtkPaperSize | |
unit | единица измерения для возвращаемого значения, не |
Возвращает
ширину листа
gtk_paper_size_get_height ()
double gtk_paper_size_get_height (GtkPaperSize *size,GtkUnit unit);
Получает высоту листа бумаги GtkPaperSize в единицах unit.
Параметры
size | объект GtkPaperSize | |
unit | единица измерения для возвращаемого значения, не |
Возвращает
высоту листа
gtk_paper_size_is_ipp ()
gboolean
gtk_paper_size_is_ipp (GtkPaperSize *size); Возвращает TRUE, если size является стандартным размером листа IPP.
Параметры
size | объект GtkPaperSize |
Возвращает
true, если size не является пользовательским размером листа IPP.
gtk_paper_size_is_custom ()
gboolean
gtk_paper_size_is_custom (GtkPaperSize *size); Возвращает TRUE, если size не является стандартным размером листа.
Параметры
size | объект GtkPaperSize |
Возвращает
true, если size является пользовательским размером листа.
gtk_paper_size_set_size ()
void gtk_paper_size_set_size (GtkPaperSize *size,double width,double height,GtkUnit unit);
Изменяет размеры size на width x height.
Параметры
size | пользовательский объект GtkPaperSize | |
width | новая ширина в единицах | |
height | новая высота в единицах | |
unit | единица измерения для |
gtk_paper_size_get_default_top_margin ()
double gtk_paper_size_get_default_top_margin (GtkPaperSize *size,GtkUnit unit);
Получает значение по умолчанию для верхней рамки GtkPaperSize.
Параметры
size | объект GtkPaperSize | |
unit | единица измерения для возвращаемого значения, не |
Возвращает
значение по умолчанию для верхней рамки
gtk_paper_size_get_default_bottom_margin ()
double gtk_paper_size_get_default_bottom_margin (GtkPaperSize *size,GtkUnit unit);
Получает значение по умолчанию для нижней рамки GtkPaperSize.
Параметры
size | объект GtkPaperSize | |
unit | единица измерения для возвращаемого значения, не |
Возвращает
значение по умолчанию для нижней рамки
gtk_paper_size_get_default_left_margin ()
double gtk_paper_size_get_default_left_margin (GtkPaperSize *size,GtkUnit unit);
Получает значение по умолчанию для левой рамки GtkPaperSize.
Параметры
size | объект GtkPaperSize | |
unit | единица измерения для возвращаемого значения, не |
Возвращает
значение по умолчанию для левой рамки
gtk_paper_size_get_default_right_margin ()
double gtk_paper_size_get_default_right_margin (GtkPaperSize *size,GtkUnit unit);
Получает значение по умолчанию для правой рамки GtkPaperSize.
Параметры
size | объект GtkPaperSize | |
unit | единица измерения для возвращаемого значения, не |
Возвращает
значение по умолчанию для правой рамки
gtk_paper_size_get_default ()
const char * gtk_paper_size_get_default (void);
Возвращает имя размера листа по умолчанию, которое зависит от текущего региона.
Возвращает
имя размера листа по умолчанию. Строка принадлежит GTK и не должна изменяться.
gtk_paper_size_new_from_key_file ()
GtkPaperSize * gtk_paper_size_new_from_key_file (GKeyFile *key_file,const char *group_name,GError **error);
Считывает размер листа из группы group_name в файле ключей key_file.
Параметры
key_file | GKeyFile для извлечения размера листа | |
group_name | имя группы в файле ключей для чтения, или | [nullable] |
error | место для возврата ошибки, или | [allow-none] |
Возвращает
новый объект GtkPaperSize с восстановленным размером листа, или NULL в случае ошибки
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 |
gtk_paper_size_to_key_file ()
void gtk_paper_size_to_key_file (GtkPaperSize *size,GKeyFile *key_file,const char *group_name);
Эта функция добавляет размер бумаги из size в key_file.
Параметры
size | объект GtkPaperSize | |
key_file | файл GKeyFile для сохранения размера бумаги | |
group_name | группа, в которую добавляются настройки в |
gtk_paper_size_to_gvariant ()
GVariant *
gtk_paper_size_to_gvariant (GtkPaperSize *paper_size); Сериализует размер бумаги в вариант a{sv}.
Параметры
paper_size | объект GtkPaperSize |
Возвращаемое значение
новый плавающий GVariant.
[transfer none]
Типы и значения
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.
См. также
© 2005–2020 The GNOME Project
Licensed under the GNU Lesser General Public License version 2.1 or later.
https://developer-old.gnome.org/gtk4/4.0/GtkPaperSize.html