gtkpapersize.h 4.25 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GTK - The GIMP Toolkit
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
 * gtkpapersize.h: Paper Size
 * Copyright (C) 2006, Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * 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.
 */

21
#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
22 23 24
#error "Only <gtk/gtk.h> can be included directly."
#endif

25 26 27
#ifndef __GTK_PAPER_SIZE_H__
#define __GTK_PAPER_SIZE_H__

28

29
#include <gtk/gtkenums.h>
30

31

32 33 34 35 36 37 38
G_BEGIN_DECLS

typedef struct _GtkPaperSize GtkPaperSize;

#define GTK_TYPE_PAPER_SIZE    (gtk_paper_size_get_type ())

/* Common names, from PWG 5101.1-2002 PWG: Standard for Media Standardized Names */
39 40 41 42 43
/**
 * GTK_PAPER_NAME_A3:
 *
 * Name for the A4 paper size.
 */
44
#define GTK_PAPER_NAME_A3 "iso_a3"
45 46 47 48 49 50

/**
 * GTK_PAPER_NAME_A4:
 *
 * Name for the A4 paper size.
 */
51
#define GTK_PAPER_NAME_A4 "iso_a4"
52 53 54 55 56 57

/**
 * GTK_PAPER_NAME_A5:
 *
 * Name for the A5 paper size.
 */
58
#define GTK_PAPER_NAME_A5 "iso_a5"
59 60 61 62 63 64

/**
 * GTK_PAPER_NAME_B5:
 *
 * Name for the B5 paper size.
 */
65
#define GTK_PAPER_NAME_B5 "iso_b5"
66 67 68 69 70 71

/**
 * GTK_PAPER_NAME_LETTER:
 *
 * Name for the Letter paper size.
 */
72
#define GTK_PAPER_NAME_LETTER "na_letter"
73 74 75 76 77 78

/**
 * GTK_PAPER_NAME_EXECUTIVE:
 *
 * Name for the Executive paper size.
 */
79
#define GTK_PAPER_NAME_EXECUTIVE "na_executive"
80 81 82 83 84 85

/**
 * GTK_PAPER_NAME_LEGAL:
 *
 * Name for the Legal paper size.
 */
86 87 88 89
#define GTK_PAPER_NAME_LEGAL "na_legal"

GType gtk_paper_size_get_type (void) G_GNUC_CONST;

90 91 92 93 94 95 96 97 98
GtkPaperSize *gtk_paper_size_new          (const gchar  *name);
GtkPaperSize *gtk_paper_size_new_from_ppd (const gchar  *ppd_name,
					   const gchar  *ppd_display_name,
					   gdouble       width,
					   gdouble       height);
GtkPaperSize *gtk_paper_size_new_custom   (const gchar  *name,
					   const gchar  *display_name,
					   gdouble       width,
					   gdouble       height,
99 100 101 102 103 104
					   GtkUnit       unit);
GtkPaperSize *gtk_paper_size_copy         (GtkPaperSize *other);
void          gtk_paper_size_free         (GtkPaperSize *size);
gboolean      gtk_paper_size_is_equal     (GtkPaperSize *size1,
					   GtkPaperSize *size2);

105
GList        *gtk_paper_size_get_paper_sizes (gboolean include_custom);
106 107

/* The width is always the shortest side, measure in mm */
108 109 110
const gchar *gtk_paper_size_get_name         (GtkPaperSize *size);
const gchar *gtk_paper_size_get_display_name (GtkPaperSize *size);
const gchar *gtk_paper_size_get_ppd_name     (GtkPaperSize *size);
111

112 113
gdouble  gtk_paper_size_get_width        (GtkPaperSize *size, GtkUnit unit);
gdouble  gtk_paper_size_get_height       (GtkPaperSize *size, GtkUnit unit);
114 115 116
gboolean gtk_paper_size_is_custom        (GtkPaperSize *size);

/* Only for custom sizes: */
117 118 119 120 121 122 123 124 125 126 127 128 129 130
void    gtk_paper_size_set_size                  (GtkPaperSize *size, 
                                                  gdouble       width, 
                                                  gdouble       height, 
                                                  GtkUnit       unit);

gdouble gtk_paper_size_get_default_top_margin    (GtkPaperSize *size,
						  GtkUnit       unit);
gdouble gtk_paper_size_get_default_bottom_margin (GtkPaperSize *size,
						  GtkUnit       unit);
gdouble gtk_paper_size_get_default_left_margin   (GtkPaperSize *size,
						  GtkUnit       unit);
gdouble gtk_paper_size_get_default_right_margin  (GtkPaperSize *size,
						  GtkUnit       unit);

131
const gchar *gtk_paper_size_get_default (void);
132

Matthias Clasen's avatar
Matthias Clasen committed
133 134 135 136 137 138 139
GtkPaperSize *gtk_paper_size_new_from_key_file (GKeyFile    *key_file,
					        const gchar *group_name,
					        GError     **error);
void     gtk_paper_size_to_key_file            (GtkPaperSize *size,
					        GKeyFile     *key_file,
					        const gchar  *group_name);

140 141 142
G_END_DECLS

#endif /* __GTK_PAPER_SIZE_H__ */