summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMike Blumenkrantz <zmike@samsung.com>2019-09-10 09:58:49 +0200
committerXavi Artigas <xavierartigas@yahoo.es>2019-09-10 10:11:43 +0200
commitc10c9b21cc4334ea1ab2344e7060982815066b7c (patch)
treefef03c63bbfb3fe97107b17f6892145758946a5d
parent6e23dfba625cc126f10fa7b40a901dd99bf1b5b4 (diff)
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
-rw-r--r--src/lib/elementary/efl_ui_widget_scrollable_content.eo26
1 files changed, 20 insertions, 6 deletions
diff --git a/src/lib/elementary/efl_ui_widget_scrollable_content.eo b/src/lib/elementary/efl_ui_widget_scrollable_content.eo
index ea50a3b271..2148ddd1de 100644
--- a/src/lib/elementary/efl_ui_widget_scrollable_content.eo
+++ b/src/lib/elementary/efl_ui_widget_scrollable_content.eo
@@ -1,13 +1,18 @@
1import eina_types; 1import eina_types;
2parse efl_text_format;
2 3
3mixin @beta Efl.Ui.Widget_Scrollable_Content requires Efl.Object 4mixin @beta Efl.Ui.Widget_Scrollable_Content requires Efl.Object
4{ 5{
5 [[Efl widget scrollable content mixin 6 [[Efl widget scrollable content mixin
6 7
7 This can be used to provide scrollable contents and text for widgets. 8 This can be used to provide scrollable contents and text for widgets. When a scrollable
9 text or content is set, this mixin will create and manage an internal scroller object which
10 will be the container of that text or content.
8 11
9 Widgets can set the "__efl_scrollable_content_scroller_style" key data during 12 Only a single content or text can be set at any given time. Setting @.scrollable_content
10 their constructor to apply a style to the internal scroller widget. 13 will unset @.scrollable_text and vice versa.
14
15 @since 1.23
11 ]] 16 ]]
12 c_prefix: efl_ui_widget; 17 c_prefix: efl_ui_widget;
13 event_prefix: efl_ui_widget_scrollable_content; 18 event_prefix: efl_ui_widget_scrollable_content;
@@ -22,11 +27,13 @@ mixin @beta Efl.Ui.Widget_Scrollable_Content requires Efl.Object
22 this method returns $true. 27 this method returns $true.
23 28
24 In the case that this returns $true, it's likely that the widget should be completing 29 In the case that this returns $true, it's likely that the widget should be completing
25 its internal sizing calculations from the optimal_size,calc callback using 30 its internal sizing calculations from the @[Efl.Ui.Widget_Scrollable_Content.optimal_size,calc] callback using
26 31
27 `efl_canvas_group_calculate(efl_super(ev->object, EFL_UI_WIDGET_SCROLLABLE_CONTENT_MIXIN));` 32 efl_canvas_group_calculate(efl_super(ev->object, EFL_UI_WIDGET_SCROLLABLE_CONTENT_MIXIN));
28 33
29 in order to skip the scrollable sizing calc. 34 in order to skip the scrollable sizing calc.
35
36 @since 1.23
30 ]] 37 ]]
31 get {} 38 get {}
32 values { 39 values {
@@ -35,6 +42,8 @@ mixin @beta Efl.Ui.Widget_Scrollable_Content requires Efl.Object
35 } 42 }
36 @property scrollable_content { 43 @property scrollable_content {
37 [[This is the content which will be placed in the internal scroller. 44 [[This is the content which will be placed in the internal scroller.
45
46 @since 1.23
38 ]] 47 ]]
39 set { 48 set {
40 return: bool; [[True on success]] 49 return: bool; [[True on success]]
@@ -47,10 +56,13 @@ mixin @beta Efl.Ui.Widget_Scrollable_Content requires Efl.Object
47 @property scrollable_text { 56 @property scrollable_text {
48 set { 57 set {
49 [[Sets the text string to be displayed by the given text object. 58 [[Sets the text string to be displayed by the given text object.
50 The text will be scrollable depending on its size relative to the 59 The text will use @Efl.Text_Format_Wrap.mixed wrapping,
60 and it will be scrollable depending on its size relative to the
51 object's geometry. 61 object's geometry.
52 62
53 See also @.scrollable_text.get. 63 See also @.scrollable_text.get.
64
65 @since 1.23
54 ]] 66 ]]
55 } 67 }
56 get { 68 get {
@@ -60,6 +72,8 @@ mixin @beta Efl.Ui.Widget_Scrollable_Content requires Efl.Object
60 Do not free() the return value. 72 Do not free() the return value.
61 73
62 See also @.scrollable_text.set. 74 See also @.scrollable_text.set.
75
76 @since 1.23
63 ]] 77 ]]
64 } 78 }
65 values { 79 values {