GtkPrintOperation

gtk_print_operation_new ()

GtkPrintOperation *
gtk_print_operation_new (void);

Создает новый GtkPrintOperation.

С версии: 2.10

gtk_print_operation_set_allow_async ()

void
gtk_print_operation_set_allow_async (GtkPrintOperation *op,
                                     gboolean allow_async);

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

С версии: 2.10

gtk_print_operation_get_error ()

void
gtk_print_operation_get_error (GtkPrintOperation *op,
                               GError **error);

Вызовите этот метод, когда результат операции печати равен GTK_PRINT_OPERATION_RESULT_ERROR, либо как возвращается gtk_print_operation_run(), либо в обработчике сигнала “done”. Возвращаемый GError будет содержать более подробную информацию о том, что пошло не так.

С версии: 2.10

gtk_print_operation_set_default_page_setup ()

void
gtk_print_operation_set_default_page_setup
                               (GtkPrintOperation *op,
                                GtkPageSetup *default_page_setup);

Делает default_page_setup настройками страницы по умолчанию для op.

Эта настройка страницы будет использоваться gtk_print_operation_run(), но её можно переопределить по страницам, подключившись к сигналу “request-page-setup”.

С версии: 2.10

gtk_print_operation_get_default_page_setup ()

GtkPageSetup *
gtk_print_operation_get_default_page_setup
                               (GtkPrintOperation *op);

Возвращает настройки страницы по умолчанию, см. gtk_print_operation_set_default_page_setup().

С версии: 2.10

gtk_print_operation_set_print_settings ()

void
gtk_print_operation_set_print_settings
                               (GtkPrintOperation *op,
                                GtkPrintSettings *print_settings);

Устанавливает параметры печати для op. Это обычно используется для восстановления параметров печати из предыдущей операции печати, см. gtk_print_operation_run().

С версии: 2.10

gtk_print_operation_get_print_settings ()

GtkPrintSettings *
gtk_print_operation_get_print_settings
                               (GtkPrintOperation *op);

Возвращает текущие параметры печати.

Обратите внимание, что возвращаемое значение равно NULL до тех пор, пока не будут вызваны gtk_print_operation_set_print_settings() или gtk_print_operation_run().

С версии: 2.10

gtk_print_operation_set_job_name ()

void
gtk_print_operation_set_job_name (GtkPrintOperation *op,
                                  const gchar *job_name);

Устанавливает имя задания печати. Имя используется для идентификации задания (например, в приложениях мониторинга, таких как eggcups).

Если вы не устанавливаете имя задания, GTK+ выбирает имя по умолчанию, нумеруя последующие задания печати.

С версии: 2.10

gtk_print_operation_set_n_pages ()

void
gtk_print_operation_set_n_pages (GtkPrintOperation *op,
                                 gint n_pages);

Устанавливает количество страниц в документе.

Это должно быть установлено в положительное число до начала рендеринга. Это может быть установлено в обработчике сигнала “begin-print”.

Обратите внимание, что номера страниц, передаваемые сигналам “request-page-setup” и “draw-page”, начинаются с 0, т. е. если пользователь выбирает печать всех страниц, последний сигнал ::draw-page будет для страницы n_pages - 1.

С версии: 2.10

gtk_print_operation_get_n_pages_to_print ()

gint
gtk_print_operation_get_n_pages_to_print
                               (GtkPrintOperation *op);

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

Обратите внимание, что это значение устанавливается во время фазы подготовки печати (GTK_PRINT_STATUS_PREPARING), поэтому эту функцию никогда не следует вызывать до фазы генерации данных (GTK_PRINT_STATUS_GENERATING_DATA). Вы можете подключиться к сигналу “status-changed” и вызвать gtk_print_operation_get_n_pages_to_print(), когда статус печати равен GTK_PRINT_STATUS_GENERATING_DATA. Это обычно используется для отслеживания прогресса операции печати.

С: 2.18

gtk_print_operation_set_current_page ()

void
gtk_print_operation_set_current_page (GtkPrintOperation *op,
                                      gint current_page);

Устанавливает текущую страницу.

Если это вызвано до gtk_print_operation_run(), пользователь сможет выбрать для печати только текущую страницу.

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

С: 2.10

gtk_print_operation_set_use_full-page ()

