clutter/clutter-box-layout.h

   1 /*
   2  * Clutter.
   3  *
   4  * An OpenGL based 'interactive canvas' library.
   5  *
   6  * Copyright (C) 2009  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  * Author:
  22  *   Emmanuele Bassi <ebassi@linux.intel.com>
  23  *
  24  * Based on the NBTK NbtkBoxLayout actor by:
  25  *   Thomas Wood <thomas.wood@intel.com>
  26  */
  27
  28 #if !defined(__CLUTTER_H_INSIDE__) && !defined(CLUTTER_COMPILATION)
  29 #error "Only <clutter/clutter.h> can be included directly."
  30 #endif
  31
  32 #ifndef __CLUTTER_BOX_LAYOUT_H__
  33 #define __CLUTTER_BOX_LAYOUT_H__
  34
  35 #include <clutter/clutter-layout-manager.h>
  36
  37 G_BEGIN_DECLS
  38
  39 #define CLUTTER_TYPE_BOX_LAYOUT                 (clutter_box_layout_get_type ())
  40 #define CLUTTER_BOX_LAYOUT(obj)                 (G_TYPE_CHECK_INSTANCE_CAST ((obj), CLUTTER_TYPE_BOX_LAYOUT, ClutterBoxLayout))
  41 #define CLUTTER_IS_BOX_LAYOUT(obj)              (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CLUTTER_TYPE_BOX_LAYOUT))
  42 #define CLUTTER_BOX_LAYOUT_CLASS(klass)         (G_TYPE_CHECK_CLASS_CAST ((klass), CLUTTER_TYPE_BOX_LAYOUT, ClutterBoxLayoutClass))
  43 #define CLUTTER_IS_BOX_LAYOUT_CLASS(klass)      (G_TYPE_CHECK_CLASS_TYPE ((klass), CLUTTER_TYPE_BOX_LAYOUT))
  44 #define CLUTTER_BOX_LAYOUT_GET_CLASS(obj)       (G_TYPE_INSTANCE_GET_CLASS ((obj), CLUTTER_TYPE_BOX_LAYOUT, ClutterBoxLayoutClass))
  45
  46 typedef struct _ClutterBoxLayout                ClutterBoxLayout;
  47 typedef struct _ClutterBoxLayoutPrivate         ClutterBoxLayoutPrivate;
  48 typedef struct _ClutterBoxLayoutClass           ClutterBoxLayoutClass;
  49
  50 /**
  51  * ClutterBoxLayout:
  52  *
  53  * The #ClutterBoxLayout structure contains only private data
  54  * and should be accessed using the provided API
  55  *
  56  * Since: 1.2
  57  */
  58 struct _ClutterBoxLayout
  59 {
  60   /*< private >*/
  61   ClutterLayoutManager parent_instance;
  62
  63   ClutterBoxLayoutPrivate *priv;
  64 };
  65
  66 /**
  67  * ClutterBoxLayoutClass:
  68  *
  69  * The #ClutterBoxLayoutClass structure contains only private
  70  * data and should be accessed using the provided API
  71  *
  72  * Since: 1.2
  73  */
  74 struct _ClutterBoxLayoutClass
  75 {
  76   /*< private >*/
  77   ClutterLayoutManagerClass parent_class;
  78 };
  79
  80 GType clutter_box_layout_get_type (void) G_GNUC_CONST;
  81
  82 ClutterLayoutManager *  clutter_box_layout_new                 (void);
  83
  84 CLUTTER_AVAILABLE_IN_1_12
  85 void                    clutter_box_layout_set_orientation      (ClutterBoxLayout    *layout,
  86                                                                  ClutterOrientation   orientation);
  87 CLUTTER_AVAILABLE_IN_1_12
  88 ClutterOrientation      clutter_box_layout_get_orientation      (ClutterBoxLayout    *layout);
  89
  90 void                    clutter_box_layout_set_spacing          (ClutterBoxLayout    *layout,
  91                                                                  guint                spacing);
  92 guint                   clutter_box_layout_get_spacing          (ClutterBoxLayout    *layout);
  93 void                    clutter_box_layout_set_homogeneous      (ClutterBoxLayout    *layout,
  94                                                                  gboolean             homogeneous);
  95 gboolean                clutter_box_layout_get_homogeneous      (ClutterBoxLayout    *layout);
  96 void                    clutter_box_layout_set_pack_start       (ClutterBoxLayout    *layout,
  97                                                                  gboolean             pack_start);
  98 gboolean                clutter_box_layout_get_pack_start       (ClutterBoxLayout    *layout);
  99
 100 CLUTTER_DEPRECATED_IN_1_12_FOR(clutter_box_layout_set_orientation)
 101 void                    clutter_box_layout_set_vertical         (ClutterBoxLayout    *layout,
 102                                                                  gboolean             vertical);
 103 CLUTTER_DEPRECATED_IN_1_12_FOR(clutter_box_layout_get_orientation)
 104 gboolean                clutter_box_layout_get_vertical         (ClutterBoxLayout    *layout);
 105
 106 void                    clutter_box_layout_pack                 (ClutterBoxLayout    *layout,
 107                                                                  ClutterActor        *actor,
 108                                                                  gboolean             expand,
 109                                                                  gboolean             x_fill,
 110                                                                  gboolean             y_fill,
 111                                                                  ClutterBoxAlignment  x_align,
 112                                                                  ClutterBoxAlignment  y_align);
 113 CLUTTER_DEPRECATED_IN_1_12
 114 void                    clutter_box_layout_set_alignment        (ClutterBoxLayout    *layout,
 115                                                                  ClutterActor        *actor,
 116                                                                  ClutterBoxAlignment  x_align,
 117                                                                  ClutterBoxAlignment  y_align);
 118 CLUTTER_DEPRECATED_IN_1_12
 119 void                    clutter_box_layout_get_alignment        (ClutterBoxLayout    *layout,
 120                                                                  ClutterActor        *actor,
 121                                                                  ClutterBoxAlignment *x_align,
 122                                                                  ClutterBoxAlignment *y_align);
 123 CLUTTER_DEPRECATED_IN_1_12
 124 void                    clutter_box_layout_set_fill             (ClutterBoxLayout    *layout,
 125                                                                  ClutterActor        *actor,
 126                                                                  gboolean             x_fill,
 127                                                                  gboolean             y_fill);
 128 CLUTTER_DEPRECATED_IN_1_12
 129 void                    clutter_box_layout_get_fill             (ClutterBoxLayout    *layout,
 130                                                                  ClutterActor        *actor,
 131                                                                  gboolean            *x_fill,
 132                                                                  gboolean            *y_fill);
 133 CLUTTER_DEPRECATED_IN_1_12
 134 void                    clutter_box_layout_set_expand           (ClutterBoxLayout    *layout,
 135                                                                  ClutterActor        *actor,
 136                                                                  gboolean             expand);
 137 CLUTTER_DEPRECATED_IN_1_12
 138 gboolean                clutter_box_layout_get_expand           (ClutterBoxLayout    *layout,
 139                                                                  ClutterActor        *actor);
 140
 141 CLUTTER_DEPRECATED_IN_1_12
 142 void                    clutter_box_layout_set_use_animations   (ClutterBoxLayout    *layout,
 143                                                                  gboolean             animate);
 144 CLUTTER_DEPRECATED_IN_1_12
 145 gboolean                clutter_box_layout_get_use_animations   (ClutterBoxLayout    *layout);
 146 CLUTTER_DEPRECATED_IN_1_12
 147 void                    clutter_box_layout_set_easing_mode      (ClutterBoxLayout    *layout,
 148                                                                  gulong               mode);
 149 CLUTTER_DEPRECATED_IN_1_12
 150 gulong                  clutter_box_layout_get_easing_mode      (ClutterBoxLayout    *layout);
 151 CLUTTER_DEPRECATED_IN_1_12
 152 void                    clutter_box_layout_set_easing_duration  (ClutterBoxLayout    *layout,
 153                                                                  guint                msecs);
 154 CLUTTER_DEPRECATED_IN_1_12
 155 guint                   clutter_box_layout_get_easing_duration  (ClutterBoxLayout    *layout);
 156
 157 G_END_DECLS
 158
 159 #endif /* __CLUTTER_BOX_LAYOUT_H__ */