libdocument/ev-document-find.h

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8; c-indent-level: 8 -*- */
   2 /*
   3  *  Copyright (C) 2004 Red Hat, Inc.
   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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  18  *
  19  *  $Id$
  20  */
  21
  22 #ifndef EV_DOCUMENT_FIND_H
  23 #define EV_DOCUMENT_FIND_H
  24
  25 #include <glib-object.h>
  26 #include <glib.h>
  27 #include <gdk/gdk.h>
  28
  29 #include "ev-document.h"        /* For EvRectangle */
  30
  31 G_BEGIN_DECLS
  32
  33 #define EV_TYPE_DOCUMENT_FIND       (ev_document_find_get_type ())
  34 #define EV_DOCUMENT_FIND(o)                 (G_TYPE_CHECK_INSTANCE_CAST ((o), EV_TYPE_DOCUMENT_FIND, EvDocumentFind))
  35 #define EV_DOCUMENT_FIND_IFACE(k)           (G_TYPE_CHECK_CLASS_CAST((k), EV_TYPE_DOCUMENT_FIND, EvDocumentFindIface))
  36 #define EV_IS_DOCUMENT_FIND(o)      (G_TYPE_CHECK_INSTANCE_TYPE ((o), EV_TYPE_DOCUMENT_FIND))
  37 #define EV_IS_DOCUMENT_FIND_IFACE(k)        (G_TYPE_CHECK_CLASS_TYPE ((k), EV_TYPE_DOCUMENT_FIND))
  38 #define EV_DOCUMENT_FIND_GET_IFACE(inst) (G_TYPE_INSTANCE_GET_INTERFACE ((inst), EV_TYPE_DOCUMENT_FIND, EvDocumentFindIface))
  39
  40 typedef struct _EvDocumentFind  EvDocumentFind;
  41 typedef struct _EvDocumentFindIface     EvDocumentFindIface;
  42
  43 struct _EvDocumentFindIface
  44 {
  45         GTypeInterface base_iface;
  46
  47         /* Methods */
  48
  49         void     (* begin)            (EvDocumentFind *document_find,
  50                                        int             page,
  51                                        const char     *search_string,
  52                                        gboolean        case_sensitive);
  53         void     (* cancel)           (EvDocumentFind *document_find);
  54         int      (* page_has_results) (EvDocumentFind *document_find,
  55                                        int             page);
  56         int      (* get_n_results)    (EvDocumentFind *document_find,
  57                                        int             page);
  58         gboolean (* get_result)       (EvDocumentFind *document_find,
  59                                        int             page,
  60                                        int             n_result,
  61                                        EvRectangle    *rectangle);
  62         double   (* get_progress)     (EvDocumentFind *document_find);
  63
  64         /* Signals */
  65
  66         void     (* find_changed)     (EvDocumentFind *document_find,
  67                                        int             page);
  68 };
  69
  70 GType     ev_document_find_get_type         (void);
  71 void      ev_document_find_begin            (EvDocumentFind *document_find,
  72                                              int             page,
  73                                              const char     *search_string,
  74                                              gboolean        case_sensitive);
  75 void      ev_document_find_cancel           (EvDocumentFind *document_find);
  76 int       ev_document_find_page_has_results (EvDocumentFind *document_find,
  77                                              int             page);
  78 int       ev_document_find_get_n_results    (EvDocumentFind *document_find,
  79                                              int             page);
  80 gboolean  ev_document_find_get_result       (EvDocumentFind *document_find,
  81                                              int             page,
  82                                              int             n_result,
  83                                              EvRectangle    *rectangle);
  84 double    ev_document_find_get_progress     (EvDocumentFind *document_find);
  85 void      ev_document_find_changed          (EvDocumentFind *document_find,
  86                                              int             page);
  87
  88 /* How this interface works:
  89  *
  90  * begin() begins a new search, canceling any previous search.
  91  *
  92  * cancel() cancels a search if any, otherwise does nothing.
  93  *
  94  */
  95
  96 G_END_DECLS
  97
  98 #endif