clutter/clutter-scroll-actor.h

   1 /*
   2  * Clutter.
   3  *
   4  * An OpenGL based 'interactive canvas' library.
   5  *
   6  * Copyright (C) 2012  Intel Corporation
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with this library. If not, see <http://www.gnu.org/licenses/>.
  20  */
  21
  22 #if !defined(__CLUTTER_H_INSIDE__) && !defined(CLUTTER_COMPILATION)
  23 #error "Only <clutter/clutter.h> can be included directly."
  24 #endif
  25
  26 #ifndef __CLUTTER_SCROLL_ACTOR_H__
  27 #define __CLUTTER_SCROLL_ACTOR_H__
  28
  29 #include <clutter/clutter-types.h>
  30 #include <clutter/clutter-actor.h>
  31
  32 G_BEGIN_DECLS
  33
  34 #define CLUTTER_TYPE_SCROLL_ACTOR               (clutter_scroll_actor_get_type ())
  35 #define CLUTTER_SCROLL_ACTOR(obj)               (G_TYPE_CHECK_INSTANCE_CAST ((obj), CLUTTER_TYPE_SCROLL_ACTOR, ClutterScrollActor))
  36 #define CLUTTER_IS_SCROLL_ACTOR(obj)            (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CLUTTER_TYPE_SCROLL_ACTOR))
  37 #define CLUTTER_SCROLL_ACTOR_CLASS(klass)       (G_TYPE_CHECK_CLASS_CAST ((klass), CLUTTER_TYPE_SCROLL_ACTOR, ClutterScrollActorClass))
  38 #define CLUTTER_IS_SCROLL_ACTOR_CLASS(klass)    (G_TYPE_CHECK_CLASS_TYPE ((klass), CLUTTER_TYPE_SCROLL_ACTOR))
  39 #define CLUTTER_SCROLL_ACTOR_GET_CLASS(obj)     (G_TYPE_INSTANCE_GET_CLASS ((obj), CLUTTER_TYPE_SCROLL_ACTOR, ClutterScrollActorClass))
  40
  41 typedef struct _ClutterScrollActorPrivate       ClutterScrollActorPrivate;
  42 typedef struct _ClutterScrollActorClass         ClutterScrollActorClass;
  43
  44 /**
  45  * ClutterScrollActor:
  46  *
  47  * The <structname>ClutterScrollActor</structname> structure contains only
  48  * private data, and should be accessed using the provided API.
  49  *
  50  * Since: 1.12
  51  */
  52 struct _ClutterScrollActor
  53 {
  54   /*< private >*/
  55   ClutterActor parent_instance;
  56
  57   ClutterScrollActorPrivate *priv;
  58 };
  59
  60 /**
  61  * ClutterScrollActorClass:
  62  *
  63  * The <structname>ClutterScrollActor</structname> structure contains only
  64  * private data.
  65  *
  66  * Since: 1.12
  67  */
  68 struct _ClutterScrollActorClass
  69 {
  70   /*< private >*/
  71   ClutterActorClass parent_instance;
  72
  73   gpointer _padding[8];
  74 };
  75
  76 CLUTTER_AVAILABLE_IN_1_12
  77 GType clutter_scroll_actor_get_type (void) G_GNUC_CONST;
  78
  79 CLUTTER_AVAILABLE_IN_1_12
  80 ClutterActor *          clutter_scroll_actor_new                (void);
  81
  82 CLUTTER_AVAILABLE_IN_1_12
  83 void                    clutter_scroll_actor_set_scroll_mode    (ClutterScrollActor *actor,
  84                                                                  ClutterScrollMode   mode);
  85 CLUTTER_AVAILABLE_IN_1_12
  86 ClutterScrollMode       clutter_scroll_actor_get_scroll_mode    (ClutterScrollActor *actor);
  87
  88 CLUTTER_AVAILABLE_IN_1_12
  89 void                    clutter_scroll_actor_scroll_to_point    (ClutterScrollActor *actor,
  90                                                                  const ClutterPoint *point);
  91 CLUTTER_AVAILABLE_IN_1_12
  92 void                    clutter_scroll_actor_scroll_to_rect     (ClutterScrollActor *actor,
  93                                                                  const ClutterRect  *rect);
  94
  95 G_END_DECLS
  96
  97 #endif /* __CLUTTER_SCROLL_ACTOR_H__ */