]> Pileus Git - ~andy/gtk/blobdiff - gtk/gtkprintjob.c
GtkEntry: Sanity check the end_pos value in _get_display_text()
[~andy/gtk] / gtk / gtkprintjob.c
index d96af1ed48825af458061df6fc4096cc1369e69e..49c664d88fcd5d228b8dd2a06841239d3f39c0ab 100644 (file)
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * 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>
@@ -321,7 +334,7 @@ gtk_print_job_new (const gchar      *title,
  * 
  * Gets the #GtkPrintSettings of the print job.
  * 
- * Return value: the settings of @job
+ * Return value: (transfer none): the settings of @job
  *
  * Since: 2.10
  */
@@ -339,7 +352,7 @@ gtk_print_job_get_settings (GtkPrintJob *job)
  * 
  * Gets the #GtkPrinter of the print job.
  * 
- * Return value: the printer of @job
+ * Return value: (transfer none): the printer of @job
  *
  * Since: 2.10
  */
@@ -361,7 +374,7 @@ gtk_print_job_get_printer (GtkPrintJob *job)
  *
  * Since: 2.10
  */
-G_CONST_RETURN gchar *
+const gchar *
 gtk_print_job_get_title (GtkPrintJob *job)
 {
   g_return_val_if_fail (GTK_IS_PRINT_JOB (job), NULL);
@@ -407,7 +420,7 @@ gtk_print_job_set_status (GtkPrintJob   *job,
 /**
  * gtk_print_job_set_source_file:
  * @job: a #GtkPrintJob
- * @filename: the file to be printed
+ * @filename: (type filename): the file to be printed
  * @error: return location for errors
  * 
  * Make the #GtkPrintJob send an existing document to the 
@@ -456,7 +469,7 @@ gtk_print_job_set_source_file (GtkPrintJob *job,
  * Gets a cairo surface onto which the pages of
  * the print job should be rendered.
  * 
- * Return value: the cairo surface of @job
+ * Return value: (transfer none): the cairo surface of @job
  *
  * Since: 2.10
  **/
@@ -734,7 +747,8 @@ gtk_print_job_set_pages (GtkPrintJob   *job,
  *
  * Gets the page ranges for this job.
  *
- * Returns: a pointer to an array of #GtkPageRange structs
+ * Returns: (array length=n_ranges) (transfer none): a pointer to an
+ * array of #GtkPageRange structs
  *
  * Since: 3.0
  */
@@ -749,7 +763,8 @@ gtk_print_job_get_page_ranges (GtkPrintJob *job,
 /**
  * gtk_print_job_set_page_ranges:
  * @job: a #GtkPrintJob
- * @ranges: pointer to an array of #GtkPageRange structs
+ * @ranges: (array length=n_ranges): pointer to an array of
+ *    #GtkPageRange structs
  * @n_ranges: the length of the @ranges array
  *
  * Sets the page ranges for this job.
@@ -975,7 +990,7 @@ gtk_print_job_get_collate (GtkPrintJob *job)
 }
 
 /**
- * gtk_print_job_set_collated:
+ * gtk_print_job_set_collate:
  * @job: a #GtkPrintJob
  * @collate: whether the job is printed collated
  *