Pileus Git - ~andy/gtk/blob - gtk/gtkpapersize.h

   1 /* GTK - The GTK+ Toolkit
   2  * gtkpapersize.h: Paper Size
   3  * Copyright (C) 2006, Red Hat, Inc.
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  */
  20
  21 #if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  22 #error "Only <gtk/gtk.h> can be included directly."
  23 #endif
  24
  25 #ifndef __GTK_PAPER_SIZE_H__
  26 #define __GTK_PAPER_SIZE_H__
  27
  28 #include <gtk/gtkenums.h>
  29
  30 G_BEGIN_DECLS
  31
  32 typedef struct _GtkPaperSize GtkPaperSize;
  33
  34 #define GTK_TYPE_PAPER_SIZE    (gtk_paper_size_get_type ())
  35
  36 /* Common names, from PWG 5101.1-2002 PWG: Standard for Media Standardized Names */
  37 #define GTK_PAPER_NAME_A3 "iso_a3"
  38 #define GTK_PAPER_NAME_A4 "iso_a4"
  39 #define GTK_PAPER_NAME_A5 "iso_a5"
  40 #define GTK_PAPER_NAME_B5 "iso_b5"
  41 #define GTK_PAPER_NAME_LETTER "na_letter"
  42 #define GTK_PAPER_NAME_EXECUTIVE "na_executive"
  43 #define GTK_PAPER_NAME_LEGAL "na_legal"
  44
  45 GType gtk_paper_size_get_type (void) G_GNUC_CONST;
  46
  47 GtkPaperSize *gtk_paper_size_new          (const gchar  *name);
  48 GtkPaperSize *gtk_paper_size_new_from_ppd (const gchar  *ppd_name,
  49                                            const gchar  *ppd_display_name,
  50                                            gdouble       width,
  51                                            gdouble       height);
  52 GtkPaperSize *gtk_paper_size_new_custom   (const gchar  *name,
  53                                            const gchar  *display_name,
  54                                            gdouble       width,
  55                                            gdouble       height,
  56                                            GtkUnit       unit);
  57 GtkPaperSize *gtk_paper_size_copy         (GtkPaperSize *other);
  58 void          gtk_paper_size_free         (GtkPaperSize *size);
  59 gboolean      gtk_paper_size_is_equal     (GtkPaperSize *size1,
  60                                            GtkPaperSize *size2);
  61
  62 GList        *gtk_paper_size_get_paper_sizes (gboolean include_custom);
  63
  64 /* The width is always the shortest side, measure in mm */
  65 G_CONST_RETURN gchar *gtk_paper_size_get_name         (GtkPaperSize *size);
  66 G_CONST_RETURN gchar *gtk_paper_size_get_display_name (GtkPaperSize *size);
  67 G_CONST_RETURN gchar *gtk_paper_size_get_ppd_name     (GtkPaperSize *size);
  68
  69 gdouble  gtk_paper_size_get_width        (GtkPaperSize *size, GtkUnit unit);
  70 gdouble  gtk_paper_size_get_height       (GtkPaperSize *size, GtkUnit unit);
  71 gboolean gtk_paper_size_is_custom        (GtkPaperSize *size);
  72
  73 /* Only for custom sizes: */
  74 void    gtk_paper_size_set_size                  (GtkPaperSize *size,
  75                                                   gdouble       width,
  76                                                   gdouble       height,
  77                                                   GtkUnit       unit);
  78
  79 gdouble gtk_paper_size_get_default_top_margin    (GtkPaperSize *size,
  80                                                   GtkUnit       unit);
  81 gdouble gtk_paper_size_get_default_bottom_margin (GtkPaperSize *size,
  82                                                   GtkUnit       unit);
  83 gdouble gtk_paper_size_get_default_left_margin   (GtkPaperSize *size,
  84                                                   GtkUnit       unit);
  85 gdouble gtk_paper_size_get_default_right_margin  (GtkPaperSize *size,
  86                                                   GtkUnit       unit);
  87
  88 G_CONST_RETURN gchar *gtk_paper_size_get_default (void);
  89
  90 GtkPaperSize *gtk_paper_size_new_from_key_file (GKeyFile    *key_file,
  91                                                 const gchar *group_name,
  92                                                 GError     **error);
  93 void     gtk_paper_size_to_key_file            (GtkPaperSize *size,
  94                                                 GKeyFile     *key_file,
  95                                                 const gchar  *group_name);
  96
  97 G_END_DECLS
  98
  99 #endif /* __GTK_PAPER_SIZE_H__ */