enlightenment/efl
enlightenment
/
efl
8
7
Fork 14
Code Issues 13 Pull Requests 6 Projects Releases Wiki Activity

efl_ui/scrollable_content: improve docs 

Summary:
this describes more behaviors of the mixin, various internal properties
used, and removes some incorrect references

ref T7717

Reviewers: segfaultxavi

Reviewed By: segfaultxavi

Subscribers: cedric, #reviewers, #committers

Tags: #efl_docs

Maniphest Tasks: T7717

Differential Revision: https://phab.enlightenment.org/D9881
This commit is contained in:
Mike Blumenkrantz 2019-09-10 09:58:49 +02:00 committed by Xavi Artigas
parent 6e23dfba62
commit c10c9b21cc
1 changed files with 20 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,13 +1,18 @@
import eina_types; import eina_types;
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 [[Efl widget scrollable content mixin
This can be used to provide scrollable contents and text for widgets. This can be used to provide scrollable contents and text for widgets. When a scrollable
text or content is set, this mixin will create and manage an internal scroller object which
will be the container of that text or content.
Widgets can set the "__efl_scrollable_content_scroller_style" key data during Only a single content or text can be set at any given time. Setting @.scrollable_content
their constructor to apply a style to the internal scroller widget. will unset @.scrollable_text and vice versa.
@since 1.23
]] ]]
c_prefix: efl_ui_widget; c_prefix: efl_ui_widget;
event_prefix: efl_ui_widget_scrollable_content; event_prefix: efl_ui_widget_scrollable_content;
@ -22,11 +27,13 @@ mixin @beta Efl.Ui.Widget_Scrollable_Content requires Efl.Object
this method returns $true. this method returns $true.
In the case that this returns $true, it's likely that the widget should be completing In the case that this returns $true, it's likely that the widget should be completing
its internal sizing calculations from the optimal_size,calc callback using 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 calc.
@since 1.23
]] ]]
get {} get {}
values { values {
@ -35,6 +42,8 @@ mixin @beta Efl.Ui.Widget_Scrollable_Content requires Efl.Object
} }
@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.
@since 1.23
]] ]]
set { set {
return: bool; [[True on success]] return: bool; [[True on success]]
@ -47,10 +56,13 @@ mixin @beta Efl.Ui.Widget_Scrollable_Content requires Efl.Object
@property scrollable_text { @property scrollable_text {
set { set {
[[Sets the text string to be displayed by the given text object. [[Sets the text string to be displayed by the given text object.
The text will be scrollable depending on its size relative to the The text will use @Efl.Text_Format_Wrap.mixed wrapping,
and it will be scrollable depending on its size relative to the
object's geometry. object's geometry.
See also @.scrollable_text.get. See also @.scrollable_text.get.
@since 1.23
]] ]]
} }
get { get {
@ -60,6 +72,8 @@ mixin @beta Efl.Ui.Widget_Scrollable_Content requires Efl.Object
Do not free() the return value. Do not free() the return value.
See also @.scrollable_text.set. See also @.scrollable_text.set.
@since 1.23
]] ]]
} }
values { values {