1 /** Lookup order used by elm_icon_standard_set(). Should look for icons in the 2 * theme, FDO paths, or both? 3 * 4 * @ingroup Elm_Icon 5 * 6 * @deprecated Prefer using elm_config "icon_theme" instead. 7 */ 8 typedef enum 9 { 10 ELM_ICON_LOOKUP_FDO_THEME = 0, /** Icon look up order: freedesktop, theme. */ 11 ELM_ICON_LOOKUP_THEME_FDO, /** Icon look up order: theme, freedesktop. */ 12 ELM_ICON_LOOKUP_FDO, /** Icon look up order: freedesktop. */ 13 ELM_ICON_LOOKUP_THEME /** Icon look up order: theme. */ 14 } Elm_Icon_Lookup_Order; 15 16 /** 17 * Add a new icon object to the parent. 18 * 19 * @param parent The parent object 20 * @return The new object or NULL if it cannot be created 21 * 22 * @see elm_image_file_set() 23 * 24 * @ingroup Elm_Icon 25 */ 26 EAPI Evas_Object *elm_icon_add(Evas_Object *parent); 27 28 /** 29 * @brief Set the file that will be used, but use a generated thumbnail. 30 * 31 * This functions like elm_image_file_set() but requires the Ethumb library 32 * support to be enabled successfully with @c elm_need_ethumb. When set the 33 * file indicated has a thumbnail generated and cached on disk for future use 34 * or will directly use an existing cached thumbnail if it is valid. 35 * 36 * @param[in] file The path to file that will be used as icon image 37 * @param[in] group The group that the icon belongs to an edje file 38 * 39 * @ingroup Elm_Icon 40 */ 41 EAPI void elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group); 42 /** 43 * @brief Sets the icon lookup order used by elm_icon_standard_set(). 44 * 45 * See also @ref elm_icon_order_lookup_get, @ref Elm_Icon_Lookup_Order. 46 * 47 * @param[in] order The icon lookup order (can be one of 48 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO or 49 * ELM_ICON_LOOKUP_THEME) 50 * 51 * @ingroup Elm_Icon 52 */ 53 54 EAPI void elm_icon_order_lookup_set(Evas_Object *obj EINA_UNUSED, Elm_Icon_Lookup_Order order EINA_UNUSED) EINA_DEPRECATED; 55 56 /** 57 * @brief Get the icon lookup order. 58 * 59 * See also @ref elm_icon_order_lookup_set, @ref Elm_Icon_Lookup_Order. 60 * 61 * @return The icon lookup order (can be one of ELM_ICON_LOOKUP_FDO_THEME, 62 * ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO or ELM_ICON_LOOKUP_THEME) 63 * 64 * @ingroup Elm_Icon 65 */ 66 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj EINA_UNUSED) EINA_DEPRECATED; 67 68 /** 69 * @brief Set the icon by icon standards names. 70 * 71 * For example, freedesktop.org defines standard icon names such as "go-home", 72 * "network-wired", etc. There can be different icon sets to match those icon keys. 73 * The "name" given as parameter is one of these "keys", and will be used to 74 * look in the freedesktop.org paths and elementary theme. 75 * 76 * If name is not found in any of the expected locations and it is the absolute 77 * path of an image file, this image will be used. 78 * 79 * @note The icon image set by this function can be changed by 80 * @ref Efl.File.file.set. 81 * 82 * @note This function does not accept relative icon path. 83 * 84 * See also @ref elm_icon_standard_get. 85 * 86 * @param[in] name The icon name 87 * 88 * @return true on success, false on error 89 * 90 * @ingroup Elm_Icon 91 */ 92 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name); 93 94 /** 95 * @brief Get the icon name set by icon standard names. 96 * 97 * If the icon image was set using elm_image_file_set() instead of 98 * @ref elm_icon_standard_set, then this function will return null. 99 * 100 * @return The icon name 101 * 102 * @ingroup Elm_Icon 103 */ 104 EAPI const char *elm_icon_standard_get(const Evas_Object *obj); 105 106 #include "elm_icon_eo.legacy.h" 107