stefan pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=89166e383795d988f988bae6d73334925d8a35c2
commit 89166e383795d988f988bae6d73334925d8a35c2
Author: Stefan Schmidt <ste...@osg.samsung.com>
Date: Fri Nov 18 11:18:27 2016 +0100
docs: gengrid: fill gaps in gengrid eo file documentation
---
src/lib/elementary/elm_gengrid.eo | 50 +++++++++++++++++-----------------
src/lib/elementary/elm_gengrid_item.eo | 5 ++--
src/lib/elementary/elm_gengrid_pan.eo | 4 +--
3 files changed, 29 insertions(+), 30 deletions(-)
diff --git a/src/lib/elementary/elm_gengrid.eo
b/src/lib/elementary/elm_gengrid.eo
index 3440818..fcb265a 100644
--- a/src/lib/elementary/elm_gengrid.eo
+++ b/src/lib/elementary/elm_gengrid.eo
@@ -12,6 +12,7 @@ class Elm.Gengrid (Elm.Layout, Elm.Interface_Scrollable,
Efl.Ui.Clickable, Elm.Interface.Atspi_Widget_Action,
Elm.Interface.Atspi.Selection)
{
+ [[Elementary gengrid class]]
legacy_prefix: elm_gengrid;
eo_prefix: elm_obj_gengrid;
event_prefix: elm_gengrid;
@@ -61,7 +62,7 @@ class Elm.Gengrid (Elm.Layout, Elm.Interface_Scrollable,
]]
}
values {
- fill: bool;
+ fill: bool; [[$true if the grid is filled, $false otherwise]]
}
}
@property page_relative {
@@ -71,8 +72,8 @@ class Elm.Gengrid (Elm.Layout, Elm.Interface_Scrollable,
set {}
get {}
values {
- h_pagerel: double;
- v_pagerel: double;
+ h_pagerel: double; [[Page relation horizontal]]
+ v_pagerel: double; [[Page relation vertical]]
}
}
@property multi_select {
@@ -96,7 +97,7 @@ class Elm.Gengrid (Elm.Layout, Elm.Interface_Scrollable,
]]
}
values {
- multi: bool;
+ multi: bool; [[$true if multislect is enabled, $false otherwise]]
}
}
@property group_item_size {
@@ -177,7 +178,7 @@ class Elm.Gengrid (Elm.Layout, Elm.Interface_Scrollable,
set {}
get {}
values {
- highlight: bool;
+ highlight: bool; [[$true if item will be highlighted, $false
otherwise]]
}
}
@property reorder_type {
@@ -271,8 +272,8 @@ class Elm.Gengrid (Elm.Layout, Elm.Interface_Scrollable,
[[Set a given gengrid widget's scrolling page size.]]
}
values {
- h_pagesize: Evas.Coord;
- v_pagesize: Evas.Coord;
+ h_pagesize: Evas.Coord; [[Page size horizontal]]
+ v_pagesize: Evas.Coord; [[Page size vertical]]
}
}
@property selected_item {
@@ -414,7 +415,7 @@ class Elm.Gengrid (Elm.Layout, Elm.Interface_Scrollable,
This behavior is O(1) and includes items which may or may not
be realized.
]]
- return: uint;
+ return: uint; [[Items in list]]
}
at_xy_item_get @const {
[[Get the item that is at the x, y canvas coords.
@@ -575,22 +576,21 @@ class Elm.Gengrid (Elm.Layout, Elm.Interface_Scrollable,
Elm.Interface.Atspi.Selection.clear;
}
events {
- realized;
- unrealized;
- index,update;
- scroll,page,changed;
- edge,bottom;
- edge,top;
- edge,right;
- edge,left;
- item,focused;
- item,unfocused;
- item,reorder,anim,start;
- item,reorder,anim,stop;
- activated;
- highlighted;
- unhighlighted;
- released;
+ realized; [[Called when gengrid realized]]
+ unrealized; [[Called when gengrid unrealized]]
+ index,update; [[Called on gengrid index update]]
+ scroll,page,changed; [[Called when scroll page changed]]
+ edge,bottom; [[Called when bottom edge is reached]]
+ edge,top; [[Called when top edge is reached]]
+ edge,right; [[Called when right edge is reached]]
+ edge,left; [[Called when left edge is reached]]
+ item,focused; [[Called when item got focus]]
+ item,unfocused; [[Called when item no longer has focus]]
+ item,reorder,anim,start; [[Called when item reorder animation started]]
+ item,reorder,anim,stop; [[Called when item reorder animation stopped]]
+ activated; [[Called when gengrid got activated]]
+ highlighted; [[Called when gengrid is highlighted]]
+ unhighlighted; [[Called when gengrid is no longer highlighted]]
+ released; [[Called when gengrid is released]]
}
-
}
diff --git a/src/lib/elementary/elm_gengrid_item.eo
b/src/lib/elementary/elm_gengrid_item.eo
index 15ceb49..ae31d34 100644
--- a/src/lib/elementary/elm_gengrid_item.eo
+++ b/src/lib/elementary/elm_gengrid_item.eo
@@ -25,6 +25,7 @@ enum Elm.Gengrid.Item.Field_Type
class Elm.Gengrid.Item(Elm.Widget.Item)
{
+ [[Elementary gengrid item class]]
legacy_prefix: elm_gengrid_item;
eo_prefix: elm_obj_gengrid_item;
data: Elm_Gen_Item;
@@ -66,7 +67,7 @@ class Elm.Gengrid.Item(Elm.Widget.Item)
set {
}
values {
- selected: bool; [[the selected state ($true selected,
$false not selected)]]
+ selected: bool; [[The selected state ($true selected,
$false not selected)]]
}
}
@property item_class {
@@ -85,7 +86,7 @@ class Elm.Gengrid.Item(Elm.Widget.Item)
[[Get the index of the item. It is only valid once
displayed.]]
}
values {
- index: int(-1); [[the position inside the list of item.]]
+ index: int(-1); [[The position inside the list of item.]]
}
}
@property pos {
diff --git a/src/lib/elementary/elm_gengrid_pan.eo
b/src/lib/elementary/elm_gengrid_pan.eo
index 72a5ade..a9c6171 100644
--- a/src/lib/elementary/elm_gengrid_pan.eo
+++ b/src/lib/elementary/elm_gengrid_pan.eo
@@ -1,5 +1,6 @@
class Elm.Gengrid.Pan (Elm.Pan)
{
+ [[Elementary gengrid pan class]]
legacy_prefix: elm_gengrid_pan;
eo_prefix: elm_obj_gengrid_pan;
event_prefix: elm_gengrid_pan;
@@ -14,7 +15,4 @@ class Elm.Gengrid.Pan (Elm.Pan)
Elm.Pan.pos_min.get;
Elm.Pan.pos_max.get;
}
- events {
- }
-
}
--
