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
This commit is contained in:
Marcel Hollerbach 2019-09-06 16:25:57 +02:00 committed by Xavi Artigas
parent 2d2e01bdec
commit a0bd73f2e0
4 changed files with 20 additions and 5 deletions

View File

@ -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 {
}

View File

@ -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.

View File

@ -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

View File

@ -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]]
}
}
}