]> Pileus Git - ~andy/gtk/blobdiff - gtk/gtkprinter.c
stylecontext: Do invalidation on first resize container
[~andy/gtk] / gtk / gtkprinter.c
index 15c866f8a110bafb8096d8efdf188f359c382e02..fac0136fe5b6bb3433cbdb59f6eb45baa66c903d 100644 (file)
@@ -12,9 +12,7 @@
  * 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/>.
  */
 
 #include "config.h"
 #include "gtkprinter-private.h"
 #include "gtkprintbackend.h"
 #include "gtkprintjob.h"
-#include "gtkalias.h"
 
-#define GTK_PRINTER_GET_PRIVATE(o)  \
-   (G_TYPE_INSTANCE_GET_PRIVATE ((o), GTK_TYPE_PRINTER, GtkPrinterPrivate))
+/**
+ * SECTION:gtkprinter
+ * @Short_description: Represents a printer
+ * @Title: GtkPrinter
+ *
+ * A #GtkPrinter object represents a printer. You only need to
+ * deal directly with printers if you use the non-portable
+ * #GtkPrintUnixDialog API.
+ *
+ * A #GtkPrinter allows to get status information about the printer,
+ * such as its description, its location, the number of queued jobs,
+ * etc. Most importantly, a #GtkPrinter object can be used to create
+ * a #GtkPrintJob object, which lets you print to the printer.
+ *
+ * Printing support was added in GTK+ 2.10.
+ */
+
 
 static void gtk_printer_finalize     (GObject *object);
 
@@ -43,13 +55,15 @@ struct _GtkPrinterPrivate
   gchar *description;
   gchar *icon_name;
 
-  guint is_active   : 1;
-  guint is_new      : 1;
-  guint is_virtual  : 1;
-  guint is_default  : 1;
-  guint has_details : 1;
-  guint accepts_pdf : 1;
-  guint accepts_ps  : 1;
+  guint is_active         : 1;
+  guint is_paused         : 1;
+  guint is_accepting_jobs : 1;
+  guint is_new            : 1;
+  guint is_virtual        : 1;
+  guint is_default        : 1;
+  guint has_details       : 1;
+  guint accepts_pdf       : 1;
+  guint accepts_ps        : 1;
 
   gchar *state_message;  
   gint job_count;
@@ -72,7 +86,9 @@ enum {
   PROP_ICON_NAME,
   PROP_JOB_COUNT,
   PROP_ACCEPTS_PDF,
-  PROP_ACCEPTS_PS
+  PROP_ACCEPTS_PS,
+  PROP_PAUSED,
+  PROP_ACCEPTING_JOBS
 };
 
 static guint signals[LAST_SIGNAL] = { 0 };
