gtkprintoperation.c 99.2 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GTK - The GIMP Toolkit
2 3 4 5 6 7 8 9 10 11 12 13 14 15
 * gtkprintoperation.c: Print Operation
 * Copyright (C) 2006, Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
Javier Jardón's avatar
Javier Jardón committed
16
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
17 18 19
 */

#include "config.h"
20 21

#include <errno.h>
22
#include <stdlib.h>
23
#include <math.h>
24
#include <string.h>
25 26 27

#include <cairo-pdf.h>

28 29 30 31
#include "gtkprintoperation-private.h"
#include "gtkmarshalers.h"
#include "gtkintl.h"
#include "gtkprivate.h"
32
#include "gtkmessagedialog.h"
33
#include "gtkwindowgroup.h"
34
#include "gtktypebuiltins.h"
35

36 37 38 39 40 41 42 43
/**
 * SECTION:gtkprintoperation
 * @Title: GtkPrintOperation
 * @Short_description: High-level Printing API
 * @See_also: #GtkPrintContext, #GtkPrintUnixDialog
 *
 * GtkPrintOperation is the high-level, portable printing API.
 * It looks a bit different than other GTK+ dialogs such as the
44
 * #GtkFileChooser, since some platforms don’t expose enough
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
 * infrastructure to implement a good print dialog. On such
 * platforms, GtkPrintOperation uses the native print dialog.
 * On platforms which do not provide a native print dialog, GTK+
 * uses its own, see #GtkPrintUnixDialog.
 *
 * The typical way to use the high-level printing API is to create
 * a GtkPrintOperation object with gtk_print_operation_new() when
 * the user selects to print. Then you set some properties on it,
 * e.g. the page size, any #GtkPrintSettings from previous print
 * operations, the number of pages, the current page, etc.
 *
 * Then you start the print operation by calling gtk_print_operation_run().
 * It will then show a dialog, let the user select a printer and
 * options. When the user finished the dialog various signals will
 * be emitted on the #GtkPrintOperation, the main one being
 * #GtkPrintOperation::draw-page, which you are supposed to catch
 * and render the page on the provided #GtkPrintContext using Cairo.
 *
63
 * # The high-level printing API
64
 *
65
 * |[<!-- language="C" -->
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93
 * 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);
 * }
94
 * ]|
95 96 97 98
 *
 * By default GtkPrintOperation uses an external application to do
 * print preview. To implement a custom print preview, an application
 * must connect to the preview signal. The functions
99
 * gtk_print_operation_preview_render_page(),
100 101 102 103 104
 * gtk_print_operation_preview_end_preview() and
 * gtk_print_operation_preview_is_selected()
 * are useful when implementing a print preview.
 */

105 106
#define SHOW_PROGRESS_TIME 1200

107

108
enum
109
{
110
  DONE,
111
  BEGIN_PRINT,
112
  PAGINATE,
113 114 115 116
  REQUEST_PAGE_SETUP,
  DRAW_PAGE,
  END_PRINT,
  STATUS_CHANGED,
117 118
  CREATE_CUSTOM_WIDGET,
  CUSTOM_WIDGET_APPLY,
119
  PREVIEW,
120
  UPDATE_CUSTOM_WIDGET,
121 122 123
  LAST_SIGNAL
};

124 125
enum 
{
126 127 128 129
  PROP_0,
  PROP_DEFAULT_PAGE_SETUP,
  PROP_PRINT_SETTINGS,
  PROP_JOB_NAME,
Alexander Larsson's avatar
Alexander Larsson committed
130
  PROP_N_PAGES,
131 132
  PROP_CURRENT_PAGE,
  PROP_USE_FULL_PAGE,
133
  PROP_TRACK_PRINT_STATUS,
134
  PROP_UNIT,
135
  PROP_SHOW_PROGRESS,
136
  PROP_ALLOW_ASYNC,
137
  PROP_EXPORT_FILENAME,
138
  PROP_STATUS,
Matthias Clasen's avatar
Matthias Clasen committed
139
  PROP_STATUS_STRING,
140
  PROP_CUSTOM_TAB_LABEL,
141 142
  PROP_EMBED_PAGE_SETUP,
  PROP_HAS_SELECTION,
143 144
  PROP_SUPPORT_SELECTION,
  PROP_N_PAGES_TO_PRINT
145 146 147 148
};

static guint signals[LAST_SIGNAL] = { 0 };
static int job_nr = 0;
149
typedef struct _PrintPagesData PrintPagesData;
150

151 152 153 154 155 156 157
static void          preview_iface_init      (GtkPrintOperationPreviewIface *iface);
static GtkPageSetup *create_page_setup       (GtkPrintOperation             *op);
static void          common_render_page      (GtkPrintOperation             *op,
					      gint                           page_nr);
static void          increment_page_sequence (PrintPagesData *data);
static void          prepare_data            (PrintPagesData *data);
static void          clamp_page_ranges       (PrintPagesData *data);
158 159 160


G_DEFINE_TYPE_WITH_CODE (GtkPrintOperation, gtk_print_operation, G_TYPE_OBJECT,
161
                         G_ADD_PRIVATE (GtkPrintOperation)
162 163
			 G_IMPLEMENT_INTERFACE (GTK_TYPE_PRINT_OPERATION_PREVIEW,
						preview_iface_init))
164 165 166 167 168 169

/**
 * gtk_print_error_quark:
 *
 * Registers an error quark for #GtkPrintOperation if necessary.
 * 
170
 * Returns: The error quark used for #GtkPrintOperation errors.
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
 *
 * Since: 2.10
 **/
GQuark     
gtk_print_error_quark (void)
{
  static GQuark quark = 0;
  if (quark == 0)
    quark = g_quark_from_static_string ("gtk-print-error-quark");
  return quark;
}
     
static void
gtk_print_operation_finalize (GObject *object)
{
  GtkPrintOperation *print_operation = GTK_PRINT_OPERATION (object);
187
  GtkPrintOperationPrivate *priv = print_operation->priv;
188

189 190
  if (priv->free_platform_data &&
      priv->platform_data)
191
    {
192 193
      priv->free_platform_data (priv->platform_data);
      priv->free_platform_data = NULL;
194 195
    }

196 197
  if (priv->default_page_setup)
    g_object_unref (priv->default_page_setup);
198
  
199 200
  if (priv->print_settings)
    g_object_unref (priv->print_settings);
201
  
202 203 204
  if (priv->print_context)
    g_object_unref (priv->print_context);

205
  g_free (priv->export_filename);
206
  g_free (priv->job_name);
Matthias Clasen's avatar
Matthias Clasen committed
207
  g_free (priv->custom_tab_label);
Matthias Clasen's avatar
Matthias Clasen committed
208
  g_free (priv->status_string);
209

210 211 212
  if (priv->print_pages_idle_id > 0)
    g_source_remove (priv->print_pages_idle_id);

213 214 215
  if (priv->show_progress_timeout_id > 0)
    g_source_remove (priv->show_progress_timeout_id);

216 217 218
  if (priv->error)
    g_error_free (priv->error);
  
219 220 221 222 223 224
  G_OBJECT_CLASS (gtk_print_operation_parent_class)->finalize (object);
}

static void
gtk_print_operation_init (GtkPrintOperation *operation)
{
225
  GtkPrintOperationPrivate *priv;
226 227
  const char *appname;

228
  priv = operation->priv = gtk_print_operation_get_instance_private (operation);
229

230 231 232 233 234
  priv->status = GTK_PRINT_STATUS_INITIAL;
  priv->status_string = g_strdup ("");
  priv->default_page_setup = NULL;
  priv->print_settings = NULL;
  priv->nr_of_pages = -1;
235 236
  priv->nr_of_pages_to_print = -1;
  priv->page_position = -1;
237 238
  priv->current_page = -1;
  priv->use_full_page = FALSE;
239
  priv->show_progress = FALSE;
240
  priv->export_filename = NULL;
241
  priv->track_print_status = FALSE;
242
  priv->is_sync = FALSE;
243 244
  priv->support_selection = FALSE;
  priv->has_selection = FALSE;
245
  priv->embed_page_setup = FALSE;
246

247 248
  priv->page_drawing_state = GTK_PAGE_DRAWING_STATE_READY;

249
  priv->rloop = NULL;
250
  priv->unit = GTK_UNIT_NONE;
251 252

  appname = g_get_application_name ();
253 254
  if (appname == NULL)
    appname = "";
255 256 257 258 259
  /* translators: this string is the default job title for print
   * jobs. %s gets replaced by the application name, %d gets replaced
   * by the job number.
   */
  priv->job_name = g_strdup_printf (_("%s job #%d"), appname, ++job_nr);
260 261
}

