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 #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         gchar         *(* form_field_text_get_text)           (EvDocumentForms   *document_forms,
  54                                                                EvFormField       *field);
  55         void           (* form_field_text_set_text)           (EvDocumentForms   *document_forms,
  56                                                                EvFormField       *field,
  57                                                                const gchar       *text);
  58         gboolean       (* form_field_button_get_state)        (EvDocumentForms   *document_forms,
  59                                                                EvFormField       *field);
  60         void           (* form_field_button_set_state)        (EvDocumentForms   *document_forms,
  61                                                                EvFormField       *field,
  62                                                                gboolean           state);
  63         gchar         *(* form_field_choice_get_item)         (EvDocumentForms   *document_forms,
  64                                                                EvFormField       *field,
  65                                                                gint               index);
  66         gint           (* form_field_choice_get_n_items)      (EvDocumentForms   *document_forms,
  67                                                                EvFormField       *field);
  68         gboolean       (* form_field_choice_is_item_selected) (EvDocumentForms   *document_forms,
  69                                                                EvFormField       *field,
  70                                                                gint               index);
  71         void           (* form_field_choice_select_item)      (EvDocumentForms   *document_forms,
  72                                                                EvFormField       *field,
  73                                                                gint               index);
  74         void           (* form_field_choice_toggle_item)      (EvDocumentForms   *document_forms,
  75                                                                EvFormField       *field,
  76                                                                gint               index);
  77         void           (* form_field_choice_unselect_all)     (EvDocumentForms   *document_forms,
  78                                                                EvFormField       *field);
  79         void           (* form_field_choice_set_text)         (EvDocumentForms   *document_forms,
  80                                                                EvFormField       *field,
  81                                                                const gchar       *text);
  82         gchar         *(* form_field_choice_get_text)         (EvDocumentForms   *document_forms,
  83                                                                EvFormField       *field);
  84 };
  85
  86 GType          ev_document_forms_get_type                           (void) G_GNUC_CONST;
  87 EvMappingList *ev_document_forms_get_form_fields                    (EvDocumentForms   *document_forms,
  88                                                                      EvPage            *page);
  89
  90 gchar         *ev_document_forms_form_field_text_get_text           (EvDocumentForms   *document_forms,
  91                                                                      EvFormField       *field);
  92 void           ev_document_forms_form_field_text_set_text           (EvDocumentForms   *document_forms,
  93                                                                      EvFormField       *field,
  94                                                                      const gchar       *text);
  95
  96 gboolean       ev_document_forms_form_field_button_get_state        (EvDocumentForms   *document_forms,
  97                                                                      EvFormField       *field);
  98 void           ev_document_forms_form_field_button_set_state        (EvDocumentForms   *document_forms,
  99                                                                      EvFormField       *field,
 100                                                                      gboolean           state);
 101
 102 gchar         *ev_document_forms_form_field_choice_get_item         (EvDocumentForms   *document_forms,
 103                                                                      EvFormField       *field,
 104                                                                      gint               index);
 105 gint           ev_document_forms_form_field_choice_get_n_items      (EvDocumentForms   *document_forms,
 106                                                                      EvFormField       *field);
 107 gboolean       ev_document_forms_form_field_choice_is_item_selected (EvDocumentForms   *document_forms,
 108                                                                      EvFormField       *field,
 109                                                                      gint               index);
 110 void           ev_document_forms_form_field_choice_select_item      (EvDocumentForms   *document_forms,
 111                                                                      EvFormField       *field,
 112                                                                      gint               index);
 113 void           ev_document_forms_form_field_choice_toggle_item      (EvDocumentForms   *document_forms,
 114                                                                      EvFormField       *field,
 115                                                                      gint               index);
 116 void           ev_document_forms_form_field_choice_unselect_all     (EvDocumentForms   *document_forms,
 117                                                                      EvFormField       *field);
 118 void           ev_document_forms_form_field_choice_set_text         (EvDocumentForms   *document_forms,
 119                                                                      EvFormField       *field,
 120                                                                      const gchar       *text);
 121 gchar         *ev_document_forms_form_field_choice_get_text         (EvDocumentForms   *document_forms,
 122                                                                      EvFormField       *field);
 123
 124 G_END_DECLS
 125
 126 #endif /* EV_DOCUMENT_FORMS_H */