libdocument/ev-document-text.h

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8; c-indent-level: 8 -*- */
   2 /*
   3  *  Copyright (C) 2010 Yaco Sistemas, Daniel Garcia <danigm@yaco.es>
   4  *
   5  *  This program is free software; you can redistribute it and/or modify
   6  *  it under the terms of the GNU General Public License as published by
   7  *  the Free Software Foundation; either version 2, or (at your option)
   8  *  any later version.
   9  *
  10  *  This program is distributed in the hope that it will be useful,
  11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  *  GNU 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  *  $Id$
  20  */
  21
  22 #if !defined (__EV_EVINCE_DOCUMENT_H_INSIDE__) && !defined (EVINCE_COMPILATION)
  23 #error "Only <evince-document.h> can be included directly."
  24 #endif
  25
  26 #ifndef EV_DOCUMENT_TEXT_H
  27 #define EV_DOCUMENT_TEXT_H
  28
  29 #include <glib-object.h>
  30 #include <glib.h>
  31 #include <gdk/gdk.h>
  32
  33 #include "ev-document.h"
  34
  35 G_BEGIN_DECLS
  36
  37 #define EV_TYPE_DOCUMENT_TEXT               (ev_document_text_get_type ())
  38 #define EV_DOCUMENT_TEXT(o)                 (G_TYPE_CHECK_INSTANCE_CAST ((o), EV_TYPE_DOCUMENT_TEXT, EvDocumentText))
  39 #define EV_DOCUMENT_TEXT_IFACE(k)           (G_TYPE_CHECK_CLASS_CAST((k), EV_TYPE_DOCUMENT_TEXT, EvDocumentTextInterface))
  40 #define EV_IS_DOCUMENT_TEXT(o)              (G_TYPE_CHECK_INSTANCE_TYPE ((o), EV_TYPE_DOCUMENT_TEXT))
  41 #define EV_IS_DOCUMENT_TEXT_IFACE(k)        (G_TYPE_CHECK_CLASS_TYPE ((k), EV_TYPE_DOCUMENT_TEXT))
  42 #define EV_DOCUMENT_TEXT_GET_IFACE(inst)    (G_TYPE_INSTANCE_GET_INTERFACE ((inst), EV_TYPE_DOCUMENT_TEXT, EvDocumentTextInterface))
  43
  44 typedef struct _EvDocumentText          EvDocumentText;
  45 typedef struct _EvDocumentTextInterface EvDocumentTextInterface;
  46
  47 struct _EvDocumentTextInterface
  48 {
  49         GTypeInterface base_iface;
  50
  51         /* Methods */
  52         cairo_region_t *(* get_text_mapping) (EvDocumentText   *document_text,
  53                                               EvPage           *page);
  54         gchar          *(* get_text)         (EvDocumentText   *document_text,
  55                                               EvPage           *page);
  56         gboolean        (* get_text_layout)  (EvDocumentText   *document_text,
  57                                               EvPage           *page,
  58                                               EvRectangle     **areas,
  59                                               guint            *n_areas);
  60 };
  61
  62 GType           ev_document_text_get_type         (void) G_GNUC_CONST;
  63
  64 gchar          *ev_document_text_get_text         (EvDocumentText  *document_text,
  65                                                    EvPage          *page);
  66 gboolean        ev_document_text_get_text_layout  (EvDocumentText  *document_text,
  67                                                    EvPage          *page,
  68                                                    EvRectangle    **areas,
  69                                                    guint           *n_areas);
  70 cairo_region_t *ev_document_text_get_text_mapping (EvDocumentText  *document_text,
  71                                                    EvPage          *page);
  72
  73 G_END_DECLS
  74
  75 #endif /* EV_DOCUMENT_TEXT_H */