Merge "Enhance Entry widget" into tizen
[platform/core/csapi/tizenfx.git] / src / ElmSharp / ElmSharp / GenList.cs
1 /*
2  * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
3  *
4  * Licensed under the Apache License, Version 2.0 (the License);
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an AS IS BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 using System;
18 using System.Collections.Generic;
19
20 namespace ElmSharp
21 {
22     /// <summary>
23     /// Enumeration for setting genlist item type.
24     /// </summary>
25     public enum GenListItemType
26     {
27         /// <summary>
28         /// if Normal is set then this item is normal item.
29         /// </summary>
30         Normal = 0,
31
32         /// <summary>
33         /// If tree is set then this item is displayed as an item that is able to expand and have child items.
34         /// </summary>
35         Tree = (1 << 0),
36
37         /// <summary>
38         /// if Group is set then this item is group index item that is displayed at the top until the next group comes.
39         /// </summary>
40         Group = (1 << 1),
41     }
42
43     /// <summary>
44     /// Enumeration for setting genlist's resizing behavior, transverse axis scrolling and items cropping.
45     /// </summary>
46     public enum GenListMode
47     {
48         /// <summary>
49         /// The genlist won't set any of its size hints to inform how a possible container should resize it.
50         /// Then, if it's not created as a "resize object", it might end with zeroed dimensions.
51         /// The genlist will respect the container's geometry and, if any of its items won't fit into its transverse axis, one won't be able to scroll it in that direction.
52         /// </summary>
53         Compress = 0,
54
55         /// <summary>
56         /// This is the same as Compress, with the exception that if any of its items won't fit into its transverse axis, one will be able to scroll it in that direction.
57         /// </summary>
58         Scroll,
59
60         /// <summary>
61         /// Sets a minimum size hint on the genlist object, so that containers may respect it (and resize itself to fit the child properly).
62         /// More specifically, a minimum size hint will be set for its transverse axis, so that the largest item in that direction fits well.
63         /// This is naturally bound by the genlist object's maximum size hints, set externally.
64         /// </summary>
65         Limit,
66
67         /// <summary>
68         /// Besides setting a minimum size on the transverse axis, just like on Limit, the genlist will set a minimum size on th longitudinal axis, trying to reserve space to all its children to be visible at a time.
69         /// This is naturally bound by the genlist object's maximum size hints, set externally.
70         /// </summary>
71         Expand
72     }
73
74     /// <summary>
75     /// It inherits System.EventArgs.
76     /// It contains Item which is <see cref="GenListItem"/> type.
77     /// All events of GenList contain GenListItemEventArgs as a parameter.
78     /// </summary>
79     public class GenListItemEventArgs : EventArgs
80     {
81         /// <summary>
82         /// Gets or sets GenList item. The return type is <see cref="GenListItem"/>.
83         /// </summary>
84         public GenListItem Item { get; set; }
85
86         internal static GenListItemEventArgs CreateFromSmartEvent(IntPtr data, IntPtr obj, IntPtr info)
87         {
88             GenListItem item = ItemObject.GetItemByHandle(info) as GenListItem;
89             return new GenListItemEventArgs() { Item = item };
90         }
91     }
92
93     /// <summary>
94     /// Enumeration that defines where to position the item in the genlist.
95     /// </summary>
96     public enum ScrollToPosition
97     {
98         /// <summary>
99         /// Scrolls to nowhere.
100         /// </summary>
101         None = 0,
102
103         /// <summary>
104         /// Scrolls to the nearest viewport.
105         /// </summary>
106         In = (1 << 0),
107
108         /// <summary>
109         /// Scrolls to the top of the viewport.
110         /// </summary>
111         Top = (1 << 1),
112
113         /// <summary>
114         /// Scrolls to the middle of the viewport.
115         /// </summary>
116         Middle = (1 << 2),
117
118         /// <summary>
119         /// Scrolls to the bottom of the viewport.
120         /// </summary>
121         Bottom = (1 << 3)
122     }
123
124     /// <summary>
125     /// It inherits <see cref="Layout"/>.
126     /// The GenList is a widget that aims to have more expansive list than the simple <see cref="List"/> in ElmSharp that could have more flexible items and allow many more entries while still being fast and low on memory usage.
127     /// At the same time it was also made to be able to do tree structures.
128     /// But the price to pay is more complexity when it comes to usage.
129     /// If all you want is a simple list with icons and a single text, use the <see cref="List"/> widget.
130     /// </summary>
131     public class GenList : Layout
132     {
133         HashSet<GenListItem> _children = new HashSet<GenListItem>();
134
135         SmartEvent<GenListItemEventArgs> _selected;
136         SmartEvent<GenListItemEventArgs> _unselected;
137         SmartEvent<GenListItemEventArgs> _activated;
138         SmartEvent<GenListItemEventArgs> _pressed;
139         SmartEvent<GenListItemEventArgs> _released;
140         SmartEvent<GenListItemEventArgs> _doubleClicked;
141         SmartEvent<GenListItemEventArgs> _expanded;
142         SmartEvent<GenListItemEventArgs> _realized;
143         SmartEvent<GenListItemEventArgs> _unrealized;
144         SmartEvent<GenListItemEventArgs> _longpressed;
145         SmartEvent<GenListItemEventArgs> _moved;
146         SmartEvent<GenListItemEventArgs> _movedAfter;
147         SmartEvent<GenListItemEventArgs> _movedBefore;
148         SmartEvent _scrollAnimationStarted;
149         SmartEvent _scrollAnimationStopped;
150         SmartEvent _changed;
151
152         /// <summary>
153         /// Creates and initializes a new instance of the GenList class.
154         /// </summary>
155         /// <param name="parent">The parent is a given container which will be attached by GenList as a child. It's <see cref="EvasObject"/> type.</param>
156         public GenList(EvasObject parent) : base(parent)
157         {
158             ListMode = GenListMode.Compress;
159             InitializeSmartEvent();
160         }
161
162         /// <summary>
163         /// Gets or sets whether the homogeneous mode is enabled.
164         /// </summary>
165         /// <remarks>
166         /// If true, the genlist items have same height and width.
167         /// </remarks>
168         public bool Homogeneous
169         {
170             get
171             {
172                 return Interop.Elementary.elm_genlist_homogeneous_get(RealHandle);
173             }
174             set
175             {
176                 Interop.Elementary.elm_genlist_homogeneous_set(RealHandle, value);
177             }
178         }
179
180         /// <summary>
181         /// Gets or sets the horizontal stretching mode. This mode used for sizing items horizontally.
182         /// The default value is <see cref="GenListMode.Scroll"/> which means that if items are too wide to fit, the scroller scrolls horizontally.
183         /// If set <see cref="GenListMode.Compress"/> which means that the item width is fixed (restricted to a minimum of) to the list width when calculating its size in order to allow the height to be calculated based on it.
184         /// If set <see cref="GenListMode.Limit"/> which means that items are expanded to the viewport width and limited to that size.
185         /// if set <see cref="GenListMode.Expand"/> which means that genlist try to reserve space to all its items to be visible at a time.
186         /// </summary>
187         /// <remarks>
188         /// Compress makes genlist resize slower as it recalculates every item height again whenever the list width changes.
189         /// The homogeneous mode is so that all items in the genlist are of the same width/height. With Compress, genlist items are initialized fast.
190         /// However, there are no sub-objects in the genlist which can be on the flying resizable (such as TEXTBLOCK).
191         /// If so, then some dynamic resizable objects in the genlist would not be diplayed properly.
192         /// </remarks>
193         public GenListMode ListMode
194         {
195             get
196             {
197                 return (GenListMode)Interop.Elementary.elm_genlist_mode_get(RealHandle);
198             }
199             set
200             {
201                 Interop.Elementary.elm_genlist_mode_set(RealHandle, (int)value);
202             }
203         }
204
205         /// <summary>
206         /// Gets the first item in the genlist.
207         /// </summary>
208         public GenListItem FirstItem
209         {
210             get
211             {
212                 IntPtr handle = Interop.Elementary.elm_genlist_first_item_get(RealHandle);
213                 return ItemObject.GetItemByHandle(handle) as GenListItem;
214             }
215         }
216
217         /// <summary>
218         /// Gets the last item in the genlist.
219         /// </summary>
220         public GenListItem LastItem
221         {
222             get
223             {
224                 IntPtr handle = Interop.Elementary.elm_genlist_last_item_get(RealHandle);
225                 return ItemObject.GetItemByHandle(handle) as GenListItem;
226             }
227         }
228
229         /// <summary>
230         /// Gets or sets the reorder mode.
231         /// After turning on the reorder mode, longpress on a normal item triggers reordering of the item.
232         /// You can move the item up and down. However, reordering does not work with group items.
233         /// </summary>
234         public bool ReorderMode
235         {
236             get
237             {
238                 return Interop.Elementary.elm_genlist_reorder_mode_get(RealHandle);
239             }
240             set
241             {
242                 Interop.Elementary.elm_genlist_reorder_mode_set(RealHandle, value);
243             }
244         }
245
246         /// <summary>
247         /// Gets or set the maximum number of items within an item block.
248         /// </summary>
249         public int BlockCount
250         {
251             get
252             {
253                 return Interop.Elementary.elm_genlist_block_count_get(RealHandle);
254             }
255             set
256             {
257                 Interop.Elementary.elm_genlist_block_count_set(RealHandle, value);
258             }
259         }
260
261         /// <summary>
262         /// Gets or sets whether the genlist items should be highlighted when an item is selected.
263         /// </summary>
264         public bool IsHighlight
265         {
266             get
267             {
268                 return Interop.Elementary.elm_genlist_highlight_mode_get(RealHandle);
269             }
270             set
271             {
272                 Interop.Elementary.elm_genlist_highlight_mode_set(RealHandle, value);
273             }
274         }
275
276         /// <summary>
277         /// Gets the depth of expanded item.
278         /// </summary>
279         public int ExpandedItemDepth
280         {
281             get
282             {
283                 return Interop.Elementary.elm_genlist_item_expanded_depth_get(RealHandle);
284             }
285         }
286
287         /// <summary>
288         /// Gets or sets the timeout in seconds for the longpress event.
289         /// </summary>
290         public double LongPressTimeout
291         {
292             get
293             {
294                 return Interop.Elementary.elm_genlist_longpress_timeout_get(RealHandle);
295             }
296             set
297             {
298                 Interop.Elementary.elm_genlist_longpress_timeout_set(RealHandle, value);
299             }
300         }
301
302         /// <summary>
303         /// Gets or sets whether enable multi-selection in the genlist.
304         /// </summary>
305         public bool IsMultiSelection
306         {
307             get
308             {
309                 return Interop.Elementary.elm_genlist_multi_select_get(RealHandle);
310             }
311             set
312             {
313                 Interop.Elementary.elm_genlist_multi_select_set(RealHandle, value);
314             }
315         }
316
317         /// <summary>
318         /// Gets the selected item in a given genlist widget.
319         /// </summary>
320         public GenListItem SelectedItem
321         {
322             get
323             {
324                 IntPtr handle = Interop.Elementary.elm_genlist_selected_item_get(RealHandle);
325                 return ItemObject.GetItemByHandle(handle) as GenListItem;
326             }
327         }
328
329         /// <summary>
330         /// Gets or sets the genlist select mode by <see cref="GenItemSelectionMode"/>.
331         /// </summary>
332         public GenItemSelectionMode SelectionMode
333         {
334             get
335             {
336                 return (GenItemSelectionMode)Interop.Elementary.elm_genlist_select_mode_get(RealHandle);
337             }
338             set
339             {
340                 Interop.Elementary.elm_genlist_select_mode_set(RealHandle, (int)value);
341             }
342         }
343
344         /// <summary>
345         /// ItemSelected is raised when a new genlist item is selected.
346         /// </summary>
347         public event EventHandler<GenListItemEventArgs> ItemSelected;
348
349         /// <summary>
350         /// ItemUnselected is raised when the genlist item is Unselected.
351         /// </summary>
352         public event EventHandler<GenListItemEventArgs> ItemUnselected;
353
354         /// <summary>
355         /// ItemPressed is raised when a new genlist item is pressed.
356         /// </summary>
357         public event EventHandler<GenListItemEventArgs> ItemPressed;
358
359         /// <summary>
360         /// ItemReleased is raised when a new genlist item is released.
361         /// </summary>
362         public event EventHandler<GenListItemEventArgs> ItemReleased;
363
364         /// <summary>
365         /// ItemActivated is raised when a new genlist item is double clicked or pressed (enter|return|spacebar).
366         /// </summary>
367         public event EventHandler<GenListItemEventArgs> ItemActivated;
368
369         /// <summary>
370         /// ItemDoubleClicked is raised when a new genlist item is double clicked.
371         /// </summary>
372         public event EventHandler<GenListItemEventArgs> ItemDoubleClicked;
373
374         /// <summary>
375         /// ItemExpanded is raised when a new genlist item is indicated to expand.
376         /// </summary>
377         public event EventHandler<GenListItemEventArgs> ItemExpanded;
378
379         /// <summary>
380         /// ItemRealized is raised when a new genlist item is created as a real object.
381         /// </summary>
382         public event EventHandler<GenListItemEventArgs> ItemRealized;
383
384         /// <summary>
385         /// ItemUnrealized is raised when a new genlist item is unrealized.
386         /// After calling unrealize, the item's content objects are deleted and the item object itself is deleted or is put into a floating cache.
387         /// </summary>
388         public event EventHandler<GenListItemEventArgs> ItemUnrealized;
389
390         /// <summary>
391         /// ItemLongPressed is raised when a genlist item is pressed for a certain amount of time. By default it's 1 second.
392         /// </summary>
393         public event EventHandler<GenListItemEventArgs> ItemLongPressed;
394
395         /// <summary>
396         /// ItemMoved is raised when a genlist item is moved in the reorder mode.
397         /// </summary>
398         public event EventHandler<GenListItemEventArgs> ItemMoved;
399
400         /// <summary>
401         /// ItemMovedAfter is raised when a genlist item is moved after another item in the reorder mode.
402         /// To get the relative previous item, use <see cref="GenListItem.Previous"/>.
403         /// </summary>
404         public event EventHandler<GenListItemEventArgs> ItemMovedAfter;
405
406         /// <summary>
407         /// ItemMovedBefore is raised when a genlist item is moved before another item in the reorder mode.
408         /// To get the relative next item, use <see cref="GenListItem.Next"/>.
409         /// </summary>
410         public event EventHandler<GenListItemEventArgs> ItemMovedBefore;
411
412         /// <summary>
413         /// Changed is raised when genlist is changed.
414         /// </summary>
415         public event EventHandler Changed
416         {
417             add { _changed.On += value; }
418             remove { _changed.On -= value; }
419         }
420
421         /// <summary>
422         /// ScrollAnimationStarted is raised when scrolling animation has started.
423         /// </summary>
424         public event EventHandler ScrollAnimationStarted
425         {
426             add { _scrollAnimationStarted.On += value; }
427             remove { _scrollAnimationStarted.On -= value; }
428         }
429
430         /// <summary>
431         /// ScrollAnimationStopped is raised when scrolling animation has stopped.
432         /// </summary>
433         public event EventHandler ScrollAnimationStopped
434         {
435             add { _scrollAnimationStopped.On += value; }
436             remove { _scrollAnimationStopped.On -= value; }
437         }
438
439         /// <summary>
440         /// Appends a new item to the end of a given genlist widget.
441         /// </summary>
442         /// <param name="itemClass">The itemClass defines how to display the data.</param>
443         /// <param name="data">The item data.</param>
444         /// <returns>Return a new added genlist item that contains data and itemClass.</returns>
445         /// <seealso cref="GenItemClass"/>
446         /// <seealso cref="GenListItem"/>
447         public GenListItem Append(GenItemClass itemClass, object data)
448         {
449             return Append(itemClass, data, GenListItemType.Normal);
450         }
451
452         /// <summary>
453         /// Appends a new item with <see cref="GenListItemType"/> to the end of a given genlist widget.
454         /// </summary>
455         /// <param name="itemClass">The itemClass defines how to display the data.</param>
456         /// <param name="data">The item data.</param>
457         /// <param name="type">The genlist item type.</param>
458         /// <returns>Return a new added genlist item that contains data and itemClass.</returns>
459         public GenListItem Append(GenItemClass itemClass, object data, GenListItemType type)
460         {
461             return Append(itemClass, data, type, null);
462         }
463
464         /// <summary>
465         /// Appends a new item with <see cref="GenListItemType"/> to the end of a given genlist widget or the end of the children list if the parent is given.
466         /// </summary>
467         /// <param name="itemClass">The itemClass defines how to display the data.</param>
468         /// <param name="data">The item data.</param>
469         /// <param name="type">The genlist item type.</param>
470         /// <param name="parent">The parent item, otherwise null if there is no parent item.</param>
471         /// <returns>Return a new added genlist item that contains data and itemClass.</returns>
472         public GenListItem Append(GenItemClass itemClass, object data, GenListItemType type, GenListItem parent)
473         {
474             GenListItem item = new GenListItem(data, itemClass);
475             IntPtr handle = Interop.Elementary.elm_genlist_item_append(RealHandle, itemClass.UnmanagedPtr, (IntPtr)item.Id, parent, (int)type, null, (IntPtr)item.Id);
476             item.Handle = handle;
477             AddInternal(item);
478             return item;
479         }
480
481         /// <summary>
482         /// Prepends a new item to the beginning of a given genlist widget.
483         /// </summary>
484         /// <param name="itemClass">The itemClass defines how to display the data.</param>
485         /// <param name="data">The item data.</param>
486         /// <returns>Return a new added genlist item that contains data and itemClass.</returns>
487         public GenListItem Prepend(GenItemClass itemClass, object data)
488         {
489             return Prepend(itemClass, data, GenListItemType.Normal);
490         }
491
492         /// <summary>
493         /// Prepends a new item with <see cref="GenListItemType"/> to the beginning of a given genlist widget.
494         /// </summary>
495         /// <param name="itemClass">The itemClass defines how to display the data.</param>
496         /// <param name="data">The item data.</param>
497         /// <param name="type">The genlist item type.</param>
498         /// <param name="parent">The parent item, otherwise null if there is no parent item.</param>
499         /// <returns>Return a new added genlist item that contains data and itemClass.</returns>
500         public GenListItem Prepend(GenItemClass itemClass, object data, GenListItemType type)
501         {
502             return Prepend(itemClass, data, type, null);
503         }
504
505         /// <summary>
506         /// Prepends a new item with <see cref="GenListItemType"/> to the beginning of a given genlist widget or the beginning of the children list if the parent is given.
507         /// </summary>
508         /// <param name="itemClass">The itemClass defines how to display the data.</param>
509         /// <param name="data">The item data.</param>
510         /// <param name="type">The genlist item type.</param>
511         /// <param name="parent">The parent item, otherwise null if there is no parent item.</param>
512         /// <returns>Return a new added genlist item that contains data and itemClass.</returns>
513         public GenListItem Prepend(GenItemClass itemClass, object data, GenListItemType type, GenListItem parent)
514         {
515             GenListItem item = new GenListItem(data, itemClass);
516             IntPtr handle = Interop.Elementary.elm_genlist_item_prepend(RealHandle, itemClass.UnmanagedPtr, (IntPtr)item.Id, parent, (int)type, null, (IntPtr)item.Id);
517             item.Handle = handle;
518             AddInternal(item);
519             return item;
520         }
521
522         /// <summary>
523         /// Inserts an item before another item in a genlist widget.
524         /// It is the same tree level or group as the item before which it is inserted.????
525         /// </summary>
526         /// <param name="itemClass">The itemClass defines how to display the data.</param>
527         /// <param name="data">The item data.</param>
528         /// <param name="before">The item before which to place this new one.</param>
529         /// <returns>Return a new added genlist item that contains data and itemClass.</returns>
530         public GenListItem InsertBefore(GenItemClass itemClass, object data, GenListItem before)
531         {
532             return InsertBefore(itemClass, data, before, GenListItemType.Normal);
533         }
534
535         /// <summary>
536         /// Inserts an item with <see cref="GenListItemType"/> before another item in a genlist widget.
537         /// It is the same tree level or group as the item before which it is inserted.????
538         /// </summary>
539         /// <param name="itemClass">The itemClass defines how to display the data.</param>
540         /// <param name="data">The item data.</param>
541         /// <param name="before">The item before which to place this new one.</param>
542         /// <param name="type">The genlist item type.</param>
543         /// <returns>Return a new added genlist item that contains data and itemClass.</returns>
544         public GenListItem InsertBefore(GenItemClass itemClass, object data, GenListItem before, GenListItemType type)
545         {
546             return InsertBefore(itemClass, data, before, type, null);
547         }
548
549         /// <summary>
550         /// Inserts an item with <see cref="GenListItemType"/> before another item under a parent in a genlist widget.
551         /// </summary>
552         /// <param name="itemClass">The itemClass defines how to display the data.</param>
553         /// <param name="data">The item data.</param>
554         /// <param name="before">The item before which to place this new one.</param>
555         /// <param name="type">The genlist item type.</param>
556         /// <param name="parent">The parent item, otherwise null if there is no parent item.</param>
557         /// <returns>Return a new added genlist item that contains data and itemClass.</returns>
558         public GenListItem InsertBefore(GenItemClass itemClass, object data, GenListItem before, GenListItemType type, GenListItem parent)
559         {
560             GenListItem item = new GenListItem(data, itemClass);
561             // insert before the `before` list item
562             IntPtr handle = Interop.Elementary.elm_genlist_item_insert_before(
563                 RealHandle, // genlist handle
564                 itemClass.UnmanagedPtr, // item class
565                 (IntPtr)item.Id, // data
566                 parent, // parent
567                 before, // before
568                 (int)type, // item type
569                 null, // select callback
570                 (IntPtr)item.Id); // callback data
571             item.Handle = handle;
572             AddInternal(item);
573             return item;
574         }
575
576         /// <summary>
577         /// Inserts an item with <see cref="GenListItemType"/> after another item under a parent in a genlist widget.
578         /// </summary>
579         /// <param name="itemClass">The itemClass defines how to display the data.</param>
580         /// <param name="data">The item data.</param>
581         /// <param name="before">The item after which to place this new one.</param>
582         /// <param name="type">The genlist item type.</param>
583         /// <param name="parent">The parent item, otherwise null if there is no parent item.</param>
584         /// <returns>Return a new added genlist item that contains data and itemClass.</returns>
585         public GenListItem InsertAfter(GenItemClass itemClass, object data, GenListItem after, GenListItemType type, GenListItem parent)
586         {
587             GenListItem item = new GenListItem(data, itemClass);
588             // insert before the `before` list item
589             IntPtr handle = Interop.Elementary.elm_genlist_item_insert_before(
590                 RealHandle, // genlist handle
591                 itemClass.UnmanagedPtr, // item class
592                 (IntPtr)item.Id, // data
593                 parent, // parent
594                 after, // after
595                 (int)type, // item type
596                 null, // select callback
597                 (IntPtr)item.Id); // callback data
598             item.Handle = handle;
599             AddInternal(item);
600             return item;
601         }
602
603         /// <summary>
604         /// Insert an item in a genlist widget using a user-defined sort function.
605         /// </summary>
606         /// <param name="itemClass">The itemClass defines how to display the data.</param>
607         /// <param name="data">The item data.</param>
608         /// <param name="func">User defined comparison function that defines the sort order based on genlist item and its data.</param>
609         /// <param name="type">The genlist item type.</param>
610         /// <param name="parent">The parent item, otherwise null if there is no parent item.</param>
611         /// <returns>Return a genlist item that contains data and itemClass.</returns>
612         public GenListItem InsertSorted(GenItemClass itemClass, object data, Comparison<GenListItem> comparison, GenListItemType type, GenListItem parent)
613         {
614             Interop.Elementary.Eina_Compare_Cb compareCallback = (handle1, handle2) =>
615             {
616                 GenListItem item1 = ItemObject.GetItemByHandle(handle1) as GenListItem;
617                 GenListItem item2 = ItemObject.GetItemByHandle(handle2) as GenListItem;
618                 return comparison(item1, item2);
619             };
620
621             GenListItem item = new GenListItem(data, itemClass);
622
623             IntPtr handle = Interop.Elementary.elm_genlist_item_sorted_insert(
624                 RealHandle, // genlist handle
625                 itemClass.UnmanagedPtr, // item clas
626                 (IntPtr)item.Id, // data
627                 parent, // parent
628                 (int)type, // item type
629                 compareCallback, // compare callback
630                 null, //select callback
631                 (IntPtr)item.Id); // callback data
632             item.Handle = handle;
633             AddInternal(item);
634             return item;
635         }
636
637         /// <summary>
638         /// Shows the given item with position type in a genlist.
639         /// When animated is true, genlist will jump to the given item and display it (by animatedly scrolling), if it is not fully visible. This may use animation and may take some time.
640         /// When animated is false, genlist will jump to the given item and display it (by jumping to that position), if it is not fully visible.
641         /// </summary>
642         /// <param name="item">The item to display.</param>
643         /// <param name="position">The position to show the given item to <see cref="ScrollToPosition"/>.</param>
644         /// <param name="animated">The animated indicates how to display the item, by scrolling or by jumping.</param>
645         public void ScrollTo(GenListItem item, ScrollToPosition position, bool animated)
646         {
647             if (animated)
648             {
649                 Interop.Elementary.elm_genlist_item_bring_in(item.Handle, (Interop.Elementary.Elm_Genlist_Item_Scrollto_Type)position);
650             }
651             else
652             {
653                 Interop.Elementary.elm_genlist_item_show(item.Handle, (Interop.Elementary.Elm_Genlist_Item_Scrollto_Type)position);
654             }
655         }
656
657         /// <summary>
658         /// Updates the content of all the realized items.
659         /// This updates all the realized items by calling all the <see cref="GenItemClass"/> again to get the content, text and states.
660         /// Use this when the original item data has changed and the changes are desired to reflect.
661         /// To update just one item, use <see cref="GenListItem.Update"/>.
662         /// </summary>
663         /// <seealso cref="GenListItem.Update"/>
664         public void UpdateRealizedItems()
665         {
666             Interop.Elementary.elm_genlist_realized_items_update(RealHandle);
667         }
668
669         /// <summary>
670         /// Removes all items from a given genlist widget.
671         /// This removes (and deletes) all items in obj, making it empty.
672         /// To delete just one item, use <see cref="ItemObject.Delete"/>.
673         /// </summary>
674         /// <seealso cref="ItemObject.Delete"/>
675         public void Clear()
676         {
677             Interop.Elementary.elm_genlist_clear(RealHandle);
678         }
679
680         /// <summary>
681         /// Get the item that is at the x, y canvas coords.
682         /// </summary>
683         /// <param name="x">The input x coordinate</param>
684         /// <param name="y">The input y coordinate</param>
685         /// <param name="pos">The position relative to the item returned here
686         ///  -1, 0, or 1, depending on whether the coordinate is on the upper portion of that item (-1), in the middle section (0), or on the lower part (1).
687         /// </param>
688         /// <returns></returns>
689         public GenListItem GetItemByPosition(int x, int y, out int pos)
690         {
691             IntPtr handle = Interop.Elementary.elm_genlist_at_xy_item_get(RealHandle, x, y, out pos);
692             return ItemObject.GetItemByHandle(handle) as GenListItem;
693         }
694
695         /// <summary>
696         /// Gets the nth item in a given genlist widget, placed at position nth, in its internal items list.
697         /// </summary>
698         /// <param name="index">The number of the item to grab (0 being the first)</param>
699         /// <returns></returns>
700         public GenListItem GetItemByIndex(int index)
701         {
702             IntPtr handle = Interop.Elementary.elm_genlist_nth_item_get(RealHandle, index);
703             return ItemObject.GetItemByHandle(handle) as GenListItem;
704         }
705
706         protected override IntPtr CreateHandle(EvasObject parent)
707         {
708             IntPtr handle = Interop.Elementary.elm_layout_add(parent.Handle);
709             Interop.Elementary.elm_layout_theme_set(handle, "layout", "elm_widget", "default");
710
711             RealHandle = Interop.Elementary.elm_genlist_add(handle);
712             Interop.Elementary.elm_object_part_content_set(handle, "elm.swallow.content", RealHandle);
713
714             return handle;
715         }
716
717         void InitializeSmartEvent()
718         {
719             _selected = new SmartEvent<GenListItemEventArgs>(this, this.RealHandle, "selected", GenListItemEventArgs.CreateFromSmartEvent);
720             _unselected = new SmartEvent<GenListItemEventArgs>(this, this.RealHandle, "unselected", GenListItemEventArgs.CreateFromSmartEvent);
721             _activated = new SmartEvent<GenListItemEventArgs>(this, this.RealHandle, "activated", GenListItemEventArgs.CreateFromSmartEvent);
722             _pressed = new SmartEvent<GenListItemEventArgs>(this, this.RealHandle, "pressed", GenListItemEventArgs.CreateFromSmartEvent);
723             _released = new SmartEvent<GenListItemEventArgs>(this, this.RealHandle, "released", GenListItemEventArgs.CreateFromSmartEvent);
724             _doubleClicked = new SmartEvent<GenListItemEventArgs>(this, this.RealHandle, "clicked,double", GenListItemEventArgs.CreateFromSmartEvent);
725             _expanded = new SmartEvent<GenListItemEventArgs>(this, this.RealHandle, "expanded", GenListItemEventArgs.CreateFromSmartEvent);
726             _realized = new SmartEvent<GenListItemEventArgs>(this, this.RealHandle, "realized", GenListItemEventArgs.CreateFromSmartEvent);
727             _unrealized = new SmartEvent<GenListItemEventArgs>(this, this.RealHandle, "unrealized", GenListItemEventArgs.CreateFromSmartEvent);
728             _longpressed = new SmartEvent<GenListItemEventArgs>(this, this.RealHandle, "longpressed", GenListItemEventArgs.CreateFromSmartEvent);
729             _moved = new SmartEvent<GenListItemEventArgs>(this, this.RealHandle, "moved", GenListItemEventArgs.CreateFromSmartEvent);
730             _movedAfter = new SmartEvent<GenListItemEventArgs>(this, this.RealHandle, "moved,after", GenListItemEventArgs.CreateFromSmartEvent);
731             _movedBefore = new SmartEvent<GenListItemEventArgs>(this, this.RealHandle, "moved,before", GenListItemEventArgs.CreateFromSmartEvent);
732             _scrollAnimationStarted = new SmartEvent(this, this.RealHandle, "scroll,anim,start");
733             _scrollAnimationStopped = new SmartEvent(this, this.RealHandle, "scroll,anim,stop");
734             _changed = new SmartEvent(this, this.RealHandle, "changed");
735
736             _selected.On += (s, e) => { if (e.Item != null) ItemSelected?.Invoke(this, e); };
737             _unselected.On += (s, e) => { if (e.Item != null) ItemUnselected?.Invoke(this, e); };
738             _activated.On += (s, e) => { if (e.Item != null) ItemActivated?.Invoke(this, e); };
739             _pressed.On += (s, e) => { if (e.Item != null) ItemPressed?.Invoke(this, e); };
740             _released.On += (s, e) => { if (e.Item != null) ItemReleased?.Invoke(this, e); };
741             _doubleClicked.On += (s, e) => { if (e.Item != null) ItemDoubleClicked?.Invoke(this, e); };
742             _expanded.On += (s, e) => { if (e.Item != null) ItemExpanded?.Invoke(this, e); };
743             _realized.On += (s, e) => { if (e.Item != null) ItemRealized?.Invoke(this, e); };
744             _unrealized.On += (s, e) => { if (e.Item != null) ItemUnrealized?.Invoke(this, e); };
745             _longpressed.On += (s, e) => { if (e.Item != null) ItemLongPressed?.Invoke(this, e); };
746             _moved.On += (s, e) => { if (e.Item != null) ItemMoved?.Invoke(this, e); };
747             _movedAfter.On += (s, e) => { if (e.Item != null) ItemMovedAfter?.Invoke(this, e); };
748             _movedBefore.On += (s, e) => { if (e.Item != null) ItemMovedBefore?.Invoke(this, e); };
749         }
750
751         void AddInternal(GenListItem item)
752         {
753             _children.Add(item);
754             item.Deleted += Item_Deleted;
755         }
756
757         void Item_Deleted(object sender, EventArgs e)
758         {
759             _children.Remove((GenListItem)sender);
760         }
761     }
762 }