From 7d727bbb26213c52f210e663359fd30e4e4f958a Mon Sep 17 00:00:00 2001 From: Mike Blumenkrantz Date: Thu, 12 Sep 2019 11:00:03 +0200 Subject: [PATCH] efl/arrangement: improve docs Summary: this adds full docs for the class and properties ref T7717 ref T7864 Reviewers: segfaultxavi Reviewed By: segfaultxavi Subscribers: cedric, #reviewers, #committers Tags: #efl Maniphest Tasks: T7864, T7717 Differential Revision: https://phab.enlightenment.org/D9912 --- src/lib/efl/interfaces/efl_gfx_arrangement.eo | 39 +++++++++++++++---- 1 file changed, 31 insertions(+), 8 deletions(-) diff --git a/src/lib/efl/interfaces/efl_gfx_arrangement.eo b/src/lib/efl/interfaces/efl_gfx_arrangement.eo index e991b8c62a..7bfe70ea82 100644 --- a/src/lib/efl/interfaces/efl_gfx_arrangement.eo +++ b/src/lib/efl/interfaces/efl_gfx_arrangement.eo @@ -1,25 +1,48 @@ interface @beta Efl.Gfx.Arrangement { - [[API common to all UI container objects.]] + [[ + This interface provides methods for manipulating how contents are arranged within a container, + providing more granularity for content positioning. + + @since 1.23 + ]] methods { @property content_align { - [[Alignment of the container within its bounds]] + [[This property determines how contents will be aligned within a container if there is + unused space. + + It is different than the @Efl.Gfx.Hint.hint_align property in that it affects the position + of all the contents within the container. For example, if a box widget has extra space + on the horizontal axis, this property can be used to align the box's contents to the + left or the right side. + + See also @Efl.Gfx.Hint.hint_align. + ]] set {} get {} values { - align_horiz: double; [[Horizontal alignment]] - align_vert: double; [[Vertical alignment]] + align_horiz: double; [[Double, ranging from 0.0 to 1.0, where 0.0 is at the start of the horizontal axis + and 1.0 is at the end. The default value is 0.5.]] + align_vert: double; [[Double, ranging from 0.0 to 1.0, where 0.0 is at the start of the vertical axis + and 1.0 is at the end. The default value is 0.5.]] } } @property content_padding { - [[Padding between items contained in this object.]] + [[This property determines the space between a container's content items. + + It is different than the @Efl.Gfx.Hint.hint_margin property in that it is applied to each + content item within the container instead of a single item. The calculation for these two properties + is cumulative. + + See also @Efl.Gfx.Hint.hint_margin. + ]] set {} get {} values { - pad_horiz: double; [[Horizontal padding]] - pad_vert: double; [[Vertical padding]] - scalable: bool; [[$true if scalable, $false otherwise]] + pad_horiz: double; [[Horizontal padding. The default value is 0.0.]] + pad_vert: double; [[Vertical padding. The default value is 0.0.]] + scalable: bool; [[$true if scalable, $false otherwise. The default value is $false.]] } } }