summaryrefslogtreecommitdiff
path: root/src/ElmSharp/ElmSharp/Box.cs
blob: 3436c649ebf2569ddc0ac9e3b1d26cf5bcf4bad1 (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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
/*
 * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
 *
 * Licensed under the Apache License, Version 2.0 (the License);
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an AS IS BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

using System;

namespace ElmSharp
{
    /// <summary>
    /// The Box is a container used to arranges UI components in a linear order.
    /// </summary>
    public class Box : Container
    {
        private Interop.Elementary.BoxLayoutCallback _layoutCallback;

        /// <summary>
        /// Creates and initializes a new instance of the Box class.
        /// </summary>
        /// <param name="parent">The EvasObject to which the new Box will be attached as a child.</param>
        public Box(EvasObject parent) : base(parent)
        {
        }

        /// <summary>
        /// Sets or gets IsHorizontal value which describe pack direction, vertical is default.
        /// </summary>
        public bool IsHorizontal
        {
            get
            {
                return Interop.Elementary.elm_box_horizontal_get(RealHandle);
            }
            set
            {
                Interop.Elementary.elm_box_horizontal_set(RealHandle, value);
            }
        }

        /// <summary>
        /// Sets or gets whether the box to arrange its children homogeneously.
        /// </summary>
        public bool IsHomogeneous
        {
            get
            {
                return Interop.Elementary.elm_box_homogeneous_get(RealHandle);
            }
            set
            {
                Interop.Elementary.elm_box_homogeneous_set(RealHandle, value);
            }
        }

        /// <summary>
        /// Adds an object at the end of the pack list.
        /// </summary>
        /// <remarks>
        /// Packs "content" object into the Box, placing it last in the list of children objects.
        /// The actual position the object will get on screen depends on the layout used.
        /// If no custom layout is set, it will be at the bottom or right,
        /// depending if the Box is vertical or horizontal, respectively.
        /// </remarks>
        /// <param name="content">The oject be packed</param>
        public void PackEnd(EvasObject content)
        {
            Interop.Elementary.elm_box_pack_end(RealHandle, content);
            AddChild(content);
        }

        /// <summary>
        /// Adds an "content" object to the beginning of the pack list.
        /// </summary>
        /// <remarks>
        /// Pack "content" object into the Box obj, placing it first in the list of children objects.
        /// The actual position the object will get on screen depends on the layout used.
        /// If no custom layout is set, it will be at the top or left,
        /// depending if the Box is vertical or horizontal, respectively.
        /// </remarks>
        /// <param name="content">The object to be packed.</param>
        public void PackStart(EvasObject content)
        {
            Interop.Elementary.elm_box_pack_start(RealHandle, content);
            AddChild(content);
        }

        /// <summary>
        /// Adds an "content "object to the Box after the "after" object.
        /// </summary>
        /// <remarks>
        /// This will add the "content" to the Box indicated after the object indicated with "after".
        /// If "after" is not already in the Box, results are undefined.
        /// After means either to the right of the "after" object or below it depending on orientation.
        /// </remarks>
        /// <param name="content">The object will be added in Box</param>
        /// <param name="after">The object has been added in Box</param>
        public void PackAfter(EvasObject content, EvasObject after)
        {
            Interop.Elementary.elm_box_pack_after(RealHandle, content, after);
            AddChild(content);
        }

        /// <summary>
        /// Adds an "content "object to the Box before the "before" object.
        /// </summary>
        /// <remarks>
        /// This will add the "content" to the Box indicated before the object indicated with "before".
        /// If "before" is not already in the Box, results are undefined.
        /// before means either to the left of the "before" object or below it depending on orientation.
        /// </remarks>
        /// <param name="content">The object will be added in Box</param>
        /// <param name="before">The object has been added in Box</param>
        public void PackBefore(EvasObject content, EvasObject before)
        {
            Interop.Elementary.elm_box_pack_before(RealHandle, content, before);
            AddChild(content);
        }

        /// <summary>
        /// Remove the "content" oject from Box without deleting it.
        /// </summary>
        /// <param name="content">The object to unpack</param>
        public void UnPack(EvasObject content)
        {
            Interop.Elementary.elm_box_unpack(RealHandle, content);
            RemoveChild(content);
        }

        /// <summary>
        /// Removes all objects from Box container.
        /// </summary>
        public void UnPackAll()
        {
            Interop.Elementary.elm_box_unpack_all(RealHandle);
            ClearChildren();
        }

        /// <summary>
        /// Whenever anything changes that requires the Box in obj to recalculate the size and position of its elements,
        /// the function cb will be called to determine what the layout of the children will be.
        /// </summary>
        /// <param name="action">The callback function used for layout </param>
        public void SetLayoutCallback(Action action)
        {
            _layoutCallback = (obj, priv, data) =>
            {
                action();
            };
            Interop.Elementary.elm_box_layout_set(RealHandle, _layoutCallback, IntPtr.Zero, null);
        }

        /// <summary>
        /// Sets the color of exact part to Box's layout parent.
        /// </summary>
        /// <param name="part">The name of part class, it could be 'bg', 'elm.swllow.content'.</param>
        /// <param name="color">The color value.</param>
        public override void SetPartColor(string part, Color color)
        {
            Interop.Elementary.elm_object_color_class_color_set(Handle, part, color.R * color.A / 255,
                                                                              color.G * color.A / 255,
                                                                              color.B * color.A / 255,
                                                                              color.A);
        }

        /// <summary>
        /// Gets the color of exact part of Box's layout parent.
        /// </summary>
        /// <param name="part">The name of part class, it could be 'bg', 'elm.swllow.content'.</param>
        /// <returns></returns>
        public override Color GetPartColor(string part)
        {
            int r, g, b, a;
            Interop.Elementary.elm_object_color_class_color_get(Handle, part, out r, out g, out b, out a);
            return new Color((int)(r / (a / 255.0)), (int)(g / (a / 255.0)), (int)(b / (a / 255.0)), a);
        }

        /// <summary>
        /// Force the box to recalculate its children packing.
        /// If any children was added or removed, box will not calculate the values immediately rather leaving it to the next main loop iteration.
        /// While this is great as it would save lots of recalculation, whenever you need to get the position of a just added item you must force recalculate before doing so.
        /// </summary>
        public void Recalculate()
        {
            Interop.Elementary.elm_box_recalculate(RealHandle);
        }

        /// <summary>
        /// Clear the box of all children.
        /// Remove all the elements contained by the box, deleting the respective objects.
        /// </summary>
        public void Clear()
        {
            Interop.Elementary.elm_box_clear(RealHandle);
            ClearChildren();
        }

        /// <summary>
        /// Sets or gets the alignment of the whole bounding box of contents.
        /// </summary>
        /// <param name="horizontal">Horizontal alignment</param>
        /// <param name="vertical">Vertical alignment</param>
        public void SetBoxAlignment(double horizontal, double vertical)
        {
            Interop.Elementary.elm_box_align_set(RealHandle, horizontal, vertical);
        }

        /// <summary>
        /// Sets or gets the space(padding) between the box's elements.
        /// </summary>
        /// <param name="horizontal">Horizontal padding</param>
        /// <param name="vertical">vertical padding</param>
        public void SetPadding(int horizontal, int vertical)
        {
            Interop.Elementary.elm_box_padding_set(RealHandle, horizontal, vertical);
        }

        protected override IntPtr CreateHandle(EvasObject parent)
        {
            IntPtr handle = Interop.Elementary.elm_layout_add(parent.Handle);
            Interop.Elementary.elm_layout_theme_set(handle, "layout", "background", "default");

            RealHandle = Interop.Elementary.elm_box_add(handle);
            Interop.Elementary.elm_object_part_content_set(handle, "elm.swallow.content", RealHandle);

            return handle;
        }
    }
}