summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarcel Hollerbach <marcel-hollerbach@t-online.de>2015-07-26 22:23:44 +0200
committerMarcel Hollerbach <marcel-hollerbach@t-online.de>2015-07-26 22:23:44 +0200
commit185d2e20e1357ec161abf9a1cfd3dca20a108c2c (patch)
tree03a3859e49a65c9b092895b573ab00dc26cba607
parent36a56ed4e0dc9e3c7e141b2514c72caddff96fef (diff)
update comments
-rw-r--r--src/lib/items/elm_items_display.eo34
-rw-r--r--src/lib/items/elm_items_item.eo12
2 files changed, 32 insertions, 14 deletions
diff --git a/src/lib/items/elm_items_display.eo b/src/lib/items/elm_items_display.eo
index 0677e0f..93ae8bb 100644
--- a/src/lib/items/elm_items_display.eo
+++ b/src/lib/items/elm_items_display.eo
@@ -23,8 +23,9 @@ abstract Elm.Items.Display (Elm.Scroller) {
23 [[Abstraction for widgets which wants to place Elm.Items.Item´s]] 23 [[Abstraction for widgets which wants to place Elm.Items.Item´s]]
24 methods { 24 methods {
25 @property tree { 25 @property tree {
26 [[The root items of the items which are displayed]]
26 get { 27 get {
27 28 [[Get the root item]]
28 } 29 }
29 values { 30 values {
30 root : Efl.Tree.Base*; 31 root : Efl.Tree.Base*;
@@ -33,31 +34,48 @@ abstract Elm.Items.Display (Elm.Scroller) {
33 sel_move { 34 sel_move {
34 [[Called if the user wants to move the selection to one of the directions of move_dir]] 35 [[Called if the user wants to move the selection to one of the directions of move_dir]]
35 params { 36 params {
36 direction : Elm.Items.Move_Dir; 37 direction : Elm.Items.Move_Dir; [[The direction where to move the selection]]
37 } 38 }
38 } 39 }
39 item_search_xywh { 40 item_search_xywh {
41 [[get the list of items which are in the region
42
43 This will only work if the region is in the viewport of the widget
44 ]]
40 params { 45 params {
41 x : int; 46 x : int; [[x coord]]
42 y : int; 47 y : int; [[y coord]]
43 w : int; 48 w : int; [[w coord]]
44 h : int; 49 h : int; [[h coord]]
45 } 50 }
46 return : list<Elm.Items.Item*>*; 51 return : list<Elm.Items.Item*>*;
47 } 52 }
48 search { 53 search {
54 [[Search the given string in the items and select the first item]]
49 params { 55 params {
50 search : const(char)*; 56 search : const(char)*;
51 } 57 }
52 } 58 }
53 @property selection_mode { 59 @property selection_mode {
60 [[How the widget is handling selections
61
62 If single select is taken only one item can be selected at once.
63
64 If multiselect is taken multiple items can be selected.
65
66 For the ctrl mode is active the widget will behave like single select as long as ctrl is not pressed.
67 If it is pressed multiple items can be selected.
68
69 In touch mode items will be added as selected every time they are selected or not
70 ]]
54 values { 71 values {
55 mode : Elm.Items.Selection_Mode; 72 mode : Elm.Items.Selection_Mode; [[The mode to use]]
56 } 73 }
57 } 74 }
58 @property selected { 75 @property selected {
76 [[The currently selected items]]
59 get { 77 get {
60 78 [[Get the current selected items]]
61 } 79 }
62 values { 80 values {
63 selected : list<Elm.Items.Item*>*; 81 selected : list<Elm.Items.Item*>*;
diff --git a/src/lib/items/elm_items_item.eo b/src/lib/items/elm_items_item.eo
index 3311f2c..f0a7790 100644
--- a/src/lib/items/elm_items_item.eo
+++ b/src/lib/items/elm_items_item.eo
@@ -17,9 +17,9 @@ class Elm.Items.Item (Elm.Widget) {
17 17
18 methods { 18 methods {
19 @property item { 19 @property item {
20 [[Get the item in the tree assiciated with this item]] 20 [[The tree item which i assiciated with this item]]
21 get { 21 get {
22 22 [[Get this tree item]]
23 } 23 }
24 values { 24 values {
25 item : Efl.Tree.Base*; 25 item : Efl.Tree.Base*;
@@ -65,11 +65,11 @@ class Elm.Items.Item (Elm.Widget) {
65 @property selected { 65 @property selected {
66 [[select / unselect the item]] 66 [[select / unselect the item]]
67 set { 67 set {
68 [[returns true/false if selecting/unselecting was legal/illegal]] 68 [[set the selection]]
69 return : bool; 69 return : bool; [[true/false if selecting/unselecting was legal/illegal]]
70 } 70 }
71 get { 71 get {
72 72 [[get the selection state]]
73 } 73 }
74 values { 74 values {
75 selected : bool; 75 selected : bool;
@@ -86,7 +86,7 @@ class Elm.Items.Item (Elm.Widget) {
86 86
87 By default false]] 87 By default false]]
88 get { 88 get {
89 89 [[get the headmode]]
90 } 90 }
91 values { 91 values {
92 headmode : bool; 92 headmode : bool;