EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj);
/* smart callbacks called:
- * "edge,left"
- * "edge,right"
- * "edge,top"
- * "edge,bottom"
- * "scroll"
- * "scroll,anim,start"
- * "scroll,anim,stop"
- * "scroll,drag,start"
- * "scroll,drag,stop"
+ * "edge,left" - the left edge of the content has been reached
+ * "edge,right" - the right edge of the content has been reached
+ * "edge,top" - the top edge of the content has been reached
+ * "edge,bottom" - the bottom edge of the content has been reached
+ * "scroll" - the content has been scrolled (moved)
+ * "scroll,anim,start" - scrolling animation has started
+ * "scroll,anim,stop" - scrolling animation has stopped
+ * "scroll,drag,start" - dragging the contents around has started
+ * "scroll,drag,stop" - dragging the contents around has stopped
*/
/* label */
EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
/* smart callbacks called:
- * "changed" - the user toggled the state
+ * "changed" - Whenever the toggle value has been changed. Is not called
+ * until the toggle is released by the cursor (assuming it has been triggered
+ * by the cursor in the first place).
*/
/* frame */
/* available styles:
* default
* noframe
- *
- * smart callbacks called:
- * "clicked" - the user clicked the thumb
- * "clicked,double" - the user double clicked the thumb
- * "press" - the user pressed the thumb
- * "generate,start" - the thumbnail generation started
- * "generate,stop" - the thumbnail generation stopped
- * "generate,error" - the thumbnail generation failed
- * "load,error" - the thumbnail image loading failed
+ */
+ /* smart callbacks called:
+ * "clicked" - This is called when a user has clicked the thumb without dragging around.
+ * "clicked,double" - This is called when a user has double-clicked the thumb.
+ * "press" - This is called when a user has pressed down the thumb.
+ * "generate,start" - The thumbnail generation started.
+ * "generate,stop" - The generation process stopped.
+ * "generate,error" - The generation failed.
+ * "load,error" - The thumbnail image loading failed.
*/
/* hoversel */
EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /* smart callbacks called:
+ * "changed" - Whenever the slider value is changed by the user.
+ * "slider,drag,start" - dragging the slider indicator around has started
+ * "slider,drag,stop" - dragging the slider indicator around has stopped
+ * "delay,changed" - A short time after the value is changed by the user.
+ * This will be called only when the user stops dragging for a very short
+ * period or when they release their finger/mouse, so it avoids possibly
+ * expensive reactions to the value change.
+ */
/* actionslider */
typedef enum _Elm_Actionslider_Pos
EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
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
+ * (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.
+ */
/* check */
EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
+ /* smart callbacks called:
+ * "changed" - when the radio status is changed
+ */
/* pager */
EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
* complex when it comes to usage. If all you want is a simple list with
* icons and a single label, use the normal List object.
*
- * 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.
- *
- * 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.
- *
* Genlist has a fairly large API, mostly because it's relatively complex,
* trying to be both expansive, powerful and efficient. First we will begin
* an overview on the theory behind genlist.
* 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
* 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
+ * 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.
+ *
+ * Signals that you can add callbacks for are:
+ *
+ * "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;
* the pointer to this integer to modify, use elm_radio_value_pointer_set().
* The radio objects will modify this directly. That implies the pointer must
* point to valid memory for as long as the radio objects exist.
+ *
+ * Signals that you can add callbacks for are:
+ *
+ * "changed" - when the radio status is changed
+ *
*/
typedef struct _Widget_Data Widget_Data;
*
* Signals that you can add callbacks for are:
*
- * edge,left - the left edge of the content has been reached
- *
- * edge,right - the right edge of the content has been reached
- *
- * edge,top - the top edge of the content has been reached
- *
- * edge,bottom - the bottom edge of the content has been reached
- *
- * scroll - the content has been scrolled (moved)
- *
- * scroll,anim,start - scrolling animation has started
- *
- * scroll,anim,stop - scrolling animation has stopped
- *
- * scroll,drag,start - dragging the contents around has started
- *
- * scroll,drag,stop - dragging the contents around has stopped
+ * "edge,left" - the left edge of the content has been reached
+ * "edge,right" - the right edge of the content has been reached
+ * "edge,top" - the top edge of the content has been reached
+ * "edge,bottom" - the bottom edge of the content has been reached
+ * "scroll" - the content has been scrolled (moved)
+ * "scroll,anim,start" - scrolling animation has started
+ * "scroll,anim,stop" - scrolling animation has stopped
+ * "scroll,drag,start" - dragging the contents around has started
+ * "scroll,drag,stop" - dragging the contents around has stopped
*/
typedef struct _Widget_Data Widget_Data;
* The slider adds a dragable “slider” widget for selecting the value of
* something within a range.
*
- * Signals that you can add callbacks for are:
- *
- * changed - Whenever the slider value is changed by the user.
- *
- * delay,changed - A short time after the value is changed by the user.
- * This will be called only when the user stops dragging for a very short
- * period or when they release their finger/mouse, so it avoids possibly
- * expensive reactions to the value change.
- *
- * slider,drag,start - dragging the slider indicator around has started
- *
- * slider,drag,stop - dragging the slider indicator around has stopped
*
* A slider can be horizontal or vertical. It can contain an Icon and has a
* primary label as well as a units label (that is formatted with floating
* slider is its length (horizontally or vertically). This will be scaled by
* the object or applications scaling factor. At any point code can query the
* slider for its value with elm_slider_value_get().
+ *
+ * Signals that you can add callbacks for are:
+ *
+ * "changed" - Whenever the slider value is changed by the user.
+ * "slider,drag,start" - dragging the slider indicator around has started
+ * "slider,drag,stop" - dragging the slider indicator around has stopped
+ * "delay,changed" - A short time after the value is changed by the user.
+ * This will be called only when the user stops dragging for a very short
+ * period or when they release their finger/mouse, so it avoids possibly
+ * expensive reactions to the value change.
*/
typedef struct _Widget_Data Widget_Data;
* is displayed the function itc->func.get() is called. This function should create the object,
* for example the object can be an evas_object_image or a photocam. When a object is no more
* displayed the function itc->func.del() is called, the user can delete the dana associated to the item.
+ *
+ * Signals that you can add callbacks for are:
+ *
+ * "changed" - when the slideshow switch to another item
*/
typedef struct _Widget_Data Widget_Data;
*
* Signals that you can add callbacks for are:
*
- * changed - Whenever the spinner value is changed by the user.
- *
- * delay,changed - A short time after the value is changed by the user.
- * This will be called only when the user stops dragging for a very short
- * period or when they release their finger/mouse, so it avoids possibly
- * expensive reactions to the value change.
+ * "changed" - Whenever the spinner value is changed by the user.
+ * "delay,changed" - A short time after the value is changed by the user.
+ * This will be called only when the user stops dragging for a very short
+ * period or when they release their finger/mouse, so it avoids possibly
+ * expensive reactions to the value change.
*/
typedef struct _Widget_Data Widget_Data;
typedef struct _Elm_Spinner_Special_Value Elm_Spinner_Special_Value;
*
* Signals that you can add callbacks for are:
*
- * clicked - This is called when a user has clicked the thumb without dragging
- * around.
- *
- * clicked,double - This is called when a user has double-clicked the thumb.
- *
- * press - This is called when a user has pressed down the thumb.
- *
- * generate,start - The thumbnail generation started.
- *
- * generate,stop - The generation process stopped.
- *
- * generate,error - The generation failed.
- *
- * load,error - The thumbnail image loading failed.
+ * "clicked" - This is called when a user has clicked the thumb without dragging
+ * around.
+ * "clicked,double" - This is called when a user has double-clicked the thumb.
+ * "press" - This is called when a user has pressed down the thumb.
+ * "generate,start" - The thumbnail generation started.
+ * "generate,stop" - The generation process stopped.
+ * "generate,error" - The generation failed.
+ * "load,error" - The thumbnail image loading failed.
*/
typedef struct _Widget_Data Widget_Data;
*
* Signals that you can add callbacks for are:
*
- * changed - Whenever the toggle value has been changed. Is not called
+ * "changed" - Whenever the toggle value has been changed. Is not called
* until the toggle is released by the cursor (assuming it has been triggered
* by the cursor in the first place).
*/
*
* A toolbar is a widget that displays a list of buttons inside
* a box. It is scrollable, and only one item can be selected at a time.
+ *
+ * Signals that you can add callbacks for are:
+ *
+ * "clicked" - when the user clicks on a toolbar item and becomes selected
+ *
*/
typedef struct _Widget_Data Widget_Data;
*
* The window class of Elementary. Contains functions to manipulate
* windows.
+ *
+ * Signals that you can add callbacks for are:
+ *
+ * "delete,request" - the user requested to delete the window
+ * "focus,in" - window got focus
+ * "focus,out" - window lost focus
+ * "moved" - window that holds the canvas was moved
*/
typedef struct _Elm_Win Elm_Win;
projects / framework / uifw / elementary.git / commitdiff