libdocument/ev-document-transition.h

   1 /* ev-document-transition.h
   2  *  this file is part of evince, a gnome document viewer
   3  *
   4  * Copyright (C) 2006 Carlos Garcia Campos <carlosgc@gnome.org>
   5  *
   6  * Evince is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * Evince is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
  19  */
  20
  21 #ifndef EV_DOCUMENT_TRANSITION_H
  22 #define EV_DOCUMENT_TRANSITION_H
  23
  24 #include <glib-object.h>
  25
  26 #include "ev-document.h"
  27
  28 G_BEGIN_DECLS
  29
  30 #define EV_TYPE_DOCUMENT_TRANSITION            (ev_document_transition_get_type ())
  31 #define EV_DOCUMENT_TRANSITION(o)              (G_TYPE_CHECK_INSTANCE_CAST ((o), EV_TYPE_DOCUMENT_TRANSITION, EvDocumentTransition))
  32 #define EV_DOCUMENT_TRANSITION_IFACE(k)        (G_TYPE_CHECK_CLASS_CAST((k), EV_TYPE_DOCUMENT_TRANSITION, EvDocumentTransitionIface))
  33 #define EV_IS_DOCUMENT_TRANSITION(o)           (G_TYPE_CHECK_INSTANCE_TYPE ((o), EV_TYPE_DOCUMENT_TRANSITION))
  34 #define EV_IS_DOCUMENT_TRANSITION_IFACE(k)     (G_TYPE_CHECK_CLASS_TYPE ((k), EV_TYPE_DOCUMENT_TRANSITION))
  35 #define EV_DOCUMENT_TRANSITION_GET_IFACE(inst) (G_TYPE_INSTANCE_GET_INTERFACE ((inst), EV_TYPE_DOCUMENT_TRANSITION, EvDocumentTransitionIface))
  36
  37 typedef struct _EvDocumentTransition      EvDocumentTransition;
  38 typedef struct _EvDocumentTransitionIface EvDocumentTransitionIface;
  39
  40 struct _EvDocumentTransitionIface
  41 {
  42         GTypeInterface base_iface;
  43
  44         /* Methods  */
  45         gdouble       (* get_page_duration)  (EvDocumentTransition *document_trans,
  46                                               gint                  page);
  47         /* TODO: Support page transition effects (page 562 PDF Reference 1.6) */
  48 };
  49
  50 GType   ev_document_transition_get_type          (void) G_GNUC_CONST;
  51 gdouble ev_document_transition_get_page_duration (EvDocumentTransition *document_trans,
  52                                                   gint                  page);
  53
  54 G_END_DECLS
  55
  56 #endif /* EV_DOCUMENT_TRANSITION_H */