void
gtk_print_operation_set_use_full_page (GtkPrintOperation *op,
                                       gboolean full_page);

Если full_page равно TRUE, преобразование для контекста cairo, полученного из GtkPrintContext, помещает начало в верхний левый угол страницы (что может не быть верхним левым углом листа в зависимости от ориентации страницы и количества страниц на листе). В противном случае начало находится в верхнем левом углу области изображения (т. е. внутри полей).

С: 2.10

gtk_print_operation_set_unit ()

void
gtk_print_operation_set_unit (GtkPrintOperation *op,
                              GtkUnit unit);

Настраивает преобразование для контекста cairo, полученного из GtkPrintContext таким образом, что расстояния измеряются в единицах unit.

С: 2.10

gtk_print_operation_set_export-filename ()

void
gtk_print_operation_set_export_filename
                               (GtkPrintOperation *op,
                                const gchar *filename);

Настраивает GtkPrintOperation для генерации файла вместо отображения диалога печати. Предполагаемое использование этой функции — для реализации действий «Экспорт в PDF». В настоящее время поддерживается только формат PDF.

Поддержка «Печать в PDF» не зависит от этого и выполняется путем выбора пункта «Печать в PDF» из списка принтеров в диалоге печати.

С: 2.10

gtk_print_operation_set_show-progress ()

void
gtk_print_operation_set_show_progress (GtkPrintOperation *op,
                                       gboolean show_progress);

Если show_progress равно TRUE, во время операции печати будет отображаться диалог с отображением хода выполнения.

С: 2.10

gtk_print_operation_set_track-print-status ()

void
gtk_print_operation_set_track_print_status
                               (GtkPrintOperation *op,
                                gboolean track_status);

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

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

С: 2.10

gtk_print_operation_set_custom-tab-label ()

void
gtk_print_operation_set_custom_tab_label
                               (GtkPrintOperation *op,
                                const gchar *label);

Устанавливает метку для вкладки, содержащей пользовательские виджеты.

С: 2.10

gtk_print_operation_run ()

GtkPrintOperationResult
gtk_print_operation_run (GtkPrintOperation *op,
                         GtkPrintOperationAction action,
                         GtkWindow *parent,
                         GError **error);

Запускает операцию печати, сначала позволяя пользователю изменить параметры печати в диалоговом окне печати, а затем распечатать документ.

Обычно эта функция не возвращает значение, пока не завершится рендеринг всех страниц. Вы можете подключиться к сигналу “status-changed” на op, чтобы получить некоторую информацию о ходе операции печати. Кроме того, она может использовать рекурсивный цикл обработки событий для отображения диалогового окна печати.

Если вы вызываете gtk_print_operation_set_allow_async() или устанавливаете свойство “allow-async”, операция будет выполняться асинхронно, если это поддерживается платформой. Сигнал “done” будет отправлен с результатом операции при её завершении (т. е. при отмене диалогового окна, успешном или неудачном выполнении печати).

Обратите внимание, что gtk_print_operation_run() может быть вызван только один раз для заданного GtkPrintOperation.

С: 2.10

gtk_print_operation_cancel ()

void
gtk_print_operation_cancel (GtkPrintOperation *op);

Отменяет выполняемую операцию печати. Эта функция может быть вызвана из обработчика сигнала “begin-print”, “paginate” или “draw-page”, чтобы остановить текущую выполняемую операцию печати.

С: 2.10

gtk_print_operation_draw_page_finish ()

void
gtk_print_operation_draw_page_finish (GtkPrintOperation *op);

Указывает, что отрисовка конкретной страницы завершена.

Вызывается после завершения отрисовки страницы (например, в другом потоке). Если gtk_print_operation_set_defer_drawing() был вызван ранее, то эта функция должна быть вызвана приложением. В противном случае она вызывается самой библиотекой.

С: 2.16

gtk_print_operation_set_defer_drawing ()

void
gtk_print_operation_set_defer_drawing (GtkPrintOperation *op);

Устанавливает GtkPrintOperation для ожидания вызова gtk_print_operation_draw_page_finish() приложением. Может использоваться для отрисовки страницы в другом потоке.

Эта функция должна вызываться в обработчике сигнала «draw-page».

С: 2.16

gtk_print_operation_get_status ()

