clutter/clutter-flow-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
  25 #if !defined(__CLUTTER_H_INSIDE__) && !defined(CLUTTER_COMPILATION)
  26 #error "Only <clutter/clutter.h> can be included directly."
  27 #endif
  28
  29 #ifndef __CLUTTER_FLOW_LAYOUT_H__
  30 #define __CLUTTER_FLOW_LAYOUT_H__
  31
  32 #include <clutter/clutter-layout-manager.h>
  33
  34 G_BEGIN_DECLS
  35
  36 #define CLUTTER_TYPE_FLOW_LAYOUT                (clutter_flow_layout_get_type ())
  37 #define CLUTTER_FLOW_LAYOUT(obj)                (G_TYPE_CHECK_INSTANCE_CAST ((obj), CLUTTER_TYPE_FLOW_LAYOUT, ClutterFlowLayout))
  38 #define CLUTTER_IS_FLOW_LAYOUT(obj)             (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CLUTTER_TYPE_FLOW_LAYOUT))
  39 #define CLUTTER_FLOW_LAYOUT_CLASS(klass)        (G_TYPE_CHECK_CLASS_CAST ((klass), CLUTTER_TYPE_FLOW_LAYOUT, ClutterFlowLayoutClass))
  40 #define CLUTTER_IS_FLOW_LAYOUT_CLASS(klass)     (G_TYPE_CHECK_CLASS_TYPE ((klass), CLUTTER_TYPE_FLOW_LAYOUT))
  41 #define CLUTTER_FLOW_LAYOUT_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS ((obj), CLUTTER_TYPE_FLOW_LAYOUT, ClutterFlowLayoutClass))
  42
  43 typedef struct _ClutterFlowLayout               ClutterFlowLayout;
  44 typedef struct _ClutterFlowLayoutPrivate        ClutterFlowLayoutPrivate;
  45 typedef struct _ClutterFlowLayoutClass          ClutterFlowLayoutClass;
  46
  47 /**
  48  * ClutterFlowLayout:
  49  *
  50  * The #ClutterFlowLayout structure contains only private data
  51  * and should be accessed using the provided API
  52  *
  53  * Since: 1.2
  54  */
  55 struct _ClutterFlowLayout
  56 {
  57   /*< private >*/
  58   ClutterLayoutManager parent_instance;
  59
  60   ClutterFlowLayoutPrivate *priv;
  61 };
  62
  63 /**
  64  * ClutterFlowLayoutClass:
  65  *
  66  * The #ClutterFlowLayoutClass structure contains only private data
  67  * and should be accessed using the provided API
  68  *
  69  * Since: 1.2
  70  */
  71 struct _ClutterFlowLayoutClass
  72 {
  73   /*< private >*/
  74   ClutterLayoutManagerClass parent_class;
  75 };
  76
  77 GType clutter_flow_layout_get_type (void) G_GNUC_CONST;
  78
  79 ClutterLayoutManager * clutter_flow_layout_new                (ClutterFlowOrientation  orientation);
  80
  81 void                   clutter_flow_layout_set_orientation    (ClutterFlowLayout      *layout,
  82                                                                ClutterFlowOrientation  orientation);
  83 ClutterFlowOrientation clutter_flow_layout_get_orientation    (ClutterFlowLayout      *layout);
  84 void                   clutter_flow_layout_set_homogeneous    (ClutterFlowLayout      *layout,
  85                                                                gboolean                homogeneous);
  86 gboolean               clutter_flow_layout_get_homogeneous    (ClutterFlowLayout      *layout);
  87
  88 void                   clutter_flow_layout_set_column_spacing (ClutterFlowLayout      *layout,
  89                                                                gfloat                  spacing);
  90 gfloat                 clutter_flow_layout_get_column_spacing (ClutterFlowLayout      *layout);
  91 void                   clutter_flow_layout_set_row_spacing    (ClutterFlowLayout      *layout,
  92                                                                gfloat                  spacing);
  93 gfloat                 clutter_flow_layout_get_row_spacing    (ClutterFlowLayout      *layout);
  94
  95 void                   clutter_flow_layout_set_column_width   (ClutterFlowLayout      *layout,
  96                                                                gfloat                  min_width,
  97                                                                gfloat                  max_width);
  98 void                   clutter_flow_layout_get_column_width   (ClutterFlowLayout      *layout,
  99                                                                gfloat                 *min_width,
 100                                                                gfloat                 *max_width);
 101 void                   clutter_flow_layout_set_row_height     (ClutterFlowLayout      *layout,
 102                                                                gfloat                  min_height,
 103                                                                gfloat                  max_height);
 104 void                   clutter_flow_layout_get_row_height     (ClutterFlowLayout      *layout,
 105                                                                gfloat                 *min_height,
 106                                                                gfloat                 *max_height);
 107
 108 G_END_DECLS
 109
 110 #endif /* __CLUTTER_FLOW_LAYOUT_H__ */