xartigas pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=a0bd73f2e0c62a198c1e36b9bfe410b22d0d6c85
commit a0bd73f2e0c62a198c1e36b9bfe410b22d0d6c85
Author: Marcel Hollerbach <m...@marcel-hollerbach.de>
Date: Fri Sep 6 16:25:57 2019 +0200
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
---
src/lib/elementary/efl_ui_tab_bar.eo | 5 ++++-
src/lib/elementary/efl_ui_tab_bar_default_item.eo | 5 ++++-
src/lib/elementary/efl_ui_tab_page.eo | 6 +++++-
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
implements Efl.Ui.Single_Selectable, Efl.Pack_Linear
composite Efl.Pack_Linear, Efl.Pack
{
- [[Tab Bar class]]
+ [[A selectable box of items.
+
+ Within one object only one @Efl.Ui.Tab_Bar_Default_Item can be selected
at the same time.
+ ]]
methods {
}
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 @@
class @beta Efl.Ui.Tab_Bar_Default_Item extends Efl.Ui.Default_Item
{
- [[ A icon that represents the default parts in the appearance of the tab
bar. ]]
+ [[ A icon that represents the default parts in the appearance of the tab
bar.
+
+ Setting the icon again after there was a previous one, will trigger an
animation.
+ ]]
methods {
@property icon {
[[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 @@
class @beta Efl.Ui.Tab_Page extends Efl.Ui.Layout_Base implements Efl.Content
{
- [[Tab Page class]]
+ [[A holder class for setting up a page in the pager.
+
+ The item assosiated with this page can be used to setup a item which will
later be displayed in the @Efl.Ui.Tab_Bar
+ of the @Efl.Ui.Tab_Pager where this page was added to.
+ ]]
methods {
@property tab_bar_item {
[[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 @@
class @beta Efl.Ui.Tab_Pager extends Efl.Ui.Spotlight.Container
{
- [[Tab Pager class]]
+ [[Container for @Efl.Ui.Tab_Page
+
+ This container consists out of a Efl.Ui.Tab_Bar and a place to display
the content of the pages.
+ The items that are generated out of the pages will be displayed in the
tab bar of this pager.
+ ]]
methods {
@property tab_bar {
+ [[Tab bar where to add items of the @Efl.Ui.Tab_Page into.]]
get {
}
values {
- tab_bar: Efl.Canvas.Object;
+ tab_bar: Efl.Ui.Tab_Bar; [[Tab bar for the items of the
@Efl.Ui.Tab_Page]]
}
}
}
--
