summaryrefslogtreecommitdiff
path: root/clutter/clutter-box-layout.h
blob: a5c085c1ffb43fa6885b8fa0d9cbe792a1ce0897 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
/*
 * Clutter.
 *
 * An OpenGL based 'interactive canvas' library.
 *
 * Copyright (C) 2009  Intel Corporation.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
 *
 * Author:
 *   Emmanuele Bassi <ebassi@linux.intel.com>
 *
 * Based on the NBTK NbtkBoxLayout actor by:
 *   Thomas Wood <thomas.wood@intel.com>
 */

#ifndef __CLUTTER_BOX_LAYOUT_H__
#define __CLUTTER_BOX_LAYOUT_H__

#if !defined(__CLUTTER_H_INSIDE__) && !defined(CLUTTER_COMPILATION)
#error "Only <clutter/clutter.h> can be included directly."
#endif

#include <clutter/clutter-layout-manager.h>

G_BEGIN_DECLS

#define CLUTTER_TYPE_BOX_LAYOUT                 (clutter_box_layout_get_type ())
#define CLUTTER_BOX_LAYOUT(obj)                 (G_TYPE_CHECK_INSTANCE_CAST ((obj), CLUTTER_TYPE_BOX_LAYOUT, ClutterBoxLayout))
#define CLUTTER_IS_BOX_LAYOUT(obj)              (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CLUTTER_TYPE_BOX_LAYOUT))
#define CLUTTER_BOX_LAYOUT_CLASS(klass)         (G_TYPE_CHECK_CLASS_CAST ((klass), CLUTTER_TYPE_BOX_LAYOUT, ClutterBoxLayoutClass))
#define CLUTTER_IS_BOX_LAYOUT_CLASS(klass)      (G_TYPE_CHECK_CLASS_TYPE ((klass), CLUTTER_TYPE_BOX_LAYOUT))
#define CLUTTER_BOX_LAYOUT_GET_CLASS(obj)       (G_TYPE_INSTANCE_GET_CLASS ((obj), CLUTTER_TYPE_BOX_LAYOUT, ClutterBoxLayoutClass))

typedef struct _ClutterBoxLayout                ClutterBoxLayout;
typedef struct _ClutterBoxLayoutPrivate         ClutterBoxLayoutPrivate;
typedef struct _ClutterBoxLayoutClass           ClutterBoxLayoutClass;

/**
 * ClutterBoxLayout:
 *
 * The #ClutterBoxLayout structure contains only private data
 * and should be accessed using the provided API
 *
 * Since: 1.2
 */
struct _ClutterBoxLayout
{
  /*< private >*/
  ClutterLayoutManager parent_instance;

  ClutterBoxLayoutPrivate *priv;
};

/**
 * ClutterBoxLayoutClass:
 *
 * The #ClutterBoxLayoutClass structure contains only private
 * data and should be accessed using the provided API
 *
 * Since: 1.2
 */
struct _ClutterBoxLayoutClass
{
  /*< private >*/
  ClutterLayoutManagerClass parent_class;
};

CLUTTER_AVAILABLE_IN_1_2
GType clutter_box_layout_get_type (void) G_GNUC_CONST;

CLUTTER_AVAILABLE_IN_1_2
ClutterLayoutManager *  clutter_box_layout_new                 (void);

CLUTTER_AVAILABLE_IN_1_12
void                    clutter_box_layout_set_orientation      (ClutterBoxLayout    *layout,
                                                                 ClutterOrientation   orientation);
CLUTTER_AVAILABLE_IN_1_12
ClutterOrientation      clutter_box_layout_get_orientation      (ClutterBoxLayout    *layout);

CLUTTER_AVAILABLE_IN_1_2
void                    clutter_box_layout_set_spacing          (ClutterBoxLayout    *layout,
                                                                 guint                spacing);
CLUTTER_AVAILABLE_IN_1_2
guint                   clutter_box_layout_get_spacing          (ClutterBoxLayout    *layout);
CLUTTER_AVAILABLE_IN_1_2
void                    clutter_box_layout_set_homogeneous      (ClutterBoxLayout    *layout,
                                                                 gboolean             homogeneous);
