1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8; c-indent-level: 8 -*- */
3 * Copyright (C) 2004 Red Hat, Inc.
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)
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.
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.
22 #ifndef EV_DOCUMENT_FIND_H
23 #define EV_DOCUMENT_FIND_H
25 #include <glib-object.h>
29 #include "ev-document.h" /* For EvRectangle */
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))
40 typedef struct _EvDocumentFind EvDocumentFind;
41 typedef struct _EvDocumentFindIface EvDocumentFindIface;
43 struct _EvDocumentFindIface
45 GTypeInterface base_iface;
49 void (* begin) (EvDocumentFind *document_find,
51 const char *search_string,
52 gboolean case_sensitive);
53 void (* cancel) (EvDocumentFind *document_find);
54 int (* page_has_results) (EvDocumentFind *document_find,
56 int (* get_n_results) (EvDocumentFind *document_find,
58 gboolean (* get_result) (EvDocumentFind *document_find,
61 EvRectangle *rectangle);
62 double (* get_progress) (EvDocumentFind *document_find);
66 void (* find_changed) (EvDocumentFind *document_find,
70 GType ev_document_find_get_type (void);
71 void ev_document_find_begin (EvDocumentFind *document_find,
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,
78 int ev_document_find_get_n_results (EvDocumentFind *document_find,
80 gboolean ev_document_find_get_result (EvDocumentFind *document_find,
83 EvRectangle *rectangle);
84 double ev_document_find_get_progress (EvDocumentFind *document_find);
85 void ev_document_find_changed (EvDocumentFind *document_find,
88 /* How this interface works:
90 * begin() begins a new search, canceling any previous search.
92 * cancel() cancels a search if any, otherwise does nothing.