[gtk+] Move GtkPrintJob docs inline
- From: Matthias Clasen <matthiasc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk+] Move GtkPrintJob docs inline
- Date: Fri, 14 Jan 2011 23:39:12 +0000 (UTC)
commit 00a3685f416b531b0bf4a21213caf08e647c0970
Author: Matthias Clasen <mclasen redhat com>
Date: Fri Jan 14 18:39:01 2011 -0500
Move GtkPrintJob docs inline
docs/reference/gtk/tmpl/.gitignore | 1 +
docs/reference/gtk/tmpl/gtkprintjob.sgml | 186 ------------------------------
gtk/gtkprintjob.c | 15 +++
gtk/gtkprintjob.h | 10 ++
4 files changed, 26 insertions(+), 186 deletions(-)
---
diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore
index 2d8d067..9f14331 100644
--- a/docs/reference/gtk/tmpl/.gitignore
+++ b/docs/reference/gtk/tmpl/.gitignore
@@ -45,6 +45,7 @@ gtkpagesetupunixdialog.sgml
gtkpaned.sgml
gtkpapersize.sgml
gtkprinter.sgml
+gtkprintjob.sgml
gtkprogressbar.sgml
gtkradioaction.sgml
gtkradiobutton.sgml
diff --git a/gtk/gtkprintjob.c b/gtk/gtkprintjob.c
index d96af1e..d37e122 100644
--- a/gtk/gtkprintjob.c
+++ b/gtk/gtkprintjob.c
@@ -17,6 +17,21 @@
* Boston, MA 02111-1307, USA.
*/
+/**
+ * SECTION:gtkprintjob
+ * @Title: GtkPrintJob
+ * @Short_description: Represents a print job
+ *
+ * A #GtkPrintJob object represents a job that is sent to a
+ * printer. You only need to deal directly with print jobs if
+ * you use the non-portable #GtkPrintUnixDialog API.
+ *
+ * Use gtk_print_job_get_surface() to obtain the cairo surface
+ * onto which the pages must be drawn. Use gtk_print_job_send()
+ * to send the finished job to the printer. If you don't use cairo
+ * #GtkPrintJob also supports printing of manually generated postscript,
+ * via gtk_print_job_set_source_file().
+ */
#include "config.h"
#include <stdlib.h>
#include <string.h>
diff --git a/gtk/gtkprintjob.h b/gtk/gtkprintjob.h
index 89668a5..d09004a 100644
--- a/gtk/gtkprintjob.h
+++ b/gtk/gtkprintjob.h
@@ -42,6 +42,16 @@ typedef struct _GtkPrintJob GtkPrintJob;
typedef struct _GtkPrintJobClass GtkPrintJobClass;
typedef struct _GtkPrintJobPrivate GtkPrintJobPrivate;
+/**
+ * GtkPrintJobCompleteFunc:
+ * @print_job: the #GtkPrintJob
+ * @user_data: user data that has been passed to gtk_print_job_send()
+ * @error: a #GError that contains error information if the sending
+ * of the print job failed, otherwise %NULL
+ *
+ * The type of callback that is passed to gtk_print_job_send().
+ * It is called when the print job has been completely sent.
+ */
typedef void (*GtkPrintJobCompleteFunc) (GtkPrintJob *print_job,
gpointer user_data,
const GError *error);
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]