Elementary.h File Reference

Elementary's API. More...

Functions
EAPI void	elm_init (int argc, char **argv)
	Inititalise Elementary.
EAPI void	elm_shutdown (void)
	Shut down Elementary.
EAPI void	elm_run (void)
	Run the main loop.
EAPI void	elm_exit (void)
	Exit the main loop.
EAPI void	elm_object_scale_set (Evas_Object *obj, double scale)
	Set the scaling factor.
EAPI double	elm_object_scale_get (const Evas_Object *obj)
	Get the scaling factor.
EAPI void	elm_object_style_set (Evas_Object *obj, const char *style)
	Set the style.
EAPI const char *	elm_object_style_get (const Evas_Object *obj)
	Get the style.
EAPI void	elm_object_disabled_set (Evas_Object *obj, Eina_Bool disabled)
	Set the disable state.
EAPI Eina_Bool	elm_object_disabled_get (const Evas_Object *obj)
	Get the disable state.
EAPI double	elm_scale_get (void)
	Get the global scaling factor.
EAPI void	elm_scale_set (double scale)
	Set the global scaling factor.
EAPI Evas_Coord	elm_finger_size_get (void)
	Get the configured finger size.
EAPI void	elm_finger_size_set (Evas_Coord size)
	Set the configured finger size.
EAPI void	elm_object_focus (Evas_Object *obj)
	Set the focus to the object.
EAPI void	elm_coords_finger_size_adjust (int times_w, Evas_Coord *w, int times_h, Evas_Coord *h)
	Adjust size of an element for finger usage.
EAPI Evas_Object *	elm_bg_add (Evas_Object *parent)
	Add a new background to the parent.
EAPI void	elm_bg_file_set (Evas_Object *obj, const char *file, const char *group)
	Set the file (image or edje) used for the background.
EAPI Evas_Object *	elm_box_add (Evas_Object *parent)
	Add a new box to the parent.
EAPI void	elm_box_horizontal_set (Evas_Object *obj, Eina_Bool horizontal)
	Set the horizontal orientation.
EAPI void	elm_box_homogenous_set (Evas_Object *obj, Eina_Bool homogenous)
	Set homogenous layout.
EAPI void	elm_box_pack_start (Evas_Object *obj, Evas_Object *subobj)
	This adds a box at the start of the box (top or left based on orientation).
EAPI void	elm_box_pack_end (Evas_Object *obj, Evas_Object *subobj)
	This adds a box at the end of the box (bottom or right based on orientation).
EAPI void	elm_box_pack_before (Evas_Object *obj, Evas_Object *subobj, Evas_Object *before)
	This adds adds an object to the box before the indicated object.
EAPI void	elm_box_pack_after (Evas_Object *obj, Evas_Object *subobj, Evas_Object *after)
	This adds adds an object to the box after the indicated object.
EAPI Evas_Object *	elm_notepad_add (Evas_Object *parent)
	Add a new notepad to the parent.
EAPI void	elm_notepad_file_set (Evas_Object *obj, const char *file, Elm_Text_Format format)
	Set the file to load text from and save text back to.
EAPI Evas_Object *	elm_anchorview_add (Evas_Object *parent)
	Add a new Anchorview object.
EAPI void	elm_anchorview_text_set (Evas_Object *obj, const char *text)
	Set the text markup of the anchorview.
EAPI void	elm_anchorview_hover_parent_set (Evas_Object *obj, Evas_Object *parent)
	Set the parent of the hover popup.
EAPI void	elm_anchorview_hover_style_set (Evas_Object *obj, const char *style)
	Set the style that the hover should use.
EAPI void	elm_anchorview_hover_end (Evas_Object *obj)
	Stop the hover popup in the anchorview.
EAPI Evas_Object *	elm_anchorblock_add (Evas_Object *parent)
	Add a new Anchorblock object.
EAPI void	elm_anchorblock_text_set (Evas_Object *obj, const char *text)
	Set the text markup of the anchorblock.
EAPI void	elm_anchorblock_hover_parent_set (Evas_Object *obj, Evas_Object *parent)
	Set the parent of the hover popup.
EAPI void	elm_anchorblock_hover_style_set (Evas_Object *obj, const char *style)
	Set the style that the hover should use.
