Elementary / genlist - updated signal callback list
authorhermet <hermet@7cbeb6ba-43b4-40fd-8cce-4c39aea84d33>
Tue, 5 Apr 2011 04:46:38 +0000 (04:46 +0000)
committerhermet <hermet@7cbeb6ba-43b4-40fd-8cce-4c39aea84d33>
Tue, 5 Apr 2011 04:46:38 +0000 (04:46 +0000)
git-svn-id: https://svn.enlightenment.org/svn/e/trunk/elementary@58344 7cbeb6ba-43b4-40fd-8cce-4c39aea84d33

src/lib/Elementary.h.in

index cae327c..5c45fef 100644 (file)
@@ -809,7 +809,6 @@ extern "C" {
    EAPI void         elm_scroller_region_bring_in(Evas_Object *obj, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
    EAPI void         elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
    EAPI Eina_Bool    elm_scroller_propagate_events_get(const Evas_Object *obj);
-
    /* smart callbacks called:
     * "edge,left" - the left edge of the content has been reached
     * "edge,right" - the right edge of the content has been reached
@@ -1846,27 +1845,68 @@ extern "C" {
    EAPI void               elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
    EAPI Eina_Bool          elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
    /* smart callbacks called:
-    * "drag,start,up" - This is called when the item in the list has been dragged
+    * "clicked,double" - This is called when a user has double-clicked an item. The
+    *                    event_info parameter is the genlist item that was double-clicked.
+    * "selected" - This is called when a user has made an item selected. The
+    *              event_info parameter is the genlist item that was selected.
+    * "unselected" - This is called when a user has made an item unselected. The
+    *                 event_info parameter is the genlist item that was unselected.
+    * "expanded" - This is called when elm_genlist_item_expanded_set() is called
+    *              and the item is now meant to be expanded. The event_info parameter is the
+    *              genlist item that was indicated to expand. It is the job of this callback
+    *              to then fill in the child items.
+    * "contracted" - This is called when elm_genlist_item_expanded_set() is called
+    *                and the item is now meant to be contracted. The event_info parameter is
+    *                the genlist item that was indicated to contract. It is the job of this
+    *                callback to then delete the child items.
+    * "expand,request" - This is called when a user has indicated they want to
+    *                    expand a tree branch item. The callback should decide if the item can
+    *                    expand (has any children) and then call elm_genlist_item_expanded_set()
+    *                    appropriately to set the state. The event_info parameter is the genlist
+    *                    item that was indicated to expand.
+    * "contract,request" - This is called when a user has indicated they want to
+    *                      contract a tree branch item. The callback should decide if the item can
+    *                      contract (has any children) and then call elm_genlist_item_expanded_set()
+    *                      appropriately to set the state. The event_info parameter is the genlist
+    *                      item that was indicated to contract.
+    * "realized" - This is called when the item in the list is created as a real
+    *              evas object. event_info parameter is the genlist item that was created.
+    *              The object may be deleted at any time, so it is up to the caller to
+    *              not use the object pointer from elm_genlist_item_object_get() in a way
+    *              where it may point to freed objects.
+    * "unrealized" - This is called just before an item is unrealized. After
+    *                this call icon objects provided will be deleted and the item object
+    *                itself delete or be put into a floating cache.
+    * "drag,start,up" - This is called when the item in the list has been dragged 
     *                   (not scrolled) up.
-    * "drag,start,down" - This is called when the item in the list has been dragged
+    * "drag,start,down" - This is called when the item in the list has been dragged 
     *                     (not scrolled) down.
-    * "drag,start,left" - This is called when the item in the list has been dragged
+    * "drag,start,left" - This is called when the item in the list has been dragged i
     *                     (not scrolled) left.
     * "drag,start,right" - This is called when the item in the list has been dragged
     *                      (not scrolled) right.
-    * "drag,stop" - This is called when the item in the list has stopped being dragged.
+    * "drag,stop" - This is called when the item in the list has stopped being
+    *               dragged.
     * "drag" - This is called when the item in the list is being dragged.
     * "longpressed" - This is called when the item is pressed for a certain amount
     *                 of time. By default it's 1 second.
-    * "scroll,edge,top" - This is called when the genlist is scrolled until the top edge.
-    * "scroll,edge,bottom" - This is called when the genlist is scrolled until the bottom edge.
-    * "scroll,edge,left" - This is called when the genlist is scrolled until the left edge.
-    * "scroll,edge,right" - This is called when the genlist is scrolled until the right edge.
-    * "multi,swipe,left" - This is called when the genlist is multi-touch swiped left.
-    * "multi,swipe,right" - This is called when the genlist is multi-touch swiped right.
+    * "scroll,edge,top" - This is called when the genlist is scrolled until the
+    *                     top edge.
+    * "scroll,edge,bottom" - This is called when the genlist is scrolled until the
+    *                         bottom edge.
+    * "scroll,edge,left" - This is called when the genlist is scrolled until the
+    *                      left edge.
+    * "scroll,edge,right" - This is called when the genlist is scrolled until the
+    *                       right edge.
+    * "multi,swipe,left" - This is called when the genlist is multi-touch swiped
+    *                       left.
+    * "multi,swipe,right" - This is called when the genlist is multi-touch swiped
+    *                       right.
     * "multi,swipe,up" - This is called when the genlist is multi-touch swiped up.
-    * "multi,swipe,down" - This is called when the genlist is multi-touch swiped down.
-    * "multi,pinch,out" - This is called when the genlist is multi-touch pinched out.
+    * "multi,swipe,down" - This is called when the genlist is multi-touch swiped
+    *                      down.
+    * "multi,pinch,out" - This is called when the genlist is multi-touch pinched
+    *                     out.
     * "multi,pinch,in" - This is called when the genlist is multi-touch pinched in.
     */
 
@@ -2465,7 +2505,6 @@ extern "C" {
    EINA_DEPRECATED EAPI void               elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
    EINA_DEPRECATED EAPI void               elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
    EINA_DEPRECATED EAPI void               elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
-
    /* smart callbacks called:
     * changed - emitted when the user select a day or change the displayed
     * month.