CLUTTER_AVAILABLE_IN_1_2
gboolean                clutter_box_layout_get_homogeneous      (ClutterBoxLayout    *layout);
CLUTTER_AVAILABLE_IN_1_2
void                    clutter_box_layout_set_pack_start       (ClutterBoxLayout    *layout,
                                                                 gboolean             pack_start);
CLUTTER_AVAILABLE_IN_1_2
gboolean                clutter_box_layout_get_pack_start       (ClutterBoxLayout    *layout);

CLUTTER_DEPRECATED_IN_1_12_FOR(clutter_box_layout_set_orientation)
void                    clutter_box_layout_set_vertical         (ClutterBoxLayout    *layout,
                                                                 gboolean             vertical);
CLUTTER_DEPRECATED_IN_1_12_FOR(clutter_box_layout_get_orientation)
gboolean                clutter_box_layout_get_vertical         (ClutterBoxLayout    *layout);

CLUTTER_AVAILABLE_IN_1_2
void                    clutter_box_layout_pack                 (ClutterBoxLayout    *layout,
                                                                 ClutterActor        *actor,
                                                                 gboolean             expand,
                                                                 gboolean             x_fill,
                                                                 gboolean             y_fill,
                                                                 ClutterBoxAlignment  x_align,
                                                                 ClutterBoxAlignment  y_align);
CLUTTER_DEPRECATED_IN_1_12
void                    clutter_box_layout_set_alignment        (ClutterBoxLayout    *layout,
                                                                 ClutterActor        *actor,
                                                                 ClutterBoxAlignment  x_align,
                                                                 ClutterBoxAlignment  y_align);
CLUTTER_DEPRECATED_IN_1_12
void                    clutter_box_layout_get_alignment        (ClutterBoxLayout    *layout,
                                                                 ClutterActor        *actor,
                                                                 ClutterBoxAlignment *x_align,
                                                                 ClutterBoxAlignment *y_align);
CLUTTER_DEPRECATED_IN_1_12
void                    clutter_box_layout_set_fill             (ClutterBoxLayout    *layout,
                                                                 ClutterActor        *actor,
                                                                 gboolean             x_fill,
                                                                 gboolean             y_fill);
CLUTTER_DEPRECATED_IN_1_12
void                    clutter_box_layout_get_fill             (ClutterBoxLayout    *layout,
                                                                 ClutterActor        *actor,
                                                                 gboolean            *x_fill,
                                                                 gboolean            *y_fill);
CLUTTER_DEPRECATED_IN_1_12
void                    clutter_box_layout_set_expand           (ClutterBoxLayout    *layout,
                                                                 ClutterActor        *actor,
                                                                 gboolean             expand);
CLUTTER_DEPRECATED_IN_1_12
gboolean                clutter_box_layout_get_expand           (ClutterBoxLayout    *layout,
                                                                 ClutterActor        *actor);

CLUTTER_DEPRECATED_IN_1_12
void                    clutter_box_layout_set_use_animations   (ClutterBoxLayout    *layout,
                                                                 gboolean             animate);
CLUTTER_DEPRECATED_IN_1_12
gboolean                clutter_box_layout_get_use_animations   (ClutterBoxLayout    *layout);
CLUTTER_DEPRECATED_IN_1_12
void                    clutter_box_layout_set_easing_mode      (ClutterBoxLayout    *layout,
                                                                 gulong               mode);
CLUTTER_DEPRECATED_IN_1_12
gulong                  clutter_box_layout_get_easing_mode      (ClutterBoxLayout    *layout);
CLUTTER_DEPRECATED_IN_1_12
void                    clutter_box_layout_set_easing_duration  (ClutterBoxLayout    *layout,
                                                                 guint                msecs);
CLUTTER_DEPRECATED_IN_1_12
guint                   clutter_box_layout_get_easing_duration  (ClutterBoxLayout    *layout);

G_END_DECLS

#endif /* __CLUTTER_BOX_LAYOUT_H__ */