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-forms.h
Go to the documentation of this file.
1 /* ev-document-forms.h
2  * this file is part of evince, a gnome document viewer
3  *
4  * Copyright (C) 2007 Carlos Garcia Campos <carlosgc@gnome.org>
5  *
6  * Evince is free software; you can redistribute it and/or modify it
7  * under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * Evince is distributed in the hope that it will be useful, but
12  * WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  */
20 
21 #if !defined (__EV_EVINCE_DOCUMENT_H_INSIDE__) && !defined (EVINCE_COMPILATION)
22 #error "Only <evince-document.h> can be included directly."
23 #endif
24 
25 #ifndef EV_DOCUMENT_FORMS_H
26 #define EV_DOCUMENT_FORMS_H
27 
28 #include <glib-object.h>
29 
30 #include "ev-document.h"
31 #include "ev-form-field.h"
32 #include "ev-mapping-list.h"
33 
34 G_BEGIN_DECLS
35 
36 #define EV_TYPE_DOCUMENT_FORMS (ev_document_forms_get_type ())
37 #define EV_DOCUMENT_FORMS(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), EV_TYPE_DOCUMENT_FORMS, EvDocumentForms))
38 #define EV_DOCUMENT_FORMS_IFACE(k) (G_TYPE_CHECK_CLASS_CAST((k), EV_TYPE_DOCUMENT_FORMS, EvDocumentFormsInterface))
39 #define EV_IS_DOCUMENT_FORMS(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), EV_TYPE_DOCUMENT_FORMS))
40 #define EV_IS_DOCUMENT_FORMS_IFACE(k) (G_TYPE_CHECK_CLASS_TYPE ((k), EV_TYPE_DOCUMENT_FORMS))
41 #define EV_DOCUMENT_FORMS_GET_IFACE(inst) (G_TYPE_INSTANCE_GET_INTERFACE ((inst), EV_TYPE_DOCUMENT_FORMS, EvDocumentFormsInterface))
42 
43 typedef struct _EvDocumentForms EvDocumentForms;
44 typedef struct _EvDocumentFormsInterface EvDocumentFormsInterface;
45 
46 struct _EvDocumentFormsInterface
47 {
48  GTypeInterface base_iface;
49 
50  /* Methods */
51  EvMappingList *(* get_form_fields) (EvDocumentForms *document_forms,
52  EvPage *page);
53  gboolean (* document_is_modified) (EvDocumentForms *document_forms);
54  gchar *(* form_field_text_get_text) (EvDocumentForms *document_forms,
55  EvFormField *field);
56  void (* form_field_text_set_text) (EvDocumentForms *document_forms,
57  EvFormField *field,
58  const gchar *text);
59  gboolean (* form_field_button_get_state) (EvDocumentForms *document_forms,
60  EvFormField *field);
61  void (* form_field_button_set_state) (EvDocumentForms *document_forms,
62  EvFormField *field,
63  gboolean state);
64  gchar *(* form_field_choice_get_item) (EvDocumentForms *document_forms,
65  EvFormField *field,
66  gint index);
67  gint (* form_field_choice_get_n_items) (EvDocumentForms *document_forms,
68  EvFormField *field);
69  gboolean (* form_field_choice_is_item_selected) (EvDocumentForms *document_forms,
70  EvFormField *field,
71  gint index);
72  void (* form_field_choice_select_item) (EvDocumentForms *document_forms,
73  EvFormField *field,
74  gint index);
75  void (* form_field_choice_toggle_item) (EvDocumentForms *document_forms,
76  EvFormField *field,
77  gint index);
78  void (* form_field_choice_unselect_all) (EvDocumentForms *document_forms,
79  EvFormField *field);
80  void (* form_field_choice_set_text) (EvDocumentForms *document_forms,
81  EvFormField *field,
82  const gchar *text);
83  gchar *(* form_field_choice_get_text) (EvDocumentForms *document_forms,
84  EvFormField *field);
85 };
86 
87 GType ev_document_forms_get_type (void) G_GNUC_CONST;
88 EvMappingList *ev_document_forms_get_form_fields (EvDocumentForms *document_forms,
89  EvPage *page);
90 gboolean ev_document_forms_document_is_modified (EvDocumentForms *document_forms);
91 
92 gchar *ev_document_forms_form_field_text_get_text (EvDocumentForms *document_forms,
93  EvFormField *field);
94 void ev_document_forms_form_field_text_set_text (EvDocumentForms *document_forms,
95  EvFormField *field,
96  const gchar *text);
97 
98 gboolean ev_document_forms_form_field_button_get_state (EvDocumentForms *document_forms,
99  EvFormField *field);
100 void ev_document_forms_form_field_button_set_state (EvDocumentForms *document_forms,
101  EvFormField *field,
102  gboolean state);
103 
104 gchar *ev_document_forms_form_field_choice_get_item (EvDocumentForms *document_forms,
105  EvFormField *field,
106  gint index);
107 gint ev_document_forms_form_field_choice_get_n_items (EvDocumentForms *document_forms,
108  EvFormField *field);
109 gboolean ev_document_forms_form_field_choice_is_item_selected (EvDocumentForms *document_forms,
110  EvFormField *field,
111  gint index);
112 void ev_document_forms_form_field_choice_select_item (EvDocumentForms *document_forms,
113  EvFormField *field,
114  gint index);
115 void ev_document_forms_form_field_choice_toggle_item (EvDocumentForms *document_forms,
116  EvFormField *field,
117  gint index);
118 void ev_document_forms_form_field_choice_unselect_all (EvDocumentForms *document_forms,
119  EvFormField *field);
120 void ev_document_forms_form_field_choice_set_text (EvDocumentForms *document_forms,
121  EvFormField *field,
122  const gchar *text);
123 gchar *ev_document_forms_form_field_choice_get_text (EvDocumentForms *document_forms,
124  EvFormField *field);
125 
126 G_END_DECLS
127 
128 #endif /* EV_DOCUMENT_FORMS_H */