Spec-Zone.ru › GTK 3.20

GtkPrintJob

GtkPrintJob — Представляет задание печати

Функции

void (*GtkPrintJobCompleteFunc) ()
GtkPrintJob * gtk_print_job_new ()
GtkPrintSettings * gtk_print_job_get_settings ()
GtkPrinter * gtk_print_job_get_printer ()
const gchar * gtk_print_job_get_title ()
GtkPrintStatus gtk_print_job_get_status ()
gboolean gtk_print_job_set_source_file ()
cairo_surface_t * gtk_print_job_get_surface ()
void gtk_print_job_send ()
void gtk_print_job_set_track_print_status ()
gboolean gtk_print_job_get_track_print_status ()
GtkPrintPages gtk_print_job_get_pages ()
void gtk_print_job_set_pages ()
GtkPageRange * gtk_print_job_get_page_ranges ()
void gtk_print_job_set_page_ranges ()
GtkPageSet gtk_print_job_get_page_set ()
void gtk_print_job_set_page_set ()
gint gtk_print_job_get_num_copies ()
void gtk_print_job_set_num_copies ()
gdouble gtk_print_job_get_scale ()
void gtk_print_job_set_scale ()
guint gtk_print_job_get_n_up ()
void gtk_print_job_set_n_up ()
GtkNumberUpLayout gtk_print_job_get_n_up_layout ()
void gtk_print_job_set_n_up_layout ()
gboolean gtk_print_job_get_rotate ()
void gtk_print_job_set_rotate ()
gboolean gtk_print_job_get_collate ()
void gtk_print_job_set_collate ()
gboolean gtk_print_job_get_reverse ()
void gtk_print_job_set_reverse ()

Свойства

GtkPageSetup * page-setup Только чтение/запись/создание
GtkPrinter * printer Только чтение/запись/создание
GtkPrintSettings * settings Только чтение/запись/создание
gchar * title Только чтение/запись/создание
gboolean track-print-status Чтение/запись

Сигналы

void status-changed Выполнить последним

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

struct GtkPrintJob

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

    GObject
    ╰── GtkPrintJob

Включаемые файлы

#include <gtk/gtkprintjob.h>

Описание

Объект GtkPrintJob представляет задачу, отправленную на печать. Вам необходимо напрямую работать с заданиями печати только если вы используете непереносимый API GtkPrintUnixDialog.

Используйте gtk_print_job_get_surface() для получения cairo поверхности, на которую необходимо нарисовать страницы. Используйте gtk_print_job_send() для отправки завершённого задания на печать. Если вы не используете cairo, GtkPrintJob также поддерживает печать вручную сгенерированных документов PostScript, через gtk_print_job_set_source_file().

Функции

GtkPrintJobCompleteFunc ()

void
(*GtkPrintJobCompleteFunc) (GtkPrintJob *print_job,
                            gpointer user_data,
                            const GError *error);

Тип обратного вызова, передаваемого в gtk_print_job_send(). Вызывается, когда задание печати полностью отправлено.

Параметры

print_job

объект GtkPrintJob

user_data

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

error

объект GError, содержащий информацию об ошибке, если отправка задания печати завершилась ошибкой, иначе NULL

gtk_print_job_new ()

GtkPrintJob *
gtk_print_job_new (const gchar *title,
                   GtkPrinter *printer,
                   GtkPrintSettings *settings,
                   GtkPageSetup *page_setup);

Создаёт новое задание GtkPrintJob.

Параметры

title

заголовок задания

printer

объект GtkPrinter

settings

объект GtkPrintSettings

page_setup

объект GtkPageSetup

Возвращает

новое задание GtkPrintJob

С: 2.10

gtk_print_job_get_settings ()

GtkPrintSettings *
gtk_print_job_get_settings (GtkPrintJob *job);

Возвращает GtkPrintSettings задания печати.

Параметры

job

объект GtkPrintJob

Возвращает

настройки job .

[transfer none]

С: 2.10

gtk_print_job_get_printer ()

GtkPrinter *
gtk_print_job_get_printer (GtkPrintJob *job);

Возвращает GtkPrinter задания печати.

Параметры

job

объект GtkPrintJob

Возвращает

принтер job .

[transfer none]

С: 2.10

gtk_print_job_get_title ()

const gchar *
gtk_print_job_get_title (GtkPrintJob *job);

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

Параметры

job

объект GtkPrintJob

Возвращает

заголовок job

С: 2.10

gtk_print_job_get_status ()

GtkPrintStatus
gtk_print_job_get_status (GtkPrintJob *job);

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

Параметры

job

объект GtkPrintJob

Возвращает

состояние job

С: 2.10

