1 /** 2 * @defgroup Elm_Icon Icon 3 * @ingroup Elementary 4 * 5 * @image html icon_inheritance_tree.png 6 * @image latex icon_inheritance_tree.eps 7 * 8 * An icon object is used to display standard icon images ("delete", 9 * "edit", "arrows", etc.) or images coming from a custom file (PNG, 10 * JPG, EDJE, etc.), on icon contexts. 11 * 12 * The icon image requested can be in the Elementary theme in use, or 13 * in the @c freedesktop.org theme paths. It's possible to set the 14 * order of preference from where an image will be fetched. 15 * 16 * This widget inherits from the @ref Image one, so that all the 17 * functions acting on it also work for icon objects. 18 * 19 * You should be using an icon, instead of an image, whenever one of 20 * the following apply: 21 * - you need a @b thumbnail version of an original image 22 * - you need freedesktop.org provided icon images 23 * - you need theme provided icon images (Edje groups) 24 * 25 * Various calls on the icon's API are marked as @b deprecated, as 26 * they just wrap the image counterpart functions. Use the ones we 27 * point you to, for each case of deprecation here, instead -- 28 * eventually the deprecated ones will be discarded (next major 29 * release). 30 * 31 * Default images provided by Elementary's default theme are described 32 * below. 33 * 34 * These are names that follow (more or less) the @b Freedesktop icon naming 35 * specification. Use of these names are @b preferred, at least if you want to 36 * give your user the ability to use other themes. All these icons can be 37 * seen in the elementary_test application, the test is called "Icon Standard". 38 * 39 * @li @c "folder" (since 1.13) 40 * @li @c "user-home" (since 1.13) 41 * @li @c "user-trash" (since 1.13) 42 * 43 * @li @c "view-close" (since 1.13) 44 * @li @c "view-refresh" (since 1.13) 45 * 46 * @li @c "window-close" (since 1.13) 47 * 48 * @li @c "document-close" (since 1.13) 49 * @li @c "document-edit" (since 1.13) 50 * 51 * @li @c "dialog-info" (since 1.13) 52 * @li @c "dialog-close" (since 1.13) 53 * 54 * @li @c "go-home" (sine 1.18) 55 * @li @c "go-up" (since 1.18) 56 * @li @c "go-down" (since 1.18) 57 * @li @c "go-previous" (since 1.18) 58 * @li @c "go-next" (since 1.18) 59 * 60 * @li @c "edit-delete" (since 1.13) 61 * @li @c "edit-find" (since 1.13) 62 * 63 * @li @c "application-chat" (since 1.13) 64 * @li @c "application-clock" (since 1.13) 65 * 66 * @li @c "media-seek-forward" (since 1.13) 67 * @li @c "media-seek-backward" (since 1.13) 68 * @li @c "media-skip-forward" (since 1.13) 69 * @li @c "media-skip-backward" (since 1.13) 70 * @li @c "media-playback-pause" (since 1.13) 71 * @li @c "media-playback-start" (since 1.13) 72 * @li @c "media-playback-stop" (since 1.13) 73 * @li @c "media-eject" (since 1.13) 74 * 75 * @li @c "audio-volume" (since 1.13) 76 * @li @c "audio-volume-muted" (since 1.13) 77 * 78 * There is also a selection of old names that were used before standard names 79 * were being encouraged. These should be considered deprecated and one of the 80 * names above used instead. 81 * 82 * @li @c "arrow_up" (since 1.13) 83 * @li @c "arrow_down" (since 1.13) 84 * @li @c "arrow_left" (since 1.13) 85 * @li @c "arrow_right" (since 1.13) 86 * @li @c "search" (since 1.13) 87 * 88 * These are names for icons that were first intended to be used in 89 * toolbars, but can be used in many other places too: 90 * @li @c "home" 91 * @li @c "close" 92 * @li @c "apps" 93 * @li @c "arrow_up" 94 * @li @c "arrow_down" 95 * @li @c "arrow_left" 96 * @li @c "arrow_right" 97 * @li @c "chat" 98 * @li @c "clock" 99 * @li @c "delete" 100 * @li @c "edit" 101 * @li @c "refresh" 102 * @li @c "folder" 103 * @li @c "file" 104 * 105 * These are names for icons that were designed to be used in menus 106 * (but again, you can use them anywhere else): 107 * @li @c "menu/home" 108 * @li @c "menu/close" 109 * @li @c "menu/apps" 110 * @li @c "menu/arrow_up" 111 * @li @c "menu/arrow_down" 112 * @li @c "menu/arrow_left" 113 * @li @c "menu/arrow_right" 114 * @li @c "menu/chat" 115 * @li @c "menu/clock" 116 * @li @c "menu/delete" 117 * @li @c "menu/edit" 118 * @li @c "menu/refresh" 119 * @li @c "menu/folder" 120 * @li @c "menu/file" 121 * 122 * And these are names for some media player specific icons: 123 * @li @c "media_player/forward" 124 * @li @c "media_player/info" 125 * @li @c "media_player/next" 126 * @li @c "media_player/pause" 127 * @li @c "media_player/play" 128 * @li @c "media_player/prev" 129 * @li @c "media_player/rewind" 130 * @li @c "media_player/stop" 131 * 132 * This widget emits the following signals, besides the ones sent from 133 * @ref Image: 134 * - @c "thumb,done" - elm_icon_thumb_set() has completed with success 135 * (since 1.7) 136 * - @c "thumb,error" - elm_icon_thumb_set() has failed (since 1.7) 137 * 138 * Elementary icon objects support the following API calls: 139 * @li elm_object_signal_emit() 140 * @li elm_object_signal_callback_add() 141 * @li elm_object_signal_callback_del() 142 * for emitting and listening to signals on the object, when the 143 * internal image comes from an Edje object. This behavior was added 144 * unintentionally, though, and is @b deprecated. Expect it to be 145 * dropped on future releases. 146 * 147 * An example of usage for this API follows: 148 * @li @ref tutorial_icon 149 */ 150 151 #ifndef EFL_NOLEGACY_API_SUPPORT 152 #include "elm_icon_legacy.h" 153 #endif 154 /** 155 * @} 156 */ 157