summaryrefslogtreecommitdiff
path: root/gtk/gtkprintoperation.c
diff options
context:
space:
mode:
authorMatthias Clasen <matthiasc@src.gnome.org>2008-08-28 02:27:14 +0000
committerMatthias Clasen <matthiasc@src.gnome.org>2008-08-28 02:27:14 +0000
commit3f53433008769dd4bbe738b45c8fb2638461af84 (patch)
treecf9a7d7e690f556524a86484aa6f660ae442c321 /gtk/gtkprintoperation.c
parent7cc3908418c32e45a2032d9908270aa80cfed310 (diff)
downloadgtk+-3f53433008769dd4bbe738b45c8fb2638461af84.tar.gz
Documentation fixes
svn path=/trunk/; revision=21217
Diffstat (limited to 'gtk/gtkprintoperation.c')
-rw-r--r--gtk/gtkprintoperation.c52
1 files changed, 27 insertions, 25 deletions
diff --git a/gtk/gtkprintoperation.c b/gtk/gtkprintoperation.c
index 316698da29..321240d82e 100644
--- a/gtk/gtkprintoperation.c
+++ b/gtk/gtkprintoperation.c
@@ -565,9 +565,10 @@ gtk_print_operation_class_init (GtkPrintOperationClass *class)
* @result: the result of the print operation
*
* Emitted when the print operation run has finished doing
- * 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
+ * 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
* gtk_print_operation_get_error() for more information.
*
* If you enabled print status tracking then
@@ -614,10 +615,10 @@ gtk_print_operation_class_init (GtkPrintOperationClass *class)
* @context: the #GtkPrintContext for the current operation
*
* Emitted after the #GtkPrintOperation::begin-print signal, but before
- * the actual rendering starts. It keeps getting emitted until it
- * returns %FALSE.
+ * the actual rendering starts. It keeps getting emitted until a connected
+ * signal handler returns %TRUE.
*
- * The ::paginate signal is intended to be used for paginating the document
+ * The ::paginate signal is intended to be used for paginating a document
* 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
@@ -784,8 +785,8 @@ gtk_print_operation_class_init (GtkPrintOperationClass *class)
* tab in the print dialog. You typically return a container widget
* with multiple widgets in it.
*
- * The print dialog owns the returned widget, and its lifetime
- * isn't controlled by the app. However, the widget is guaranteed
+ * The print dialog owns the returned widget, and its lifetime is not
+ * controlled by the application. However, the widget is guaranteed
* 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.
@@ -1057,12 +1058,12 @@ gtk_print_operation_class_init (GtkPrintOperationClass *class)
*
* Some systems don't support asynchronous printing, but those that do
* will return %GTK_PRINT_OPERATION_RESULT_IN_PROGRESS as the status, and
- * emit the done signal when the operation is actually done.
+ * emit the #GtkPrintOperation::done signal when the operation is actually
+ * done.
*
- * 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.
+ * 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.
*
* Since: 2.10
*/
@@ -1077,9 +1078,8 @@ gtk_print_operation_class_init (GtkPrintOperationClass *class)
/**
* GtkPrintOperation:export-filename:
*
- * The name of a file file to generate instead of showing
- * the print dialog. Currently, PDF is the only supported
- * format.
+ * The name of a file to generate instead of showing the print dialog.
+ * Currently, PDF is the only supported format.
*
* The intended use of this property is for implementing
* "Export to PDF" actions.
@@ -1121,8 +1121,8 @@ gtk_print_operation_class_init (GtkPrintOperationClass *class)
* The string is translated and suitable for displaying the print
* status e.g. in a #GtkStatusbar.
*
- * See the ::status property for a status value that is suitable
- * for programmatic use.
+ * See the #GtkPrintOperation:status property for a status value that
+ * is suitable for programmatic use.
*
* Since: 2.10
*/
@@ -2333,7 +2333,7 @@ print_pages (GtkPrintOperation *op,
gtk_message_dialog_format_secondary_text (GTK_MESSAGE_DIALOG (error_dialog),
_("The most probable reason is that a temporary file could not be created."));
- if (parent->group)
+ if (parent && parent->group)
gtk_window_group_add_window (parent->group, GTK_WINDOW (error_dialog));
g_signal_connect (error_dialog, "response",
@@ -2428,11 +2428,12 @@ gtk_print_operation_get_error (GtkPrintOperation *op,
* information about the progress of the print operation.
* Furthermore, it may use a recursive mainloop to show the print dialog.
*
- * If you call gtk_print_operation_set_allow_async() or set the allow-async
- * property the operation will run asyncronously if this is supported on the
- * platform. The #GtkPrintOperation::done signal will be emitted with the
- * operation results when the operation is done (i.e. when the dialog is
- * canceled, or when the print succeeds or fails).
+ * If you call gtk_print_operation_set_allow_async() or set the
+ * #GtkPrintOperation:allow-async property the operation will run
+ * asynchronously if this is supported on the platform. The
+ * #GtkPrintOperation::done signal will be emitted with the result of the
+ * operation when the it is done (i.e. when the dialog is canceled, or when
+ * the print succeeds or fails).
* |[
* if (settings != NULL)
* gtk_print_operation_set_print_settings (print, settings);
@@ -2480,7 +2481,8 @@ gtk_print_operation_get_error (GtkPrintOperation *op,
* the used print settings with gtk_print_operation_get_print_settings()
* and store them for reuse with the next print operation. A value of
* %GTK_PRINT_OPERATION_RESULT_IN_PROGRESS means the operation is running
- * asynchronously, and will emit the ::done signal when done.
+ * asynchronously, and will emit the #GtkPrintOperation::done signal when
+ * done.
*
* Since: 2.10
**/