gtk_print_job_set_source_file ()

gboolean
gtk_print_job_set_source_file (GtkPrintJob *job,
                               const gchar *filename,
                               GError **error);

Заставляет GtkPrintJob отправить существующий документ в систему печати. Файл может быть в любом формате, поддерживаемом системой печати платформы (обычно PostScript, но на многих платформах может работать и PDF). См. gtk_printer_accepts_pdf() и gtk_printer_accepts_ps().

Параметры

job

объект GtkPrintJob

filename

файл для печати.

[type filename]

error

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

Возвращает

FALSE, если произошла ошибка

С: 2.10

gtk_print_job_get_surface ()

cairo_surface_t *
gtk_print_job_get_surface (GtkPrintJob *job,
                           GError **error);

Возвращает поверхность cairo, на которую следует отрисовывать страницы задания печати.

Параметры

job

объект GtkPrintJob

error

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

[allow-none]

Возвращает

поверхность cairo job .

[transfer none]

С: 2.10

gtk_print_job_send ()

void
gtk_print_job_send (GtkPrintJob *job,
                    GtkPrintJobCompleteFunc callback,
                    gpointer user_data,
                    GDestroyNotify dnotify);

Отправляет задание печати на принтер.

Параметры

job

объект GtkPrintJob

callback

функция для вызова при завершении задания или возникновении ошибки

user_data

пользовательские данные, которые передаются в callback

dnotify

уведомление о разрушении user_data

С: 2.10

gtk_print_job_set_track_print_status ()

void
gtk_print_job_set_track_print_status (GtkPrintJob *job,
                                      gboolean track_status);

Если track_status равен TRUE, задание печати будет пытаться продолжать сообщать о состоянии задания печати в очередях принтера и принтере. Это может позволить вашему приложению отображать такие проблемы, как «нет бумаги», и когда задание печати фактически достигает принтера.

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

Параметры

job

объект GtkPrintJob

track_status

TRUE для отслеживания состояния после печати

С: 2.10

gtk_print_job_get_track_print_status ()

gboolean
gtk_print_job_get_track_print_status (GtkPrintJob *job);

Возвращает, будут ли отслеживаться задания после печати. Подробнее см. gtk_print_job_set_track_print_status().

Параметры

job

объект GtkPrintJob

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

TRUE, если статус задания печати будет сообщён после печати

С: 2.10

gtk_print_job_get_pages ()

GtkPrintPages
gtk_print_job_get_pages (GtkPrintJob *job);

Получает значение настройки GtkPrintPages для этого задания.

Параметры

job

объект GtkPrintJob

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

значение настройки GtkPrintPages

С: 3.0

gtk_print_job_set_pages ()

void
gtk_print_job_set_pages (GtkPrintJob *job,
                         GtkPrintPages pages);

Устанавливает значение настройки GtkPrintPages для этого задания.

Параметры

job

объект GtkPrintJob

pages

значение настройки GtkPrintPages

С: 3.0

gtk_print_job_get_page_ranges ()

GtkPageRange *
gtk_print_job_get_page_ranges (GtkPrintJob *job,
                               gint *n_ranges);

Получает диапазоны страниц для этого задания.

Параметры

job

объект GtkPrintJob

n_ranges

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

[out]

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

указатель на массив структур GtkPageRange.

[array length=n_ranges][transfer none]

С: 3.0

gtk_print_job_set_page_ranges ()

void
gtk_print_job_set_page_ranges (GtkPrintJob *job,
                               GtkPageRange *ranges,
                               gint n_ranges);

Устанавливает диапазоны страниц для этого задания.

Параметры

job

объект GtkPrintJob

ranges

указатель на массив структур GtkPageRange.

[array length=n_ranges]

n_ranges

длина массива ranges

С: 3.0

gtk_print_job_get_page_set ()

GtkPageSet
gtk_print_job_get_page_set (GtkPrintJob *job);

Получает значение настройки GtkPageSet для этого задания.

Параметры

job

объект GtkPrintJob

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

значение настройки GtkPageSet

С: 3.0

gtk_print_job_set_page_set ()

void
gtk_print_job_set_page_set (GtkPrintJob *job,
                            GtkPageSet page_set);

Устанавливает значение настройки GtkPageSet для этого задания.

Параметры

job

объект GtkPrintJob

page_set

значение настройки GtkPageSet

С: 3.0

gtk_print_job_get_num_copies ()

gint
gtk_print_job_get_num_copies (GtkPrintJob *job);

Получает количество копий этого задания.

Параметры

job

объект GtkPrintJob

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

количество копий

С: 3.0

gtk_print_job_set_num_copies ()