GtkPrintStatus
gtk_print_operation_get_status (GtkPrintOperation *op);

Возвращает состояние операции печати. Также см. gtk_print_operation_get_status_string().

С: 2.10

gtk_print_operation_get_status_string ()

const gchar *
gtk_print_operation_get_status_string (GtkPrintOperation *op);

Возвращает строковое представление состояния операции печати. Строка переведена и подходит для отображения состояния печати, например, в GtkStatusbar.

Используйте gtk_print_operation_get_status() для получения значения состояния, подходящего для программного использования.

С: 2.10

gtk_print_operation_is_finished ()

gboolean
gtk_print_operation_is_finished (GtkPrintOperation *op);

Функция-удобство для определения, завершена ли операция печати, успешно (GTK_PRINT_STATUS_FINISHED) или безуспешно (GTK_PRINT_STATUS_FINISHED_ABORTED).

Примечание: при включении отслеживания состояния печати операция печати может находиться в незавершенном состоянии даже после вызова done, так как состояние операции тогда отслеживает состояние задания печати на принтере.

С: 2.10

gtk_print_operation_set_support-selection ()

void
gtk_print_operation_set_support_selection
                               (GtkPrintOperation *op,
                                gboolean support_selection);

Устанавливает, поддерживает ли GtkPrintOperation выбор.

С: 2.18

gtk_print_operation_get_support_selection ()

gboolean
gtk_print_operation_get_support_selection
                               (GtkPrintOperation *op);

Получает значение свойства «support-selection».

С момента: 2.18

gtk_print_operation_set_has_selection ()

void
gtk_print_operation_set_has_selection (GtkPrintOperation *op,
                                       gboolean has_selection);

Устанавливает, есть ли выделение для печати.

Приложение должно установить количество страниц, на которых будет отображаться выделение, с помощью gtk_print_operation_set_n_pages() в обработчике сигнала «begin-print».

С момента: 2.18

gtk_print_operation_get_has_selection ()

gboolean
gtk_print_operation_get_has_selection (GtkPrintOperation *op);

Получает значение свойства «has-selection».

С момента: 2.18

gtk_print_operation_set_embed_page-setup ()

void
gtk_print_operation_set_embed_page_setup
                               (GtkPrintOperation *op,
                                gboolean embed);

Встраивает поля выбора размера страницы и ориентации в страницу настроек страницы. Выбранные параметры страницы сохраняются как параметры страницы по умолчанию в GtkPrintOperation.

С момента: 2.18

gtk_print_operation_get_embed_page-setup ()

gboolean
gtk_print_operation_get_embed_page_setup
                               (GtkPrintOperation *op);

Получает значение свойства «embed-page-setup».

С момента: 2.18

gtk_print_run_page-setup-dialog ()

GtkPageSetup *
gtk_print_run_page_setup_dialog (GtkWindow *parent,
                                 GtkPageSetup *page_setup,
                                 GtkPrintSettings *settings);

Открывает диалог настроек страницы, позволяющий пользователю изменить значения из page_setup. Если пользователь отменяет диалог, возвращаемый GtkPageSetup идентичен переданному page_setup, в противном случае он содержит изменения, сделанные в диалоге.

Обратите внимание, что эта функция может использовать рекурсивный цикл обработки событий для отображения диалога настроек страницы. Используйте gtk_print_run_page_setup_dialog_async(), если это проблема.

С момента: 2.10

GtkPageSetupDoneFunc ()

void
(*GtkPageSetupDoneFunc) (GtkPageSetup *page_setup,
                         gpointer data);

Тип функции, передаваемой в gtk_print_run_page_setup_dialog_async().

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

gtk_print_run_page-setup-dialog-async ()

void
gtk_print_run_page_setup_dialog_async (GtkWindow *parent,
                                       GtkPageSetup *page_setup,
                                       GtkPrintSettings *settings,
                                       GtkPageSetupDoneFunc done_cb,
                                       gpointer data);

Открывает диалог настроек страницы, позволяющий пользователю изменить значения из page_setup.

В отличие от gtk_print_run_page_setup_dialog(), эта функция возвращается после отображения диалога настроек страницы на платформах, которые это поддерживают, и вызывает done_cb из обработчика сигнала ::response диалога.

С момента: 2.10

gtk_print_operation_preview_end_preview ()

