1/* GTK - The GIMP 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#ifndef __GTK_PAPER_SIZE_H__
22#define __GTK_PAPER_SIZE_H__
23
24
25#if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
26#error "Only <gtk/gtk.h> can be included directly."
27#endif
28
29#include <gtk/gtkenums.h>
30
31
32G_BEGIN_DECLS
33
34typedef struct _GtkPaperSize GtkPaperSize;
35
36#define GTK_TYPE_PAPER_SIZE (gtk_paper_size_get_type ())
37
38/* Common names, from PWG 5101.1-2002 PWG: Standard for Media Standardized Names */
39#define GTK_PAPER_NAME_A3 "iso_a3"
40#define GTK_PAPER_NAME_A4 "iso_a4"
41#define GTK_PAPER_NAME_A5 "iso_a5"
42#define GTK_PAPER_NAME_B5 "iso_b5"
43#define GTK_PAPER_NAME_LETTER "na_letter"
44#define GTK_PAPER_NAME_EXECUTIVE "na_executive"
45#define GTK_PAPER_NAME_LEGAL "na_legal"
46
47GType gtk_paper_size_get_type (void) G_GNUC_CONST;
48
49GtkPaperSize *gtk_paper_size_new (const gchar *name);
50GtkPaperSize *gtk_paper_size_new_from_ppd (const gchar *ppd_name,
51 const gchar *ppd_display_name,
52 gdouble width,
53 gdouble height);
54GtkPaperSize *gtk_paper_size_new_custom (const gchar *name,
55 const gchar *display_name,
56 gdouble width,
57 gdouble height,
58 GtkUnit unit);
59GtkPaperSize *gtk_paper_size_copy (GtkPaperSize *other);
60void gtk_paper_size_free (GtkPaperSize *size);
61gboolean gtk_paper_size_is_equal (GtkPaperSize *size1,
62 GtkPaperSize *size2);
63
64GList *gtk_paper_size_get_paper_sizes (gboolean include_custom);
65
66/* The width is always the shortest side, measure in mm */
67const gchar *gtk_paper_size_get_name (GtkPaperSize *size);
68const gchar *gtk_paper_size_get_display_name (GtkPaperSize *size);
69const gchar *gtk_paper_size_get_ppd_name (GtkPaperSize *size);
70
71gdouble gtk_paper_size_get_width (GtkPaperSize *size, GtkUnit unit);
72gdouble gtk_paper_size_get_height (GtkPaperSize *size, GtkUnit unit);
73gboolean gtk_paper_size_is_custom (GtkPaperSize *size);
74
75/* Only for custom sizes: */
76void gtk_paper_size_set_size (GtkPaperSize *size,
77 gdouble width,
78 gdouble height,
79 GtkUnit unit);
80
81gdouble gtk_paper_size_get_default_top_margin (GtkPaperSize *size,
82 GtkUnit unit);
83gdouble gtk_paper_size_get_default_bottom_margin (GtkPaperSize *size,
84 GtkUnit unit);
85gdouble gtk_paper_size_get_default_left_margin (GtkPaperSize *size,
86 GtkUnit unit);
87gdouble gtk_paper_size_get_default_right_margin (GtkPaperSize *size,
88 GtkUnit unit);
89
90const gchar *gtk_paper_size_get_default (void);
91
92GtkPaperSize *gtk_paper_size_new_from_key_file (GKeyFile *key_file,
93 const gchar *group_name,
94 GError **error);
95void gtk_paper_size_to_key_file (GtkPaperSize *size,
96 GKeyFile *key_file,
97 const gchar *group_name);
98
99G_END_DECLS
100
101#endif /* __GTK_PAPER_SIZE_H__ */
102