PROP_IS_VIRTUAL,
g_param_spec_boolean ("is-virtual",
P_("Is Virtual"),
- P_("False if this represents a real hardware printer"),
+ P_("FALSE if this represents a real hardware printer"),
FALSE,
GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
g_object_class_install_property (G_OBJECT_CLASS (class),
0,
GTK_PARAM_READABLE));
-
+ /**
+ * GtkPrinter::details-acquired:
+ * @printer: the #GtkPrinter on which the signal is emitted
+ * @success: %TRUE if the details were successfully acquired
+ *
+ * Gets emitted in response to a request for detailed information
+ * about a printer from the print backend. The @success parameter
+ * indicates if the information was actually obtained.
+ *
+ * Since: 2.10
+ */
signals[DETAILS_ACQUIRED] =
g_signal_new ("details-acquired",
G_TYPE_FROM_CLASS (class),
/**
* gtk_printer_new:
+ * @name: the name of the printer
+ * @backend: a #GtkPrintBackend
+ * @gboolean: whether the printer is virtual
*
* Creates a new #GtkPrinter.
*
* Return value: a new #GtkPrinter
*
- * Since: 2.8
+ * Since: 2.10
**/
GtkPrinter *
-gtk_printer_new (const char *name,
+gtk_printer_new (const gchar *name,
GtkPrintBackend *backend,
gboolean virtual)
{
return (GtkPrinter *) result;
}
+/**
+ * gtk_printer_get_backend:
+ * @printer: a #GtkPrinter
+ *
+ * Returns the backend of the printer.
+ *
+ * Return value: the backend of @printer
+ *
+ * Since: 2.10
+ */
GtkPrintBackend *
gtk_printer_get_backend (GtkPrinter *printer)
{
gtk_printer_set_backend (GtkPrinter *printer,
GtkPrintBackend *backend)
{
+ g_return_if_fail (GTK_IS_PRINTER (printer));
+ g_return_if_fail (GTK_IS_PRINT_BACKEND (backend));
+
if (printer->priv->backend)
g_object_unref (printer->priv->backend);
printer->priv->backend = g_object_ref (backend);
}
-const gchar *
+/**
+ * gtk_printer_get_name:
+ * @printer: a #GtkPrinter
+ *
+ * Returns the name of the printer.
+ *
+ * Return value: the name of @printer
+ *
+ * Since: 2.10
+ */
+G_CONST_RETURN gchar *
gtk_printer_get_name (GtkPrinter *printer)
{
g_return_val_if_fail (GTK_IS_PRINTER (printer), NULL);
return printer->priv->name;
}
-const gchar *
+/**
+ * gtk_printer_get_description:
+ * @printer: a #GtkPrinter
+ *
+ * Gets the description of the printer.
+ *
+ * Return value: the description of @printer
+ *
+ * Since: 2.10
+ */
+G_CONST_RETURN gchar *
gtk_printer_get_description (GtkPrinter *printer)
{
g_return_val_if_fail (GTK_IS_PRINTER (printer), NULL);
}
gboolean
-gtk_printer_set_description (GtkPrinter *printer,
- const char *description)
+gtk_printer_set_description (GtkPrinter *printer,
+ const gchar *description)
{
+ g_return_val_if_fail (GTK_IS_PRINTER (printer), FALSE);
+
if (safe_strcmp (printer->priv->description, description) == 0)
return FALSE;
return TRUE;
}
-const gchar *
+/**
+ * gtk_printer_get_state_message:
+ * @printer: a #GtkPrinter
+ *
+ * Returns the state message describing the current state
+ * of the printer.
+ *
+ * Return value: the state message of @printer
+ *
+ * Since: 2.10
+ */
+G_CONST_RETURN gchar *
gtk_printer_get_state_message (GtkPrinter *printer)
{
g_return_val_if_fail (GTK_IS_PRINTER (printer), NULL);
}
gboolean
-gtk_printer_set_state_message (GtkPrinter *printer,
- const char *message)
+gtk_printer_set_state_message (GtkPrinter *printer,
+ const gchar *message)
{
+ g_return_val_if_fail (GTK_IS_PRINTER (printer), FALSE);
+
if (safe_strcmp (printer->priv->state_message, message) == 0)
return FALSE;
return TRUE;
}
-const gchar *
+/**
+ * gtk_printer_get_location:
+ * @printer: a #GtkPrinter
+ *
+ * Returns a description of the location of the printer.
+ *
+ * Return value: the location of @printer
+ *
+ * Since: 2.10
+ */
+G_CONST_RETURN gchar *
gtk_printer_get_location (GtkPrinter *printer)
{
g_return_val_if_fail (GTK_IS_PRINTER (printer), NULL);
}
gboolean
-gtk_printer_set_location (GtkPrinter *printer,
- const char *location)
+gtk_printer_set_location (GtkPrinter *printer,
+ const gchar *location)
{
+ g_return_val_if_fail (GTK_IS_PRINTER (printer), FALSE);
+
if (safe_strcmp (printer->priv->location, location) == 0)
return FALSE;
return TRUE;
}
-const gchar *
+/**
+ * gtk_printer_get_icon_name:
+ * @printer: a #GtkPrinter
+ *
+ * Gets the name of the icon to use for the printer.
+ *
+ * Return value: the icon name for @printer
+ *
+ * Since: 2.10
+ */
+G_CONST_RETURN gchar *
gtk_printer_get_icon_name (GtkPrinter *printer)
{
g_return_val_if_fail (GTK_IS_PRINTER (printer), NULL);
}
void
-gtk_printer_set_icon_name (GtkPrinter *printer,
- const char *icon)
+gtk_printer_set_icon_name (GtkPrinter *printer,
+ const gchar *icon)
{
+ g_return_if_fail (GTK_IS_PRINTER (printer));
+
g_free (printer->priv->icon_name);
printer->priv->icon_name = g_strdup (icon);
g_object_notify (G_OBJECT (printer), "icon-name");
}
+/**
+ * gtk_printer_get_job_count:
+ * @printer: a #GtkPrinter
+ *
+ * Gets the number of jobs currently queued on the printer.
+ *
+ * Return value: the number of jobs on @printer
+ *
+ * Since: 2.10
+ */
gint
gtk_printer_get_job_count (GtkPrinter *printer)
{
gboolean
gtk_printer_set_job_count (GtkPrinter *printer,
- int count)
+ gint count)
{
+ g_return_val_if_fail (GTK_IS_PRINTER (printer), FALSE);
+
if (printer->priv->job_count == count)
return FALSE;
gboolean
_gtk_printer_has_details (GtkPrinter *printer)
{
- g_return_val_if_fail (GTK_IS_PRINTER (printer), TRUE);
-
return printer->priv->has_details;
}
printer->priv->has_details = val;
}
+/**
+ * gtk_printer_is_active:
+ * @printer: a #GtkPrinter
+ *
+ * Returns whether the printer is currently active (i.e.
+ * accepts new jobs).
+ *
+ * Return value: %TRUE if @printer is active
+ *
+ * Since: 2.10
+ */
gboolean
gtk_printer_is_active (GtkPrinter *printer)
{
gtk_printer_set_is_active (GtkPrinter *printer,
gboolean val)
{
+ g_return_if_fail (GTK_IS_PRINTER (printer));
+
printer->priv->is_active = val;
}
+/**
+ * gtk_printer_is_virtual:
+ * @printer: a #GtkPrinter
+ *
+ * Returns whether the printer is virtual (i.e. does not
+ * represent actual printer hardware, but something like
+ * a CUPS class).
+ *
+ * Return value: %TRUE if @printer is virtual
+ *
+ * Since: 2.10
+ */
gboolean
gtk_printer_is_virtual (GtkPrinter *printer)
{
gtk_printer_set_is_new (GtkPrinter *printer,
gboolean val)
{
+ g_return_if_fail (GTK_IS_PRINTER (printer));
+
printer->priv->is_new = val;
}
+/**
+ * gtk_printer_is_default:
+ * @printer: a #GtkPrinter
+ *
+ * Returns whether the printer is the default printer.
+ *
+ * Return value: %TRUE if @printer is the default
+ *
+ * Since: 2.10
+ */
gboolean
gtk_printer_is_default (GtkPrinter *printer)
{
void
gtk_printer_set_is_default (GtkPrinter *printer,
- gboolean val)
+ gboolean val)
{
+ g_return_if_fail (GTK_IS_PRINTER (printer));
+
printer->priv->is_default = TRUE;
}
}
GtkPrinterOptionSet *
-_gtk_printer_get_options (GtkPrinter *printer,
+_gtk_printer_get_options (GtkPrinter *printer,
GtkPrintSettings *settings,
- GtkPageSetup *page_setup)
+ GtkPageSetup *page_setup)
{
GtkPrintBackendIface *backend_iface = GTK_PRINT_BACKEND_GET_IFACE (printer->priv->backend);
return backend_iface->printer_get_options (printer, settings, page_setup);
}
void
-_gtk_printer_prepare_for_print (GtkPrinter *printer,
- GtkPrintJob *print_job,
+_gtk_printer_prepare_for_print (GtkPrinter *printer,
+ GtkPrintJob *print_job,
GtkPrintSettings *settings,
- GtkPageSetup *page_setup)
+ GtkPageSetup *page_setup)
{
GtkPrintBackendIface *backend_iface = GTK_PRINT_BACKEND_GET_IFACE (printer->priv->backend);
return backend_iface->printer_prepare_for_print (printer, print_job, settings, page_setup);
cairo_surface_t *
_gtk_printer_create_cairo_surface (GtkPrinter *printer,
- gdouble width,
- gdouble height,
- gint cache_fd)
+ gdouble width,
+ gdouble height,
+ gint cache_fd)
{
GtkPrintBackendIface *backend_iface = GTK_PRINT_BACKEND_GET_IFACE (printer->priv->backend);
}
void
-_gtk_printer_get_hard_margins (GtkPrinter *printer,
- double *top,
- double *bottom,
- double *left,
- double *right)
+_gtk_printer_get_hard_margins (GtkPrinter *printer,
+ gdouble *top,
+ gdouble *bottom,
+ gdouble *left,
+ gdouble *right)
{
GtkPrintBackendIface *backend_iface = GTK_PRINT_BACKEND_GET_IFACE (printer->priv->backend);
projects / ~andy / gtk / blobdiff