EAPI void	elm_anchorblock_hover_end (Evas_Object *obj)
	Stop the hover popup in the anchorblock.
EAPI Evas_Object *	elm_hoversel_add (Evas_Object *parent)
	Add a new Hoversel object.
EAPI void	elm_hoversel_hover_parent_set (Evas_Object *obj, Evas_Object *parent)
	Set the Hover parent.
EAPI void	elm_hoversel_label_set (Evas_Object *obj, const char *label)
	Set the hoversel button label.
EAPI const char *	elm_hoversel_label_get (Evas_Object *obj)
	Get the hoversel button label.
EAPI void	elm_hoversel_icon_set (Evas_Object *obj, Evas_Object *icon)
	Set the icon of the hoversel button.
EAPI Evas_Object *	elm_hoversel_icon_get (Evas_Object *obj)
	Get the icon of the hoversel button.
EAPI void	elm_hoversel_hover_begin (Evas_Object *obj)
	Trigger the hoversel popup from code.
EAPI void	elm_hoversel_hover_end (Evas_Object *obj)
	This ends the hoversel popup.
EAPI void	elm_hoversel_clear (Evas_Object *obj)
	Remove all the items from the given hoversel object.
EAPI Elm_Hoversel_Item *	elm_hoversel_item_add (Evas_Object *obj, const char *label, const char *icon_file, Elm_Icon_Type icon_type, void(*func)(void *data, Evas_Object *obj, void *event_info), const void *data)
	Add an item to the hoversel button.
EAPI void	elm_hoversel_item_del (Elm_Hoversel_Item *item)
	Delete an item from the hoversel.
EAPI void *	elm_hoversel_item_data_get (Elm_Hoversel_Item *it)
	Get the data pointer passed to the item add function.
EAPI const char *	elm_hoversel_item_label_get (Elm_Hoversel_Item *it)
	Get the text label of an hoversel item.
EAPI void	elm_hoversel_item_icon_set (Elm_Hoversel_Item *it, const char *icon_file, const char *icon_group, Elm_Icon_Type icon_type)
	Set the icon of the hoversel item.
EAPI Evas_Object *	elm_slider_add (Evas_Object *parent)
	Add a new slider to the parent.
EAPI void	elm_slider_label_set (Evas_Object *obj, const char *label)
	Set the label of the slider.
EAPI const char *	elm_slider_label_get (Evas_Object *obj)
	Get the label of the slider.
EAPI void	elm_slider_icon_set (Evas_Object *obj, Evas_Object *icon)
	Set the icon object of the slider object.
EAPI Evas_Object *	elm_slider_icon_get (Evas_Object *obj)
	Get the icon object of the slider object.
EAPI void	elm_slider_span_size_set (Evas_Object *obj, Evas_Coord size)
	Set the length of the dragable region of the slider.
EAPI void	elm_slider_unit_format_set (Evas_Object *obj, const char *format)
	Set the format string of the unit area.
EAPI void	elm_slider_indicator_format_set (Evas_Object *obj, const char *indicator)
	Set the format string for the inducator area.
EAPI void	elm_slider_horizontal_set (Evas_Object *obj, Eina_Bool horizontal)
	Set orientation of the slider.
EAPI void	elm_slider_min_max_set (Evas_Object *obj, double min, double max)
	Set the minimum and maximum values for the slider.
EAPI void	elm_slider_value_set (Evas_Object *obj, double val)
	Set the value the slider indicates.
EAPI double	elm_slider_value_get (const Evas_Object *obj)
	Get the value the slider has.
EAPI void	elm_slider_inverted_set (Evas_Object *obj, Eina_Bool inverted)
	Invert the slider display.
EAPI Evas_Object *	elm_genlist_add (Evas_Object *parent)
	Add a new Genlist object.
EAPI Elm_Genlist_Item *	elm_genlist_item_append (Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Genlist_Item *parent, Elm_Genlist_Item_Flags flags, void(*func)(void *data, Evas_Object *obj, void *event_info), const void *func_data)
	Append item to the end of the genlist.
EAPI Elm_Genlist_Item *	elm_genlist_item_prepend (Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Genlist_Item *parent, Elm_Genlist_Item_Flags flags, void(*func)(void *data, Evas_Object *obj, void *event_info), const void *func_data)
	Prepend item at start of the genlist.
