Elementary genlist: Moved signal doxygen to header file.
authorseoz <seoz@7cbeb6ba-43b4-40fd-8cce-4c39aea84d33>
Wed, 27 Apr 2011 02:41:11 +0000 (02:41 +0000)
committerseoz <seoz@7cbeb6ba-43b4-40fd-8cce-4c39aea84d33>
Wed, 27 Apr 2011 02:41:11 +0000 (02:41 +0000)
This is a first action of doxygen movement. All doxygen will be moved to
headers after all.

git-svn-id: svn+ssh://svn.enlightenment.org/var/svn/e/trunk/elementary@58943 7cbeb6ba-43b4-40fd-8cce-4c39aea84d33

src/lib/Elementary.h.in
src/lib/elm_genlist.c

index 5153666..8a154cf 100644 (file)
@@ -1863,70 +1863,80 @@ extern "C" {
    EAPI void               elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
    EAPI const char        *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
    EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-   /* smart callbacks called:
-    * "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.
+   /** Signals that you can add callbacks for are:
+    * "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.
+    *                 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.
+    *              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.
+    *                    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.
+    *                      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.
+    *              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 
-    *                     (not scrolled) down.
-    * "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.
+    *                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 (not scrolled) down.
+    * "drag,start,left" - This is called when the item in the list has been
+    *                     dragged (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" - 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.
+    * "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,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.
+    * "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,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,pinch,in" - This is called when the genlist is multi-touch pinched in.
+    * "multi,pinch,in" - This is called when the genlist is multi-touch pinched
+    *                    in.
     */
 
    /* check */
index e8a30b9..c14e7ce 100644 (file)
  * have a specific style that overrides any theme the user or system sets up
  * you can use elm_theme_overlay_add() to add such a file.
  *
- * Signals that you can add callbacks for are:
- *
- * "clicked,double" - This is called when a user has double-clicked an item. The
- *                    event_info parameter is the genlist item that was double-c
- *                    licked.
- * "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
- *                     (not scrolled) down.
- * "drag,start,left" - This is called when the item in the list has been dragged
- *                     (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" - 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.
- * "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,pinch,in" - This is called when the genlist is multi-touch pinched in.
  */
 
 typedef struct _Widget_Data Widget_Data;