Documentation fixes
svn path=/trunk/; revision=21217
This commit is contained in:
		@ -1,3 +1,7 @@
 | 
				
			|||||||
 | 
					2008-08-27  Matthias Clasen  <mclasen@redhat.com>
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
						* gtk/gtkprintoperation.c: Documentation fixes.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
2008-08-27  Matthias Clasen  <mclasen@redhat.com>
 | 
					2008-08-27  Matthias Clasen  <mclasen@redhat.com>
 | 
				
			||||||
 | 
					
 | 
				
			||||||
	* gdk/x11/gdkwindow-x11.c:
 | 
						* gdk/x11/gdkwindow-x11.c:
 | 
				
			||||||
 | 
				
			|||||||
@ -565,9 +565,10 @@ gtk_print_operation_class_init (GtkPrintOperationClass *class)
 | 
				
			|||||||
   * @result: the result of the print operation
 | 
					   * @result: the result of the print operation
 | 
				
			||||||
   *
 | 
					   *
 | 
				
			||||||
   * Emitted when the print operation run has finished doing
 | 
					   * Emitted when the print operation run has finished doing
 | 
				
			||||||
   * everything required for printing. @result gives you information
 | 
					   * everything required for printing. 
 | 
				
			||||||
   * about what happened during the run. If @result is
 | 
					   *
 | 
				
			||||||
   * %GTK_PRINT_OPERATION_RESULT_ERROR then you can call
 | 
					   * @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.
 | 
					   * gtk_print_operation_get_error() for more information.
 | 
				
			||||||
   *
 | 
					   *
 | 
				
			||||||
   * If you enabled print status tracking then 
 | 
					   * 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
 | 
					   * @context: the #GtkPrintContext for the current operation
 | 
				
			||||||
   *
 | 
					   *
 | 
				
			||||||
   * Emitted after the #GtkPrintOperation::begin-print signal, but before 
 | 
					   * Emitted after the #GtkPrintOperation::begin-print signal, but before 
 | 
				
			||||||
   * the actual rendering starts. It keeps getting emitted until it 
 | 
					   * the actual rendering starts. It keeps getting emitted until a connected 
 | 
				
			||||||
   * returns %FALSE. 
 | 
					   * 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
 | 
					   * in small chunks, to avoid blocking the user interface for a long
 | 
				
			||||||
   * time. The signal handler should update the number of pages using
 | 
					   * time. The signal handler should update the number of pages using
 | 
				
			||||||
   * gtk_print_operation_set_n_pages(), and return %TRUE if the document
 | 
					   * 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
 | 
					   * tab in the print dialog. You typically return a container widget
 | 
				
			||||||
   * with multiple widgets in it.
 | 
					   * with multiple widgets in it.
 | 
				
			||||||
   *
 | 
					   *
 | 
				
			||||||
   * The print dialog owns the returned widget, and its lifetime
 | 
					   * The print dialog owns the returned widget, and its lifetime is not 
 | 
				
			||||||
   * isn't controlled by the app. However, the widget is guaranteed
 | 
					   * controlled by the application. However, the widget is guaranteed 
 | 
				
			||||||
   * to stay around until the #GtkPrintOperation::custom-widget-apply 
 | 
					   * to stay around until the #GtkPrintOperation::custom-widget-apply 
 | 
				
			||||||
   * signal is emitted on the operation. Then you can read out any 
 | 
					   * signal is emitted on the operation. Then you can read out any 
 | 
				
			||||||
   * information you need from the widgets.
 | 
					   * 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
 | 
					   * Some systems don't support asynchronous printing, but those that do
 | 
				
			||||||
   * will return %GTK_PRINT_OPERATION_RESULT_IN_PROGRESS as the status, and
 | 
					   * 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
 | 
					   * The Windows port does not support asynchronous operation at all (this 
 | 
				
			||||||
   * at all (this is unlikely to change). On other platforms, all actions
 | 
					   * is unlikely to change). On other platforms, all actions except for 
 | 
				
			||||||
   * except for %GTK_PRINT_OPERATION_ACTION_EXPORT support asynchronous
 | 
					   * %GTK_PRINT_OPERATION_ACTION_EXPORT support asynchronous operation.
 | 
				
			||||||
   * operation.
 | 
					 | 
				
			||||||
   *
 | 
					   *
 | 
				
			||||||
   * Since: 2.10
 | 
					   * Since: 2.10
 | 
				
			||||||
   */
 | 
					   */
 | 
				
			||||||