EAPI Elm_Genlist_Item *	elm_genlist_item_insert_before (Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Genlist_Item *before, Elm_Genlist_Item_Flags flags, void(*func)(void *data, Evas_Object *obj, void *event_info), const void *func_data)
	Insert item before another in the genlist.
EAPI Elm_Genlist_Item *	elm_genlist_item_insert_after (Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Genlist_Item *after, Elm_Genlist_Item_Flags flags, void(*func)(void *data, Evas_Object *obj, void *event_info), const void *func_data)
	Insert and item after another in the genlst.
EAPI void	elm_genlist_clear (Evas_Object *obj)
	Clear the genlist.
EAPI void	elm_genlist_multi_select_set (Evas_Object *obj, Eina_Bool multi)
	Enable or disable multi-select in the genlist.
EAPI Elm_Genlist_Item *	elm_genlist_selected_item_get (const Evas_Object *obj)
	Get the selectd item in the genlist.
EAPI const Eina_List *	elm_genlist_selected_items_get (const Evas_Object *obj)
	Get a list of selected items in the genlist.
EAPI Elm_Genlist_Item *	elm_genlist_first_item_get (const Evas_Object *obj)
	Get the first item in the genlist.
EAPI Elm_Genlist_Item *	elm_genlist_last_item_get (const Evas_Object *obj)
	Get the last item in the genlist.
EAPI Elm_Genlist_Item *	elm_genlist_item_next_get (const Elm_Genlist_Item *item)
	Get the next item in the genlist.
EAPI Elm_Genlist_Item *	elm_genlist_item_prev_get (const Elm_Genlist_Item *item)
	Get the previous item in the genlist.
EAPI Evas_Object *	elm_genlist_item_genlist_get (const Elm_Genlist_Item *item)
	Get the genlist object from an item.
EAPI Elm_Genlist_Item *	elm_genlist_item_parent_get (const Elm_Genlist_Item *it)
	Get the parent item of the given item.
EAPI void	elm_genlist_item_subitems_clear (Elm_Genlist_Item *item)
	Clear all sub-items (children) of the given item.
EAPI void	elm_genlist_item_selected_set (Elm_Genlist_Item *item, Eina_Bool selected)
	Set the selected state of an item.
EAPI Eina_Bool	elm_genlist_item_selected_get (const Elm_Genlist_Item *item)
	Get the selected state of an item.
