diff options
author | Marcel Hollerbach <mail@marcel-hollerbach.de> | 2019-09-06 16:25:57 +0200 |
---|---|---|
committer | Xavi Artigas <xavierartigas@yahoo.es> | 2019-09-06 16:32:56 +0200 |
commit | a0bd73f2e0c62a198c1e36b9bfe410b22d0d6c85 (patch) | |
tree | 4162082872125a616e885a7b2953f5e929998e4d | |
parent | 2d2e01bdecc59f87649940645dc0ee48a49caf3b (diff) |
efl_ui_tab_*: enhance documentation
Summary: just a commit bringing more information.
Reviewers: segfaultxavi
Reviewed By: segfaultxavi
Subscribers: cedric, #reviewers, #committers
Tags: #efl
Differential Revision: https://phab.enlightenment.org/D9864
-rw-r--r-- | src/lib/elementary/efl_ui_tab_bar.eo | 5 | ||||
-rw-r--r-- | src/lib/elementary/efl_ui_tab_bar_default_item.eo | 5 | ||||
-rw-r--r-- | src/lib/elementary/efl_ui_tab_page.eo | 6 | ||||
-rw-r--r-- | src/lib/elementary/efl_ui_tab_pager.eo | 9 |
4 files changed, 20 insertions, 5 deletions
diff --git a/src/lib/elementary/efl_ui_tab_bar.eo b/src/lib/elementary/efl_ui_tab_bar.eo index b4aabe1197..996a897b98 100644 --- a/src/lib/elementary/efl_ui_tab_bar.eo +++ b/src/lib/elementary/efl_ui_tab_bar.eo | |||
@@ -2,7 +2,10 @@ class @beta Efl.Ui.Tab_Bar extends Efl.Ui.Layout_Base | |||
2 | implements Efl.Ui.Single_Selectable, Efl.Pack_Linear | 2 | implements Efl.Ui.Single_Selectable, Efl.Pack_Linear |
3 | composite Efl.Pack_Linear, Efl.Pack | 3 | composite Efl.Pack_Linear, Efl.Pack |
4 | { | 4 | { |
5 | [[Tab Bar class]] | 5 | [[A selectable box of items. |
6 | |||
7 | Within one object only one @Efl.Ui.Tab_Bar_Default_Item can be selected at the same time. | ||
8 | ]] | ||
6 | methods { | 9 | methods { |
7 | 10 | ||
8 | } | 11 | } |
diff --git a/src/lib/elementary/efl_ui_tab_bar_default_item.eo b/src/lib/elementary/efl_ui_tab_bar_default_item.eo index 22034d8957..7feb31d981 100644 --- a/src/lib/elementary/efl_ui_tab_bar_default_item.eo +++ b/src/lib/elementary/efl_ui_tab_bar_default_item.eo | |||
@@ -1,6 +1,9 @@ | |||
1 | class @beta Efl.Ui.Tab_Bar_Default_Item extends Efl.Ui.Default_Item | 1 | class @beta Efl.Ui.Tab_Bar_Default_Item extends Efl.Ui.Default_Item |
2 | { | 2 | { |
3 | [[ A icon that represents the default parts in the appearance of the tab bar. ]] | 3 | [[ A icon that represents the default parts in the appearance of the tab bar. |
4 | |||
5 | Setting the icon again after there was a previous one, will trigger an animation. | ||
6 | ]] | ||
4 | methods { | 7 | methods { |
5 | @property icon { | 8 | @property icon { |
6 | [[Set the content of the default item as a image. | 9 | [[Set the content of the default item as a image. |
diff --git a/src/lib/elementary/efl_ui_tab_page.eo b/src/lib/elementary/efl_ui_tab_page.eo index d13dde7ac6..4b21dc6241 100644 --- a/src/lib/elementary/efl_ui_tab_page.eo +++ b/src/lib/elementary/efl_ui_tab_page.eo | |||
@@ -1,6 +1,10 @@ | |||
1 | class @beta Efl.Ui.Tab_Page extends Efl.Ui.Layout_Base implements Efl.Content | 1 | class @beta Efl.Ui.Tab_Page extends Efl.Ui.Layout_Base implements Efl.Content |
2 | { | 2 | { |
3 | [[Tab Page class]] | 3 | [[A holder class for setting up a page in the pager. |
4 | |||
5 | The item assosiated with this page can be used to setup a item which will later be displayed in the @Efl.Ui.Tab_Bar | ||
6 | of the @Efl.Ui.Tab_Pager where this page was added to. | ||
7 | ]] | ||
4 | methods { | 8 | methods { |
5 | @property tab_bar_item { | 9 | @property tab_bar_item { |
6 | [[Get this page represented as a @Efl.Ui.Tab_Bar_Default_Item | 10 | [[Get this page represented as a @Efl.Ui.Tab_Bar_Default_Item |
diff --git a/src/lib/elementary/efl_ui_tab_pager.eo b/src/lib/elementary/efl_ui_tab_pager.eo index 9efb40c753..9f4bb42d4f 100644 --- a/src/lib/elementary/efl_ui_tab_pager.eo +++ b/src/lib/elementary/efl_ui_tab_pager.eo | |||
@@ -1,13 +1,18 @@ | |||
1 | class @beta Efl.Ui.Tab_Pager extends Efl.Ui.Spotlight.Container | 1 | class @beta Efl.Ui.Tab_Pager extends Efl.Ui.Spotlight.Container |
2 | { | 2 | { |
3 | [[Tab Pager class]] | 3 | [[Container for @Efl.Ui.Tab_Page |
4 | |||
5 | This container consists out of a Efl.Ui.Tab_Bar and a place to display the content of the pages. | ||
6 | The items that are generated out of the pages will be displayed in the tab bar of this pager. | ||
7 | ]] | ||
4 | methods { | 8 | methods { |
5 | @property tab_bar { | 9 | @property tab_bar { |
10 | [[Tab bar where to add items of the @Efl.Ui.Tab_Page into.]] | ||
6 | get { | 11 | get { |
7 | 12 | ||
8 | } | 13 | } |
9 | values { | 14 | values { |
10 | tab_bar: Efl.Canvas.Object; | 15 | tab_bar: Efl.Ui.Tab_Bar; [[Tab bar for the items of the @Efl.Ui.Tab_Page]] |
11 | } | 16 | } |
12 | } | 17 | } |
13 | } | 18 | } |