1 /* GTK - The GIMP Toolkit
2 * gtkpapersize.h: Paper Size
3 * Copyright (C) 2006, Red Hat, Inc.
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.
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.
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.
21 #ifndef __GTK_PAPER_SIZE_H__
22 #define __GTK_PAPER_SIZE_H__
24 #include <glib-object.h>
29 typedef struct _GtkPaperSize GtkPaperSize;
31 #define GTK_TYPE_PAPER_SIZE (gtk_paper_size_get_type ())
33 /* Common names, from PWG 5101.1-2002 PWG: Standard for Media Standardized Names */
34 #define GTK_PAPER_NAME_A3 "iso_a3"
35 #define GTK_PAPER_NAME_A4 "iso_a4"
36 #define GTK_PAPER_NAME_A5 "iso_a5"
37 #define GTK_PAPER_NAME_B5 "iso_b5"
38 #define GTK_PAPER_NAME_LETTER "na_letter"
39 #define GTK_PAPER_NAME_EXECUTIVE "na_executive"
40 #define GTK_PAPER_NAME_LEGAL "na_legal"
42 GType gtk_paper_size_get_type (void) G_GNUC_CONST;
44 GtkPaperSize *gtk_paper_size_new (const char *name);
45 GtkPaperSize *gtk_paper_size_new_from_ppd (const char *ppd_name,
46 const char *ppd_display_name,
49 GtkPaperSize *gtk_paper_size_new_custom (const char *name,
50 const char *display_name,
54 GtkPaperSize *gtk_paper_size_copy (GtkPaperSize *other);
55 void gtk_paper_size_free (GtkPaperSize *size);
56 gboolean gtk_paper_size_is_equal (GtkPaperSize *size1,
60 /* The width is always the shortest side, measure in mm */
61 G_CONST_RETURN char * gtk_paper_size_get_name (GtkPaperSize *size);
62 G_CONST_RETURN char * gtk_paper_size_get_display_name (GtkPaperSize *size);
63 G_CONST_RETURN char * gtk_paper_size_get_ppd_name (GtkPaperSize *size);
65 double gtk_paper_size_get_width (GtkPaperSize *size, GtkUnit unit);
66 double gtk_paper_size_get_height (GtkPaperSize *size, GtkUnit unit);
67 gboolean gtk_paper_size_is_custom (GtkPaperSize *size);
69 /* Only for custom sizes: */
70 void gtk_paper_size_set_size (GtkPaperSize *size,
75 double gtk_paper_size_get_default_top_margin (GtkPaperSize *size,
77 double gtk_paper_size_get_default_bottom_margin (GtkPaperSize *size,
79 double gtk_paper_size_get_default_left_margin (GtkPaperSize *size,
81 double gtk_paper_size_get_default_right_margin (GtkPaperSize *size,
84 G_CONST_RETURN char * gtk_paper_size_get_default (void);
88 #endif /* __GTK_PAPER_SIZE_H__ */