This is a push-button. Press it and run some function. It can contain a simple label and icon object and it also has an autorepeat feature.

This widget inherits from the Layout one, so that all the functions acting on it also work for button objects.

This widget emits the following signals, besides the ones sent from Layout :

"clicked": the user clicked the button (press/release).
"repeated": the user pressed the button without releasing it.
"pressed": button was pressed.
"unpressed": button was released after being pressed.
"focused" : When the button has received focus. (since 1.8)
"unfocused" : When the button has lost focus. (since 1.8) In all cases, the event parameter of the callback will be NULL.

Also, defined in the default theme, the button has the following styles available:

default: a normal button.
anchor: Like default, but the button fades away when the mouse is not over it, leaving only the text or icon.
hoversel_vertical: Internally used by Hoversel to give a continuous look across its options.
hoversel_vertical_entry: Another internal for Hoversel.
naviframe: Internally used by Elm_Naviframe for its back button.
colorselector: Internally used by Colorselector for its left and right buttons.

Default content parts of the button widget that you can use for are:

"icon" - An icon of the button

Default text parts of the button widget that you can use for are:

"default" - A label of the button

Supported elm_object common APIs.

Here is some sample code using it:

Functions
Evas_Object *	elm_button_add (Evas_Object *parent)
void	elm_button_autorepeat_initial_timeout_set (Evas_Object *obj, double t)
	The initial timeout before the autorepeat event is generated.
double	elm_button_autorepeat_initial_timeout_get (const Evas_Object *obj)
	The initial timeout before the autorepeat event is generated.
void	elm_button_autorepeat_gap_timeout_set (Evas_Object *obj, double t)
	The interval between each generated autorepeat event.
double	elm_button_autorepeat_gap_timeout_get (const Evas_Object *obj)
	The interval between each generated autorepeat event.
void	elm_button_autorepeat_set (Evas_Object *obj, Eina_Bool on)
	Turn on/off the autorepeat event generated when the button is kept pressed.
Eina_Bool	elm_button_autorepeat_get (const Evas_Object *obj)
	Turn on/off the autorepeat event generated when the button is kept pressed.

Function Documentation

Evas_Object* elm_button_add ( Evas_Object * parent )

Add a new button to the parent's canvas

Parameters:

parent The parent object

Returns:: The new object or NULL if it cannot be created

Since :: 2.3

Examples:: box_example_02.c, button_example_00.c, button_example_01.c, calendar_example_06.c, codegen_example.c, conformant_example_01.c, conformant_example_02.c, diskselector_example_02.c, entry_example.c, fileselector_example.c, flipselector_example.c, general_funcs_example.c, gengrid_example.c, genlist_example_02.c, genlist_example_04.c, genlist_example_05.c, glview_example_01.c, hover_example_01.c, hoversel_example_01.c, index_example_01.c, inwin_example.c, layout_example_01.c, layout_example_03.c, list_example_03.c, map_example_01.c, map_example_02.c, map_example_03.c, menu_example_01.c, naviframe_example.c, panes_example.c, photocam_example_01.c, popup_example_02.c, popup_example_03.c, progressbar_example.c, relative_container_example_01.c, relative_container_example_02.c, slideshow_example.c, theme_example_01.c, theme_example_02.c, toolbar_example_01.c, toolbar_example_02.c, toolbar_example_03.c, transit_example_01.c, transit_example_02.c, transit_example_03.c, transit_example_04.c, web_example_02.c, and win_example.c.

double elm_button_autorepeat_gap_timeout_get ( const Evas_Object * obj )

The interval between each generated autorepeat event.

After the first repeated event is fired, all subsequent ones will follow after a delay of t seconds for each.

Returns:: Interval in seconds

Since :: 2.3

void elm_button_autorepeat_gap_timeout_set	(	Evas_Object *	obj,
		double	t
	)

The interval between each generated autorepeat event.

After the first repeated event is fired, all subsequent ones will follow after a delay of t seconds for each.

Parameters:

[in] t Interval in seconds

Since :: 2.3

Examples:: button_example_01.c.

Eina_Bool elm_button_autorepeat_get ( const Evas_Object * obj )

Turn on/off the autorepeat event generated when the button is kept pressed.

When off, no autorepeat is performed and buttons emit a normal clicked signal when they are clicked.

When on, keeping a button pressed will continuously emit a repeated signal until the button is released. The time it takes until it starts emitting the signal is given by elm_button_autorepeat_initial_timeout_set, and the time between each new emission by elm_button_autorepeat_gap_timeout_set.

Returns:: A bool to turn on/off the event

Since :: 2.3

double elm_button_autorepeat_initial_timeout_get ( const Evas_Object * obj )

The initial timeout before the autorepeat event is generated.

Sets the timeout, in seconds, since the button is pressed until the first repeated signal is emitted. If t is 0.0 or less, there won't be any delay and the event will be fired the moment the button is pressed.

Returns:: Timeout in seconds

Since :: 2.3

void elm_button_autorepeat_initial_timeout_set	(	Evas_Object *	obj,
		double	t
	)

The initial timeout before the autorepeat event is generated.

Sets the timeout, in seconds, since the button is pressed until the first repeated signal is emitted. If t is 0.0 or less, there won't be any delay and the event will be fired the moment the button is pressed.

Parameters:

[in] t Timeout in seconds

Since :: 2.3

Examples:: button_example_01.c.

void elm_button_autorepeat_set	(	Evas_Object *	obj,
		Eina_Bool	on
	)

Turn on/off the autorepeat event generated when the button is kept pressed.

When off, no autorepeat is performed and buttons emit a normal clicked signal when they are clicked.

When on, keeping a button pressed will continuously emit a repeated signal until the button is released. The time it takes until it starts emitting the signal is given by elm_button_autorepeat_initial_timeout_set, and the time between each new emission by elm_button_autorepeat_gap_timeout_set.

Parameters:

[in] on A bool to turn on/off the event

Since :: 2.3

Examples:: button_example_01.c.

Functions

Function Documentation