summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorXavi Artigas <xavierartigas@yahoo.es>2019-07-09 19:22:10 +0200
committerXavi Artigas <xavierartigas@yahoo.es>2019-07-09 19:22:10 +0200
commit56970daac4a9d82417490f552cf4124a5e546004 (patch)
treed666f10e9781b78a245ca449628b78292d65a22c
parentfa60393b4fe90e1031d49f36b74a97e5884cd52a (diff)
docs: Update Efl.Ui.Box documentation
It has had a big uppercase FIXME text for 2 years.
-rw-r--r--src/lib/elementary/efl_ui_box.eo40
1 files changed, 24 insertions, 16 deletions
diff --git a/src/lib/elementary/efl_ui_box.eo b/src/lib/elementary/efl_ui_box.eo
index b0a42013ae..4b27389c52 100644
--- a/src/lib/elementary/efl_ui_box.eo
+++ b/src/lib/elementary/efl_ui_box.eo
@@ -1,29 +1,37 @@
1class @beta Efl.Ui.Box extends Efl.Ui.Widget implements Efl.Pack_Linear, Efl.Pack_Layout, 1class @beta Efl.Ui.Box extends Efl.Ui.Widget implements Efl.Pack_Linear, Efl.Pack_Layout,
2 Efl.Ui.Layout_Orientable, Efl.Gfx.Arrangement 2 Efl.Ui.Layout_Orientable, Efl.Gfx.Arrangement
3{ 3{
4 [[The box widget. 4 [[A container that arranges children widgets in a vertical or horizontal fashion.
5 5
6 A box arranges objects in a linear fashion, governed by a layout function 6 The Box widget is the most basic (and the most used) of the container widgets.
7 that defines the details of this arrangement. 7 Other widgets are added to the Box through the @Efl.Pack_Linear interface, and the
8 layout direction (either vertical or horizontal) is controlled through the
9 @Efl.Ui.Layout_Orientable.orientation property.
8 10
9 By default, the box will use an internal function to set the layout to 11 The Box widget itself is invisible, as are most container widgets: Their purpose is
10 a single row, either vertical or horizontal. This layout is affected 12 to handle the position and size of all their children so you don't have to.
11 by a number of parameters. The values given by @Efl.Gfx.Arrangement.content_padding.set
12 and @Efl.Gfx.Arrangement.content_align.set and the hints set to each object in the box.
13 13
14 FIXME: 14 All widgets inside a vertical Box container will have the same width as the container,
15 THIS CLASS NEEDS GOOD UP TO DATE DOCUMENTATION. LEGACY BOX AND UI BOX 15 and their heights will be automatically chosen so that they cover the whole surface of
16 BEHAVE SLIGHTLY DIFFERENTLY AND USE VASTLY DIFFERENT APIS. 16 the container from top to bottom (Imagine a stack of pizza boxes neatly fitting inside
17 your oven). The @Efl.Ui.Box.homogeneous property then controls whether all widgets have
18 the same height (homogeneous) or not.
19
20 A horizontal Box container example would be the button toolbar at the top of most word
21 processing programs.
22
23 Precise layout can be further customized through the @Efl.Gfx.Arrangement interface on
24 the Box itself, or through the @Efl.Gfx.Hint interface on each of the children widgets.
17 ]] 25 ]]
18 methods { 26 methods {
19 @property homogeneous { 27 @property homogeneous {
20 [[Control homogeneous mode. 28 [[In homogeneous mode all children of a vertical Box have the same height, equal to
21 29 the height of the tallest widget. Children of a horizontal Box have the same width,
22 This will enable the homogeneous mode where children are of the same 30 equal to the width of the widest widget. Otherwise, individual widget sizes are not
23 weight and of the same min size which is determined by maximum min 31 modified.
24 size of children.]] 32 ]]
25 values { 33 values {
26 homogeneous: bool; [[$true if the box is homogeneous, $false otherwise]] 34 homogeneous: bool; [[$true if the Box is homogeneous, $false otherwise.]]
27 } 35 }
28 } 36 }
29 } 37 }