Spec-Zone.ru › GTK 3.20

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 Чтение/Запись/Только для создания
gchar * icon-name Только чтение
gboolean is-virtual Чтение/Запись/Только для создания
gint job-count Только чтение
gchar * location Только чтение
gchar * name Чтение/Запись/Только для создания
gboolean paused Только чтение
gchar * state-message Только чтение

Сигналы

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

a GtkPrintBackend

virtual_

является ли принтер виртуальным

Возвращает

новый GtkPrinter

С: 2.10

gtk_printer_get_backend ()

GtkPrintBackend *
gtk_printer_get_backend (GtkPrinter *printer);

Возвращает бэкенд принтера.

Параметры

printer

a GtkPrinter

Возвращает

бэкенд printer .

[transfer none]

С: 2.10

gtk_printer_get_name ()

const gchar *
gtk_printer_get_name (GtkPrinter *printer);

Возвращает имя принтера.

Параметры

printer

a GtkPrinter

Возвращает

имя printer

С: 2.10

gtk_printer_get_state_message ()

const gchar *
gtk_printer_get_state_message (GtkPrinter *printer);

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

Параметры

printer

a GtkPrinter

Возвращает

сообщение о состоянии printer

С: 2.10

gtk_printer_get_description ()

const gchar *
gtk_printer_get_description (GtkPrinter *printer);

Возвращает описание принтера.

Параметры

printer

a GtkPrinter

Возвращает

описание printer

С: 2.10

gtk_printer_get_location ()

const gchar *
gtk_printer_get_location (GtkPrinter *printer);

Возвращает описание местоположения принтера.

Параметры

printer

a GtkPrinter

Возвращает

местоположение printer

С: 2.10

gtk_printer_get_icon_name ()

const gchar *
gtk_printer_get_icon_name (GtkPrinter *printer);

Возвращает имя иконки для принтера.

Параметры

printer

a GtkPrinter

Возвращает

имя иконки для printer

С: 2.10

gtk_printer_get_job_count ()

gint
gtk_printer_get_job_count (GtkPrinter *printer);

Возвращает количество задач, текущих в очереди печати на принтере.

Параметры

printer

a GtkPrinter

Возвращает

количество задач в очереди на printer

С: 2.10

gtk_printer_is_active ()

gboolean
gtk_printer_is_active (GtkPrinter *printer);

Возвращает, активен ли принтер (т.е. принимает ли новые задачи).

Параметры

printer

a GtkPrinter

Возвращает

TRUE, если printer активен

С: 2.10

gtk_printer_is_paused ()

gboolean
gtk_printer_is_paused (GtkPrinter *printer);

Возвращает, приостановлен ли принтер. Приостановленный принтер всё ещё принимает задачи, но не печатает их.

Параметры

printer

a GtkPrinter

Возвращает

TRUE, если printer приостановлен

С: 2.14

gtk_printer_is_accepting_jobs ()

gboolean
gtk_printer_is_accepting_jobs (GtkPrinter *printer);

Возвращает, принимает ли принтер задания

Параметры

printer

a GtkPrinter

Возвращает

TRUE, если printer принимает задания

С: 2.14

gtk_printer_is_virtual ()

gboolean
gtk_printer_is_virtual (GtkPrinter *printer);

Возвращает, является ли принтер виртуальным (т.е. не представляет собой реального принтера, а что-то вроде класса CUPS).

Параметры

printer

a GtkPrinter

Возвращает

TRUE, если printer виртуальный

С: 2.10

gtk_printer_is_default ()

gboolean
gtk_printer_is_default (GtkPrinter *printer);

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

Параметры

printer

a GtkPrinter

Возвращает

TRUE, если printer по умолчанию

С: 2.10

gtk_printer_accepts_ps ()

gboolean
gtk_printer_accepts_ps (GtkPrinter *printer);

Возвращает, принимает ли принтер входные данные в формате PostScript.

Параметры

printer

a GtkPrinter

Возвращает

TRUE, если printer принимает PostScript

С: 2.10

gtk_printer_accepts_pdf ()

gboolean
gtk_printer_accepts_pdf (GtkPrinter *printer);

Возвращает, принимает ли принтер входные данные в формате PDF.

Параметры

printer

a GtkPrinter

Возвращает

TRUE, если printer принимает PDF

Since: 2.10

gtk_printer_list_papers ()

GList *
gtk_printer_list_papers (GtkPrinter *printer);

Перечисляет все размеры бумаги, которые поддерживает printer. Этот метод вернёт пустой список, если данные о принтере недоступны, см. gtk_printer_has_details() и gtk_printer_request_details().

Параметры

printer

a GtkPrinter

Возвращает

новый динамически выделенный список объектов GtkPageSetup.

[element-type GtkPageSetup][transfer full]

Since: 2.12

gtk_printer_compare ()

gint
gtk_printer_compare (GtkPrinter *a,
                     GtkPrinter *b);

Сравнивает два принтера.

Параметры

a

a GtkPrinter

b

another GtkPrinter

Возвращает

0, если принтеры совпадают, отрицательное значение, если a < b, или положительное значение, если a > b

Since: 2.10

gtk_printer_has_details ()

gboolean
gtk_printer_has_details (GtkPrinter *printer);

Возвращает, доступны ли данные о принтере.

Параметры

printer

a GtkPrinter

Возвращает

