src/lib/elm_tooltip.h

   1    /**
   2     * @defgroup Tooltips Tooltips
   3     *
   4     * The Tooltip is an (internal, for now) smart object used to show a
   5     * content in a frame on mouse hover of objects(or widgets), with
   6     * tips/information about them.
   7     *
   8     * @{
   9     */
  10
  11    /**
  12     * Called back when a widget's tooltip is activated and needs content.
  13     * @param data user-data given to elm_object_tooltip_content_cb_set()
  14     * @param obj owner widget.
  15     * @param tooltip The tooltip object (affix content to this!)
  16     */
  17    typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
  18
  19    /**
  20     * Called back when a widget's item tooltip is activated and needs content.
  21     * @param data user-data given to elm_object_tooltip_content_cb_set()
  22     * @param obj owner widget.
  23     * @param tooltip The tooltip object (affix content to this!)
  24     * @param item context dependent item. As an example, if tooltip was
  25     *        set on Elm_List_Item, then it is of this type.
  26     */
  27    typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
  28
  29    EAPI double       elm_tooltip_delay_get(void);
  30    EAPI Eina_Bool    elm_tooltip_delay_set(double delay);
  31    EAPI void         elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
  32    EAPI void         elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
  33    EAPI void         elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
  34    EAPI void         elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
  35 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
  36    EAPI void         elm_object_tooltip_content_cb_set(Evas_Object *obj, Elm_Tooltip_Content_Cb func, const void *data, Evas_Smart_Cb del_cb) EINA_ARG_NONNULL(1);
  37    EAPI void         elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
  38    EAPI void         elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
  39    EAPI const char  *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
  40    EAPI Eina_Bool    elm_object_tooltip_window_mode_set(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
  41    EAPI Eina_Bool    elm_object_tooltip_window_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
  42
  43    /**
  44     * @}
  45     */
  46