EAPI void	elm_genlist_item_expanded_set (Elm_Genlist_Item *item, Eina_Bool expanded)
	Sets the expanded state of an item (if it's a parent).
EAPI Eina_Bool	elm_genlist_item_expanded_get (const Elm_Genlist_Item *item)
	Get the expanded state of an item.
EAPI void	elm_genlist_item_disabled_set (Elm_Genlist_Item *item, Eina_Bool disabled)
	Sets the disabled state of an item.
EAPI Eina_Bool	elm_genlist_item_disabled_get (const Elm_Genlist_Item *item)
	Get the disabled state of an item.
EAPI void	elm_genlist_item_show (Elm_Genlist_Item *item)
	Show the given item.
EAPI void	elm_genlist_item_del (Elm_Genlist_Item *item)
	XXX.
EAPI void *	elm_genlist_item_data_get (const Elm_Genlist_Item *item)
	Get the data item from the genlist item.
EAPI void	elm_genlist_item_data_set (Elm_Genlist_Item *it, void *data)
	Set the data item from the genlist item.
EAPI void	elm_genlist_item_update (Elm_Genlist_Item *item)
	Update the contents of an item.
EAPI void	elm_genlist_horizontal_mode_set (Evas_Object *obj, Elm_List_Mode mode)
	This sets the horizontal stretching mode.
EAPI void	elm_genlist_always_select_mode_set (Evas_Object *obj, Eina_Bool always_select)
	Set the always select mode.
EAPI void	elm_genlist_no_select_mode_set (Evas_Object *obj, Eina_Bool no_select)
	Set no select mode.
EAPI Evas_Object *	elm_check_add (Evas_Object *parent)
	Add a new Check object.
EAPI void	elm_check_label_set (Evas_Object *obj, const char *label)
	Set the text label of the check object.
EAPI const char *	elm_check_label_get (Evas_Object *obj)
	Get the text label of the check object.
EAPI void	elm_check_icon_set (Evas_Object *obj, Evas_Object *icon)
	Set the icon object of the check object.
EAPI Evas_Object *	elm_check_icon_get (Evas_Object *obj)
	Get the icon object of the check object.
EAPI void	elm_check_state_set (Evas_Object *obj, Eina_Bool state)
	Set the on/off state of the check object.
EAPI Eina_Bool	elm_check_state_get (const Evas_Object *obj)
	Get the state of the check object.
EAPI void	elm_check_state_pointer_set (Evas_Object *obj, Eina_Bool *statep)
	Set a convenience pointer to a boolean to change.
EAPI Evas_Object *	elm_radio_add (Evas_Object *parent)
	Add a new radio to the parent.
EAPI void	elm_radio_label_set (Evas_Object *obj, const char *label)
	Set the text label of the radio object.
EAPI const char *	elm_radio_label_get (Evas_Object *obj)
	Get the text label of the radio object.
EAPI void	elm_radio_icon_set (Evas_Object *obj, Evas_Object *icon)
	Set the icon object of the radio object.
EAPI Evas_Object *	elm_radio_icon_get (Evas_Object *obj)
	Get the icon object of the radio object.
EAPI void	elm_radio_group_add (Evas_Object *obj, Evas_Object *group)
	Add this radio to a group of other radio objects.
EAPI void	elm_radio_state_value_set (Evas_Object *obj, int value)
	Set the integer value that this radio object represents.
EAPI void	elm_radio_value_set (Evas_Object *obj, int value)
	Set the value the radio.
EAPI int	elm_radio_value_get (const Evas_Object *obj)
	Get the state of the radio object.
EAPI void	elm_radio_value_pointer_set (Evas_Object *obj, int *valuep)
	Set a convenience pointer to a integer to change.
EAPI Evas_Object *	elm_pager_add (Evas_Object *parent)
	Add a new pager to the parent.
EAPI void	elm_pager_content_push (Evas_Object *obj, Evas_Object *content)
	Push an object to the top of the pager stack (and show it).
EAPI void	elm_pager_content_pop (Evas_Object *obj)
	Pop the object that is on top of the stack.
EAPI void	elm_pager_content_promote (Evas_Object *obj, Evas_Object *content)
	Promote an object already in the pager stack to the top of the stack.
EAPI Evas_Object *	elm_pager_content_bottom_get (Evas_Object *obj)
	Return the object at the bottom of the pager stack.
EAPI Evas_Object *	elm_pager_content_top_get (Evas_Object *obj)
	Return the object at the top of the pager stack.
EAPI Evas_Object *	elm_progressbar_add (Evas_Object *parent)
	Add a new progressbar to the parent.
EAPI void	elm_progressbar_label_set (Evas_Object *obj, const char *label)
	Set the label of the progressbar.
EAPI void	elm_progressbar_icon_set (Evas_Object *obj, Evas_Object *icon)
	Set the icon object of the progressbar object.
EAPI void	elm_progressbar_span_size_set (Evas_Object *obj, Evas_Coord size)
	Set the length of the progression region of the progressbar.
EAPI void	elm_progressbar_horizontal_set (Evas_Object *obj, Eina_Bool horizontal)
	Set orientation of the progressbar.
EAPI void	elm_progressbar_inverted_set (Evas_Object *obj, Eina_Bool inverted)
	Invert the progressbar display.
EAPI void	elm_progressbar_pulse_set (Evas_Object *obj, Eina_Bool pulse)
	Normally the progressbar will display and interpret values from low to high.
EAPI void	elm_progressbar_pulse (Evas_Object *obj, Eina_Bool state)
	Normally the progressbar will display and interpret values from low to high.
EAPI void	elm_progressbar_unit_format_set (Evas_Object *obj, const char *format)
	Set the format string of the unit area.
EAPI void	elm_progressbar_value_set (Evas_Object *obj, double val)
	Set the value the progressbar indicates.
EAPI double	elm_progressbar_value_get (const Evas_Object *obj)
	Get the value the progressbar has.

---

Detailed Description

Elementary's API.

Elementary API.