GtkPrintOperation

gtk_print_operation_new ()

GtkPrintOperation *
gtk_print_operation_new (void);

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

gtk_print_operation_set_allow_async ()

void
gtk_print_operation_set_allow_async (GtkPrintOperation *op,
                                     gboolean allow_async);

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

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 содержит подробности об ошибке.

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”.

gtk_print_operation_get_default_page_setup ()

GtkPageSetup *
gtk_print_operation_get_default_page_setup
                               (GtkPrintOperation *op);

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

gtk_print_operation_set_print_settings ()

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

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

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().

gtk_print_operation_set_job_name ()

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

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

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

gtk_print_operation_set_n_pages ()

void
gtk_print_operation_set_n_pages (GtkPrintOperation *op,
                                 int n_pages);

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

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

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

gtk_print_operation_get_n_pages_to_print ()

int
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. Это обычно используется для отслеживания прогресса операции печати.

gtk_print_operation_set_current_page ()

void
gtk_print_operation_set_current_page (GtkPrintOperation *op,
                                      int current_page);

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

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

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

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, устанавливает начало в верхнем левом углу страницы (что может не совпадать с верхним левым углом листа, в зависимости от ориентации страницы и количества страниц на листе). В противном случае начало устанавливается в верхнем левом углу области изображения (т.е. внутри полей).

gtk_print_operation_set_unit ()

void
gtk_print_operation_set_unit (GtkPrintOperation *op,
                              GtkUnit unit);

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

gtk_print_operation_set_export_filename ()

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

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

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

gtk_print_operation_set_show_progress ()

void
gtk_print_operation_set_show_progress (GtkPrintOperation *op,
                                       gboolean show_progress);

Если show_progress равно TRUE, операция печати отобразит диалог прогресса во время процесса печати.

gtk_print_operation_set_track_print_status ()

void
gtk_print_operation_set_track_print_status
                               (GtkPrintOperation *op,
                                gboolean track_status);

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

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

gtk_print_operation_set_custom_tab_label ()

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

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

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.

gtk_print_operation_cancel ()

void
gtk_print_operation_cancel (GtkPrintOperation *op);

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

gtk_print_operation_draw_page_finish ()

void
gtk_print_operation_draw_page_finish (GtkPrintOperation *op);

Сигнализирует о завершении отрисовки страницы.

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

gtk_print_operation_set_defer_drawing ()

void
gtk_print_operation_set_defer_drawing (GtkPrintOperation *op);

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

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

gtk_print_operation_get_status ()

GtkPrintStatus
gtk_print_operation_get_status (GtkPrintOperation *op);

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

gtk_print_operation_get_status_string ()

const char *
gtk_print_operation_get_status_string (GtkPrintOperation *op);

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

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

gtk_print_operation_is_finished ()

gboolean
gtk_print_operation_is_finished (GtkPrintOperation *op);

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

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

gtk_print_operation_set_support_selection ()

void
gtk_print_operation_set_support_selection
                               (GtkPrintOperation *op,
                                gboolean support_selection);

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

gtk_print_operation_get_support_selection ()

gboolean
gtk_print_operation_get_support_selection
                               (GtkPrintOperation *op);

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

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”.

gtk_print_operation_get_has_selection ()

gboolean
gtk_print_operation_get_has_selection (GtkPrintOperation *op);

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

gtk_print_operation_set_embed_page_setup ()

void
gtk_print_operation_set_embed_page_setup
                               (GtkPrintOperation *op,
                                gboolean embed);

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

gtk_print_operation_get_embed_page_setup ()

gboolean
gtk_print_operation_get_embed_page_setup
                               (GtkPrintOperation *op);

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

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(), если это проблема.

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 диалога.

gtk_print_operation_preview_end_preview ()

void
gtk_print_operation_preview_end_preview
                               (GtkPrintOperationPreview *preview);

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

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

gtk_print_operation_preview_is-selected ()

gboolean
gtk_print_operation_preview_is_selected
                               (GtkPrintOperationPreview *preview,
                                int page_nr);

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

gtk_print_operation_preview_render_page ()

void
gtk_print_operation_preview_render_page
                               (GtkPrintOperationPreview *preview,
                                int page_nr);

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

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

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

Сигнал “begin-print”

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

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

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

Флаги: Выполнять последним

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

GObject*
user_function (GtkPrintOperation *operation,
               gpointer           user_data)

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

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

Флаги: Выполнять последним

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

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

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

Флаги: Выполнять последним

Сигнал “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”.

Флаги: Выполнять последним

Сигнал “draw-page”

void
user_function (GtkPrintOperation *operation,
               GtkPrintContext   *context,
               int                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 в соответствии с вашими потребностями.

Флаги: Выполнять последним

Сигнал “end-print”

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

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

Флаги: Выполнять последним

Сигнал “paginate”

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

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

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

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

Флаги: Выполнять последним

Сигнал “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

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

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

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

Флаги: Run Last

Сигнал “status-changed”

void
user_function (GtkPrintOperation *operation,
               gpointer           user_data)

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

Флаги: Run Last

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

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

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

Флаги: Run Last

Сигнал “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