libview/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 #if !defined (__EV_EVINCE_VIEW_H_INSIDE__) && !defined (EVINCE_COMPILATION)
  21 #error "Only <evince-view.h> can be included directly."
  22 #endif
  23
  24 #ifndef __EV_PAGE_CACHE_H__
  25 #define __EV_PAGE_CACHE_H__
  26
  27 #include <gtk/gtk.h>
  28
  29 #include <evince-document.h>
  30
  31 G_BEGIN_DECLS
  32 #define EV_TYPE_PAGE_CACHE            (ev_page_cache_get_type ())
  33 #define EV_PAGE_CACHE(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), EV_TYPE_PAGE_CACHE, EvPageCache))
  34 #define EV_IS_PAGE_CACHE(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), EV_TYPE_PAGE_CACHE))
  35
  36 GType          ev_page_cache_get_type            (void) G_GNUC_CONST;
  37
  38 /* Used by ev-document.c only */
  39 EvPageCache   *ev_page_cache_new                 (EvDocument    *document);
  40 gint           ev_page_cache_get_n_pages         (EvPageCache   *page_cache);
  41 const char    *ev_page_cache_get_title           (EvPageCache   *page_cache);
  42 void           ev_page_cache_get_size            (EvPageCache   *page_cache,
  43                                                   gint           page,
  44                                                   gint           rotation,
  45                                                   gfloat         scale,
  46                                                   gint          *width,
  47                                                   gint          *height);
  48 void           ev_page_cache_get_max_width       (EvPageCache   *page_cache,
  49                                                   gint           rotation,
  50                                                   gfloat         scale,
  51                                                   gint          *width);
  52 void           ev_page_cache_get_max_height      (EvPageCache   *page_cache,
  53                                                   gint           rotation,
  54                                                   gfloat         scale,
  55                                                   gint          *height);
  56 void           ev_page_cache_get_height_to_page  (EvPageCache   *page_cache,
  57                                                   gint           page,
  58                                                   gint           rotation,
  59                                                   gfloat         scale,
  60                                                   gint          *height,
  61                                                   gint          *dual_height);
  62 void           ev_page_cache_get_thumbnail_size  (EvPageCache   *page_cache,
  63                                                   gint           page,
  64                                                   gint           rotation,
  65                                                   gint          *width,
  66                                                   gint          *height);
  67 gint           ev_page_cache_get_max_label_chars (EvPageCache   *page_cache);
  68 char          *ev_page_cache_get_page_label      (EvPageCache   *page_cache,
  69                                                   gint           page);
  70 gboolean       ev_page_cache_has_nonnumeric_page_labels (EvPageCache *page_cache);
  71 const EvDocumentInfo *ev_page_cache_get_info            (EvPageCache *page_cache);
  72
  73 gboolean       ev_page_cache_get_dual_even_left  (EvPageCache *page_cache);
  74
  75 /* Navigation */
  76 gint           ev_page_cache_get_current_page    (EvPageCache *page_cache);
  77 void           ev_page_cache_set_current_page    (EvPageCache *page_cache,
  78                                                   int          page);
  79 void           ev_page_cache_set_current_page_history  (EvPageCache *page_cache,
  80                                                         int          page);
  81 gboolean       ev_page_cache_set_page_label      (EvPageCache *page_cache,
  82                                                   const char  *page_label);
  83
  84 EvPageCache   *ev_page_cache_get                 (EvDocument *document);
  85
  86 gboolean       ev_page_cache_check_dimensions    (EvPageCache *page_cache);
  87
  88 G_END_DECLS
  89
  90 #endif /* __EV_PAGE_CACHE_H__ */