GtkPrinter
GtkPrinter — Представляет принтер
Функции
| GtkPrinter * | gtk_printer_new () |
| GtkPrintBackend * | gtk_printer_get_backend () |
| const gchar * | gtk_printer_get_name () |
| const gchar * | gtk_printer_get_state_message () |
| const gchar * | gtk_printer_get_description () |
| const gchar * | gtk_printer_get_location () |
| const gchar * | gtk_printer_get_icon_name () |
| gint | gtk_printer_get_job_count () |
| gboolean | gtk_printer_is_active () |
| gboolean | gtk_printer_is_paused () |
| gboolean | gtk_printer_is_accepting_jobs () |
| gboolean | gtk_printer_is_virtual () |
| gboolean | gtk_printer_is_default () |
| gboolean | gtk_printer_accepts_ps () |
| gboolean | gtk_printer_accepts_pdf () |
| GList * | gtk_printer_list_papers () |
| gint | gtk_printer_compare () |
| gboolean | gtk_printer_has_details () |
| void | gtk_printer_request_details () |
| GtkPrintCapabilities | gtk_printer_get_capabilities () |
| GtkPageSetup * | gtk_printer_get_default_page_size () |
| gboolean | gtk_printer_get_hard_margins () |
| gboolean | (*GtkPrinterFunc) () |
| void | gtk_enumerate_printers () |
Свойства
| gboolean | accepting-jobs | Чтение |
| gboolean | accepts-pdf | Чтение/Запись/Только создание |
| gboolean | accepts-ps | Чтение/Запись/Только создание |
| GtkPrintBackend * | backend | Чтение/Запись/Только создание |
| char * | имя-иконки | Чтение |
| gboolean | виртуальный | Чтение/Запись/Только создание |
| int | счёт-заданий | Чтение |
| char * | местоположение | Чтение |
| char * | имя | Чтение/Запись/Только создание |
| gboolean | приостановлен | Чтение |
| char * | сообщение-о-состоянии | Чтение |
Сигналы
| void | details-acquired | Выполнить последним |
Типы и значения
| struct | GtkPrinter |
| GtkPrintBackend |
Иерархия объектов
GObject
├── GtkPrintBackend
╰── GtkPrinter
Включаемые файлы
#include <gtk/gtk.h>
Описание
Объект GtkPrinter представляет принтер. Вам нужно работать напрямую с принтерами только в случае использования непереносимого API GtkPrintUnixDialog.
Объект GtkPrinter позволяет получить информацию о статусе принтера, такую как его описание, местоположение, количество задач в очереди и т. д. Важно, что объект GtkPrinter может использоваться для создания объекта GtkPrintJob, который позволяет печатать на принтере.
Поддержка печати была добавлена в GTK+ 2.10.
Функции
gtk_printer_new ()
GtkPrinter * gtk_printer_new (const gchar *name,GtkPrintBackend *backend,gboolean virtual_);
Создаёт новый GtkPrinter.
Параметры
name | имя принтера | |
backend | ||
virtual_ | является ли принтер виртуальным |
Возвращает
новый GtkPrinter
С: 2.10
gtk_printer_get_backend ()
GtkPrintBackend *
gtk_printer_get_backend (GtkPrinter *printer); Возвращает бэкенд принтера.
Параметры
printer |
Возвращает
бэкенд printer.
[transfer none]
С: 2.10
gtk_printer_get_name ()
const gchar *
gtk_printer_get_name (GtkPrinter *printer); Возвращает имя принтера.
Параметры
printer |
Возвращает
имя printer.
С: 2.10
gtk_printer_get_state_message ()
const gchar *
gtk_printer_get_state_message (GtkPrinter *printer); Возвращает сообщение о состоянии, описывающее текущее состояние принтера.
Параметры
printer |
Возвращает
сообщение о состоянии printer.
С: 2.10
gtk_printer_get_description ()
const gchar *
gtk_printer_get_description (GtkPrinter *printer); Возвращает описание принтера.
Параметры
printer |
Возвращает
описание printer.
С: 2.10
gtk_printer_get_location ()
const gchar *
gtk_printer_get_location (GtkPrinter *printer); Возвращает описание местоположения принтера.
Параметры
printer |
Возвращает
местоположение printer.
С: 2.10
gtk_printer_get_icon_name ()
const gchar *
gtk_printer_get_icon_name (GtkPrinter *printer); Возвращает имя иконки для принтера.
Параметры
printer |
Возвращает
имя иконки для printer.
С: 2.10
gtk_printer_get_job_count ()
gint
gtk_printer_get_job_count (GtkPrinter *printer); Возвращает количество задач, в очереди на принтере.
Параметры
printer |
Возвращает
количество задач на printer.
С: 2.10
gtk_printer_is_active ()
gboolean
gtk_printer_is_active (GtkPrinter *printer); Возвращает, активен ли принтер (то есть принимает ли новые задания).
Параметры
printer |
Возвращает
TRUE если printer активен
С: 2.10
gtk_printer_is_paused ()
gboolean
gtk_printer_is_paused (GtkPrinter *printer); Возвращает, приостановлен ли принтер. Приостановленный принтер всё ещё принимает задания, но не печатает их.
Параметры
printer |
Возвращает
TRUE если printer приостановлен
С: 2.14
gtk_printer_is_accepting_jobs ()
gboolean
gtk_printer_is_accepting_jobs (GtkPrinter *printer); Возвращает, принимает ли принтер задания
Параметры
printer |
Возвращает
TRUE если printer принимает задания
С: 2.14
gtk_printer_is_virtual ()
gboolean
gtk_printer_is_virtual (GtkPrinter *printer); Возвращает, является ли принтер виртуальным (то есть не представляет собой реальное оборудование принтера, а что-то вроде класса CUPS).
Параметры
printer |
Возвращает
TRUE если printer виртуальный
С: 2.10
gtk_printer_is_default ()
gboolean
gtk_printer_is_default (GtkPrinter *printer); Возвращает, является ли принтер принтером по умолчанию.
Параметры
printer |
Возвращает
TRUE если printer по умолчанию
С: 2.10
gtk_printer_accepts_ps ()
gboolean
gtk_printer_accepts_ps (GtkPrinter *printer); Возвращает, принимает ли принтер входные данные в формате PostScript.
Параметры
printer |
Возвращает
TRUE если printer принимает PostScript
С: 2.10
gtk_printer_accepts_pdf ()
gboolean
gtk_printer_accepts_pdf (GtkPrinter *printer); Возвращает, принимает ли принтер входные данные в формате PDF.
Параметры
printer |
Возвращает
TRUE если printer принимает PDF
С: 2.10
gtk_printer_list_papers ()
GList *
gtk_printer_list_papers (GtkPrinter *printer); Перечисляет все размеры бумаги, которые printer поддерживает. Будет возвращён пустой список, если данные о принтере недоступны; см. gtk_printer_has_details() и gtk_printer_request_details().
Параметры
printer | объект GtkPrinter |
Возвращаемое значение
новый динамически выделенный список объектов GtkPageSetup.
[element-type GtkPageSetup][transfer full]
С версии: 2.12
gtk_printer_compare ()
gint gtk_printer_compare (GtkPrinter *a,GtkPrinter *b);
Сравнивает два принтера.
Параметры
a | объект GtkPrinter | |
b | другой объект GtkPrinter |
Возвращаемое значение
0, если принтеры совпадают; отрицательное значение, если a < b; положительное значение, если a > b
С версии: 2.10
gtk_printer_has-details ()
gboolean
gtk_printer_has_details (GtkPrinter *printer); Возвращает, доступны ли данные о принтере.
Параметры
printer | объект GtkPrinter |
Возвращаемое значение
TRUE если данные о printer доступны
С версии: 2.12
gtk_printer_request-details ()
void
gtk_printer_request_details (GtkPrinter *printer); Запрашивает данные о принтере. Когда данные станут доступны, на объекте printer будет испущен сигнал “details-acquired”.
Параметры
printer | объект GtkPrinter |
С версии: 2.12
gtk_printer_get-capabilities ()
GtkPrintCapabilities
gtk_printer_get_capabilities (GtkPrinter *printer); Возвращает возможности принтера.
Полезно, когда вы используете настройки «manual-capabilities» в GtkPrintUnixDialog и хотите узнать, какие настройки принтер может обработать, а какие вам нужно обработать самостоятельно.
Возвращает 0, если данные о принтере недоступны; см. gtk_printer_has_details() и gtk_printer_request_details().
Параметры
printer | объект GtkPrinter |
Возвращаемое значение
возможности принтера
С версии: 2.12
gtk_printer_get-default-page-size ()
GtkPageSetup *
gtk_printer_get_default_page_size (GtkPrinter *printer); Возвращает размер страницы по умолчанию для printer .
Параметры
printer | объект GtkPrinter |
Возвращаемое значение
новый объект GtkPageSetup с размером страницы по умолчанию для принтера.
С версии: 2.14
gtk_printer_get-hard-margins ()
gboolean gtk_printer_get_hard_margins (GtkPrinter *printer,gdouble *top,gdouble *bottom,gdouble *left,gdouble *right);
Возвращает жёсткие поля printer, т.е. поля, определяющие область по краям листа, в которую принтер не может печатать.
Примечание: Эта функция не сработает, если данные о принтере недоступны; см. gtk_printer_has_details() и gtk_printer_request_details().
Параметры
printer | объект GtkPrinter | |
top | место для хранения верхнего поля. | [out] |
bottom | место для хранения нижнего поля. | [out] |
left | место для хранения левого поля. | [out] |
right | место для хранения правого поля. | [out] |
Возвращаемое значение
TRUE если жёсткие поля были получены
С версии: 2.20
GtkPrinterFunc ()
gboolean (*GtkPrinterFunc) (GtkPrinter *printer,gpointer data);
Тип функции, передаваемой в gtk_enumerate_printers(). Обратите внимание, что вам нужно сохранить ссылку на printer, если вы хотите сохранить ссылку на неё после возвращения функции.
Параметры
printer | объект GtkPrinter | |
data | данные пользователя, передаваемые в | [closure] |
Возвращаемое значение
TRUE для остановки перечисления, FALSE для продолжения
С версии: 2.10
gtk_enumerate-printers ()
void gtk_enumerate_printers (GtkPrinterFunc func,gpointer data,GDestroyNotify destroy,gboolean wait);
Вызывает функцию для всех GtkPrinters. Если func возвращает TRUE, перечисление останавливается.
Параметры
func | функция, вызываемая для каждого принтера | |
data | данные пользователя, передаваемые в | |
destroy | функция, вызываемая, если | |
wait | если |
С версии: 2.10
Типы и значения
Структура GtkPrinter
struct GtkPrinter;
GtkPrintBackend
typedef struct _GtkPrintBackend GtkPrintBackend;
Подробное описание свойств
Свойство “accepting-jobs”
“accepting-jobs” gboolean
Это свойство равно TRUE если принтер принимает задания.
Владелец: GtkPrinter
Флаги: Чтение
Значение по умолчанию: TRUE
С версии: 2.14
Свойство “accepts-pdf”
“accepts-pdf” gboolean
TRUE, если принтер может принимать PDF-документы.
Владелец: GtkPrinter
Флаги: Чтение / Запись / Только для создания
Значение по умолчанию: FALSE
Свойство “accepts-ps”
“accepts-ps” gboolean
TRUE, если принтер может принимать PostScript-документы.
Владелец: GtkPrinter
Флаги: Чтение / Запись / Только для создания
Значение по умолчанию: TRUE
Свойство “backend”
“backend” GtkPrintBackend *
Бэкенд принтера.
Владелец: GtkPrinter
Флаги: Чтение / Запись / Только для создания
Свойство “icon-name”
“icon-name” char *
Имя иконки для принтера.
Владелец: GtkPrinter
Флаги: Чтение
Значение по умолчанию: ""
Свойство “is-virtual”
“is-virtual” gboolean
FALSE, если это реальный физический принтер.
Владелец: GtkPrinter
Флаги: Чтение / Запись / Только для создания
Значение по умолчанию: FALSE
Свойство “job-count”
“job-count” int
Количество заданий в очереди принтера.
Владелец: GtkPrinter
Флаги: Чтение
Допустимые значения: >= 0
Значение по умолчанию: 0
Свойство “location”
“location” char *
Расположение принтера.
Владелец: GtkPrinter
Флаги: Чтение
Значение по умолчанию: ""
Свойство “name”
“name” char *
Имя принтера.
Владелец: GtkPrinter
Флаги: Чтение / Запись / Только для создания
Значение по умолчанию: ""
Свойство “paused”
“paused” gboolean
Это свойство равно TRUE если принтер приостановлен. Приостановленный принтер всё ещё принимает задания, но не печатает их.
Владелец: GtkPrinter
Флаги: Чтение
Значение по умолчанию: FALSE
С версии: 2.14
Свойство “state-message”
“state-message” char *
Строка, отображающая текущее состояние принтера.
Владелец: GtkPrinter
Флаги: Чтение
Значение по умолчанию: ""
Подробное описание сигналов
Сигнал “details-acquired”
void user_function (GtkPrinter *printer, gboolean success, gpointer user_data)
Вызывается в ответ на запрос подробной информации о принтере от бэкенда печати. Параметр success указывает, была ли информация успешно получена.
Параметры
printer | принтер GtkPrinter, на котором сгенерирован сигнал | |
success |
| |
user_data | пользовательские данные, установленные при подключении обработчика сигнала. |
Флаги: Выполнить последним
С версии: 2.10
© 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/GtkPrinter.html