Evince
Evince is a document viewer capable of displaying multiple and single page document formats like PDF and Postscript.
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
ev-document-model.h
Go to the documentation of this file.
1 /* this file is part of evince, a gnome document viewer
2  *
3  * Copyright (C) 2009 Carlos Garcia Campos
4  *
5  * Evince is free software; you can redistribute it and/or modify it
6  * under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * Evince is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18  */
19 
20 #if !defined (__EV_EVINCE_VIEW_H_INSIDE__) && !defined (EVINCE_COMPILATION)
21 #error "Only <evince-view.h> can be included directly."
22 #endif
23 
24 #ifndef __EV_DOCUMENT_MODEL_H__
25 #define __EV_DOCUMENT_MODEL_H__
26 
27 #include <glib-object.h>
28 #include <evince-document.h>
29 
30 G_BEGIN_DECLS
31 
32 #define EV_TYPE_DOCUMENT_MODEL (ev_document_model_get_type ())
33 #define EV_DOCUMENT_MODEL(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), EV_TYPE_DOCUMENT_MODEL, EvDocumentModel))
34 #define EV_IS_DOCUMENT_MODEL(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), EV_TYPE_DOCUMENT_MODEL))
35 #define EV_DOCUMENT_MODEL_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), EV_TYPE_DOCUMENT_MODEL, EvDocumentModelClass))
36 #define EV_IS_DOCUMENT_MODEL_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), EV_TYPE_DOCUMENT_MODEL))
37 #define EV_DOCUMENT_MODEL_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), EV_TYPE_DOCUMENT_MODEL, EvDocumentModelClass))
38 
47 typedef enum {
48  EV_SIZING_FIT_PAGE,
49  EV_SIZING_BEST_FIT = EV_SIZING_FIT_PAGE, /* Deprecated */
50  EV_SIZING_FIT_WIDTH,
51  EV_SIZING_FREE,
52  EV_SIZING_AUTOMATIC
53 } EvSizingMode;
54 
55 typedef enum {
56  EV_PAGE_LAYOUT_SINGLE,
57  EV_PAGE_LAYOUT_DUAL,
58  EV_PAGE_LAYOUT_AUTOMATIC
59 } EvPageLayout;
60 
61 typedef struct _EvDocumentModel EvDocumentModel;
62 typedef struct _EvDocumentModelClass EvDocumentModelClass;
63 
64 GType ev_document_model_get_type (void) G_GNUC_CONST;
65 EvDocumentModel *ev_document_model_new (void);
66 EvDocumentModel *ev_document_model_new_with_document (EvDocument *document);
67 
68 void ev_document_model_set_document (EvDocumentModel *model,
69  EvDocument *document);
70 EvDocument *ev_document_model_get_document (EvDocumentModel *model);
71 void ev_document_model_set_page (EvDocumentModel *model,
72  gint page);
73 void ev_document_model_set_page_by_label (EvDocumentModel *model,
74  const gchar *page_label);
75 gint ev_document_model_get_page (EvDocumentModel *model);
76 void ev_document_model_set_scale (EvDocumentModel *model,
77  gdouble scale);
78 gdouble ev_document_model_get_scale (EvDocumentModel *model);
79 void ev_document_model_set_max_scale (EvDocumentModel *model,
80  gdouble max_scale);
81 gdouble ev_document_model_get_max_scale (EvDocumentModel *model);
82 void ev_document_model_set_min_scale (EvDocumentModel *model,
83  gdouble min_scale);
84 gdouble ev_document_model_get_min_scale (EvDocumentModel *model);
85 void ev_document_model_set_sizing_mode (EvDocumentModel *model,
86  EvSizingMode mode);
87 EvSizingMode ev_document_model_get_sizing_mode (EvDocumentModel *model);
88 void ev_document_model_set_page_layout (EvDocumentModel *model,
89  EvPageLayout layout);
90 EvPageLayout ev_document_model_get_page_layout (EvDocumentModel *model);
91 void ev_document_model_set_rotation (EvDocumentModel *model,
92  gint rotation);
93 gint ev_document_model_get_rotation (EvDocumentModel *model);
94 void ev_document_model_set_inverted_colors (EvDocumentModel *model,
95  gboolean inverted_colors);
96 gboolean ev_document_model_get_inverted_colors (EvDocumentModel *model);
97 void ev_document_model_set_continuous (EvDocumentModel *model,
98  gboolean continuous);
99 gboolean ev_document_model_get_continuous (EvDocumentModel *model);
100 void ev_document_model_set_dual_page_odd_pages_left (EvDocumentModel *model,
101  gboolean odd_left);
102 gboolean ev_document_model_get_dual_page_odd_pages_left (EvDocumentModel *model);
103 void ev_document_model_set_fullscreen (EvDocumentModel *model,
104  gboolean fullscreen);
105 gboolean ev_document_model_get_fullscreen (EvDocumentModel *model);
106 
107 /* deprecated */
108 
109 EV_DEPRECATED_FOR(ev_document_model_set_page_layout)
110 void ev_document_model_set_dual_page (EvDocumentModel *model,
111  gboolean dual_page);
112 EV_DEPRECATED_FOR(ev_document_model_get_page_layout)
113 gboolean ev_document_model_get_dual_page (EvDocumentModel *model);
114 
115 G_END_DECLS
116 
117 #endif /* __EV_DOCUMENT_MODEL_H__ */