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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  19  */
  20
  21 #if !defined (__EV_EVINCE_DOCUMENT_H_INSIDE__) && !defined (EVINCE_COMPILATION)
  22 #error "Only <evince-document.h> can be included directly."
  23 #endif
  24
  25 #ifndef EV_DOCUMENT_TRANSITION_H
  26 #define EV_DOCUMENT_TRANSITION_H
  27
  28 #include <glib-object.h>
  29
  30 #include "ev-document.h"
  31 #include "ev-transition-effect.h"
  32
  33 G_BEGIN_DECLS
  34
  35 #define EV_TYPE_DOCUMENT_TRANSITION            (ev_document_transition_get_type ())
  36 #define EV_DOCUMENT_TRANSITION(o)              (G_TYPE_CHECK_INSTANCE_CAST ((o), EV_TYPE_DOCUMENT_TRANSITION, EvDocumentTransition))
  37 #define EV_DOCUMENT_TRANSITION_IFACE(k)        (G_TYPE_CHECK_CLASS_CAST((k), EV_TYPE_DOCUMENT_TRANSITION, EvDocumentTransitionInterface))
  38 #define EV_IS_DOCUMENT_TRANSITION(o)           (G_TYPE_CHECK_INSTANCE_TYPE ((o), EV_TYPE_DOCUMENT_TRANSITION))
  39 #define EV_IS_DOCUMENT_TRANSITION_IFACE(k)     (G_TYPE_CHECK_CLASS_TYPE ((k), EV_TYPE_DOCUMENT_TRANSITION))
  40 #define EV_DOCUMENT_TRANSITION_GET_IFACE(inst) (G_TYPE_INSTANCE_GET_INTERFACE ((inst), EV_TYPE_DOCUMENT_TRANSITION, EvDocumentTransitionInterface))
  41
  42 typedef struct _EvDocumentTransition          EvDocumentTransition;
  43 typedef struct _EvDocumentTransitionInterface EvDocumentTransitionInterface;
  44
  45 struct _EvDocumentTransitionInterface
  46 {
  47         GTypeInterface base_iface;
  48
  49         /* Methods  */
  50         gdouble              (* get_page_duration) (EvDocumentTransition *document_trans,
  51                                                     gint                  page);
  52         EvTransitionEffect * (* get_effect)        (EvDocumentTransition *document_trans,
  53                                                     gint                  page);
  54 };
  55
  56 GType                ev_document_transition_get_type          (void) G_GNUC_CONST;
  57 gdouble              ev_document_transition_get_page_duration (EvDocumentTransition *document_trans,
  58                                                                gint                  page);
  59 EvTransitionEffect * ev_document_transition_get_effect        (EvDocumentTransition *document_trans,
  60                                                                gint                  page);
  61
  62 G_END_DECLS
  63
  64 #endif /* EV_DOCUMENT_TRANSITION_H */