262 263
static void
preview_iface_render_page (GtkPrintOperationPreview *preview,
264
			   gint                      page_nr)
265
{
266

267 268 269 270 271 272 273 274 275 276
  GtkPrintOperation *op;

  op = GTK_PRINT_OPERATION (preview);
  common_render_page (op, page_nr);
}

static void
preview_iface_end_preview (GtkPrintOperationPreview *preview)
{
  GtkPrintOperation *op;
277
  GtkPrintOperationResult result;
278 279 280 281 282 283 284
  
  op = GTK_PRINT_OPERATION (preview);

  g_signal_emit (op, signals[END_PRINT], 0, op->priv->print_context);

  if (op->priv->rloop)
    g_main_loop_quit (op->priv->rloop);
285 286 287
  
  if (op->priv->end_run)
    op->priv->end_run (op, op->priv->is_sync, TRUE);
288
  
289 290
  _gtk_print_operation_set_status (op, GTK_PRINT_STATUS_FINISHED, NULL);

291 292 293 294 295 296 297 298
  if (op->priv->error)
    result = GTK_PRINT_OPERATION_RESULT_ERROR;
  else if (op->priv->cancelled)
    result = GTK_PRINT_OPERATION_RESULT_CANCEL;
  else
    result = GTK_PRINT_OPERATION_RESULT_APPLY;

  g_signal_emit (op, signals[DONE], 0, result);
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313
}

static gboolean
preview_iface_is_selected (GtkPrintOperationPreview *preview,
			   gint                      page_nr)
{
  GtkPrintOperation *op;
  GtkPrintOperationPrivate *priv;
  int i;
  
  op = GTK_PRINT_OPERATION (preview);
  priv = op->priv;
  
  switch (priv->print_pages)
    {
314
    case GTK_PRINT_PAGES_SELECTION:
315 316 317 318 319 320 321 322
    case GTK_PRINT_PAGES_ALL:
      return (page_nr >= 0) && (page_nr < priv->nr_of_pages);
    case GTK_PRINT_PAGES_CURRENT:
      return page_nr == priv->current_page;
    case GTK_PRINT_PAGES_RANGES:
      for (i = 0; i < priv->num_page_ranges; i++)
	{
	  if (page_nr >= priv->page_ranges[i].start &&
323
	      (page_nr <= priv->page_ranges[i].end || priv->page_ranges[i].end == -1))
324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
	    return TRUE;
	}
      return FALSE;
    }
  return FALSE;
}

static void
preview_iface_init (GtkPrintOperationPreviewIface *iface)
{
  iface->render_page = preview_iface_render_page;
  iface->end_preview = preview_iface_end_preview;
  iface->is_selected = preview_iface_is_selected;
}

static void
preview_start_page (GtkPrintOperation *op,
		    GtkPrintContext   *print_context,
		    GtkPageSetup      *page_setup)
{
344 345 346
  if ((op->priv->manual_number_up < 2) ||
      (op->priv->page_position % op->priv->manual_number_up == 0))
    g_signal_emit_by_name (op, "got-page-size", print_context, page_setup);
347 348 349 350 351 352
}

static void
preview_end_page (GtkPrintOperation *op,
		  GtkPrintContext   *print_context)
{
353 354 355 356 357 358 359 360
  cairo_t *cr;

  cr = gtk_print_context_get_cairo_context (print_context);

  if ((op->priv->manual_number_up < 2) ||
      ((op->priv->page_position + 1) % op->priv->manual_number_up == 0) ||
      (op->priv->page_position == op->priv->nr_of_pages_to_print - 1))
    cairo_show_page (cr);
361 362 363 364 365 366 367 368 369 370 371 372
}

static void
preview_end_run (GtkPrintOperation *op,
		 gboolean           wait,
		 gboolean           cancelled)
{
  g_free (op->priv->page_ranges);
  op->priv->page_ranges = NULL;
}


