efl/src/lib/elementary/elm_button_legacy.h

114 lines
3.6 KiB
C

typedef Eo Elm_Button;
/**
* Add a new button to the parent's canvas
*
* @param parent The parent object
* @return The new object or NULL if it cannot be created
*
* @ingroup Elm_Button
*/
EAPI Evas_Object *elm_button_add(Evas_Object *parent);
/**
* @brief The initial timeout before the autorepeat event is generated
*
* Sets the timeout, in seconds, since the button is pressed until the first
* @c repeated signal is emitted. If @c t is 0.0 or less, there won't be any
* delay and the event will be fired the moment the button is pressed.
*
* See also @ref elm_button_autorepeat_set,
* @ref elm_button_autorepeat_gap_timeout_set.
*
* @param[in] t Timeout in seconds
*
* @ingroup Elm_Button
*/
EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t);
/**
* @brief The initial timeout before the autorepeat event is generated
*
* Sets the timeout, in seconds, since the button is pressed until the first
* @c repeated signal is emitted. If @c t is 0.0 or less, there won't be any
* delay and the event will be fired the moment the button is pressed.
*
* See also @ref elm_button_autorepeat_set,
* @ref elm_button_autorepeat_gap_timeout_set.
*
* @return Timeout in seconds
*
* @ingroup Elm_Button
*/
EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj);
/**
* @brief The interval between each generated autorepeat event
*
* After the first @c repeated event is fired, all subsequent ones will follow
* after a delay of @c t seconds for each.
*
* See also @ref elm_button_autorepeat_initial_timeout_set.
*
* @param[in] t Interval in seconds
*
* @ingroup Elm_Button
*/
EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t);
/**
* @brief The interval between each generated autorepeat event
*
* After the first @c repeated event is fired, all subsequent ones will follow
* after a delay of @c t seconds for each.
*
* See also @ref elm_button_autorepeat_initial_timeout_set.
*
* @return Interval in seconds
*
* @ingroup Elm_Button
*/
EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj);
/**
* @brief Turn on/off the autorepeat event generated when the button is kept
* pressed
*
* When off, no autorepeat is performed and buttons emit a normal @c clicked
* signal when they are clicked.
*
* When on, keeping a button pressed will continuously emit a @c repeated
* signal until the button is released. The time it takes until it starts
* emitting the signal is given by @ref elm_button_autorepeat_initial_timeout_set,
* and the time between each new emission by
* @ref elm_button_autorepeat_gap_timeout_set.
*
* @param[in] on A bool to turn on/off the event
*
* @ingroup Elm_Button
*/
EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on);
/**
* @brief Turn on/off the autorepeat event generated when the button is kept
* pressed
*
* When off, no autorepeat is performed and buttons emit a normal @c clicked
* signal when they are clicked.
*
* When on, keeping a button pressed will continuously emit a @c repeated
* signal until the button is released. The time it takes until it starts
* emitting the signal is given by @ref elm_button_autorepeat_initial_timeout_set,
* and the time between each new emission by
* @ref elm_button_autorepeat_gap_timeout_set.
*
* @return A bool to turn on/off the event
*
* @ingroup Elm_Button
*/
EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj);
#include "efl_ui_button_eo.legacy.h"