TRUE, если данные о printer принтере доступны

Since: 2.12

gtk_printer_request_details ()

void
gtk_printer_request_details (GtkPrinter *printer);

Запрашивает данные о принтере. Когда данные доступны, сигнал “details-acquired” будет испущен для printer .

Параметры

printer

a GtkPrinter

Since: 2.12

gtk_printer_get_capabilities ()

GtkPrintCapabilities
gtk_printer_get_capabilities (GtkPrinter *printer);

Возвращает возможности принтера.

Это полезно, когда вы используете ручные возможности GtkPrintUnixDialog и нужно знать, какие параметры может обрабатывать принтер, а какие нужно обработать самостоятельно.

Возвращает 0, если данные о принтере недоступны, см. gtk_printer_has_details() и gtk_printer_request_details().

Параметры

printer

a GtkPrinter

Возвращает

возможности принтера

Since: 2.12

gtk_printer_get_default_page_size ()

GtkPageSetup *
gtk_printer_get_default_page_size (GtkPrinter *printer);

Возвращает стандартный размер страницы для printer.

Параметры

printer

a GtkPrinter

Возвращает

новый динамически выделенный объект GtkPageSetup с размером страницы по умолчанию для принтера.

Since: 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

a GtkPrinter

top

место для хранения верхнего поля.

[out]

bottom

место для хранения нижнего поля.

[out]

left

место для хранения левого поля.

[out]

right

место для хранения правого поля.

[out]

Возвращает

TRUE, если жёсткие поля были получены

Since: 2.20

GtkPrinterFunc ()

gboolean
(*GtkPrinterFunc) (GtkPrinter *printer,
                   gpointer data);

Тип функции, передаваемой в gtk_enumerate_printers(). Обратите внимание, что необходимо ссылаться на printer, если вам нужно сохранить на него ссылку после возвращения из функции.

Параметры

printer

a GtkPrinter

data

пользовательские данные, переданные в gtk_enumerate_printers().

[closure]

Возвращает

TRUE для остановки перечисления, FALSE для продолжения

Since: 2.10

gtk_enumerate_printers ()

void
gtk_enumerate_printers (GtkPrinterFunc func,
                        gpointer data,
                        GDestroyNotify destroy,
                        gboolean wait);

Вызывает функцию для всех GtkПринтеров. Если func возвращает TRUE, перечисление останавливается.

Параметры

func

функция, вызываемая для каждого принтера

data

данные пользователя, передаваемые в func

destroy

функция, вызываемая, если data больше не нужна

wait

если TRUE, ожидать в рекурсивном цикле главного потока до тех пор, пока все принтеры не будут перечислены; в противном случае вернуть результат рано

С: 2.10

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

struct GtkPrinter

struct GtkPrinter;

GtkPrintBackend

typedef struct _GtkPrintBackend GtkPrintBackend;

Подробное описание свойств

Свойство “accepting-jobs”

  “accepting-jobs”           gboolean

Это свойство равно TRUE, если принтер принимает задания.

Флаги: Чтение

Значение по умолчанию: TRUE

С: 2.14

Свойство “accepts-pdf”

  “accepts-pdf”              gboolean

Истинно, если этот принтер может принимать PDF.

Флаги: Чтение / Запись / Только для построения

Значение по умолчанию: FALSE

Свойство “accepts-ps”

  “accepts-ps”               gboolean

Истинно, если этот принтер может принимать PostScript.

Флаги: Чтение / Запись / Только для построения

Значение по умолчанию: TRUE

Свойство “backend”

  “backend”                  GtkPrintBackend *

Бекенд для принтера.

Флаги: Чтение / Запись / Только для построения

Свойство “icon-name”

  “icon-name”                gchar *

Имя иконки для использования с принтером.

Флаги: Чтение

Значение по умолчанию: ""

Свойство “is-virtual”

  “is-virtual”               gboolean

ЛОЖЬ, если это представляет собой реальный принтер аппаратного обеспечения.

Флаги: Чтение / Запись / Только для построения

Значение по умолчанию: FALSE

Свойство “job-count”

  “job-count”                gint

Количество заданий в очереди в принтере.

Флаги: Чтение

Допустимые значения: >= 0

Значение по умолчанию: 0

Свойство “location”

  “location”                 gchar *

Расположение принтера.

Флаги: Чтение

Значение по умолчанию: ""

Свойство “name”

  “name”                     gchar *

Имя принтера.

Флаги: Чтение / Запись / Только для построения

Значение по умолчанию: ""

Свойство “paused”

  “paused”                   gboolean

Это свойство равно TRUE, если этот принтер приостановлен. Приостановленный принтер по-прежнему принимает задания, но не печатает их.

Флаги: Чтение

Значение по умолчанию: FALSE

С: 2.14

Свойство “state-message”

  “state-message”            gchar *

Строка, отображающая текущее состояние принтера.

Флаги: Чтение

Значение по умолчанию: ""

Подробное описание сигналов

Сигнал “details-acquired”

void
user_function (GtkPrinter *printer,
               gboolean    success,
               gpointer    user_data)

Выдаётся в ответ на запрос подробной информации о принтере от бекенда печати. Параметр success указывает, была ли информация фактически получена.

Параметры

printer

принтер GtkПринтер, на котором выпущен сигнал

success

TRUE, если детали были успешно получены

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

Spec-Zone.ru

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