timer23
/
efl
forked from enlightenment/efl
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs: Efl.Ui.Widget_Scroller_Content updated docs 

Summary: Ref T8254

Reviewers: zmike

Reviewed By: zmike

Subscribers: cedric, #reviewers, #committers

Tags: #efl

Maniphest Tasks: T8254

Differential Revision: https://phab.enlightenment.org/D10082
This commit is contained in:
Xavi Artigas 2019-09-23 18:05:07 +02:00
parent e79d6bd0af
commit 883ef612b7
1 changed files with 13 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
src/lib/elementary/efl_ui_widget_scrollable_content.eo
View File

@ -3,14 +3,14 @@ parse efl_text_format;
mixin @beta Efl.Ui.Widget_Scrollable_Content requires Efl.Object mixin @beta Efl.Ui.Widget_Scrollable_Content requires Efl.Object
{ {
[[Efl widget scrollable content mixin [[Mixin helper to add scrollable content to widgets.
This can be used to provide scrollable contents and text for widgets. When a scrollable This can be used to provide scrollable contents and text for widgets. When @.scrollable_content or
text or content is set, this mixin will create and manage an internal scroller object which @.scrollable_text is set, this mixin will create and manage an internal scroller object which
will be the container of that text or content. will be the container of that text or content.
Only a single content or text can be set at any given time. Setting @.scrollable_content Only a single content or text can be set at any given time. Setting @.scrollable_text
will unset @.scrollable_text and vice versa. will unset @.scrollable_content.
@since 1.23 @since 1.23
]] ]]
@ -21,34 +21,32 @@ mixin @beta Efl.Ui.Widget_Scrollable_Content requires Efl.Object
@property scrollable_content_did_group_calc @protected @beta { @property scrollable_content_did_group_calc @protected @beta {
[[Widgets can call this function during their @Efl.Canvas.Group.group_calculate [[Widgets can call this function during their @Efl.Canvas.Group.group_calculate
implementation after the super call to determine whether the internal scroller implementation after the super call to determine whether the internal scroller
has performed sizing calculations. has already performed sizing calculations.
The optimal_size,calc event will have been emitted during the super call if If this property is $true, the @[Efl.Ui.Widget_Scrollable_Content.optimal_size,calc] event will have been
this method returns $true. emitted during the super call. In this case it's likely that the widget should be completing
its internal sizing calculations from that event using:
In the case that this returns $true, it's likely that the widget should be completing
its internal sizing calculations from the @[Efl.Ui.Widget_Scrollable_Content.optimal_size,calc] callback using
efl_canvas_group_calculate(efl_super(ev->object, EFL_UI_WIDGET_SCROLLABLE_CONTENT_MIXIN)); efl_canvas_group_calculate(efl_super(ev->object, EFL_UI_WIDGET_SCROLLABLE_CONTENT_MIXIN));
in order to skip the scrollable sizing calc. in order to skip the scrollable sizing calculation.
@since 1.23 @since 1.23
]] ]]
get {} get {}
values { values {
did_group_calc: bool; [[Whether the internal scroller has done sizing calcs.]] did_group_calc: bool; [[Whether the internal scroller has already done sizing calculations.]]
} }
} }
@property scrollable_content { @property scrollable_content {
[[This is the content which will be placed in the internal scroller. [[This is the content which will be placed in the internal scroller.
If a scrollable text string is set, this will return $NULL. If a @.scrollable_text string is set, this property will be $NULL.
@since 1.23 @since 1.23
]] ]]
set { set {
return: bool; [[True on success]] return: bool; [[$true on success.]]
} }
get {} get {}
values { values {