Elementary elm_genlist.c: Fixed genlist doxygen.

SVN revision: 58343
This commit is contained in:
Daniel Juyung Seo 2011-04-05 04:30:34 +00:00
parent 902a467b7e
commit 9ef7f1f943
1 changed files with 51 additions and 26 deletions

View File

@ -187,71 +187,96 @@
* per application with elm_theme_extension_add(). If you absolutely must * per application with elm_theme_extension_add(). If you absolutely must
* have a specific style that overrides any theme the user or system sets up * 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. * you can use elm_theme_overlay_add() to add such a file.
*
* clicked,double - This is called when a user has double-clicked an item. The * 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. * event_info parameter is the genlist item that was double-clicked.
* *
* selected - This is called when a user has made an item selected. The * "selected" - This is called when a user has made an item selected. The
* event_info parameter is the genlist item that was selected. * event_info parameter is the genlist item that was selected.
* *
* unselected - This is called when a user has made an item unselected. The * "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 * "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 * 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 * genlist item that was indicated to expand. It is the job of this callback
* to then fill in the child items. * to then fill in the child items.
* *
* contracted - This is called when elm_genlist_item_expanded_set() is called * "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 * 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 * the genlist item that was indicated to contract. It is the job of this
* callback to then delete the child items. * callback to then delete the child items.
* *
* expand,request - This is called when a user has indicated they want to * "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 a tree branch item. The callback should decide if the item can
* expand (has any children) and then call elm_genlist_item_expanded_set() * expand (has any children) and then call elm_genlist_item_expanded_set()
* appropriately to set the state. The event_info parameter is the genlist * appropriately to set the state. The event_info parameter is the genlist
* item that was indicated to expand. * item that was indicated to expand.
* *
* contract,request - This is called when a user has indicated they want to * "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 a tree branch item. The callback should decide if the item can
* contract (has any children) and then call elm_genlist_item_expanded_set() * contract (has any children) and then call elm_genlist_item_expanded_set()
* appropriately to set the state. The event_info parameter is the genlist * appropriately to set the state. The event_info parameter is the genlist
* item that was indicated to contract. * item that was indicated to contract.
* *
* realized - This is called when the item in the list is created as a real * "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. * 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 * 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 * not use the object pointer from elm_genlist_item_object_get() in a way
* where it may point to freed objects. * where it may point to freed objects.
* *
* unrealized - This is called just before an item is unrealized. After * "unrealized" - This is called just before an item is unrealized. After
* this call icon objects provided will be deleted and the item object * this call icon objects provided will be deleted and the item object
* itself delete or be put into a floating cache. * itself delete or be put into a floating cache.
* *
* Signals that you can add callbacks for are:
*
* "drag,start,up" - This is called when the item in the list has been dragged * "drag,start,up" - This is called when the item in the list has been dragged
* (not scrolled) up. * (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. * (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
* (not scrolled) left. * (not scrolled) left.
*
* "drag,start,right" - This is called when the item in the list has been dragged * "drag,start,right" - This is called when the item in the list has been dragged
* (not scrolled) right. * (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. * "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 * "longpressed" - This is called when the item is pressed for a certain amount
* of time. By default it's 1 second. * 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,top" - This is called when the genlist is scrolled until the
* "scroll,edge,left" - This is called when the genlist is scrolled until the left edge. * top 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. * "scroll,edge,bottom" - This is called when the genlist is scrolled until the
* "multi,swipe,right" - This is called when the genlist is multi-touch swiped right. * 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,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. * "multi,pinch,in" - This is called when the genlist is multi-touch pinched in.
*/ */