libdocument/ev-document-layers.h

   1 /* ev-document-layers.h
   2  *  this file is part of evince, a gnome document viewer
   3  *
   4  * Copyright (C) 2008 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_LAYERS_H
  26 #define EV_DOCUMENT_LAYERS_H
  27
  28 #include <glib-object.h>
  29 #include <glib.h>
  30 #include <gtk/gtk.h>
  31
  32 #include "ev-layer.h"
  33
  34 G_BEGIN_DECLS
  35
  36 #define EV_TYPE_DOCUMENT_LAYERS            (ev_document_layers_get_type ())
  37 #define EV_DOCUMENT_LAYERS(o)              (G_TYPE_CHECK_INSTANCE_CAST ((o), EV_TYPE_DOCUMENT_LAYERS, EvDocumentLayers))
  38 #define EV_DOCUMENT_LAYERS_IFACE(k)        (G_TYPE_CHECK_CLASS_CAST((k), EV_TYPE_DOCUMENT_LAYERS, EvDocumentLayersInterface))
  39 #define EV_IS_DOCUMENT_LAYERS(o)           (G_TYPE_CHECK_INSTANCE_TYPE ((o), EV_TYPE_DOCUMENT_LAYERS))
  40 #define EV_IS_DOCUMENT_LAYERS_IFACE(k)     (G_TYPE_CHECK_CLASS_TYPE ((k), EV_TYPE_DOCUMENT_LAYERS))
  41 #define EV_DOCUMENT_LAYERS_GET_IFACE(inst) (G_TYPE_INSTANCE_GET_INTERFACE ((inst), EV_TYPE_DOCUMENT_LAYERS, EvDocumentLayersInterface))
  42
  43 typedef struct _EvDocumentLayers          EvDocumentLayers;
  44 typedef struct _EvDocumentLayersInterface EvDocumentLayersInterface;
  45
  46 enum {
  47         EV_DOCUMENT_LAYERS_COLUMN_TITLE,
  48         EV_DOCUMENT_LAYERS_COLUMN_LAYER,
  49         EV_DOCUMENT_LAYERS_COLUMN_VISIBLE,
  50         EV_DOCUMENT_LAYERS_COLUMN_ENABLED,
  51         EV_DOCUMENT_LAYERS_COLUMN_SHOWTOGGLE,
  52         EV_DOCUMENT_LAYERS_COLUMN_RBGROUP,
  53         EV_DOCUMENT_LAYERS_N_COLUMNS
  54 };
  55
  56 struct _EvDocumentLayersInterface
  57 {
  58         GTypeInterface base_iface;
  59
  60         /* Methods  */
  61         gboolean      (* has_layers)       (EvDocumentLayers *document_layers);
  62         GtkTreeModel *(* get_layers)       (EvDocumentLayers *document_layers);
  63
  64         void          (* show_layer)       (EvDocumentLayers *document_layers,
  65                                             EvLayer          *layer);
  66         void          (* hide_layer)       (EvDocumentLayers *document_layers,
  67                                             EvLayer          *layer);
  68         gboolean      (* layer_is_visible) (EvDocumentLayers *document_layers,
  69                                             EvLayer          *layer);
  70 };
  71
  72 GType         ev_document_layers_get_type         (void) G_GNUC_CONST;
  73
  74 gboolean      ev_document_layers_has_layers       (EvDocumentLayers *document_layers);
  75 GtkTreeModel *ev_document_layers_get_layers       (EvDocumentLayers *document_layers);
  76 void          ev_document_layers_show_layer       (EvDocumentLayers *document_layers,
  77                                                    EvLayer          *layer);
  78 void          ev_document_layers_hide_layer       (EvDocumentLayers *document_layers,
  79                                                    EvLayer          *layer);
  80 gboolean      ev_document_layers_layer_is_visible (EvDocumentLayers *document_layers,
  81                                                    EvLayer          *layer);
  82
  83 G_END_DECLS
  84
  85 #endif /* EV_DOCUMENT_LAYERS_H */