git.maemo.org Git - modest/blob - src/widgets/modest-scrollable.h

   1 /* Copyright (c) 2009, Igalia
   2  * All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  * * Redistributions of source code must retain the above copyright
   9  *   notice, this list of conditions and the following disclaimer.
  10  * * Redistributions in binary form must reproduce the above copyright
  11  *   notice, this list of conditions and the following disclaimer in the
  12  *   documentation and/or other materials provided with the distribution.
  13  * * Neither the name of the Nokia Corporation nor the names of its
  14  *   contributors may be used to endorse or promote products derived from
  15  *   this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
  18  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  19  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  20  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
  21  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  22  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  23  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  24  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  25  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  26  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  27  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30 #ifndef MODEST_SCROLLABLE_H
  31 #define MODEST_SCROLLABLE_H
  32
  33 #include <glib.h>
  34 #include <glib-object.h>
  35 #include <gtk/gtk.h>
  36
  37 G_BEGIN_DECLS
  38
  39 #define MODEST_TYPE_SCROLLABLE            (modest_scrollable_get_type ())
  40 #define MODEST_SCROLLABLE(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), MODEST_TYPE_SCROLLABLE, ModestScrollable))
  41 #define MODEST_IS_SCROLLABLE(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), MODEST_TYPE_SCROLLABLE))
  42 #define MODEST_SCROLLABLE_GET_IFACE(inst) (G_TYPE_INSTANCE_GET_INTERFACE ((inst), MODEST_TYPE_SCROLLABLE, ModestScrollableIface))
  43
  44 typedef struct _ModestScrollable ModestScrollable;
  45 typedef struct _ModestScrollableIface ModestScrollableIface;
  46
  47 struct _ModestScrollableIface
  48 {
  49         GTypeInterface parent;
  50
  51         void (*add_with_viewport) (ModestScrollable *self, GtkWidget *widget);
  52         GtkAdjustment * (*get_vadjustment) (ModestScrollable *self);
  53         GtkAdjustment * (*get_hadjustment) (ModestScrollable *self);
  54         void (*scroll_to) (ModestScrollable *self, const gint x, const gint y);
  55         void (*jump_to) (ModestScrollable *self, const gint x, const gint y);
  56         GtkPolicyType (*get_vertical_policy) (ModestScrollable *self);
  57         GtkPolicyType (*get_horizontal_policy) (ModestScrollable *self);
  58         void (*set_vertical_policy) (ModestScrollable *self, GtkPolicyType policy);
  59         void (*set_horizontal_policy) (ModestScrollable *self, GtkPolicyType policy);
  60
  61         /* properties */
  62         /* horizontal-policy; */
  63         /* vertical-policy; */
  64         /* movement-mode */
  65         /* horizontal-max-overshoot */
  66         /* vertical-max-overshoot */
  67
  68 };
  69
  70 GType modest_scrollable_get_type (void);
  71
  72 typedef enum {
  73   MODEST_MOVEMENT_MODE_HORIZONTAL = 1 << 1,
  74   MODEST_MOVEMENT_MODE_VERTICAL = 1 << 2,
  75   MODEST_MOVEMENT_MODE_BOTH = 0x000006
  76 } ModestMovementMode;
  77
  78
  79 GType modest_movement_mode_get_type (void);
  80 #define MODEST_TYPE_MOVEMENT_MODE (modest_movement_mode_get_type())
  81
  82
  83 /* virtual methods */
  84 void modest_scrollable_add_with_viewport (ModestScrollable *self, GtkWidget *widget);
  85 GtkAdjustment * modest_scrollable_get_vadjustment (ModestScrollable *self);
  86 GtkAdjustment * modest_scrollable_get_hadjustment (ModestScrollable *self);
  87 void modest_scrollable_scroll_to (ModestScrollable *self, const gint x, const gint y);
  88 void modest_scrollable_jump_to (ModestScrollable *self, const gint x, const gint y);
  89 GtkPolicyType modest_scrollable_get_vertical_policy (ModestScrollable *self);
  90 GtkPolicyType modest_scrollable_get_horizontal_policy (ModestScrollable *self);
  91 void modest_scrollable_set_vertical_policy (ModestScrollable *self, GtkPolicyType policy);
  92 void modest_scrollable_set_horizontal_policy (ModestScrollable *self, GtkPolicyType policy);
  93
  94 /* utils */
  95 void modest_scrollable_scroll (ModestScrollable *self, gint horizontal, gint vertical);
  96
  97 G_END_DECLS
  98
  99 #endif