Web   ·   Wiki   ·   Activities   ·   Blog   ·   Lists   ·   Chat   ·   Meeting   ·   Bugs   ·   Git   ·   Translate   ·   Archive   ·   People   ·   Donate
summaryrefslogtreecommitdiffstats
path: root/backend/ev-document.h
blob: 4cf4601fc0cac639a83eec7cd2288e881ae7a126 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8; c-indent-level: 8 -*- */
/*
 *  Copyright (C) 2000-2003 Marco Pesenti Gritti
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2, or (at your option)
 *  any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *
 *  $Id$
 */

#ifndef EV_DOCUMENT_H
#define EV_DOCUMENT_H

#include <glib-object.h>
#include <glib.h>
#include <gdk/gdk.h>

G_BEGIN_DECLS

typedef struct
{
  int page_num;
  GdkRectangle highlight_area;
} EvFindResult;

#define EV_TYPE_DOCUMENT	    (ev_document_get_type ())
#define EV_DOCUMENT(o)		    (G_TYPE_CHECK_INSTANCE_CAST ((o), EV_TYPE_DOCUMENT, EvDocument))
#define EV_DOCUMENT_IFACE(k)	    (G_TYPE_CHECK_CLASS_CAST((k), EV_TYPE_DOCUMENT, EvDocumentIface))
#define EV_IS_DOCUMENT(o)	    (G_TYPE_CHECK_INSTANCE_TYPE ((o), EV_TYPE_DOCUMENT))
#define EV_IS_DOCUMENT_IFACE(k)	    (G_TYPE_CHECK_CLASS_TYPE ((k), EV_TYPE_DOCUMENT))
#define EV_DOCUMENT_GET_IFACE(inst) (G_TYPE_INSTANCE_GET_INTERFACE ((inst), EV_TYPE_DOCUMENT, EvDocumentIface))

typedef struct _EvDocument	EvDocument;
typedef struct _EvDocumentIface	EvDocumentIface;

struct _EvDocumentIface
{
	GTypeInterface base_iface;

	/* Methods  */
	gboolean    (* load)	        (EvDocument *document,
					 const char *uri,
					 GError    **error);
	int         (* get_n_pages)     (EvDocument *document);
	void	    (* set_page)	(EvDocument  *document,
					 int          page);
	int	    (* get_page)	(EvDocument  *document);
	void	    (* set_target)      (EvDocument  *document,
					 GdkDrawable *target);
	void	    (* set_scale)       (EvDocument  *document,
					 double       scale);
	void	    (* set_page_offset) (EvDocument  *document,
					 int          x,
					 int          y);
	void	    (* get_page_size)   (EvDocument  *document,
					 int         *width,
					 int         *height);
	void	    (* render)          (EvDocument  *document,
					 int          clip_x,
					 int          clip_y,
					 int          clip_width,
					 int          clip_height);
        
        void         (* begin_find)     (EvDocument    *document,
                                         const char    *search_string,
                                         gboolean       case_sensitive);
        void         (* end_find)       (EvDocument    *document);

        /* Signals */

        /* "found" emitted at least 1 time (possibly with n_results == 0)
         * for any call to begin_find; also emitted with NULL,0 when
	 * you end_find. Calling begin_find twice without calling end_find
	 * is considered OK.
         */
        void         (* found)          (EvDocument         *document,
                                         const EvFindResult *results,
                                         int                 n_results,
                                         double              percent_complete);
};

GType ev_document_get_type (void);

gboolean ev_document_load            (EvDocument   *document,
				      const char   *uri,
				      GError      **error);
int      ev_document_get_n_pages     (EvDocument   *document);
void     ev_document_set_page        (EvDocument   *document,
				      int           page);
int      ev_document_get_page        (EvDocument   *document);
void     ev_document_set_target      (EvDocument   *document,
				      GdkDrawable  *target);
void     ev_document_set_scale       (EvDocument   *document,
				      double        scale);
void     ev_document_set_page_offset (EvDocument   *document,
				      int           x,
				      int           y);
void     ev_document_get_page_size   (EvDocument   *document,
				      int          *width,
				      int          *height);
void     ev_document_render          (EvDocument   *document,
				      int           clip_x,
				      int           clip_y,
				      int           clip_width,
				      int           clip_height);
void     ev_document_begin_find    (EvDocument   *document,
                                    const char   *search_string,
                                    gboolean      case_sensitive);
void     ev_document_end_find      (EvDocument   *document);

void     ev_document_found         (EvDocument         *document,
				    const EvFindResult *results,
				    int                 n_results,
				    double              percent_complete);
				    

G_END_DECLS

#endif