void
gtk_print_operation_preview_end_preview
                               (GtkPrintOperationPreview *preview);

Завершает предварительный просмотр.

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

С: 2.10

gtk_print_operation_preview_is_selected ()

gboolean
gtk_print_operation_preview_is_selected
                               (GtkPrintOperationPreview *preview,
                                gint page_nr);

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

С: 2.10

gtk_print_operation_preview_render_page ()

void
gtk_print_operation_preview_render_page
                               (GtkPrintOperationPreview *preview,
                                gint page_nr);

Отображает страницу в предварительном просмотре, используя контекст печати, переданный обработчику «preview» вместе с preview.

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

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

С: 2.10

Сигнал “begin-print”

void
user_function (GtkPrintOperation *operation,
               GtkPrintContext   *context,
               gpointer           user_data)

Издаётся после того, как пользователь завершил изменение параметров печати в диалоговом окне, перед началом фактического рендеринга.

Типичное использование сигнала ::begin-print — это использование параметров из GtkPrintContext для соответствующей постраничной обработки документа, а затем установка количества страниц с помощью gtk_print_operation_set_n_pages().

Флаги: Run Last

С версии: 2.10

Сигнал “create-custom-widget”

GObject*
user_function (GtkPrintOperation *operation,
               gpointer           user_data)

Издаётся при отображении диалогового окна печати. Если в обработчике этого сигнала возвращается виджет, он будет добавлен в пользовательскую вкладку диалогового окна печати. Обычно возвращается контейнерный виджет с несколькими виджетами внутри.

Диалоговое окно печати владеет возвращенным виджетом, и его жизненный цикл не контролируется приложением. Однако гарантируется, что виджет будет существовать до тех пор, пока не будет издан сигнал “custom-widget-apply” для операции. Затем вы можете получить необходимую информацию из виджетов.

Флаги: Run Last

С версии: 2.10

Сигнал “custom-widget-apply”

void
user_function (GtkPrintOperation *operation,
               GtkWidget         *widget,
               gpointer           user_data)

Издаётся непосредственно перед “begin-print”, если вы добавили пользовательский виджет в обработчике “create-custom-widget”. При получении этого сигнала вы должны получить информацию из пользовательских виджетов, так как нет гарантии, что виджеты будут доступны позже.

Флаги: Run Last

С версии: 2.10

Сигнал “done”

void
user_function (GtkPrintOperation      *operation,
               GtkPrintOperationResult result,
               gpointer                user_data)

Издаётся, когда операция печати завершила все необходимые действия.

result предоставляет информацию о том, что произошло во время выполнения. Если result имеет значение GTK_PRINT_OPERATION_RESULT_ERROR, вы можете получить подробности, вызвав gtk_print_operation_get_error().

Если вы включили отслеживание статуса печати, то gtk_print_operation_is_finished() может всё ещё возвращать FALSE после того, как был издан сигнал “done”.

Флаги: Run Last

С версии: 2.10

Сигнал “draw-page”

void
user_function (GtkPrintOperation *operation,
               GtkPrintContext   *context,
               gint               page_nr,
               gpointer           user_data)

Издаётся для каждой печатаемой страницы. Обработчик сигнала должен отобразить страницу page_nr на контексте Cairo, полученном из context с помощью gtk_print_context_get_cairo_context().

static GtkPrintSettings *settings = NULL;

static void
do_print (void)
{
  GtkPrintOperation *print;
  GtkPrintOperationResult res;

  print = gtk_print_operation_new ();

  if (settings != NULL)
    gtk_print_operation_set_print_settings (print, settings);

  g_signal_connect (print, "begin_print", G_CALLBACK (begin_print), NULL);
  g_signal_connect (print, "draw_page", G_CALLBACK (draw_page), NULL);

  res = gtk_print_operation_run (print, GTK_PRINT_OPERATION_ACTION_PRINT_DIALOG,
                                 GTK_WINDOW (main_window), NULL);

  if (res == GTK_PRINT_OPERATION_RESULT_APPLY)
    {
      if (settings != NULL)
        g_object_unref (settings);
      settings = g_object_ref (gtk_print_operation_get_print_settings (print));
    }

  g_object_unref (print);
}

