Session Functions
[Printing]

Data Structures
struct	PrintSession
Functions
PrintSession *	gnc_print_session_create (gboolean hand_built_pages)
void	gnc_print_session_destroy (PrintSession *ps)
void	gnc_print_session_done (PrintSession *ps)

---

Function Documentation

PrintSession* gnc_print_session_create

(

gboolean

hand_built_pages

)

Create a new print 'session'. Once created, a series of commands can be issued on the session to create the output page. The output will be printed when the session is done. This function will present the standard print/preview selection box to the user and wait for the result.

If the hand_built_pages argument is set to TRUE, this function will perform a couple of extra setup steps. Specifically it will call the gnome begin page, set color and set font functions. The code will also call close page when the gnc_print_session_done function is called.

Parameters:

hand_built_pages

If TRUE, this funciton will perform extra setup.

Returns:

A pointer to the data structure describing this print session.

Definition at line 130 of file print-session.c.

{
  PrintSession * ps = g_new0(PrintSession, 1);
  GnomePrintConfig *config;
  GtkWidget *dialog;
  gint response;

  /* Ask the user what to do with the output */
  config = gnome_print_config_default();
  ps->job = gnome_print_job_new(config);
  g_object_unref(config);
  dialog = gnome_print_dialog_new(ps->job, (guchar *) _("Print GnuCash Document"), 0);
  response = gtk_dialog_run(GTK_DIALOG(dialog));
  switch (response) {
    case GNOME_PRINT_DIALOG_RESPONSE_PRINT: 
    case GNOME_PRINT_DIALOG_RESPONSE_PREVIEW:
      gtk_widget_destroy(dialog);
      ps->context = gnome_print_job_get_context(ps->job);
      break;
    
    default:
      gtk_widget_destroy(dialog);
      g_object_unref(ps->job);
      g_free(ps);
      return NULL;
  }

  ps->hand_built_pages = hand_built_pages;
  ps->print_type = response;

  ps->default_font = gnome_font_find_closest((guchar *)"Sans Regular", 12);

  if (hand_built_pages) {
    gnome_print_beginpage(ps->context, (guchar *)"");
    gnome_print_setrgbcolor(ps->context, 0.0, 0.0, 0.0);
    gnome_print_setfont(ps->context, ps->default_font);
  }
  return ps;
}

void gnc_print_session_destroy

(

PrintSession *

ps

)

Destroy a print 'session' without producing any output.

Parameters:

ps

A pointer to the session to be destroyed.

Definition at line 171 of file print-session.c.

{
  g_object_unref(ps->job);
  g_object_unref(ps->default_font);

  g_free(ps);
}

void gnc_print_session_done

(

PrintSession *

ps

)

Finish a print 'session'. The output from this session will be printed to the device selected when the session was created.

Parameters:

ps

A pointer to the session to be closed.

Definition at line 181 of file print-session.c.

{
  GtkWidget *widget;

  if (ps->hand_built_pages) {
    gnome_print_showpage(ps->context);
  }
  gnome_print_job_close (ps->job);

  switch (ps->print_type) {
    case GNOME_PRINT_DIALOG_RESPONSE_PRINT: 
      gnome_print_job_print(ps->job);
      break;

    case GNOME_PRINT_DIALOG_RESPONSE_PREVIEW:
      widget = gnome_print_job_preview_new(ps->job, (guchar*)"Print Preview");
      gtk_widget_show(widget);
      break;
    
    default:
      break;
  }
}

---