@ -1077,9 +1078,8 @@ gtk_print_operation_class_init (GtkPrintOperationClass *class)
 | 
				
			|||||||
  /**
 | 
					  /**
 | 
				
			||||||
   * GtkPrintOperation:export-filename:
 | 
					   * GtkPrintOperation:export-filename:
 | 
				
			||||||
   *
 | 
					   *
 | 
				
			||||||
   * The name of a file file to generate instead of showing 
 | 
					   * The name of a file to generate instead of showing the print dialog. 
 | 
				
			||||||
   * the print dialog. Currently, PDF is the only supported
 | 
					   * Currently, PDF is the only supported format.
 | 
				
			||||||
   * format.
 | 
					 | 
				
			||||||
   *
 | 
					   *
 | 
				
			||||||
   * The intended use of this property is for implementing 
 | 
					   * The intended use of this property is for implementing 
 | 
				
			||||||
   * "Export to PDF" actions.
 | 
					   * "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 
 | 
					   * The string is translated and suitable for displaying the print 
 | 
				
			||||||
   * status e.g. in a #GtkStatusbar.
 | 
					   * status e.g. in a #GtkStatusbar.
 | 
				
			||||||
   *
 | 
					   *
 | 
				
			||||||
   * See the ::status property for a status value that is suitable 
 | 
					   * See the #GtkPrintOperation:status property for a status value that 
 | 
				
			||||||
   * for programmatic use. 
 | 
					   * is suitable for programmatic use. 
 | 
				
			||||||
   *
 | 
					   *
 | 
				
			||||||
   * Since: 2.10
 | 
					   * Since: 2.10
 | 
				
			||||||
   */
 | 
					   */
 | 
				
			||||||
@ -2333,7 +2333,7 @@ print_pages (GtkPrintOperation       *op,
 | 
				
			|||||||
          gtk_message_dialog_format_secondary_text (GTK_MESSAGE_DIALOG (error_dialog),
 | 
					          gtk_message_dialog_format_secondary_text (GTK_MESSAGE_DIALOG (error_dialog),
 | 
				
			||||||
                                                    _("The most probable reason is that a temporary file could not be created."));
 | 
					                                                    _("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));
 | 
					            gtk_window_group_add_window (parent->group, GTK_WINDOW (error_dialog));
 | 
				
			||||||
 | 
					
 | 
				
			||||||
          g_signal_connect (error_dialog, "response",
 | 
					          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. 
 | 
					 * information about the progress of the print operation. 
 | 
				
			||||||
 * Furthermore, it may use a recursive mainloop to show the print dialog.
 | 
					 * 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
 | 
					 * If you call gtk_print_operation_set_allow_async() or set the 
 | 
				
			||||||
 * property the operation will run asyncronously if this is supported on the
 | 
					 * #GtkPrintOperation:allow-async property the operation will run 
 | 
				
			||||||
 * platform. The #GtkPrintOperation::done signal will be emitted with the 
 | 
					 * asynchronously if this is supported on the platform. The 
 | 
				
			||||||
 * operation results when the operation is done (i.e. when the dialog is 
 | 
					 * #GtkPrintOperation::done signal will be emitted with the result of the 
 | 
				
			||||||
 * canceled, or when the print succeeds or fails).
 | 
					 * operation when the it is done (i.e. when the dialog is canceled, or when 
 | 
				
			||||||
 | 
					 * the print succeeds or fails).
 | 
				
			||||||
 * |[
 | 
					 * |[
 | 
				
			||||||
 * if (settings != NULL)
 | 
					 * if (settings != NULL)
 | 
				
			||||||
 *   gtk_print_operation_set_print_settings (print, settings);
 | 
					 *   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() 
 | 
					 *   the used print settings with gtk_print_operation_get_print_settings() 
 | 
				
			||||||
 *   and store them for reuse with the next print operation. A value of
 | 
					 *   and store them for reuse with the next print operation. A value of
 | 
				
			||||||
 *   %GTK_PRINT_OPERATION_RESULT_IN_PROGRESS means the operation is running
 | 
					 *   %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
 | 
					 * Since: 2.10
 | 
				
			||||||
 **/
 | 
					 **/
 | 
				
			||||||
 | 
				
			|||||||
		Reference in New Issue
	
	Block a user