373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391
static void
gtk_print_operation_set_property (GObject      *object,
				  guint         prop_id,
				  const GValue *value,
				  GParamSpec   *pspec)
{
  GtkPrintOperation *op = GTK_PRINT_OPERATION (object);
  
  switch (prop_id)
    {
    case PROP_DEFAULT_PAGE_SETUP:
      gtk_print_operation_set_default_page_setup (op, g_value_get_object (value));
      break;
    case PROP_PRINT_SETTINGS:
      gtk_print_operation_set_print_settings (op, g_value_get_object (value));
      break;
    case PROP_JOB_NAME:
      gtk_print_operation_set_job_name (op, g_value_get_string (value));
      break;
Alexander Larsson's avatar
Alexander Larsson committed
392 393
    case PROP_N_PAGES:
      gtk_print_operation_set_n_pages (op, g_value_get_int (value));
394 395 396 397 398 399 400
      break;
    case PROP_CURRENT_PAGE:
      gtk_print_operation_set_current_page (op, g_value_get_int (value));
      break;
    case PROP_USE_FULL_PAGE:
      gtk_print_operation_set_use_full_page (op, g_value_get_boolean (value));
      break;
401 402 403
    case PROP_TRACK_PRINT_STATUS:
      gtk_print_operation_set_track_print_status (op, g_value_get_boolean (value));
      break;
404 405 406
    case PROP_UNIT:
      gtk_print_operation_set_unit (op, g_value_get_enum (value));
      break;
407 408
    case PROP_ALLOW_ASYNC:
      gtk_print_operation_set_allow_async (op, g_value_get_boolean (value));
409
      break;
410 411 412
    case PROP_SHOW_PROGRESS:
      gtk_print_operation_set_show_progress (op, g_value_get_boolean (value));
      break;
413 414
    case PROP_EXPORT_FILENAME:
      gtk_print_operation_set_export_filename (op, g_value_get_string (value));
415
      break;
Matthias Clasen's avatar
Matthias Clasen committed
416 417 418
    case PROP_CUSTOM_TAB_LABEL:
      gtk_print_operation_set_custom_tab_label (op, g_value_get_string (value));
      break;
419 420 421
    case PROP_EMBED_PAGE_SETUP:
      gtk_print_operation_set_embed_page_setup (op, g_value_get_boolean (value));
      break;
422 423 424 425 426 427
    case PROP_HAS_SELECTION:
      gtk_print_operation_set_has_selection (op, g_value_get_boolean (value));
      break;
    case PROP_SUPPORT_SELECTION:
      gtk_print_operation_set_support_selection (op, g_value_get_boolean (value));
      break;
428 429 430 431 432 433 434 435 436 437 438 439 440
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}

static void
gtk_print_operation_get_property (GObject    *object,
				  guint       prop_id,
				  GValue     *value,
				  GParamSpec *pspec)
{
  GtkPrintOperation *op = GTK_PRINT_OPERATION (object);
441 442
  GtkPrintOperationPrivate *priv = op->priv;

443 444 445
  switch (prop_id)
    {
    case PROP_DEFAULT_PAGE_SETUP:
446
      g_value_set_object (value, priv->default_page_setup);
447 448
      break;
    case PROP_PRINT_SETTINGS:
449
      g_value_set_object (value, priv->print_settings);
450 451
      break;
    case PROP_JOB_NAME:
452
      g_value_set_string (value, priv->job_name);
453
      break;
Alexander Larsson's avatar
Alexander Larsson committed
454
    case PROP_N_PAGES:
455
      g_value_set_int (value, priv->nr_of_pages);
456 457
      break;
    case PROP_CURRENT_PAGE:
458
      g_value_set_int (value, priv->current_page);
459 460
      break;      
    case PROP_USE_FULL_PAGE:
461
      g_value_set_boolean (value, priv->use_full_page);
462
      break;
463 464 465
    case PROP_TRACK_PRINT_STATUS:
      g_value_set_boolean (value, priv->track_print_status);
      break;
466
    case PROP_UNIT:
467
      g_value_set_enum (value, priv->unit);
468
      break;
469 470
    case PROP_ALLOW_ASYNC:
      g_value_set_boolean (value, priv->allow_async);
471
      break;
472 473 474
    case PROP_SHOW_PROGRESS:
      g_value_set_boolean (value, priv->show_progress);
      break;
475 476
    case PROP_EXPORT_FILENAME:
      g_value_set_string (value, priv->export_filename);
477 478
      break;
    case PROP_STATUS:
479
      g_value_set_enum (value, priv->status);
480 481
      break;
    case PROP_STATUS_STRING:
482
      g_value_set_string (value, priv->status_string);
483
      break;
Matthias Clasen's avatar
Matthias Clasen committed
484 485 486
    case PROP_CUSTOM_TAB_LABEL:
      g_value_set_string (value, priv->custom_tab_label);
      break;
487 488 489
    case PROP_EMBED_PAGE_SETUP:
      g_value_set_boolean (value, priv->embed_page_setup);
      break;
490 491 492 493 494 495
    case PROP_HAS_SELECTION:
      g_value_set_boolean (value, priv->has_selection);
      break;
    case PROP_SUPPORT_SELECTION:
      g_value_set_boolean (value, priv->support_selection);
      break;
496 497 498
    case PROP_N_PAGES_TO_PRINT:
      g_value_set_int (value, priv->nr_of_pages_to_print);
      break;
499 500 501 502 503 504
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}

505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529
struct _PrintPagesData
{
  GtkPrintOperation *op;
  gint uncollated_copies;
  gint collated_copies;
  gint uncollated, collated, total;

  gint range, num_ranges;
  GtkPageRange *ranges;
  GtkPageRange one_range;

  gint page;
  gint sheet;
  gint first_position, last_position;
  gint first_sheet;
  gint num_of_sheets;
  gint *pages;

  GtkWidget *progress;
 
  gboolean initialized;
  gboolean is_preview;
  gboolean done;
};

530 531 532 533 534 535 536 537
typedef struct
{
  GtkPrintOperationPreview *preview;
  GtkPrintContext *print_context;
  GtkWindow *parent;
  cairo_surface_t *surface;
  gchar *filename;
  gboolean wait;
538
  PrintPagesData *pages_data;
539 540 541 542 543 544 545 546 547 548
} PreviewOp;

static void
preview_print_idle_done (gpointer data)
{
  GtkPrintOperation *op;
  PreviewOp *pop = (PreviewOp *) data;

  op = GTK_PRINT_OPERATION (pop->preview);

549
  cairo_surface_finish (pop->surface);
550 551 552 553 554 555 556 557 558 559 560 561 562

  if (op->priv->status == GTK_PRINT_STATUS_FINISHED_ABORTED)
    {
      cairo_surface_destroy (pop->surface);
    }
  else
    {
      /* Surface is destroyed in launch_preview */
      _gtk_print_operation_platform_backend_launch_preview (op,
							    pop->surface,
							    pop->parent,
							    pop->filename);
    }
563 564 565 566

  g_free (pop->filename);

  gtk_print_operation_preview_end_preview (pop->preview);
567

568 569 570 571
  g_object_unref (pop->pages_data->op);
  g_free (pop->pages_data->pages);
  g_free (pop->pages_data);

572
  g_object_unref (op);
573 574 575 576 577 578 579 580
  g_free (pop);
}

static gboolean
preview_print_idle (gpointer data)
{
  PreviewOp *pop;
  GtkPrintOperation *op;
581
  GtkPrintOperationPrivate *priv; 
582
  gboolean done = FALSE;
583 584 585

  pop = (PreviewOp *) data;
  op = GTK_PRINT_OPERATION (pop->preview);
586
  priv = op->priv;
587

588 589
  if (priv->page_drawing_state == GTK_PAGE_DRAWING_STATE_READY)
    {
590 591 592 593 594 595
      if (priv->cancelled)
	{
	  done = TRUE;
          _gtk_print_operation_set_status (op, GTK_PRINT_STATUS_FINISHED_ABORTED, NULL);
	}
      else if (!pop->pages_data->initialized)
596
        {
597 598
          pop->pages_data->initialized = TRUE;
          prepare_data (pop->pages_data);
599
        }
600
      else
601
        {
602 603 604 605 606 607
          increment_page_sequence (pop->pages_data);

          if (!pop->pages_data->done)
            gtk_print_operation_preview_render_page (pop->preview, pop->pages_data->page);
          else
            done = priv->page_drawing_state == GTK_PAGE_DRAWING_STATE_READY;
608 609
        }
    }
610

611
  return !done;
612 613 614 615 616 617
}

static void
preview_got_page_size (GtkPrintOperationPreview *preview, 
		       GtkPrintContext          *context,
		       GtkPageSetup             *page_setup,
618
		       PreviewOp                *pop)
619 620
{
  GtkPrintOperation *op = GTK_PRINT_OPERATION (preview);
621
  cairo_t *cr;
622 623

  _gtk_print_operation_platform_backend_resize_preview_surface (op, page_setup, pop->surface);
624 625

  cr = gtk_print_context_get_cairo_context (pop->print_context);
626
  _gtk_print_operation_platform_backend_preview_start_page (op, pop->surface, cr);
627

628 629 630 631
}

static void
preview_ready (GtkPrintOperationPreview *preview,
632 633
               GtkPrintContext          *context,
	       PreviewOp                *pop)
634
{
635 636
  guint id;

637 638
  pop->print_context = context;

639 640
  g_object_ref (preview);
      
641 642 643 644 645
  id = gdk_threads_add_idle_full (G_PRIORITY_DEFAULT_IDLE + 10,
				  preview_print_idle,
				  pop,
				  preview_print_idle_done);
  g_source_set_name_by_id (id, "[gtk+] preview_print_idle");
646 647
}

648

649
static gboolean
650
gtk_print_operation_preview_handler (GtkPrintOperation        *op,
651 652 653 654 655 656 657 658 659 660
                                     GtkPrintOperationPreview *preview, 
				     GtkPrintContext          *context,
				     GtkWindow                *parent)
{
  gdouble dpi_x, dpi_y;
  PreviewOp *pop;
  GtkPageSetup *page_setup;
  cairo_t *cr;

  pop = g_new0 (PreviewOp, 1);
661
  pop->filename = NULL;
662 663
  pop->preview = preview;
  pop->parent = parent;
664 665 666
  pop->pages_data = g_new0 (PrintPagesData, 1);
  pop->pages_data->op = g_object_ref (GTK_PRINT_OPERATION (preview));
  pop->pages_data->is_preview = TRUE;
667 668 669 670 671 672 673

  page_setup = gtk_print_context_get_page_setup (context);

  pop->surface =
    _gtk_print_operation_platform_backend_create_preview_surface (op,
								  page_setup,
								  &dpi_x, &dpi_y,
674
								  &pop->filename);
675

676 677 678 679 680 681
  if (pop->surface == NULL)
    {
      g_free (pop);
      return FALSE;
    }

682 683 684 685 686 687 688 689 690 691 692
  cr = cairo_create (pop->surface);
  gtk_print_context_set_cairo_context (op->priv->print_context, cr,
				       dpi_x, dpi_y);
  cairo_destroy (cr);

  g_signal_connect (preview, "ready", (GCallback) preview_ready, pop);
  g_signal_connect (preview, "got-page-size", (GCallback) preview_got_page_size, pop);
  
  return TRUE;
}

693 694 695 696 697 698
static GtkWidget *
gtk_print_operation_create_custom_widget (GtkPrintOperation *operation)
{
  return NULL;
}

699 700 701 702 703 704 705 706
static gboolean
gtk_print_operation_paginate (GtkPrintOperation *operation,
                              GtkPrintContext   *context)
{
  /* assume the number of pages is already set and pagination is not needed */
  return TRUE;
}

707
static void
708 709
gtk_print_operation_done (GtkPrintOperation       *operation,
                          GtkPrintOperationResult  result)
710 711 712 713 714 715 716 717 718 719
{
  GtkPrintOperationPrivate *priv = operation->priv;

  if (priv->print_context)
    {
      g_object_unref (priv->print_context);
      priv->print_context = NULL;
    } 
}

720 721 722 723 724 725 726 727 728
static gboolean
custom_widget_accumulator (GSignalInvocationHint *ihint,
			   GValue                *return_accu,
			   const GValue          *handler_return,
			   gpointer               dummy)
{
  gboolean continue_emission;
  GtkWidget *widget;
  
729
  widget = g_value_get_object (handler_return);
730
  if (widget != NULL)
731
    g_value_set_object (return_accu, widget);
732 733 734 735 736
  continue_emission = (widget == NULL);
  
  return continue_emission;
}

737 738 739 740 741 742 743 744 745 746 747 748 749
static gboolean
paginate_accumulator (GSignalInvocationHint *ihint,
                      GValue                *return_accu,
                      const GValue          *handler_return,
                      gpointer               dummy)
{
  *return_accu = *handler_return;

  /* Stop signal emission on first invocation, so if it's a callback then
   * the default handler won't run. */
  return FALSE;
}

750 751 752 753 754 755 756 757
static void
gtk_print_operation_class_init (GtkPrintOperationClass *class)
{
  GObjectClass *gobject_class = (GObjectClass *)class;

  gobject_class->set_property = gtk_print_operation_set_property;
  gobject_class->get_property = gtk_print_operation_get_property;
  gobject_class->finalize = gtk_print_operation_finalize;
758 759
 
  class->preview = gtk_print_operation_preview_handler; 
760
  class->create_custom_widget = gtk_print_operation_create_custom_widget;
761
  class->paginate = gtk_print_operation_paginate;
762
  class->done = gtk_print_operation_done;
763

764 765 766 767 768
  /**
   * GtkPrintOperation::done:
   * @operation: the #GtkPrintOperation on which the signal was emitted
   * @result: the result of the print operation
   *
769
   * Emitted when the print operation run has finished doing
Matthias Clasen's avatar
Matthias Clasen committed
770 771 772 773
   * everything required for printing. 
   *
   * @result gives you information about what happened during the run. 
   * If @result is %GTK_PRINT_OPERATION_RESULT_ERROR then you can call
774 775
   * gtk_print_operation_get_error() for more information.
   *
776 777
   * If you enabled print status tracking then 
   * gtk_print_operation_is_finished() may still return %FALSE 
Matthias Clasen's avatar
Matthias Clasen committed
778
   * after #GtkPrintOperation::done was emitted.
779 780 781 782 783 784 785 786 787
   *
   * Since: 2.10
   */
  signals[DONE] =
    g_signal_new (I_("done"),
		  G_TYPE_FROM_CLASS (gobject_class),
		  G_SIGNAL_RUN_LAST,
		  G_STRUCT_OFFSET (GtkPrintOperationClass, done),
		  NULL, NULL,
788 789
		  g_cclosure_marshal_VOID__ENUM,
		  G_TYPE_NONE, 1, GTK_TYPE_PRINT_OPERATION_RESULT);
790

791 792 793 794 795
  /**
   * GtkPrintOperation::begin-print:
   * @operation: the #GtkPrintOperation on which the signal was emitted
   * @context: the #GtkPrintContext for the current operation
   *
796
   * Emitted after the user has finished changing print settings
797 798
   * in the dialog, before the actual rendering starts. 
   *
Matthias Clasen's avatar
Matthias Clasen committed
799
   * A typical use for ::begin-print is to use the parameters from the
800
   * #GtkPrintContext and paginate the document accordingly, and then
Alexander Larsson's avatar
Alexander Larsson committed
801
   * set the number of pages with gtk_print_operation_set_n_pages().
802 803 804 805
   *
   * Since: 2.10
   */
  signals[BEGIN_PRINT] =
Matthias Clasen's avatar
Matthias Clasen committed
806
    g_signal_new (I_("begin-print"),
807 808 809 810 811 812 813
		  G_TYPE_FROM_CLASS (gobject_class),
		  G_SIGNAL_RUN_LAST,
		  G_STRUCT_OFFSET (GtkPrintOperationClass, begin_print),
		  NULL, NULL,
		  g_cclosure_marshal_VOID__OBJECT,
		  G_TYPE_NONE, 1, GTK_TYPE_PRINT_CONTEXT);

814
   /**
815
   * GtkPrintOperation::paginate:
816 817 818
   * @operation: the #GtkPrintOperation on which the signal was emitted
   * @context: the #GtkPrintContext for the current operation
   *
Matthias Clasen's avatar
Matthias Clasen committed
819
   * Emitted after the #GtkPrintOperation::begin-print signal, but before 
Matthias Clasen's avatar
Matthias Clasen committed
820 821
   * the actual rendering starts. It keeps getting emitted until a connected 
   * signal handler returns %TRUE.
822
   *
Matthias Clasen's avatar
Matthias Clasen committed
823
   * The ::paginate signal is intended to be used for paginating a document
824 825 826 827 828 829
   * in small chunks, to avoid blocking the user interface for a long
   * time. The signal handler should update the number of pages using
   * gtk_print_operation_set_n_pages(), and return %TRUE if the document
   * has been completely paginated.
   *
   * If you don't need to do pagination in chunks, you can simply do
Matthias Clasen's avatar
Matthias Clasen committed
830
   * it all in the ::begin-print handler, and set the number of pages
831 832
   * from there.
   *
833
   * Returns: %TRUE if pagination is complete
834
   *
835 836 837 838 839 840 841
   * Since: 2.10
   */
  signals[PAGINATE] =
    g_signal_new (I_("paginate"),
		  G_TYPE_FROM_CLASS (gobject_class),
		  G_SIGNAL_RUN_LAST,
		  G_STRUCT_OFFSET (GtkPrintOperationClass, paginate),
842
		  paginate_accumulator, NULL,
843 844 845 846
		  _gtk_marshal_BOOLEAN__OBJECT,
		  G_TYPE_BOOLEAN, 1, GTK_TYPE_PRINT_CONTEXT);


847 848 849 850
  /**
   * GtkPrintOperation::request-page-setup:
   * @operation: the #GtkPrintOperation on which the signal was emitted
   * @context: the #GtkPrintContext for the current operation
851
   * @page_nr: the number of the currently printed page (0-based)
852 853
   * @setup: the #GtkPageSetup 
   * 
854
   * Emitted once for every page that is printed, to give
855 856 857 858 859 860
   * the application a chance to modify the page setup. Any changes 
   * done to @setup will be in force only for printing this page.
   *
   * Since: 2.10
   */
  signals[REQUEST_PAGE_SETUP] =
Matthias Clasen's avatar
Matthias Clasen committed
861
    g_signal_new (I_("request-page-setup"),
862 863 864 865 866 867 868 869 870 871 872 873 874 875
		  G_TYPE_FROM_CLASS (gobject_class),
		  G_SIGNAL_RUN_LAST,
		  G_STRUCT_OFFSET (GtkPrintOperationClass, request_page_setup),
		  NULL, NULL,
		  _gtk_marshal_VOID__OBJECT_INT_OBJECT,
		  G_TYPE_NONE, 3,
		  GTK_TYPE_PRINT_CONTEXT,
		  G_TYPE_INT,
		  GTK_TYPE_PAGE_SETUP);

  /**
   * GtkPrintOperation::draw-page:
   * @operation: the #GtkPrintOperation on which the signal was emitted
   * @context: the #GtkPrintContext for the current operation
876
   * @page_nr: the number of the currently printed page (0-based)
877
   *
878
   * Emitted for every page that is printed. The signal handler
879
   * must render the @page_nr's page onto the cairo context obtained
880
   * from @context using gtk_print_context_get_cairo_context().
881
   * |[<!-- language="C" -->
Matthias Clasen's avatar
Matthias Clasen committed
882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908
   * static void
   * draw_page (GtkPrintOperation *operation,
   *            GtkPrintContext   *context,
   *            gint               page_nr,
   *            gpointer           user_data)
   * {
   *   cairo_t *cr;
   *   PangoLayout *layout;
   *   gdouble width, text_height;
   *   gint layout_height;
   *   PangoFontDescription *desc;
   *   
   *   cr = gtk_print_context_get_cairo_context (context);
   *   width = gtk_print_context_get_width (context);
   *   
   *   cairo_rectangle (cr, 0, 0, width, HEADER_HEIGHT);
   *   
   *   cairo_set_source_rgb (cr, 0.8, 0.8, 0.8);
   *   cairo_fill (cr);
   *   
   *   layout = gtk_print_context_create_pango_layout (context);
   *   
   *   desc = pango_font_description_from_string ("sans 14");
   *   pango_layout_set_font_description (layout, desc);
   *   pango_font_description_free (desc);
   *   
   *   pango_layout_set_text (layout, "some text", -1);
909
   *   pango_layout_set_width (layout, width * PANGO_SCALE);
Matthias Clasen's avatar
Matthias Clasen committed
910
   *   pango_layout_set_alignment (layout, PANGO_ALIGN_CENTER);
Matthias Clasen's avatar
Matthias Clasen committed
911
   *      		      
Matthias Clasen's avatar
Matthias Clasen committed
912
   *   pango_layout_get_size (layout, NULL, &layout_height);
Matthias Clasen's avatar
Matthias Clasen committed
913 914 915 916
   *   text_height = (gdouble)layout_height / PANGO_SCALE;
   *   
   *   cairo_move_to (cr, width / 2,  (HEADER_HEIGHT - text_height) / 2);
   *   pango_cairo_show_layout (cr, layout);
Matthias Clasen's avatar
Matthias Clasen committed
917
   *   
Matthias Clasen's avatar
Matthias Clasen committed
918 919
   *   g_object_unref (layout);
   * }
Matthias Clasen's avatar
Matthias Clasen committed
920
   * ]|
921
   *
Matthias Clasen's avatar
Matthias Clasen committed
922 923 924 925 926
   * Use gtk_print_operation_set_use_full_page() and 
   * gtk_print_operation_set_unit() before starting the print operation
   * to set up the transformation of the cairo context according to your
   * needs.
   * 
927 928 929
   * Since: 2.10
   */
  signals[DRAW_PAGE] =
Matthias Clasen's avatar
Matthias Clasen committed
930
    g_signal_new (I_("draw-page"),
931 932 933 934 935 936 937 938 939 940 941 942 943 944
		  G_TYPE_FROM_CLASS (gobject_class),
		  G_SIGNAL_RUN_LAST,
		  G_STRUCT_OFFSET (GtkPrintOperationClass, draw_page),
		  NULL, NULL,
		  _gtk_marshal_VOID__OBJECT_INT,
		  G_TYPE_NONE, 2,
		  GTK_TYPE_PRINT_CONTEXT,
		  G_TYPE_INT);

  /**
   * GtkPrintOperation::end-print:
   * @operation: the #GtkPrintOperation on which the signal was emitted
   * @context: the #GtkPrintContext for the current operation
   *
945
   * Emitted after all pages have been rendered. 
946
   * A handler for this signal can clean up any resources that have
Matthias Clasen's avatar
Matthias Clasen committed
947
   * been allocated in the #GtkPrintOperation::begin-print handler.
948 949 950 951
   * 
   * Since: 2.10
   */
  signals[END_PRINT] =
Matthias Clasen's avatar
Matthias Clasen committed
952
    g_signal_new (I_("end-print"),
953 954 955 956 957 958 959 960 961 962 963
		  G_TYPE_FROM_CLASS (gobject_class),
		  G_SIGNAL_RUN_LAST,
		  G_STRUCT_OFFSET (GtkPrintOperationClass, end_print),
		  NULL, NULL,
		  g_cclosure_marshal_VOID__OBJECT,
		  G_TYPE_NONE, 1, GTK_TYPE_PRINT_CONTEXT);

  /**
   * GtkPrintOperation::status-changed:
   * @operation: the #GtkPrintOperation on which the signal was emitted
   *
964
   * Emitted at between the various phases of the print operation.
965 966 967 968 969 970 971
   * See #GtkPrintStatus for the phases that are being discriminated.
   * Use gtk_print_operation_get_status() to find out the current
   * status.
   *
   * Since: 2.10
   */
  signals[STATUS_CHANGED] =
Matthias Clasen's avatar
Matthias Clasen committed
972
    g_signal_new (I_("status-changed"),
973 974 975 976 977 978 979 980 981
		  G_TYPE_FROM_CLASS (class),
		  G_SIGNAL_RUN_LAST,
		  G_STRUCT_OFFSET (GtkPrintOperationClass, status_changed),
		  NULL, NULL,
		  g_cclosure_marshal_VOID__VOID,
		  G_TYPE_NONE, 0);


  /**
Matthias Clasen's avatar
Matthias Clasen committed
982
   * GtkPrintOperation::create-custom-widget:
983 984
   * @operation: the #GtkPrintOperation on which the signal was emitted
   *
985
   * Emitted when displaying the print dialog. If you return a
986 987 988 989
   * widget in a handler for this signal it will be added to a custom
   * tab in the print dialog. You typically return a container widget
   * with multiple widgets in it.
   *
Matthias Clasen's avatar
Matthias Clasen committed
990 991
   * The print dialog owns the returned widget, and its lifetime is not 
   * controlled by the application. However, the widget is guaranteed 
Matthias Clasen's avatar
Matthias Clasen committed
992 993 994
   * to stay around until the #GtkPrintOperation::custom-widget-apply 
   * signal is emitted on the operation. Then you can read out any 
   * information you need from the widgets.
995
   *
996 997
   * Returns: (transfer none): A custom widget that gets embedded in
   *          the print dialog, or %NULL
Matthias Clasen's avatar
Matthias Clasen committed
998
   *
999 1000 1001 1002 1003 1004 1005 1006
   * Since: 2.10
   */
  signals[CREATE_CUSTOM_WIDGET] =
    g_signal_new (I_("create-custom-widget"),
		  G_TYPE_FROM_CLASS (class),
		  G_SIGNAL_RUN_LAST,
		  G_STRUCT_OFFSET (GtkPrintOperationClass, create_custom_widget),
		  custom_widget_accumulator, NULL,
1007 1008
		  _gtk_marshal_OBJECT__VOID,
		  G_TYPE_OBJECT, 0);
1009

1010 1011 1012 1013 1014 1015 1016
  /**
   * GtkPrintOperation::update-custom-widget:
   * @operation: the #GtkPrintOperation on which the signal was emitted
   * @widget: the custom widget added in create-custom-widget
   * @setup: actual page setup
   * @settings: actual print settings
   *
1017
   * Emitted after change of selected printer. The actual page setup and
1018
   * print settings are passed to the custom widget, which can actualize
1019
   * itself according to this change.
1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031
   *
   * Since: 2.18
   */
  signals[UPDATE_CUSTOM_WIDGET] =
    g_signal_new (I_("update-custom-widget"),
		  G_TYPE_FROM_CLASS (class),
		  G_SIGNAL_RUN_LAST,
		  G_STRUCT_OFFSET (GtkPrintOperationClass, update_custom_widget),
		  NULL, NULL,
		  _gtk_marshal_VOID__OBJECT_OBJECT_OBJECT,
		  G_TYPE_NONE, 3, GTK_TYPE_WIDGET, GTK_TYPE_PAGE_SETUP, GTK_TYPE_PRINT_SETTINGS);

1032 1033 1034 1035 1036
  /**
   * GtkPrintOperation::custom-widget-apply:
   * @operation: the #GtkPrintOperation on which the signal was emitted
   * @widget: the custom widget added in create-custom-widget
   *
Matthias Clasen's avatar
Matthias Clasen committed
1037
   * Emitted right before #GtkPrintOperation::begin-print if you added
1038
   * a custom widget in the #GtkPrintOperation::create-custom-widget handler. 
Matthias Clasen's avatar
Matthias Clasen committed
1039 1040 1041
   * When you get this signal you should read the information from the 
   * custom widgets, as the widgets are not guaraneed to be around at a 
   * later time.
1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052
   *
   * Since: 2.10
   */
  signals[CUSTOM_WIDGET_APPLY] =
    g_signal_new (I_("custom-widget-apply"),
		  G_TYPE_FROM_CLASS (class),
		  G_SIGNAL_RUN_LAST,
		  G_STRUCT_OFFSET (GtkPrintOperationClass, custom_widget_apply),
		  NULL, NULL,
		  g_cclosure_marshal_VOID__OBJECT,
		  G_TYPE_NONE, 1, GTK_TYPE_WIDGET);
1053

1054 1055 1056
   /**
   * GtkPrintOperation::preview:
   * @operation: the #GtkPrintOperation on which the signal was emitted
1057
   * @preview: the #GtkPrintOperationPreview for the current operation
1058
   * @context: the #GtkPrintContext that will be used
1059
   * @parent: (allow-none): the #GtkWindow to use as window parent, or %NULL
1060 1061 1062
   *
   * Gets emitted when a preview is requested from the native dialog.
   *
1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076
   * The default handler for this signal uses an external viewer 
   * application to preview.
   *
   * To implement a custom print preview, an application must return
   * %TRUE from its handler for this signal. In order to use the
   * provided @context for the preview implementation, it must be
   * given a suitable cairo context with gtk_print_context_set_cairo_context().
   * 
   * The custom preview implementation can use 
   * gtk_print_operation_preview_is_selected() and 
   * gtk_print_operation_preview_render_page() to find pages which
   * are selected for print and render them. The preview must be
   * finished by calling gtk_print_operation_preview_end_preview()
   * (typically in response to the user clicking a close button).
1077
   *
1078
   * Returns: %TRUE if the listener wants to take over control of the preview
1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094
   * 
   * Since: 2.10
   */
  signals[PREVIEW] =
    g_signal_new (I_("preview"),
		  G_TYPE_FROM_CLASS (gobject_class),
		  G_SIGNAL_RUN_LAST,
		  G_STRUCT_OFFSET (GtkPrintOperationClass, preview),
		  _gtk_boolean_handled_accumulator, NULL,
		  _gtk_marshal_BOOLEAN__OBJECT_OBJECT_OBJECT,
		  G_TYPE_BOOLEAN, 3,
		  GTK_TYPE_PRINT_OPERATION_PREVIEW,
		  GTK_TYPE_PRINT_CONTEXT,
		  GTK_TYPE_WINDOW);

  
Matthias Clasen's avatar
Matthias Clasen committed
1095 1096 1097 1098 1099 1100 1101
  /**
   * GtkPrintOperation:default-page-setup:
   *
   * The #GtkPageSetup used by default.
   * 
   * This page setup will be used by gtk_print_operation_run(),
   * but it can be overridden on a per-page basis by connecting
Matthias Clasen's avatar
Matthias Clasen committed
1102
   * to the #GtkPrintOperation::request-page-setup signal.
Matthias Clasen's avatar
Matthias Clasen committed
1103 1104 1105
   *
   * Since: 2.10
   */
1106 1107 1108 1109 1110 1111 1112 1113
  g_object_class_install_property (gobject_class,
				   PROP_DEFAULT_PAGE_SETUP,
				   g_param_spec_object ("default-page-setup",
							P_("Default Page Setup"),
							P_("The GtkPageSetup used by default"),
							GTK_TYPE_PAGE_SETUP,
							GTK_PARAM_READWRITE));

Matthias Clasen's avatar
Matthias Clasen committed
1114 1115 1116 1117 1118
  /**
   * GtkPrintOperation:print-settings:
   *
   * The #GtkPrintSettings used for initializing the dialog.
   *
Matthias Clasen's avatar
Matthias Clasen committed
1119 1120 1121
   * Setting this property is typically used to re-establish 
   * print settings from a previous print operation, see 
   * gtk_print_operation_run().
Matthias Clasen's avatar
Matthias Clasen committed
1122 1123 1124
   *
   * Since: 2.10
   */
1125 1126 1127 1128 1129 1130 1131
  g_object_class_install_property (gobject_class,
				   PROP_PRINT_SETTINGS,
				   g_param_spec_object ("print-settings",
							P_("Print Settings"),
							P_("The GtkPrintSettings used for initializing the dialog"),
							GTK_TYPE_PRINT_SETTINGS,
							GTK_PARAM_READWRITE));
Matthias Clasen's avatar
Matthias Clasen committed
1132 1133 1134 1135
  
  /**
   * GtkPrintOperation:job-name:
   *
Matthias Clasen's avatar
Matthias Clasen committed
1136 1137
   * A string used to identify the job (e.g. in monitoring 
   * applications like eggcups). 
Matthias Clasen's avatar
Matthias Clasen committed
1138
   * 
Matthias Clasen's avatar
Matthias Clasen committed
1139 1140
   * If you don't set a job name, GTK+ picks a default one 
   * by numbering successive print jobs.
Matthias Clasen's avatar
Matthias Clasen committed
1141 1142 1143
   *
   * Since: 2.10
   */
1144 1145 1146 1147 1148 1149 1150
  g_object_class_install_property (gobject_class,
				   PROP_JOB_NAME,
				   g_param_spec_string ("job-name",
							P_("Job Name"),
							P_("A string used for identifying the print job."),
							"",
							GTK_PARAM_READWRITE));
Matthias Clasen's avatar
Matthias Clasen committed
1151 1152

  /**
Alexander Larsson's avatar
Alexander Larsson committed
1153
   * GtkPrintOperation:n-pages:
Matthias Clasen's avatar
Matthias Clasen committed
1154 1155 1156
   *
   * The number of pages in the document. 
   *
1157
   * This must be set to a positive number
Matthias Clasen's avatar
Matthias Clasen committed
1158 1159
   * before the rendering starts. It may be set in a 
   * #GtkPrintOperation::begin-print signal hander.
Matthias Clasen's avatar
Matthias Clasen committed
1160
   *
Matthias Clasen's avatar
Matthias Clasen committed
1161 1162 1163 1164 1165
   * Note that the page numbers passed to the 
   * #GtkPrintOperation::request-page-setup and 
   * #GtkPrintOperation::draw-page signals are 0-based, i.e. if 
   * the user chooses to print all pages, the last ::draw-page signal 
   * will be for page @n_pages - 1.
Matthias Clasen's avatar
Matthias Clasen committed
1166 1167 1168
   *
   * Since: 2.10
   */
1169
  g_object_class_install_property (gobject_class,
Alexander Larsson's avatar
Alexander Larsson committed
1170 1171
				   PROP_N_PAGES,
				   g_param_spec_int ("n-pages",
1172 1173 1174 1175 1176
						     P_("Number of Pages"),
						     P_("The number of pages in the document."),
						     -1,
						     G_MAXINT,
						     -1,
1177
						     GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY));
Matthias Clasen's avatar
Matthias Clasen committed
1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190

  /**
   * GtkPrintOperation:current-page:
   *
   * The current page in the document.
   *
   * If this is set before gtk_print_operation_run(), 
   * the user will be able to select to print only the current page.
   *
   * Note that this only makes sense for pre-paginated documents.
   *
   * Since: 2.10
   */
1191 1192 1193 1194
  g_object_class_install_property (gobject_class,
				   PROP_CURRENT_PAGE,
				   g_param_spec_int ("current-page",
						     P_("Current Page"),
1195
						     P_("The current page in the document"),
1196 1197 1198
						     -1,
						     G_MAXINT,
						     -1,
1199
						     GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY));
1200
  
Matthias Clasen's avatar
Matthias Clasen committed
1201 1202 1203
  /**
   * GtkPrintOperation:use-full-page:
   *
Matthias Clasen's avatar
Matthias Clasen committed
1204 1205 1206 1207 1208 1209
   * If %TRUE, the transformation for the cairo context obtained 
   * from #GtkPrintContext puts the origin at the top left corner 
   * of the page (which may not be the top left corner of the sheet, 
   * depending on page orientation and the number of pages per sheet). 
   * Otherwise, the origin is at the top left corner of the imageable 
   * area (i.e. inside the margins).
Matthias Clasen's avatar
Matthias Clasen committed
1210 1211 1212
   * 
   * Since: 2.10
   */
1213 1214 1215 1216
  g_object_class_install_property (gobject_class,
				   PROP_USE_FULL_PAGE,
				   g_param_spec_boolean ("use-full-page",
							 P_("Use full page"),
Matthias Clasen's avatar
Matthias Clasen committed
1217
							 P_("TRUE if the origin of the context should be at the corner of the page and not the corner of the imageable area"),
1218
							 FALSE,
1219
							 GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY));
1220 1221
  

1222 1223 1224
  /**
   * GtkPrintOperation:track-print-status:
   *
Matthias Clasen's avatar
Matthias Clasen committed
1225 1226
   * If %TRUE, the print operation will try to continue report on 
   * the status of the print job in the printer queues and printer. 
1227
   * This can allow your application to show things like “out of paper” 
Matthias Clasen's avatar
Matthias Clasen committed
1228 1229 1230
   * issues, and when the print job actually reaches the printer. 
   * However, this is often implemented using polling, and should 
   * not be enabled unless needed.
1231 1232 1233 1234
   * 
   * Since: 2.10
   */
  g_object_class_install_property (gobject_class,
Matthias Clasen's avatar
Matthias Clasen committed
1235
				   PROP_TRACK_PRINT_STATUS,
1236 1237
				   g_param_spec_boolean ("track-print-status",
							 P_("Track Print Status"),
Matthias Clasen's avatar
Matthias Clasen committed
1238
							 P_("TRUE if the print operation will continue to report on the print job status after the print data has been sent to the printer or print server."),
1239
							 FALSE,
1240
							 GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY));
1241 1242
  

Matthias Clasen's avatar
Matthias Clasen committed
1243 1244 1245 1246
  /**
   * GtkPrintOperation:unit:
   *
   * The transformation for the cairo context obtained from
Matthias Clasen's avatar
Matthias Clasen committed
1247 1248
   * #GtkPrintContext is set up in such a way that distances 
   * are measured in units of @unit.
Matthias Clasen's avatar
Matthias Clasen committed
1249 1250 1251
   *
   * Since: 2.10
   */
1252 1253 1254 1255
  g_object_class_install_property (gobject_class,
				   PROP_UNIT,
				   g_param_spec_enum ("unit",
						      P_("Unit"),
Matthias Clasen's avatar
Matthias Clasen committed
1256
						      P_("The unit in which distances can be measured in the context"),
1257
						      GTK_TYPE_UNIT,
1258
						      GTK_UNIT_NONE,
1259
						      GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY));
1260
  
1261
  
Matthias Clasen's avatar
Matthias Clasen committed
1262
  /**
1263
   * GtkPrintOperation:show-progress:
Matthias Clasen's avatar
Matthias Clasen committed
1264
   *
1265 1266
   * Determines whether to show a progress dialog during the 
   * print operation.
Matthias Clasen's avatar
Matthias Clasen committed
1267 1268 1269
   *
   * Since: 2.10
   */
1270
  g_object_class_install_property (gobject_class,
1271 1272
				   PROP_SHOW_PROGRESS,
				   g_param_spec_boolean ("show-progress",
1273
							 P_("Show Dialog"),
1274 1275
							 P_("TRUE if a progress dialog is shown while printing."),
							 FALSE,
1276
							 GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY));
1277

1278
  /**
1279
   * GtkPrintOperation:allow-async:
1280
   *
1281
   * Determines whether the print operation may run asynchronously or not.
Matthias Clasen's avatar
Matthias Clasen committed
1282
   *
1283
   * Some systems don't support asynchronous printing, but those that do
Matthias Clasen's avatar
Matthias Clasen committed
1284
   * will return %GTK_PRINT_OPERATION_RESULT_IN_PROGRESS as the status, and
Matthias Clasen's avatar
Matthias Clasen committed
1285 1286
   * emit the #GtkPrintOperation::done signal when the operation is actually 
   * done.
1287
   *
Matthias Clasen's avatar
Matthias Clasen committed
1288 1289 1290
   * The Windows port does not support asynchronous operation at all (this 
   * is unlikely to change). On other platforms, all actions except for 
   * %GTK_PRINT_OPERATION_ACTION_EXPORT support asynchronous operation.
Matthias Clasen's avatar
Matthias Clasen committed
1291
   *
1292 1293 1294
   * Since: 2.10
   */
  g_object_class_install_property (gobject_class,
1295 1296 1297 1298
				   PROP_ALLOW_ASYNC,
				   g_param_spec_boolean ("allow-async",
							 P_("Allow Async"),
							 P_("TRUE if print process may run asynchronous."),
1299
							 FALSE,
1300
							 GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY));
1301
  
Matthias Clasen's avatar
Matthias Clasen committed
1302
  /**
Matthias Clasen's avatar
Matthias Clasen committed
1303
   * GtkPrintOperation:export-filename:
Matthias Clasen's avatar
Matthias Clasen committed
1304
   *
Matthias Clasen's avatar
Matthias Clasen committed
1305 1306
   * The name of a file to generate instead of showing the print dialog. 
   * Currently, PDF is the only supported format.
Matthias Clasen's avatar
Matthias Clasen committed
1307
   *
Matthias Clasen's avatar
Matthias Clasen committed
1308
   * The intended use of this property is for implementing 
1309
   * “Export to PDF” actions.
Matthias Clasen's avatar
Matthias Clasen committed
1310
   *
1311 1312
   * “Print to PDF” support is independent of this and is done
   * by letting the user pick the “Print to PDF” item from the 
Matthias Clasen's avatar
Matthias Clasen committed
1313
   * list of printers in the print dialog.
Matthias Clasen's avatar
Matthias Clasen committed
1314 1315 1316
   *
   * Since: 2.10
   */
1317
  g_object_class_install_property (gobject_class,
Matthias Clasen's avatar
Matthias Clasen committed
1318 1319 1320 1321
				   PROP_EXPORT_FILENAME,
				   g_param_spec_string ("export-filename",
							P_("Export filename"),
							P_("Export filename"),
1322 1323 1324
							NULL,
							GTK_PARAM_READWRITE));
  
Matthias Clasen's avatar
Matthias Clasen committed
1325 1326 1327 1328 1329 1330 1331
  /**
   * GtkPrintOperation:status:
   *
   * The status of the print operation.
   * 
   * Since: 2.10
   */
1332 1333 1334 1335 1336 1337 1338
  g_object_class_install_property (gobject_class,
				   PROP_STATUS,
				   g_param_spec_enum ("status",
						      P_("Status"),
						      P_("The status of the print operation"),
						      GTK_TYPE_PRINT_STATUS,
						      GTK_PRINT_STATUS_INITIAL,
1339
						      GTK_PARAM_READABLE|G_PARAM_EXPLICIT_NOTIFY));
1340
  
Matthias Clasen's avatar
Matthias Clasen committed
1341 1342 1343 1344 1345 1346 1347
  /**
   * GtkPrintOperation:status-string:
   *
   * A string representation of the status of the print operation. 
   * The string is translated and suitable for displaying the print 
   * status e.g. in a #GtkStatusbar.
   *
Matthias Clasen's avatar
Matthias Clasen committed
1348 1349
   * See the #GtkPrintOperation:status property for a status value that 
   * is suitable for programmatic use. 
Matthias Clasen's avatar
Matthias Clasen committed
1350 1351 1352
   *
   * Since: 2.10
   */
1353 1354 1355 1356 1357 1358 1359 1360 1361
  g_object_class_install_property (gobject_class,
				   PROP_STATUS_STRING,
				   g_param_spec_string ("status-string",
							P_("Status String"),
							P_("A human-readable description of the status"),
							"",
							GTK_PARAM_READABLE));
  

Matthias Clasen's avatar
Matthias Clasen committed
1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379
  /**
   * GtkPrintOperation:custom-tab-label:
   *
   * Used as the label of the tab containing custom widgets.
   * Note that this property may be ignored on some platforms.
   * 
   * If this is %NULL, GTK+ uses a default label.
   *
   * Since: 2.10
   */
  g_object_class_install_property (gobject_class,
				   PROP_CUSTOM_TAB_LABEL,
				   g_param_spec_string ("custom-tab-label",
							P_("Custom tab label"),
							P_("Label for the tab containing custom widgets."),
							NULL,
							GTK_PARAM_READWRITE));

1380 1381 1382 1383 1384 1385 1386 1387 1388
  /**
   * GtkPrintOperation:support-selection:
   *
   * If %TRUE, the print operation will support print of selection.
   * This allows the print dialog to show a "Selection" button.
   * 
   * Since: 2.18
   */
  g_object_class_install_property (gobject_class,
1389
				   PROP_SUPPORT_SELECTION,
1390 1391 1392 1393
				   g_param_spec_boolean ("support-selection",
							 P_("Support Selection"),
							 P_("TRUE if the print operation will support print of selection."),
							 FALSE,
1394
							 GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY));
1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405

  /**
   * GtkPrintOperation:has-selection:
   *
   * Determines whether there is a selection in your application.
   * This can allow your application to print the selection.
   * This is typically used to make a "Selection" button sensitive.
   * 
   * Since: 2.18
   */
  g_object_class_install_property (gobject_class,
1406
				   PROP_HAS_SELECTION,
1407 1408
				   g_param_spec_boolean ("has-selection",
							 P_("Has Selection"),
1409
							 P_("TRUE if a selection exists."),
1410
							 FALSE,
1411
							 GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY));
1412

1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424

  /**
   * GtkPrintOperation:embed-page-setup:
   *
   * If %TRUE, page size combo box and orientation combo box are embedded into page setup page.
   * 
   * Since: 2.18
   */
  g_object_class_install_property (gobject_class,
				   PROP_EMBED_PAGE_SETUP,
				   g_param_spec_boolean ("embed-page-setup",
							 P_("Embed Page Setup"),
1425
							 P_("TRUE if page setup combos are embedded in GtkPrintUnixDialog"),
1426
							 FALSE,
1427
							 GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY));
1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450
  /**
   * GtkPrintOperation:n-pages-to-print:
   *
   * The number of pages that will be printed.
   *
   * Note that this value is set during print preparation phase
   * (%GTK_PRINT_STATUS_PREPARING), so this value should never be
   * get before the data generation phase (%GTK_PRINT_STATUS_GENERATING_DATA).
   * You can connect to the #GtkPrintOperation::status-changed signal
   * and call gtk_print_operation_get_n_pages_to_print() when
   * print status is %GTK_PRINT_STATUS_GENERATING_DATA.
   * This is typically used to track the progress of print operation.
   *
   * Since: 2.18
   */
  g_object_class_install_property (gobject_class,
				   PROP_N_PAGES_TO_PRINT,
				   g_param_spec_int ("n-pages-to-print",
						     P_("Number of Pages To Print"),
						     P_("The number of pages that will be printed."),
						     -1,
						     G_MAXINT,
						     -1,
1451
						     GTK_PARAM_READABLE|G_PARAM_EXPLICIT_NOTIFY));
1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475
}

/**
 * gtk_print_operation_new:
 *
 * Creates a new #GtkPrintOperation. 
 *
 * Returns: a new #GtkPrintOperation
 *
 * Since: 2.10
 */
GtkPrintOperation *
gtk_print_operation_new (void)
{
  GtkPrintOperation *print_operation;

  print_operation = g_object_new (GTK_TYPE_PRINT_OPERATION, NULL);
  
  return print_operation;
}

/**
 * gtk_print_operation_set_default_page_setup:
 * @op: a #GtkPrintOperation
1476 1477
 * @default_page_setup: (allow-none): a #GtkPageSetup, or %NULL
 *
1478 1479 1480 1481
 * Makes @default_page_setup the default page setup for @op.
 *
 * This page setup will be used by gtk_print_operation_run(),
 * but it can be overridden on a per-page basis by connecting
Matthias Clasen's avatar
Matthias Clasen committed
1482
 * to the #GtkPrintOperation::request-page-setup signal.
1483 1484 1485 1486 1487 1488 1489
 *
 * Since: 2.10
 **/
void
gtk_print_operation_set_default_page_setup (GtkPrintOperation *op,
					    GtkPageSetup      *default_page_setup)
{
1490 1491
  GtkPrintOperationPrivate *priv;

1492 1493 1494 1495
  g_return_if_fail (GTK_IS_PRINT_OPERATION (op));
  g_return_if_fail (default_page_setup == NULL || 
                    GTK_IS_PAGE_SETUP (default_page_setup));

1496 1497 1498
  priv = op->priv;

  if (default_page_setup != priv->default_page_setup)
1499 1500 1501 1502
    {
      if (default_page_setup)
	g_object_ref (default_page_setup);
      
1503 1504
      if (priv->default_page_setup)
	g_object_unref (priv->default_page_setup);
1505
      
1506
      priv->default_page_setup = default_page_setup;
1507 1508 1509 1510 1511 1512 1513 1514 1515
     
      g_object_notify (G_OBJECT (op), "default-page-setup");
    }
}

/**
 * gtk_print_operation_get_default_page_setup:
 * @op: a #GtkPrintOperation
 *
1516
 * Returns the default page setup, see
1517 1518
 * gtk_print_operation_set_default_page_setup().
 *
1519
 * Returns: (transfer none): the default page setup
1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534
 *
 * Since: 2.10
 */
GtkPageSetup *
gtk_print_operation_get_default_page_setup (GtkPrintOperation *op)
{
  g_return_val_if_fail (GTK_IS_PRINT_OPERATION (op), NULL);

  return op->priv->default_page_setup;
}


/**
 * gtk_print_operation_set_print_settings:
 * @op: a #GtkPrintOperation
1535 1536
 * @print_settings: (allow-none): #GtkPrintSettings
 *
1537 1538 1539 1540 1541 1542 1543 1544 1545 1546
 * Sets the print settings for @op. This is typically used to
 * re-establish print settings from a previous print operation,
 * see gtk_print_operation_run().
 *
 * Since: 2.10
 **/
void
gtk_print_operation_set_print_settings (GtkPrintOperation *op,
					GtkPrintSettings  *print_settings)
{
1547 1548
  GtkPrintOperationPrivate *priv;

1549 1550 1551 1552
  g_return_if_fail (GTK_IS_PRINT_OPERATION (op));
  g_return_if_fail (print_settings == NULL || 
                    GTK_IS_PRINT_SETTINGS (print_settings));

1553 1554 1555
  priv = op->priv;

  if (print_settings != priv->print_settings)
1556 1557 1558 1559
    {
      if (print_settings)
        g_object_ref (print_settings);

1560 1561
      if (priv->print_settings)
        g_object_unref (priv->print_settings);
1562
  
1563
      priv->print_settings = print_settings;
1564 1565 1566 1567 1568 1569 1570 1571 1572

      g_object_notify (G_OBJECT (op), "print-settings");
    }
}

/**
 * gtk_print_operation_get_print_settings:
 * @op: a #GtkPrintOperation
 *
1573 1574 1575 1576
 * Returns the current print settings.
 *
 * Note that the return value is %NULL until either
 * gtk_print_operation_set_print_settings() or
1577
 * gtk_print_operation_run() have been called.
1578
 *
1579
 * Returns: (transfer none): the current print settings of @op.
1580
 *
Alexander Larsson's avatar