libdocument/ev-document-forms.h

   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
  33 G_BEGIN_DECLS
  34
  35 #define EV_TYPE_DOCUMENT_FORMS            (ev_document_forms_get_type ())
  36 #define EV_DOCUMENT_FORMS(o)              (G_TYPE_CHECK_INSTANCE_CAST ((o), EV_TYPE_DOCUMENT_FORMS, EvDocumentForms))
  37 #define EV_DOCUMENT_FORMS_IFACE(k)        (G_TYPE_CHECK_CLASS_CAST((k), EV_TYPE_DOCUMENT_FORMS, EvDocumentFormsIface))
  38 #define EV_IS_DOCUMENT_FORMS(o)           (G_TYPE_CHECK_INSTANCE_TYPE ((o), EV_TYPE_DOCUMENT_FORMS))
  39 #define EV_IS_DOCUMENT_FORMS_IFACE(k)     (G_TYPE_CHECK_CLASS_TYPE ((k), EV_TYPE_DOCUMENT_FORMS))
  40 #define EV_DOCUMENT_FORMS_GET_IFACE(inst) (G_TYPE_INSTANCE_GET_INTERFACE ((inst), EV_TYPE_DOCUMENT_FORMS, EvDocumentFormsIface))
  41
  42 typedef struct _EvDocumentForms      EvDocumentForms;
  43 typedef struct _EvDocumentFormsIface EvDocumentFormsIface;
  44
  45 struct _EvDocumentFormsIface
  46 {
  47         GTypeInterface base_iface;
  48
  49         /* Methods  */
  50         GList   *(* get_form_fields)                    (EvDocumentForms   *document_forms,
  51                                                          EvPage            *page);
  52         gchar   *(* form_field_text_get_text)           (EvDocumentForms   *document_forms,
  53                                                          EvFormField       *field);
  54         void     (* form_field_text_set_text)           (EvDocumentForms   *document_forms,
  55                                                          EvFormField       *field,
  56                                                          const gchar       *text);
  57         gboolean (* form_field_button_get_state)        (EvDocumentForms   *document_forms,
  58                                                          EvFormField       *field);
  59         void     (* form_field_button_set_state)        (EvDocumentForms   *document_forms,
  60                                                          EvFormField       *field,
  61                                                          gboolean           state);
  62         gchar   *(* form_field_choice_get_item)         (EvDocumentForms   *document_forms,
  63                                                          EvFormField       *field,
  64                                                          gint               index);
  65         gint     (* form_field_choice_get_n_items)      (EvDocumentForms   *document_forms,
  66                                                          EvFormField       *field);
  67         gboolean (* form_field_choice_is_item_selected) (EvDocumentForms   *document_forms,
  68                                                          EvFormField       *field,
  69                                                          gint               index);
  70         void     (* form_field_choice_select_item)      (EvDocumentForms   *document_forms,
  71                                                          EvFormField       *field,
  72                                                          gint               index);
  73         void     (* form_field_choice_toggle_item)      (EvDocumentForms   *document_forms,
  74                                                          EvFormField       *field,
  75                                                          gint               index);
  76         void     (* form_field_choice_unselect_all)     (EvDocumentForms   *document_forms,
  77                                                          EvFormField       *field);
  78         void     (* form_field_choice_set_text)         (EvDocumentForms   *document_forms,
  79                                                          EvFormField       *field,
  80                                                          const gchar       *text);
  81         gchar   *(* form_field_choice_get_text)         (EvDocumentForms   *document_forms,
  82                                                          EvFormField       *field);
  83 };
  84
  85 GType    ev_document_forms_get_type                            (void) G_GNUC_CONST;
  86 GList   *ev_document_forms_get_form_fields                     (EvDocumentForms   *document_forms,
  87                                                                 EvPage            *page);
  88
  89 gchar   *ev_document_forms_form_field_text_get_text            (EvDocumentForms   *document_forms,
  90                                                                 EvFormField       *field);
  91 void     ev_document_forms_form_field_text_set_text            (EvDocumentForms   *document_forms,
  92                                                                 EvFormField       *field,
  93                                                                 const gchar       *text);
  94
  95 gboolean ev_document_forms_form_field_button_get_state         (EvDocumentForms   *document_forms,
  96                                                                 EvFormField       *field);
  97 void     ev_document_forms_form_field_button_set_state         (EvDocumentForms   *document_forms,
  98                                                                 EvFormField       *field,
  99                                                                 gboolean           state);
 100
 101 gchar    *ev_document_forms_form_field_choice_get_item         (EvDocumentForms   *document_forms,
 102                                                                 EvFormField       *field,
 103                                                                 gint               index);
 104 gint      ev_document_forms_form_field_choice_get_n_items      (EvDocumentForms   *document_forms,
 105                                                                 EvFormField       *field);
 106 gboolean  ev_document_forms_form_field_choice_is_item_selected (EvDocumentForms   *document_forms,
 107                                                                 EvFormField       *field,
 108                                                                 gint               index);
 109 void      ev_document_forms_form_field_choice_select_item      (EvDocumentForms   *document_forms,
 110                                                                 EvFormField       *field,
 111                                                                 gint               index);
 112 void      ev_document_forms_form_field_choice_toggle_item      (EvDocumentForms   *document_forms,
 113                                                                 EvFormField       *field,
 114                                                                 gint               index);
 115 void      ev_document_forms_form_field_choice_unselect_all     (EvDocumentForms   *document_forms,
 116                                                                 EvFormField       *field);
 117 void      ev_document_forms_form_field_choice_set_text         (EvDocumentForms   *document_forms,
 118                                                                 EvFormField       *field,
 119                                                                 const gchar       *text);
 120 gchar    *ev_document_forms_form_field_choice_get_text         (EvDocumentForms   *document_forms,
 121                                                                 EvFormField       *field);
 122
 123 G_END_DECLS
 124
 125 #endif /* EV_DOCUMENT_FORMS_H */