shell/ev-page-cache.h

   1 /* this file is part of evince, a gnome document viewer
   2  *
   3  *  Copyright (C) 2005 Red Hat, Inc
   4  *
   5  * Evince is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * Evince is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * 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
  20 #ifndef __EV_PAGE_CACHE_H__
  21 #define __EV_PAGE_CACHE_H__
  22
  23 #include <gtk/gtkwidget.h>
  24 #include "ev-document.h"
  25
  26 G_BEGIN_DECLS
  27 #define EV_TYPE_PAGE_CACHE            (ev_page_cache_get_type ())
  28 #define EV_PAGE_CACHE(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), EV_TYPE_PAGE_CACHE, EvPageCache))
  29 #define EV_IS_PAGE_CACHE(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), EV_TYPE_PAGE_CACHE))
  30
  31 GType          ev_page_cache_get_type            (void) G_GNUC_CONST;
  32
  33 /* Used by ev-document.c only */
  34 EvPageCache   *ev_page_cache_new                 (EvDocument   *document);
  35 gint           ev_page_cache_get_n_pages         (EvPageCache  *page_cache);
  36 const char    *ev_page_cache_get_title           (EvPageCache  *page_cache);
  37 void           ev_page_cache_get_size            (EvPageCache  *page_cache,
  38                                                   gint          page,
  39                                                   EvOrientation orientation,
  40                                                   gfloat        scale,
  41                                                   gint         *width,
  42                                                   gint         *height);
  43 void           ev_page_cache_get_max_width      (EvPageCache   *page_cache,
  44                                                   gfloat        scale,
  45                                                   gint         *width);
  46 void           ev_page_cache_get_max_height      (EvPageCache  *page_cache,
  47                                                   gfloat        scale,
  48                                                   gint         *height);
  49 void           ev_page_cache_get_height_to_page  (EvPageCache   *page_cache,
  50                                                                  gint page,
  51                                                   gfloat         scale,
  52                                                   gint          *height,
  53                                                   gint          *dual_height);
  54 gint           ev_page_cache_get_max_label_chars (EvPageCache   *page_cache);
  55 char          *ev_page_cache_get_page_label      (EvPageCache   *page_cache,
  56                                                   gint           page);
  57 gboolean       ev_page_cache_has_nonnumeric_page_labels (EvPageCache *page_cache);
  58 const EvDocumentInfo *ev_page_cache_get_info            (EvPageCache *page_cache);
  59
  60 /* Navigation */
  61 gint           ev_page_cache_get_current_page    (EvPageCache *page_cache);
  62 void           ev_page_cache_set_current_page    (EvPageCache *page_cache,
  63                                                   int          page);
  64 gboolean       ev_page_cache_set_page_label      (EvPageCache *page_cache,
  65                                                   const char  *page_label);
  66 void           ev_page_cache_set_link            (EvPageCache *page_cache,
  67                                                   EvLink      *link);
  68 gboolean       ev_page_cache_next_page           (EvPageCache *page_cache);
  69 gboolean       ev_page_cache_prev_page           (EvPageCache *page_cache);
  70
  71 EvPageCache   *ev_page_cache_get                 (EvDocument *document);
  72
  73 G_END_DECLS
  74
  75 #endif /* __EV_PAGE_CACHE_H__ */