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”, нумеруются с нуля, т.е. если пользователь выбрал печать всех страниц, последний сигнал ::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,
               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 в соответствии с вашими потребностями.

Флаги: 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,
               int                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