/* -*- 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