diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore index 2d8d06735a..9f143317e7 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/docs/reference/gtk/tmpl/gtkprintjob.sgml b/docs/reference/gtk/tmpl/gtkprintjob.sgml deleted file mode 100644 index 09d2681327..0000000000 --- a/docs/reference/gtk/tmpl/gtkprintjob.sgml +++ /dev/null @@ -1,186 +0,0 @@ - -GtkPrintJob - - -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(). - - - - - -Printing support was added in GTK+ 2.10. - - - - - - - - - - - - - - - -The GtkPrintJob struct contains only private members -and should not be directly accessed. - - - - - - - - -@printjob: the object which received the signal. - - - - - - - - - - - - - - - - - - - - - - - - - - - - -The type of callback that is passed to gtk_print_job_send(). -It is called when the print job has been completely sent. - - -@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 - - - - - - - -@title: -@printer: -@settings: -@page_setup: -@Returns: - - - - - - - -@job: -@Returns: - - - - - - - -@job: -@Returns: - - - - - - - -@job: -@Returns: - - - - - - - -@job: -@Returns: - - - - - - - -@job: -@filename: -@error: -@Returns: - - - - - - - -@job: -@error: -@Returns: - - - - - - - -@job: -@callback: -@user_data: -@dnotify: - - - - - - - -@job: -@track_status: - - - - - - - -@job: -@Returns: - - diff --git a/gtk/gtkprintjob.c b/gtk/gtkprintjob.c index d96af1ed48..d37e1221a9 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 #include diff --git a/gtk/gtkprintjob.h b/gtk/gtkprintjob.h index 89668a5c7e..d09004a63f 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);