Используйте gtk_print_operation_set_use_full_page() и gtk_print_operation_set_unit() перед запуском операции печати для настройки преобразования контекста Cairo в соответствии с вашими потребностями.

Флаги: Run Last

С версии: 2.10

Сигнал “end-print”

void
user_function (GtkPrintOperation *operation,
               GtkPrintContext   *context,
               gpointer           user_data)

Издаётся после рендеринга всех страниц. Обработчик этого сигнала может очистить ресурсы, выделенные в обработчике “begin-print”.

Флаги: Run Last

С версии: 2.10

Сигнал “paginate”

gboolean
user_function (GtkPrintOperation *operation,
               GtkPrintContext   *context,
               gpointer           user_data)

Выполняется после сигнала “begin-print”, но перед началом фактического рендеринга. Он продолжает выполняться до тех пор, пока подключенный обработчик сигнала не вернёт TRUE.

Сигнал ::paginate предназначен для разбиения документа на небольшие части при разбиении, чтобы избежать блокировки пользовательского интерфейса на длительное время. Обработчик сигнала должен обновить количество страниц с помощью gtk_print_operation_set_n_pages() и вернуть TRUE, если документ был полностью разбит на страницы.

Если вам не нужно выполнять разбиение на страницы частями, вы можете выполнить это полностью в обработчике ::begin-print и установить количество страниц оттуда.

Флаги: Run Last

С: 2.10

Сигнал “preview”

gboolean
user_function (GtkPrintOperation        *operation,
               GtkPrintOperationPreview *preview,
               GtkPrintContext          *context,
               GtkWindow                *parent,
               gpointer                  user_data)

Выполняется при запросе предварительного просмотра из системного диалога.

По умолчанию обработчик этого сигнала использует внешнее приложение-просмотрщик для предварительного просмотра.

Для реализации пользовательского предварительного просмотра печати приложение должно вернуть TRUE из своего обработчика для этого сигнала. Чтобы использовать предоставленный context для реализации предварительного просмотра, ему необходимо предоставить подходящий контекст Cairo с помощью gtk_print_context_set_cairo_context().

Реализация пользовательского предварительного просмотра может использовать gtk_print_operation_preview_is_selected() и gtk_print_operation_preview_render_page() для поиска страниц, выбранных для печати, и их рендеринга. Предварительный просмотр должен быть завершён вызовом gtk_print_operation_preview_end_preview() (обычно в ответ на нажатие пользователем кнопки закрытия).

Флаги: Run Last

С: 2.10

Сигнал “request-page-setup”

void
user_function (GtkPrintOperation *operation,
               GtkPrintContext   *context,
               gint               page_nr,
               GtkPageSetup      *setup,
               gpointer           user_data)

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

Флаги: Run Last

С: 2.10

Сигнал “status-changed”

void
user_function (GtkPrintOperation *operation,
               gpointer           user_data)

Выполняется между различными фазами операции печати. См. GtkPrintStatus для фаз, которые различаются. Используйте gtk_print_operation_get_status() для определения текущего состояния.

Флаги: Run Last

С: 2.10

Сигнал “update-custom-widget”

void
user_function (GtkPrintOperation *operation,
               GtkWidget         *widget,
               GtkPageSetup      *setup,
               GtkPrintSettings  *settings,
               gpointer           user_data)

Выполняется после изменения выбранного принтера. Фактические параметры страницы и настройки печати передаются пользовательскому виджету, который может обновить себя в соответствии с этим изменением.

Флаги: Run Last

С: 2.18

Сигнал “got-page-size”

void
user_function (GtkPrintOperationPreview *preview,
               GtkPrintContext          *context,
               GtkPageSetup             *page_setup,
               gpointer                  user_data)

Сигнал ::got-page-size генерируется один раз для каждой страницы, которая отображается в предварительном просмотре.

Обработчик этого сигнала должен обновить context в соответствии с page_setup и настроить подходящий контекст cairo, используя gtk_print_context_set_cairo_context().

Флаги: Run Last

Сигнал “ready”

void
user_function (GtkPrintOperationPreview *preview,
               GtkPrintContext          *context,
               gpointer                  user_data)

Сигнал ::ready генерируется один раз на операцию предварительного просмотра, перед рендерингом первой страницы.

Обработчик этого сигнала может быть использован для задач настройки.

Флаги: Run Last