@@ -88,18 +104,6 @@ static void gtk_printer_get_property (GObject      *object,
 
 G_DEFINE_TYPE (GtkPrinter, gtk_printer, G_TYPE_OBJECT)
 
-static int
-safe_strcmp (const char *a, const char *b)
-{
-  if (a == b)
-    return 0;
-  if (a == NULL)
-    return -1;
-  if (b == NULL)
-    return 1;
-  return strcmp (a, b);
-}
-
 static void
 gtk_printer_class_init (GtkPrinterClass *class)
 {
@@ -139,7 +143,7 @@ gtk_printer_class_init (GtkPrinterClass *class)
                                    g_param_spec_boolean ("accepts-pdf",
                                                         P_("Accepts PDF"),
                                                         P_("TRUE if this printer can accept PDF"),
-                                                        TRUE,
+                                                        FALSE,
                                                         GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
   g_object_class_install_property (G_OBJECT_CLASS (class),
                                    PROP_ACCEPTS_PS,
@@ -179,6 +183,37 @@ gtk_printer_class_init (GtkPrinterClass *class)
                                                     0,
                                                     GTK_PARAM_READABLE));
 
+  /**
+   * GtkPrinter:paused:
+   *
+   * This property is %TRUE if this printer is paused. 
+   * A paused printer still accepts jobs, but it does 
+   * not print them.
+   *
+   * Since: 2.14
+   */
+  g_object_class_install_property (G_OBJECT_CLASS (class),
+                                   PROP_PAUSED,
+                                   g_param_spec_boolean ("paused",
+                                                        P_("Paused Printer"),
+                                                        P_("TRUE if this printer is paused"),
+                                                        FALSE,
+                                                        GTK_PARAM_READABLE));
+  /**
+   * GtkPrinter:accepting-jobs:
+   *
+   * This property is %TRUE if the printer is accepting jobs.
+   *
+   * Since: 2.14
+   */ 
+  g_object_class_install_property (G_OBJECT_CLASS (class),
+                                   PROP_ACCEPTING_JOBS,
+                                   g_param_spec_boolean ("accepting-jobs",
+                                                        P_("Accepting Jobs"),
+                                                        P_("TRUE if this printer is accepting new jobs"),
+                                                        TRUE,
+                                                        GTK_PARAM_READABLE));
+
   /**
    * GtkPrinter::details-acquired:
    * @printer: the #GtkPrinter on which the signal is emitted
@@ -205,7 +240,9 @@ gtk_printer_init (GtkPrinter *printer)
 {
   GtkPrinterPrivate *priv;
 
-  priv = printer->priv = GTK_PRINTER_GET_PRIVATE (printer); 
+  priv = printer->priv = G_TYPE_INSTANCE_GET_PRIVATE (printer,
+                                                      GTK_TYPE_PRINTER,
+                                                      GtkPrinterPrivate);
 
   priv->name = NULL;
   priv->location = NULL;
@@ -213,9 +250,11 @@ gtk_printer_init (GtkPrinter *printer)
   priv->icon_name = NULL;
 
   priv->is_active = TRUE;
+  priv->is_paused = FALSE;
+  priv->is_accepting_jobs = TRUE;
   priv->is_new = TRUE;
   priv->has_details = FALSE;
-  priv->accepts_pdf = TRUE;
+  priv->accepts_pdf = FALSE;
   priv->accepts_ps = TRUE;
 
   priv->state_message = NULL;  
@@ -327,6 +366,12 @@ gtk_printer_get_property (GObject    *object,
     case PROP_ACCEPTS_PS:
       g_value_set_boolean (value, priv->accepts_ps);
       break;
+    case PROP_PAUSED:
+      g_value_set_boolean (value, priv->is_paused);
+      break;
+    case PROP_ACCEPTING_JOBS:
+      g_value_set_boolean (value, priv->is_accepting_jobs);
+      break;
     default:
       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
       break;
@@ -367,7 +412,7 @@ gtk_printer_new (const gchar     *name,
  * 
  * Returns the backend of the printer.
  * 
- * Return value: the backend of @printer
+ * Return value: (transfer none): the backend of @printer
  * 
  * Since: 2.10
  */
@@ -389,7 +434,7 @@ gtk_printer_get_backend (GtkPrinter *printer)
  *
  * Since: 2.10
  */
-G_CONST_RETURN gchar *
+const gchar *
 gtk_printer_get_name (GtkPrinter *printer)
 {
   g_return_val_if_fail (GTK_IS_PRINTER (printer), NULL);
@@ -407,7 +452,7 @@ gtk_printer_get_name (GtkPrinter *printer)
  *
  * Since: 2.10
  */
-G_CONST_RETURN gchar *
+const gchar *
 gtk_printer_get_description (GtkPrinter *printer)
 {
   g_return_val_if_fail (GTK_IS_PRINTER (printer), NULL);
@@ -425,7 +470,7 @@ gtk_printer_set_description (GtkPrinter  *printer,
 
   priv = printer->priv;
 
-  if (safe_strcmp (priv->description, description) == 0)
+  if (g_strcmp0 (priv->description, description) == 0)
     return FALSE;
 
   g_free (priv->description);
@@ -445,7 +490,7 @@ gtk_printer_set_description (GtkPrinter  *printer,
  *
  * Since: 2.10
  */
-G_CONST_RETURN gchar *
+const gchar *
 gtk_printer_get_state_message (GtkPrinter *printer)
 {
   g_return_val_if_fail (GTK_IS_PRINTER (printer), NULL);
@@ -463,7 +508,7 @@ gtk_printer_set_state_message (GtkPrinter  *printer,
 
   priv = printer->priv;
 
-  if (safe_strcmp (priv->state_message, message) == 0)
+  if (g_strcmp0 (priv->state_message, message) == 0)
     return FALSE;
 
   g_free (priv->state_message);
@@ -483,7 +528,7 @@ gtk_printer_set_state_message (GtkPrinter  *printer,
  *
  * Since: 2.10
  */
-G_CONST_RETURN gchar *
+const gchar *
 gtk_printer_get_location (GtkPrinter *printer)
 {
   g_return_val_if_fail (GTK_IS_PRINTER (printer), NULL);
@@ -501,7 +546,7 @@ gtk_printer_set_location (GtkPrinter  *printer,
 
   priv = printer->priv;
 
-  if (safe_strcmp (priv->location, location) == 0)
+  if (g_strcmp0 (priv->location, location) == 0)
     return FALSE;
 
   g_free (priv->location);
@@ -521,7 +566,7 @@ gtk_printer_set_location (GtkPrinter  *printer,
  *
  * Since: 2.10
  */
-G_CONST_RETURN gchar * 
+const gchar *
 gtk_printer_get_icon_name (GtkPrinter *printer)
 {
   g_return_val_if_fail (GTK_IS_PRINTER (printer), NULL);
@@ -635,6 +680,79 @@ gtk_printer_set_is_active (GtkPrinter *printer,
   printer->priv->is_active = val;
 }
 
+/**
+ * gtk_printer_is_paused:
+ * @printer: a #GtkPrinter
+ * 
+ * Returns whether the printer is currently paused.
+ * A paused printer still accepts jobs, but it is not
+ * printing them.
+ * 
+ * Return value: %TRUE if @printer is paused
+ *
+ * Since: 2.14
+ */
+gboolean
+gtk_printer_is_paused (GtkPrinter *printer)
+{
+  g_return_val_if_fail (GTK_IS_PRINTER (printer), TRUE);
+  
+  return printer->priv->is_paused;
+}
+
+gboolean
+gtk_printer_set_is_paused (GtkPrinter *printer,
+                          gboolean    val)
+{
+  GtkPrinterPrivate *priv;
+
+  g_return_val_if_fail (GTK_IS_PRINTER (printer), FALSE);
+
+  priv = printer->priv;
+
+  if (val == priv->is_paused)
+    return FALSE;
+
+  priv->is_paused = val;
+
+  return TRUE;
+}
+
+/**
+ * gtk_printer_is_accepting_jobs:
+ * @printer: a #GtkPrinter
+ * 
+ * Returns whether the printer is accepting jobs
+ * 
+ * Return value: %TRUE if @printer is accepting jobs
+ *
+ * Since: 2.14
+ */
+gboolean
+gtk_printer_is_accepting_jobs (GtkPrinter *printer)
+{
+  g_return_val_if_fail (GTK_IS_PRINTER (printer), TRUE);
+  
+  return printer->priv->is_accepting_jobs;
+}
+
+gboolean
+gtk_printer_set_is_accepting_jobs (GtkPrinter *printer,
+                                  gboolean val)
+{
+  GtkPrinterPrivate *priv;
+
+  g_return_val_if_fail (GTK_IS_PRINTER (printer), FALSE);
+
+  priv = printer->priv;
+
+  if (val == priv->is_accepting_jobs)
+    return FALSE;
+
+  priv->is_accepting_jobs = val;
+
+  return TRUE;
+}
 
 /**
  * gtk_printer_is_virtual:
@@ -675,6 +793,15 @@ gtk_printer_accepts_pdf (GtkPrinter *printer)
   return printer->priv->accepts_pdf;
 }
 
+void
+gtk_printer_set_accepts_pdf (GtkPrinter *printer,
+                            gboolean val)
+{
+  g_return_if_fail (GTK_IS_PRINTER (printer));
+
+  printer->priv->accepts_pdf = val;
+}
+
 /**
  * gtk_printer_accepts_ps:
  * @printer: a #GtkPrinter
@@ -694,6 +821,15 @@ gtk_printer_accepts_ps (GtkPrinter *printer)
   return printer->priv->accepts_ps;
 }
 
+void
+gtk_printer_set_accepts_ps (GtkPrinter *printer,
+                           gboolean val)
+{
+  g_return_if_fail (GTK_IS_PRINTER (printer));
+
+  printer->priv->accepts_ps = val;
+}
+
 gboolean
 gtk_printer_is_new (GtkPrinter *printer)
 {
@@ -736,7 +872,7 @@ gtk_printer_set_is_default (GtkPrinter *printer,
 {
   g_return_if_fail (GTK_IS_PRINTER (printer));
 
-  printer->priv->is_default = TRUE;
+  printer->priv->is_default = val;
 }
 
 /**
@@ -816,8 +952,8 @@ _gtk_printer_create_cairo_surface (GtkPrinter       *printer,
  * Lists all the paper sizes @printer supports.
  * This will return and empty list unless the printer's details are 
  * available, see gtk_printer_has_details() and gtk_printer_request_details().
- * 
- * Return value: a newly allocated list of newly allocated #GtkPageSetup s.
+ *
+ * Return value: (element-type GtkPageSetup) (transfer full): a newly allocated list of newly allocated #GtkPageSetup s.
  *
  * Since: 2.12
  */
@@ -832,16 +968,55 @@ gtk_printer_list_papers (GtkPrinter *printer)
   return backend_class->printer_list_papers (printer);
 }
 
-void
-_gtk_printer_get_hard_margins (GtkPrinter *printer,
-                              gdouble    *top,
-                              gdouble    *bottom,
-                              gdouble    *left,
-                              gdouble    *right)
+/**
+ * gtk_printer_get_default_page_size:
+ * @printer: a #GtkPrinter
+ *
+ * Returns default page size of @printer.
+ * 
+ * Return value: a newly allocated #GtkPageSetup with default page size of the printer.
+ *
+ * Since: 2.14
+ */
+GtkPageSetup  *
+gtk_printer_get_default_page_size (GtkPrinter *printer)
+{
+  GtkPrintBackendClass *backend_class;
+
+  g_return_val_if_fail (GTK_IS_PRINTER (printer), NULL);
+
+  backend_class = GTK_PRINT_BACKEND_GET_CLASS (printer->priv->backend);
+  return backend_class->printer_get_default_page_size (printer);
+}
+
+/**
+ * gtk_printer_get_hard_margins:
+ * @printer: a #GtkPrinter
+ * @top: (out): a location to store the top margin in
+ * @bottom: (out): a location to store the bottom margin in
+ * @left: (out): a location to store the left margin in
+ * @right: (out): a location to store the right margin in
+ *
+ * Retrieve the hard margins of @printer, i.e. the margins that define
+ * the area at the borders of the paper that the printer cannot print to.
+ *
+ * Note: This will not succeed unless the printer's details are available,
+ * see gtk_printer_has_details() and gtk_printer_request_details().
+ *
+ * Return value: %TRUE iff the hard margins were retrieved
+ *
+ * Since: 2.20
+ */
+gboolean
+gtk_printer_get_hard_margins (GtkPrinter *printer,
+                             gdouble    *top,
+                             gdouble    *bottom,
+                             gdouble    *left,
+                             gdouble    *right)
 {
   GtkPrintBackendClass *backend_class = GTK_PRINT_BACKEND_GET_CLASS (printer->priv->backend);
 
-  backend_class->printer_get_hard_margins (printer, top, bottom, left, right);
+  return backend_class->printer_get_hard_margins (printer, top, bottom, left, right);
 }
 
 /**
@@ -856,7 +1031,7 @@ _gtk_printer_get_hard_margins (GtkPrinter *printer,
  *
  * This will return 0 unless the printer's details are available, see
  * gtk_printer_has_details() and gtk_printer_request_details().
- *  *
+ *
  * Return value: the printer's capabilities
  *
  * Since: 2.12
@@ -961,14 +1136,25 @@ list_added_cb (GtkPrintBackend *backend,
 }
 
 static void
-list_done_cb (GtkPrintBackend *backend, 
-             PrinterList     *printer_list)
+backend_status_changed (GObject    *object,
+                        GParamSpec *pspec,
+                        gpointer    data)
+{
+  GtkPrintBackend *backend = GTK_PRINT_BACKEND (object);
+  PrinterList *printer_list = data;
+  GtkPrintBackendStatus status;
+
+  g_object_get (backend, "status", &status, NULL);
+  if (status == GTK_PRINT_BACKEND_STATUS_UNAVAILABLE)
+    list_done_cb (backend, printer_list);  
+}
+
+static void
+list_printers_remove_backend (PrinterList     *printer_list,
+                              GtkPrintBackend *backend)
 {
   printer_list->backends = g_list_remove (printer_list->backends, backend);
-  
-  g_signal_handlers_disconnect_by_func (backend, list_added_cb, printer_list);
-  g_signal_handlers_disconnect_by_func (backend, list_done_cb, printer_list);
-  
   gtk_print_backend_destroy (backend);
   g_object_unref (backend);
 
@@ -976,11 +1162,23 @@ list_done_cb (GtkPrintBackend *backend,
     free_printer_list (printer_list);
 }
 
+static void
+list_done_cb (GtkPrintBackend *backend,
+             PrinterList     *printer_list)
+{
+  g_signal_handlers_disconnect_by_func (backend, list_added_cb, printer_list);
+  g_signal_handlers_disconnect_by_func (backend, list_done_cb, printer_list);
+  g_signal_handlers_disconnect_by_func (backend, backend_status_changed, printer_list);
+
+  list_printers_remove_backend(printer_list, backend);
+}
+
 static gboolean
 list_printers_init (PrinterList     *printer_list,
                    GtkPrintBackend *backend)
 {
   GList *list, *node;
+  GtkPrintBackendStatus status;
 
   list = gtk_print_backend_get_printer_list (backend);
 
@@ -995,12 +1193,11 @@ list_printers_init (PrinterList     *printer_list,
 
   g_list_free (list);
 
-  if (gtk_print_backend_printer_list_is_done (backend))
-    {
-      printer_list->backends = g_list_remove (printer_list->backends, backend);
-      gtk_print_backend_destroy (backend);
-      g_object_unref (backend);
-    }
+  g_object_get (backend, "status", &status, NULL);
+  
+  if (status == GTK_PRINT_BACKEND_STATUS_UNAVAILABLE || 
+      gtk_print_backend_printer_list_is_done (backend))
+    list_printers_remove_backend(printer_list, backend);
   else
     {
       g_signal_connect (backend, "printer-added", 
@@ -1009,6 +1206,9 @@ list_printers_init (PrinterList     *printer_list,
       g_signal_connect (backend, "printer-list-done", 
                        (GCallback) list_done_cb, 
                        printer_list);
+      g_signal_connect (backend, "notify::status", 
+                        (GCallback) backend_status_changed,
+                        printer_list);     
     }
 
   return FALSE;
@@ -1064,9 +1264,9 @@ gtk_enumerate_printers (GtkPrinterFunc func,
     {
       printer_list->loop = g_main_loop_new (NULL, FALSE);
 
-      GDK_THREADS_LEAVE ();  
+      gdk_threads_leave ();  
       g_main_loop_run (printer_list->loop);
-      GDK_THREADS_ENTER ();  
+      gdk_threads_enter ();  
     }
 }
 
@@ -1087,6 +1287,7 @@ gtk_print_capabilities_get_type (void)
         { GTK_PRINT_CAPABILITY_GENERATE_PS, "GTK_PRINT_CAPABILITY_GENERATE_PS", "generate-ps" },
         { GTK_PRINT_CAPABILITY_PREVIEW, "GTK_PRINT_CAPABILITY_PREVIEW", "preview" },
        { GTK_PRINT_CAPABILITY_NUMBER_UP, "GTK_PRINT_CAPABILITY_NUMBER_UP", "number-up"},
+        { GTK_PRINT_CAPABILITY_NUMBER_UP_LAYOUT, "GTK_PRINT_CAPABILITY_NUMBER_UP_LAYOUT", "number-up-layout" },
         { 0, NULL, NULL }
       };
 
@@ -1095,7 +1296,3 @@ gtk_print_capabilities_get_type (void)
 
   return etype;
 }
-
-
-#define __GTK_PRINTER_C__
-#include "gtkaliasdef.c"