void
gtk_print_job_set_num_copies (GtkPrintJob *job,
                              gint num_copies);

Устанавливает количество копий для этого задания.

Параметры

job

объект GtkPrintJob

num_copies

количество копий

С: 3.0

gtk_print_job_get_scale ()

gdouble
gtk_print_job_get_scale (GtkPrintJob *job);

Получает масштаб для этого задания (где 1.0 означает отсутствие масштабирования).

Параметры

job

объект GtkPrintJob

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

масштаб

С: 3.0

gtk_print_job_set_scale ()

void
gtk_print_job_set_scale (GtkPrintJob *job,
                         gdouble scale);

Устанавливает масштаб для этого задания (где 1.0 означает отсутствие масштабирования).

Параметры

job

объект GtkPrintJob

scale

масштаб

С: 3.0

gtk_print_job_get_n-up ()

guint
gtk_print_job_get_n_up (GtkPrintJob *job);

Получает значение настройки n-up для этого задания.

Параметры

job

объект GtkPrintJob

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

значение настройки n-up

С: 3.0

gtk_print_job_set_n_up ()

void
gtk_print_job_set_n_up (GtkPrintJob *job,
                        guint n_up);

Устанавливает значение n-up для этого задания.

Параметры

job

объект GtkPrintJob

n_up

значение n-up

С: 3.0

gtk_print_job_get_n_up_layout ()

GtkNumberUpLayout
gtk_print_job_get_n_up_layout (GtkPrintJob *job);

Получает значение n-up макета для этого задания.

Параметры

job

объект GtkPrintJob

Возвращает

макет n-up

С: 3.0

gtk_print_job_set_n_up_layout ()

void
gtk_print_job_set_n_up_layout (GtkPrintJob *job,
                               GtkNumberUpLayout layout);

Устанавливает значение макета n-up для этого задания.

Параметры

job

объект GtkPrintJob

layout

значение макета n-up

С: 3.0

gtk_print_job_get_rotate ()

gboolean
gtk_print_job_get_rotate (GtkPrintJob *job);

Получает, следует ли задание печатать, повернув на 90 градусов.

Параметры

job

объект GtkPrintJob

Возвращает

следует ли задание печатать, повернув на 90 градусов

С: 3.0

gtk_print_job_set_rotate ()

void
gtk_print_job_set_rotate (GtkPrintJob *job,
                          gboolean rotate);

Устанавливает, следует ли это задание печатать, повернув на 90 градусов.

Параметры

job

объект GtkPrintJob

rotate

следует ли печатать, повернув на 90 градусов

С: 3.0

gtk_print_job_get_collate ()

gboolean
gtk_print_job_get_collate (GtkPrintJob *job);

Получает, следует ли задание печатать в стопку.

Параметры

job

объект GtkPrintJob

Возвращает

следует ли задание печатать в стопку

С: 3.0

gtk_print_job_set_collate ()

void
gtk_print_job_set_collate (GtkPrintJob *job,
                           gboolean collate);

Устанавливает, следует ли это задание печатать в стопку.

Параметры

job

объект GtkPrintJob

collate

следует ли задание печатать в стопку

С: 3.0

gtk_print_job_get_reverse ()

gboolean
gtk_print_job_get_reverse (GtkPrintJob *job);

Получает, следует ли задание печатать в обратном порядке.

Параметры

job

объект GtkPrintJob

Возвращает

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

С: 3.0

gtk_print_job_set_reverse ()

void
gtk_print_job_set_reverse (GtkPrintJob *job,
                           gboolean reverse);

Устанавливает, следует ли это задание печатать в обратном порядке.

Параметры

job

объект GtkPrintJob

reverse

следует ли задание печатать в обратном порядке

С: 3.0

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

struct GtkPrintJob

struct GtkPrintJob;

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

Свойство “page-setup”

  “page-setup”               GtkPageSetup *

Настройка страницы.

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

Свойство “printer”

  “printer”                  GtkPrinter *

Принтер, на который печатается задание.

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

Свойство “settings”

  “settings”                 GtkPrintSettings *

Настройки принтера.

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

Свойство “title”

  “title”                    gchar *

Заголовок задания печати.

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

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

Свойство “track-print-status”

  “track-print-status”       gboolean

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

Флаги: Чтение / Запись

Значение по умолчанию: ЛОЖЬ

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

Сигнал “status-changed”

void
user_function (GtkPrintJob *job,
               gpointer     user_data)

Выдается при изменении состояния задания. Обработчик сигнала может использовать gtk_print_job_get_status(), чтобы получить новое состояние.

Параметры

job

объект GtkPrintJob, на котором был излучён сигнал

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/GtkPrintJob.html

Spec-Zone.ru

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