\section{Icon}
\label{group__Icon}\index{Icon@{Icon}}
\subsection*{Functions}
\begin{DoxyCompactItemize}
\item 
E\+I\+N\+A\+\_\+\+D\+E\+P\+R\+E\+C\+A\+T\+E\+D Eina\+\_\+\+Bool \hyperlink{group__Icon_ga8f63b279b1cc73699d33f5a0d6ba6b6d}{elm\+\_\+icon\+\_\+file\+\_\+set} (Evas\+\_\+\+Object $\ast$obj, const char $\ast$file, const char $\ast$group)
\begin{DoxyCompactList}\small\item\em Set the file that will be used as icon. \end{DoxyCompactList}\item 
E\+I\+N\+A\+\_\+\+D\+E\+P\+R\+E\+C\+A\+T\+E\+D Eina\+\_\+\+Bool \hyperlink{group__Icon_ga9ab6137d507b6b26e3509a8e4d4702b1}{elm\+\_\+icon\+\_\+memfile\+\_\+set} (Evas\+\_\+\+Object $\ast$obj, const void $\ast$img, size\+\_\+t size, const char $\ast$format, const char $\ast$key)
\begin{DoxyCompactList}\small\item\em Set a location in memory to be used as an icon. \end{DoxyCompactList}\item 
E\+I\+N\+A\+\_\+\+D\+E\+P\+R\+E\+C\+A\+T\+E\+D void \hyperlink{group__Icon_gaea8ca3a125bf863ff5c1750a754fe4f4}{elm\+\_\+icon\+\_\+file\+\_\+get} (const Evas\+\_\+\+Object $\ast$obj, const char $\ast$$\ast$file, const char $\ast$$\ast$group)
\begin{DoxyCompactList}\small\item\em Get the file that will be used as icon. \end{DoxyCompactList}\item 
E\+I\+N\+A\+\_\+\+D\+E\+P\+R\+E\+C\+A\+T\+E\+D void \hyperlink{group__Icon_gada290e2867b9c2548306f7b875dae22d}{elm\+\_\+icon\+\_\+smooth\+\_\+set} (Evas\+\_\+\+Object $\ast$obj, Eina\+\_\+\+Bool smooth)
\begin{DoxyCompactList}\small\item\em Set the smooth scaling for an icon object. \end{DoxyCompactList}\item 
E\+I\+N\+A\+\_\+\+D\+E\+P\+R\+E\+C\+A\+T\+E\+D Eina\+\_\+\+Bool \hyperlink{group__Icon_ga55dcaa0812cd19c48c426338a058bf33}{elm\+\_\+icon\+\_\+smooth\+\_\+get} (const Evas\+\_\+\+Object $\ast$obj)
\begin{DoxyCompactList}\small\item\em Get whether smooth scaling is enabled for an icon object. \end{DoxyCompactList}\item 
E\+I\+N\+A\+\_\+\+D\+E\+P\+R\+E\+C\+A\+T\+E\+D void \hyperlink{group__Icon_ga20a619a001f0f67a4fd71cf3bd3ed335}{elm\+\_\+icon\+\_\+no\+\_\+scale\+\_\+set} (Evas\+\_\+\+Object $\ast$obj, Eina\+\_\+\+Bool no\+\_\+scale)
\begin{DoxyCompactList}\small\item\em Disable scaling of this object. \end{DoxyCompactList}\item 
E\+I\+N\+A\+\_\+\+D\+E\+P\+R\+E\+C\+A\+T\+E\+D Eina\+\_\+\+Bool \hyperlink{group__Icon_ga7bafdcd87e80ad6c451e788bdba59bfe}{elm\+\_\+icon\+\_\+no\+\_\+scale\+\_\+get} (const Evas\+\_\+\+Object $\ast$obj)
\begin{DoxyCompactList}\small\item\em Get whether scaling is disabled on the object. \end{DoxyCompactList}\item 
E\+I\+N\+A\+\_\+\+D\+E\+P\+R\+E\+C\+A\+T\+E\+D void \hyperlink{group__Icon_gab4e9af0524f8100ac1f74f0af2631f1e}{elm\+\_\+icon\+\_\+resizable\+\_\+set} (Evas\+\_\+\+Object $\ast$obj, Eina\+\_\+\+Bool size\+\_\+up, Eina\+\_\+\+Bool size\+\_\+down)
\begin{DoxyCompactList}\small\item\em Set if the object is (up/down) resizable. \end{DoxyCompactList}\item 
E\+I\+N\+A\+\_\+\+D\+E\+P\+R\+E\+C\+A\+T\+E\+D void \hyperlink{group__Icon_ga9e49b6205b865de4ea171ae8a6afab95}{elm\+\_\+icon\+\_\+resizable\+\_\+get} (const Evas\+\_\+\+Object $\ast$obj, Eina\+\_\+\+Bool $\ast$size\+\_\+up, Eina\+\_\+\+Bool $\ast$size\+\_\+down)
\begin{DoxyCompactList}\small\item\em Get if the object is (up/down) resizable. \end{DoxyCompactList}\item 
E\+I\+N\+A\+\_\+\+D\+E\+P\+R\+E\+C\+A\+T\+E\+D void \hyperlink{group__Icon_ga3246f21dd7f76fe396aec2e642de77bf}{elm\+\_\+icon\+\_\+size\+\_\+get} (const Evas\+\_\+\+Object $\ast$obj, int $\ast$w, int $\ast$h)
\begin{DoxyCompactList}\small\item\em Get the object\textquotesingle{}s image size. \end{DoxyCompactList}\item 
E\+I\+N\+A\+\_\+\+D\+E\+P\+R\+E\+C\+A\+T\+E\+D void \hyperlink{group__Icon_ga947a7ce58a9951e6544f462474bc555c}{elm\+\_\+icon\+\_\+fill\+\_\+outside\+\_\+set} (Evas\+\_\+\+Object $\ast$obj, Eina\+\_\+\+Bool fill\+\_\+outside)
\begin{DoxyCompactList}\small\item\em Set if the icon fill the entire object area. \end{DoxyCompactList}\item 
E\+I\+N\+A\+\_\+\+D\+E\+P\+R\+E\+C\+A\+T\+E\+D Eina\+\_\+\+Bool \hyperlink{group__Icon_gacf20468921f4aa7e2d99b89a64de0166}{elm\+\_\+icon\+\_\+fill\+\_\+outside\+\_\+get} (const Evas\+\_\+\+Object $\ast$obj)
\begin{DoxyCompactList}\small\item\em Get if the object is filled outside. \end{DoxyCompactList}\item 
E\+I\+N\+A\+\_\+\+D\+E\+P\+R\+E\+C\+A\+T\+E\+D void \hyperlink{group__Icon_ga31463d82332ee32c010e171aea370b8d}{elm\+\_\+icon\+\_\+prescale\+\_\+set} (Evas\+\_\+\+Object $\ast$obj, int size)
\begin{DoxyCompactList}\small\item\em Set the prescale size for the icon. \end{DoxyCompactList}\item 
E\+I\+N\+A\+\_\+\+D\+E\+P\+R\+E\+C\+A\+T\+E\+D int \hyperlink{group__Icon_ga3ee7dd4f5d9c57b129fa76a29e0629cc}{elm\+\_\+icon\+\_\+prescale\+\_\+get} (const Evas\+\_\+\+Object $\ast$obj)
\begin{DoxyCompactList}\small\item\em Get the prescale size for the icon. \end{DoxyCompactList}\item 
E\+I\+N\+A\+\_\+\+D\+E\+P\+R\+E\+C\+A\+T\+E\+D Evas\+\_\+\+Object $\ast$ \hyperlink{group__Icon_ga6d0566aa2c521c0b3ea1a3d1e3d7ca8f}{elm\+\_\+icon\+\_\+object\+\_\+get} (Evas\+\_\+\+Object $\ast$obj)
\begin{DoxyCompactList}\small\item\em Get the image object of the icon. \end{DoxyCompactList}\item 
E\+I\+N\+A\+\_\+\+D\+E\+P\+R\+E\+C\+A\+T\+E\+D void \hyperlink{group__Icon_ga060c70b2aa9fa4048177536001a44a2c}{elm\+\_\+icon\+\_\+preload\+\_\+disabled\+\_\+set} (Evas\+\_\+\+Object $\ast$obj, Eina\+\_\+\+Bool disabled)
\begin{DoxyCompactList}\small\item\em Enable or disable preloading of the icon. \end{DoxyCompactList}\item 
E\+I\+N\+A\+\_\+\+D\+E\+P\+R\+E\+C\+A\+T\+E\+D Eina\+\_\+\+Bool \hyperlink{group__Icon_ga43df827062efb1a7de5808e755cbd4a9}{elm\+\_\+icon\+\_\+animated\+\_\+available\+\_\+get} (const Evas\+\_\+\+Object $\ast$obj)
\begin{DoxyCompactList}\small\item\em Get if the icon supports animation or not. \end{DoxyCompactList}\item 
E\+I\+N\+A\+\_\+\+D\+E\+P\+R\+E\+C\+A\+T\+E\+D void \hyperlink{group__Icon_ga8a9dcf2fbe799b747260ab2ebc624ec7}{elm\+\_\+icon\+\_\+animated\+\_\+set} (Evas\+\_\+\+Object $\ast$obj, Eina\+\_\+\+Bool animated)
\begin{DoxyCompactList}\small\item\em Set animation mode of the icon. \end{DoxyCompactList}\item 
E\+I\+N\+A\+\_\+\+D\+E\+P\+R\+E\+C\+A\+T\+E\+D Eina\+\_\+\+Bool \hyperlink{group__Icon_ga74ee1112e53d551754b7437d43381102}{elm\+\_\+icon\+\_\+animated\+\_\+get} (const Evas\+\_\+\+Object $\ast$obj)
\begin{DoxyCompactList}\small\item\em Get animation mode of the icon. \end{DoxyCompactList}\item 
E\+I\+N\+A\+\_\+\+D\+E\+P\+R\+E\+C\+A\+T\+E\+D void \hyperlink{group__Icon_ga2706a53b91d2f3c4a4aa5161b119ac4b}{elm\+\_\+icon\+\_\+animated\+\_\+play\+\_\+set} (Evas\+\_\+\+Object $\ast$obj, Eina\+\_\+\+Bool play)
\begin{DoxyCompactList}\small\item\em Set animation play mode of the icon. \end{DoxyCompactList}\item 
E\+I\+N\+A\+\_\+\+D\+E\+P\+R\+E\+C\+A\+T\+E\+D Eina\+\_\+\+Bool \hyperlink{group__Icon_ga7247a037b4b19d01a8a8a4e8302a79ae}{elm\+\_\+icon\+\_\+animated\+\_\+play\+\_\+get} (const Evas\+\_\+\+Object $\ast$obj)
\begin{DoxyCompactList}\small\item\em Get animation play mode of the icon. \end{DoxyCompactList}\item 
E\+I\+N\+A\+\_\+\+D\+E\+P\+R\+E\+C\+A\+T\+E\+D void \hyperlink{group__Icon_gaa347e3a65bf3234789d0ad8eee8cb5ea}{elm\+\_\+icon\+\_\+aspect\+\_\+fixed\+\_\+set} (Evas\+\_\+\+Object $\ast$obj, Eina\+\_\+\+Bool fixed)
\begin{DoxyCompactList}\small\item\em Set whether the original aspect ratio of the icon should be kept on resize. \end{DoxyCompactList}\item 
E\+I\+N\+A\+\_\+\+D\+E\+P\+R\+E\+C\+A\+T\+E\+D Eina\+\_\+\+Bool \hyperlink{group__Icon_ga22d102913423a42675dc7be08418f5b3}{elm\+\_\+icon\+\_\+aspect\+\_\+fixed\+\_\+get} (const Evas\+\_\+\+Object $\ast$obj)
\begin{DoxyCompactList}\small\item\em Get if the object retains the original aspect ratio. \end{DoxyCompactList}\item 
Evas\+\_\+\+Object $\ast$ \hyperlink{group__Icon_ga5739728c1209f90422cf65a778a16502}{elm\+\_\+icon\+\_\+add} (Evas\+\_\+\+Object $\ast$parent)
\begin{DoxyCompactList}\small\item\em Add a new icon object to the parent. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
 
\begin{DoxyImageNoCaption}
  \mbox{\includegraphics[width=\textwidth,height=\textheight/2,keepaspectratio=true]{icon_inheritance_tree}}
\end{DoxyImageNoCaption}


 
\begin{DoxyImageNoCaption}
  \mbox{\includegraphics[width=\textwidth,height=\textheight/2,keepaspectratio=true]{img/widget/icon/preview-00}}
\end{DoxyImageNoCaption}


An icon object is used to display standard icon images (\char`\"{}delete\char`\"{}, \char`\"{}edit\char`\"{}, \char`\"{}arrows\char`\"{}, etc.) or images coming from a custom file (P\+N\+G, J\+P\+G, E\+D\+J\+E, etc.), on icon contexts.

The icon image requested can be in the Elementary theme in use, or in the {\ttfamily freedesktop.\+org} theme paths. It\textquotesingle{}s possible to set the order of preference from where an image will be fetched.

This widget inherits from the \hyperlink{group__Image}{Image} one, so that all the functions acting on it also work for icon objects.

You should be using an icon, instead of an image, whenever one of the following apply\+:
\begin{DoxyItemize}
\item you need a {\bfseries thumbnail} version of an original image
\item you need freedesktop.\+org provided icon images
\item you need theme provided icon images (Edje groups)
\end{DoxyItemize}

Various calls on the icon\textquotesingle{}s A\+P\+I are marked as {\bfseries deprecated}, as they just wrap the image counterpart functions. Use the ones we point you to, for each case of deprecation here, instead -- eventually the deprecated ones will be discarded (next major release).

Default images provided by Elementary\textquotesingle{}s default theme are described below.

These are names that follow (more or less) the {\bfseries Freedesktop} icon naming specification. Use of these names are {\bfseries preferred}, at least if you want to give your user the ability to use other themes. All these icons can be seen in the elementary\+\_\+test application, the test is called \char`\"{}\+Icon Standard\char`\"{}.

\begin{DoxyItemize}
\item {\ttfamily \char`\"{}folder\char`\"{}} (since 1.\+13) \item {\ttfamily \char`\"{}user-\/home\char`\"{}} (since 1.\+13) \item {\ttfamily \char`\"{}user-\/trash\char`\"{}} (since 1.\+13)\end{DoxyItemize}
\begin{DoxyItemize}
\item {\ttfamily \char`\"{}view-\/close\char`\"{}} (since 1.\+13) \item {\ttfamily \char`\"{}view-\/refresh\char`\"{}} (since 1.\+13)\end{DoxyItemize}
\begin{DoxyItemize}
\item {\ttfamily \char`\"{}window-\/close\char`\"{}} (since 1.\+13)\end{DoxyItemize}
\begin{DoxyItemize}
\item {\ttfamily \char`\"{}document-\/close\char`\"{}} (since 1.\+13) \item {\ttfamily \char`\"{}document-\/edit\char`\"{}} (since 1.\+13)\end{DoxyItemize}
\begin{DoxyItemize}
\item {\ttfamily \char`\"{}dialog-\/info\char`\"{}} (since 1.\+13) \item {\ttfamily \char`\"{}dialog-\/close\char`\"{}} (since 1.\+13)\end{DoxyItemize}
\begin{DoxyItemize}
\item {\ttfamily \char`\"{}arrow-\/up\char`\"{}} (since 1.\+13) \item {\ttfamily \char`\"{}arrow-\/down\char`\"{}} (since 1.\+13) \item {\ttfamily \char`\"{}arrow-\/left\char`\"{}} (since 1.\+13) \item {\ttfamily \char`\"{}arrow-\/right\char`\"{}} (since 1.\+13) \item {\ttfamily \char`\"{}arrow-\/up-\/left\char`\"{}} (since 1.\+13) \item {\ttfamily \char`\"{}arrow-\/up-\/right\char`\"{}} (since 1.\+13) \item {\ttfamily \char`\"{}arrow-\/down-\/left\char`\"{}} (since 1.\+13) \item {\ttfamily \char`\"{}arrow-\/down-\/right\char`\"{}} (since 1.\+13)\end{DoxyItemize}
\begin{DoxyItemize}
\item {\ttfamily \char`\"{}edit-\/delete\char`\"{}} (since 1.\+13)\end{DoxyItemize}
\begin{DoxyItemize}
\item {\ttfamily \char`\"{}application-\/chat\char`\"{}} (since 1.\+13) \item {\ttfamily \char`\"{}application-\/clock\char`\"{}} (since 1.\+13)\end{DoxyItemize}
\begin{DoxyItemize}
\item {\ttfamily \char`\"{}media-\/seek-\/forward\char`\"{}} (since 1.\+13) \item {\ttfamily \char`\"{}media-\/seek-\/backward\char`\"{}} (since 1.\+13) \item {\ttfamily \char`\"{}media-\/skip-\/forward\char`\"{}} (since 1.\+13) \item {\ttfamily \char`\"{}media-\/skip-\/backward\char`\"{}} (since 1.\+13) \item {\ttfamily \char`\"{}media-\/playback-\/pause\char`\"{}} (since 1.\+13) \item {\ttfamily \char`\"{}media-\/playback-\/start\char`\"{}} (since 1.\+13) \item {\ttfamily \char`\"{}media-\/playback-\/stop\char`\"{}} (since 1.\+13) \item {\ttfamily \char`\"{}media-\/eject\char`\"{}} (since 1.\+13)\end{DoxyItemize}
\begin{DoxyItemize}
\item {\ttfamily \char`\"{}audio-\/volume\char`\"{}} (since 1.\+13) \item {\ttfamily \char`\"{}audio-\/volume-\/muted\char`\"{}} (since 1.\+13)\end{DoxyItemize}
These are names for icons that were first intended to be used in toolbars, but can be used in many other places too\+: \begin{DoxyItemize}
\item {\ttfamily \char`\"{}home\char`\"{}} \item {\ttfamily \char`\"{}close\char`\"{}} \item {\ttfamily \char`\"{}apps\char`\"{}} \item {\ttfamily \char`\"{}arrow\+\_\+up\char`\"{}} \item {\ttfamily \char`\"{}arrow\+\_\+down\char`\"{}} \item {\ttfamily \char`\"{}arrow\+\_\+left\char`\"{}} \item {\ttfamily \char`\"{}arrow\+\_\+right\char`\"{}} \item {\ttfamily \char`\"{}chat\char`\"{}} \item {\ttfamily \char`\"{}clock\char`\"{}} \item {\ttfamily \char`\"{}delete\char`\"{}} \item {\ttfamily \char`\"{}edit\char`\"{}} \item {\ttfamily \char`\"{}refresh\char`\"{}} \item {\ttfamily \char`\"{}folder\char`\"{}} \item {\ttfamily \char`\"{}file\char`\"{}} \end{DoxyItemize}
These are names for icons that were designed to be used in menus (but again, you can use them anywhere else)\+: \begin{DoxyItemize}
\item {\ttfamily \char`\"{}menu/home\char`\"{}} \item {\ttfamily \char`\"{}menu/close\char`\"{}} \item {\ttfamily \char`\"{}menu/apps\char`\"{}} \item {\ttfamily \char`\"{}menu/arrow\+\_\+up\char`\"{}} \item {\ttfamily \char`\"{}menu/arrow\+\_\+down\char`\"{}} \item {\ttfamily \char`\"{}menu/arrow\+\_\+left\char`\"{}} \item {\ttfamily \char`\"{}menu/arrow\+\_\+right\char`\"{}} \item {\ttfamily \char`\"{}menu/chat\char`\"{}} \item {\ttfamily \char`\"{}menu/clock\char`\"{}} \item {\ttfamily \char`\"{}menu/delete\char`\"{}} \item {\ttfamily \char`\"{}menu/edit\char`\"{}} \item {\ttfamily \char`\"{}menu/refresh\char`\"{}} \item {\ttfamily \char`\"{}menu/folder\char`\"{}} \item {\ttfamily \char`\"{}menu/file\char`\"{}} \end{DoxyItemize}
And these are names for some media player specific icons\+: \begin{DoxyItemize}
\item {\ttfamily \char`\"{}media\+\_\+player/forward\char`\"{}} \item {\ttfamily \char`\"{}media\+\_\+player/info\char`\"{}} \item {\ttfamily \char`\"{}media\+\_\+player/next\char`\"{}} \item {\ttfamily \char`\"{}media\+\_\+player/pause\char`\"{}} \item {\ttfamily \char`\"{}media\+\_\+player/play\char`\"{}} \item {\ttfamily \char`\"{}media\+\_\+player/prev\char`\"{}} \item {\ttfamily \char`\"{}media\+\_\+player/rewind\char`\"{}} \item {\ttfamily \char`\"{}media\+\_\+player/stop\char`\"{}} \end{DoxyItemize}
This widget emits the following signals, besides the ones sent from Image\+:
\begin{DoxyItemize}
\item {\ttfamily \char`\"{}thumb,done\char`\"{}} -\/ elm\+\_\+icon\+\_\+thumb\+\_\+set() has completed with success (since 1.\+7)
\item {\ttfamily \char`\"{}thumb,error\char`\"{}} -\/ elm\+\_\+icon\+\_\+thumb\+\_\+set() has failed (since 1.\+7)
\end{DoxyItemize}

Elementary icon objects support the following A\+P\+I calls\+: \begin{DoxyItemize}
\item \hyperlink{group__General_ga1beada7edf5d714c0dba5459bcc993fc}{elm\+\_\+object\+\_\+signal\+\_\+emit()} \item \hyperlink{group__General_ga6f9574b798efcd454afdac6f2904f633}{elm\+\_\+object\+\_\+signal\+\_\+callback\+\_\+add()} \item \hyperlink{group__General_ga3c76b5447be522d647e352cb7ff7c9e6}{elm\+\_\+object\+\_\+signal\+\_\+callback\+\_\+del()} for emitting and listening to signals on the object, when the internal image comes from an Edje object. This behavior was added unintentionally, though, and is {\bfseries deprecated}. Expect it to be dropped on future releases.\end{DoxyItemize}
An example of usage for this A\+P\+I follows\+: \begin{DoxyItemize}
\item \hyperlink{tutorial_icon}{Icon example} \end{DoxyItemize}


\subsection{Function Documentation}
\index{Icon@{Icon}!elm\+\_\+icon\+\_\+add@{elm\+\_\+icon\+\_\+add}}
\index{elm\+\_\+icon\+\_\+add@{elm\+\_\+icon\+\_\+add}!Icon@{Icon}}
\subsubsection[{elm\+\_\+icon\+\_\+add(\+Evas\+\_\+\+Object $\ast$parent)}]{\setlength{\rightskip}{0pt plus 5cm}Evas\+\_\+\+Object$\ast$ elm\+\_\+icon\+\_\+add (
\begin{DoxyParamCaption}
\item[{Evas\+\_\+\+Object $\ast$}]{parent}
\end{DoxyParamCaption}
)}\label{group__Icon_ga5739728c1209f90422cf65a778a16502}


Add a new icon object to the parent. 


\begin{DoxyParams}{Parameters}
{\em parent} & The parent object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
The new object or N\+U\+L\+L if it cannot be created
\end{DoxyReturn}
\begin{DoxySeeAlso}{See also}
\hyperlink{group__Image_gad1a96ede5f513042cef3c1dac4572f73}{elm\+\_\+image\+\_\+file\+\_\+set()} 
\end{DoxySeeAlso}
\index{Icon@{Icon}!elm\+\_\+icon\+\_\+animated\+\_\+available\+\_\+get@{elm\+\_\+icon\+\_\+animated\+\_\+available\+\_\+get}}
\index{elm\+\_\+icon\+\_\+animated\+\_\+available\+\_\+get@{elm\+\_\+icon\+\_\+animated\+\_\+available\+\_\+get}!Icon@{Icon}}
\subsubsection[{elm\+\_\+icon\+\_\+animated\+\_\+available\+\_\+get(const Evas\+\_\+\+Object $\ast$obj)}]{\setlength{\rightskip}{0pt plus 5cm}E\+I\+N\+A\+\_\+\+D\+E\+P\+R\+E\+C\+A\+T\+E\+D Eina\+\_\+\+Bool elm\+\_\+icon\+\_\+animated\+\_\+available\+\_\+get (
\begin{DoxyParamCaption}
\item[{const Evas\+\_\+\+Object $\ast$}]{obj}
\end{DoxyParamCaption}
)}\label{group__Icon_ga43df827062efb1a7de5808e755cbd4a9}


Get if the icon supports animation or not. 


\begin{DoxyParams}{Parameters}
{\em obj} & The icon object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
{\ttfamily E\+I\+N\+A\+\_\+\+T\+R\+U\+E} if the icon supports animation, {\ttfamily E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E} otherwise.
\end{DoxyReturn}
Return if this elm icon\textquotesingle{}s image can be animated. Currently Evas only supports gif animation. If the return value is E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E, other elm\+\_\+icon\+\_\+animated\+\_\+xxx A\+P\+Is won\textquotesingle{}t work.

\begin{DoxyRefDesc}{Deprecated}
\item[\hyperlink{deprecated__deprecated000063}{Deprecated}]Use \hyperlink{group__Image_ga1f61c469baddcaed97ab9846ea294594}{elm\+\_\+image\+\_\+animated\+\_\+available\+\_\+get()} instead.\end{DoxyRefDesc}


References elm\+\_\+image\+\_\+animated\+\_\+available\+\_\+get().

\index{Icon@{Icon}!elm\+\_\+icon\+\_\+animated\+\_\+get@{elm\+\_\+icon\+\_\+animated\+\_\+get}}
\index{elm\+\_\+icon\+\_\+animated\+\_\+get@{elm\+\_\+icon\+\_\+animated\+\_\+get}!Icon@{Icon}}
\subsubsection[{elm\+\_\+icon\+\_\+animated\+\_\+get(const Evas\+\_\+\+Object $\ast$obj)}]{\setlength{\rightskip}{0pt plus 5cm}E\+I\+N\+A\+\_\+\+D\+E\+P\+R\+E\+C\+A\+T\+E\+D Eina\+\_\+\+Bool elm\+\_\+icon\+\_\+animated\+\_\+get (
\begin{DoxyParamCaption}
\item[{const Evas\+\_\+\+Object $\ast$}]{obj}
\end{DoxyParamCaption}
)}\label{group__Icon_ga74ee1112e53d551754b7437d43381102}


Get animation mode of the icon. 


\begin{DoxyParams}{Parameters}
{\em obj} & The icon object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
The animation mode of the icon object 
\end{DoxyReturn}
\begin{DoxySeeAlso}{See also}
\hyperlink{group__Icon_ga8a9dcf2fbe799b747260ab2ebc624ec7}{elm\+\_\+icon\+\_\+animated\+\_\+set}
\end{DoxySeeAlso}
\begin{DoxyRefDesc}{Deprecated}
\item[\hyperlink{deprecated__deprecated000065}{Deprecated}]Use \hyperlink{group__Image_gaba9148979630af8ab6351ccfa7f6156a}{elm\+\_\+image\+\_\+animated\+\_\+get()} instead.\end{DoxyRefDesc}


References elm\+\_\+image\+\_\+animated\+\_\+get().

\index{Icon@{Icon}!elm\+\_\+icon\+\_\+animated\+\_\+play\+\_\+get@{elm\+\_\+icon\+\_\+animated\+\_\+play\+\_\+get}}
\index{elm\+\_\+icon\+\_\+animated\+\_\+play\+\_\+get@{elm\+\_\+icon\+\_\+animated\+\_\+play\+\_\+get}!Icon@{Icon}}
\subsubsection[{elm\+\_\+icon\+\_\+animated\+\_\+play\+\_\+get(const Evas\+\_\+\+Object $\ast$obj)}]{\setlength{\rightskip}{0pt plus 5cm}E\+I\+N\+A\+\_\+\+D\+E\+P\+R\+E\+C\+A\+T\+E\+D Eina\+\_\+\+Bool elm\+\_\+icon\+\_\+animated\+\_\+play\+\_\+get (
\begin{DoxyParamCaption}
\item[{const Evas\+\_\+\+Object $\ast$}]{obj}
\end{DoxyParamCaption}
)}\label{group__Icon_ga7247a037b4b19d01a8a8a4e8302a79ae}


Get animation play mode of the icon. 


\begin{DoxyParams}{Parameters}
{\em obj} & The icon object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
The play mode of the icon object
\end{DoxyReturn}
\begin{DoxySeeAlso}{See also}
\hyperlink{group__Icon_ga7247a037b4b19d01a8a8a4e8302a79ae}{elm\+\_\+icon\+\_\+animated\+\_\+play\+\_\+get}
\end{DoxySeeAlso}
\begin{DoxyRefDesc}{Deprecated}
\item[\hyperlink{deprecated__deprecated000067}{Deprecated}]Use \hyperlink{group__Image_gafc3120f2ff8cc7403238783b8561bf55}{elm\+\_\+image\+\_\+animated\+\_\+play\+\_\+get()} instead.\end{DoxyRefDesc}


References elm\+\_\+image\+\_\+animated\+\_\+play\+\_\+get().

\index{Icon@{Icon}!elm\+\_\+icon\+\_\+animated\+\_\+play\+\_\+set@{elm\+\_\+icon\+\_\+animated\+\_\+play\+\_\+set}}
\index{elm\+\_\+icon\+\_\+animated\+\_\+play\+\_\+set@{elm\+\_\+icon\+\_\+animated\+\_\+play\+\_\+set}!Icon@{Icon}}
\subsubsection[{elm\+\_\+icon\+\_\+animated\+\_\+play\+\_\+set(\+Evas\+\_\+\+Object $\ast$obj, Eina\+\_\+\+Bool play)}]{\setlength{\rightskip}{0pt plus 5cm}E\+I\+N\+A\+\_\+\+D\+E\+P\+R\+E\+C\+A\+T\+E\+D void elm\+\_\+icon\+\_\+animated\+\_\+play\+\_\+set (
\begin{DoxyParamCaption}
\item[{Evas\+\_\+\+Object $\ast$}]{obj, }
\item[{Eina\+\_\+\+Bool}]{play}
\end{DoxyParamCaption}
)}\label{group__Icon_ga2706a53b91d2f3c4a4aa5161b119ac4b}


Set animation play mode of the icon. 


\begin{DoxyParams}{Parameters}
{\em obj} & The icon object \\
\hline
{\em play} & {\ttfamily E\+I\+N\+A\+\_\+\+T\+R\+U\+E} the object play animation images, {\ttfamily E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E} otherwise. Default is {\ttfamily E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E}.\\
\hline
\end{DoxyParams}
To play elm icon\textquotesingle{}s animation, set play to E\+I\+N\+A\+\_\+\+T\+R\+U\+E. For example, you make gif player using this set/get A\+P\+I and click event. This literally lets you control current play or paused state. To have this work with animated G\+I\+F files for example, you first, before setting the file have to use \hyperlink{group__Icon_ga8a9dcf2fbe799b747260ab2ebc624ec7}{elm\+\_\+icon\+\_\+animated\+\_\+set()} to enable animation at all on the icon.


\begin{DoxyEnumerate}
\item Click event occurs
\item Check play flag using elm\+\_\+icon\+\_\+animated\+\_\+play\+\_\+get
\item If elm icon was playing, set play to E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E. Then animation will be stopped and vice versa
\end{DoxyEnumerate}

\begin{DoxyRefDesc}{Deprecated}
\item[\hyperlink{deprecated__deprecated000066}{Deprecated}]Use \hyperlink{group__Image_gac4d8f9a8c756e478c0b31bb1371dee46}{elm\+\_\+image\+\_\+animated\+\_\+play\+\_\+set()} instead.\end{DoxyRefDesc}


References elm\+\_\+image\+\_\+animated\+\_\+play\+\_\+set().

\index{Icon@{Icon}!elm\+\_\+icon\+\_\+animated\+\_\+set@{elm\+\_\+icon\+\_\+animated\+\_\+set}}
\index{elm\+\_\+icon\+\_\+animated\+\_\+set@{elm\+\_\+icon\+\_\+animated\+\_\+set}!Icon@{Icon}}
\subsubsection[{elm\+\_\+icon\+\_\+animated\+\_\+set(\+Evas\+\_\+\+Object $\ast$obj, Eina\+\_\+\+Bool animated)}]{\setlength{\rightskip}{0pt plus 5cm}E\+I\+N\+A\+\_\+\+D\+E\+P\+R\+E\+C\+A\+T\+E\+D void elm\+\_\+icon\+\_\+animated\+\_\+set (
\begin{DoxyParamCaption}
\item[{Evas\+\_\+\+Object $\ast$}]{obj, }
\item[{Eina\+\_\+\+Bool}]{animated}
\end{DoxyParamCaption}
)}\label{group__Icon_ga8a9dcf2fbe799b747260ab2ebc624ec7}


Set animation mode of the icon. 


\begin{DoxyParams}{Parameters}
{\em obj} & The icon object \\
\hline
{\em animated} & {\ttfamily E\+I\+N\+A\+\_\+\+T\+R\+U\+E} if the object do animation job, {\ttfamily E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E} otherwise. Default is {\ttfamily E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E}.\\
\hline
\end{DoxyParams}
Since the default animation mode is set to E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E, the icon is shown without animation. Files like animated G\+I\+F files can animate, and this is supported if you enable animated support on the icon. Set it to E\+I\+N\+A\+\_\+\+T\+R\+U\+E when the icon needs to be animated.

\begin{DoxyRefDesc}{Deprecated}
\item[\hyperlink{deprecated__deprecated000064}{Deprecated}]Use \hyperlink{group__Image_gafb3915f863b15be7e5d41d80a6bf3a08}{elm\+\_\+image\+\_\+animated\+\_\+set()} instead.\end{DoxyRefDesc}


References elm\+\_\+image\+\_\+animated\+\_\+set().

\index{Icon@{Icon}!elm\+\_\+icon\+\_\+aspect\+\_\+fixed\+\_\+get@{elm\+\_\+icon\+\_\+aspect\+\_\+fixed\+\_\+get}}
\index{elm\+\_\+icon\+\_\+aspect\+\_\+fixed\+\_\+get@{elm\+\_\+icon\+\_\+aspect\+\_\+fixed\+\_\+get}!Icon@{Icon}}
\subsubsection[{elm\+\_\+icon\+\_\+aspect\+\_\+fixed\+\_\+get(const Evas\+\_\+\+Object $\ast$obj)}]{\setlength{\rightskip}{0pt plus 5cm}E\+I\+N\+A\+\_\+\+D\+E\+P\+R\+E\+C\+A\+T\+E\+D Eina\+\_\+\+Bool elm\+\_\+icon\+\_\+aspect\+\_\+fixed\+\_\+get (
\begin{DoxyParamCaption}
\item[{const Evas\+\_\+\+Object $\ast$}]{obj}
\end{DoxyParamCaption}
)}\label{group__Icon_ga22d102913423a42675dc7be08418f5b3}


Get if the object retains the original aspect ratio. 


\begin{DoxyParams}{Parameters}
{\em obj} & The icon object. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
{\ttfamily E\+I\+N\+A\+\_\+\+T\+R\+U\+E} if the object keeps the original aspect, {\ttfamily E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E} otherwise.
\end{DoxyReturn}
\begin{DoxyRefDesc}{Deprecated}
\item[\hyperlink{deprecated__deprecated000069}{Deprecated}]Use elm\+\_\+image\+\_\+aspect\+\_\+fixed\+\_\+get() instead.\end{DoxyRefDesc}
\index{Icon@{Icon}!elm\+\_\+icon\+\_\+aspect\+\_\+fixed\+\_\+set@{elm\+\_\+icon\+\_\+aspect\+\_\+fixed\+\_\+set}}
\index{elm\+\_\+icon\+\_\+aspect\+\_\+fixed\+\_\+set@{elm\+\_\+icon\+\_\+aspect\+\_\+fixed\+\_\+set}!Icon@{Icon}}
\subsubsection[{elm\+\_\+icon\+\_\+aspect\+\_\+fixed\+\_\+set(\+Evas\+\_\+\+Object $\ast$obj, Eina\+\_\+\+Bool fixed)}]{\setlength{\rightskip}{0pt plus 5cm}E\+I\+N\+A\+\_\+\+D\+E\+P\+R\+E\+C\+A\+T\+E\+D void elm\+\_\+icon\+\_\+aspect\+\_\+fixed\+\_\+set (
\begin{DoxyParamCaption}
\item[{Evas\+\_\+\+Object $\ast$}]{obj, }
\item[{Eina\+\_\+\+Bool}]{fixed}
\end{DoxyParamCaption}
)}\label{group__Icon_gaa347e3a65bf3234789d0ad8eee8cb5ea}


Set whether the original aspect ratio of the icon should be kept on resize. 


\begin{DoxyParams}{Parameters}
{\em obj} & The icon object. \\
\hline
{\em fixed} & {\ttfamily E\+I\+N\+A\+\_\+\+T\+R\+U\+E} if the icon should retain the aspect, {\ttfamily E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E} otherwise.\\
\hline
\end{DoxyParams}
The original aspect ratio (width / height) of the icon is usually distorted to match the object\textquotesingle{}s size. Enabling this option will retain this original aspect, and the way that the icon is fit into the object\textquotesingle{}s area depends on the option set by \hyperlink{group__Icon_ga947a7ce58a9951e6544f462474bc555c}{elm\+\_\+icon\+\_\+fill\+\_\+outside\+\_\+set()}.

\begin{DoxySeeAlso}{See also}
\hyperlink{group__Icon_ga22d102913423a42675dc7be08418f5b3}{elm\+\_\+icon\+\_\+aspect\+\_\+fixed\+\_\+get()} 

\hyperlink{group__Icon_ga947a7ce58a9951e6544f462474bc555c}{elm\+\_\+icon\+\_\+fill\+\_\+outside\+\_\+set()}
\end{DoxySeeAlso}
\begin{DoxyRefDesc}{Deprecated}
\item[\hyperlink{deprecated__deprecated000068}{Deprecated}]Use elm\+\_\+image\+\_\+aspect\+\_\+fixed\+\_\+set() instead.\end{DoxyRefDesc}
\index{Icon@{Icon}!elm\+\_\+icon\+\_\+file\+\_\+get@{elm\+\_\+icon\+\_\+file\+\_\+get}}
\index{elm\+\_\+icon\+\_\+file\+\_\+get@{elm\+\_\+icon\+\_\+file\+\_\+get}!Icon@{Icon}}
\subsubsection[{elm\+\_\+icon\+\_\+file\+\_\+get(const Evas\+\_\+\+Object $\ast$obj, const char $\ast$$\ast$file, const char $\ast$$\ast$group)}]{\setlength{\rightskip}{0pt plus 5cm}E\+I\+N\+A\+\_\+\+D\+E\+P\+R\+E\+C\+A\+T\+E\+D void elm\+\_\+icon\+\_\+file\+\_\+get (
\begin{DoxyParamCaption}
\item[{const Evas\+\_\+\+Object $\ast$}]{obj, }
\item[{const char $\ast$$\ast$}]{file, }
\item[{const char $\ast$$\ast$}]{group}
\end{DoxyParamCaption}
)}\label{group__Icon_gaea8ca3a125bf863ff5c1750a754fe4f4}


Get the file that will be used as icon. 


\begin{DoxyParams}{Parameters}
{\em obj} & The icon object \\
\hline
{\em file} & The path to file that will be used as the icon image \\
\hline
{\em group} & The group that the icon belongs to, in edje file\\
\hline
\end{DoxyParams}
\begin{DoxySeeAlso}{See also}
\hyperlink{group__Image_gad1a96ede5f513042cef3c1dac4572f73}{elm\+\_\+image\+\_\+file\+\_\+set()}
\end{DoxySeeAlso}
\begin{DoxyRefDesc}{Deprecated}
\item[\hyperlink{deprecated__deprecated000049}{Deprecated}]Use \hyperlink{group__Image_ga2457a336d2123a8074725e814e459cba}{elm\+\_\+image\+\_\+file\+\_\+get()} instead.\end{DoxyRefDesc}


References elm\+\_\+image\+\_\+file\+\_\+get().

\index{Icon@{Icon}!elm\+\_\+icon\+\_\+file\+\_\+set@{elm\+\_\+icon\+\_\+file\+\_\+set}}
\index{elm\+\_\+icon\+\_\+file\+\_\+set@{elm\+\_\+icon\+\_\+file\+\_\+set}!Icon@{Icon}}
\subsubsection[{elm\+\_\+icon\+\_\+file\+\_\+set(\+Evas\+\_\+\+Object $\ast$obj, const char $\ast$file, const char $\ast$group)}]{\setlength{\rightskip}{0pt plus 5cm}E\+I\+N\+A\+\_\+\+D\+E\+P\+R\+E\+C\+A\+T\+E\+D Eina\+\_\+\+Bool elm\+\_\+icon\+\_\+file\+\_\+set (
\begin{DoxyParamCaption}
\item[{Evas\+\_\+\+Object $\ast$}]{obj, }
\item[{const char $\ast$}]{file, }
\item[{const char $\ast$}]{group}
\end{DoxyParamCaption}
)}\label{group__Icon_ga8f63b279b1cc73699d33f5a0d6ba6b6d}


Set the file that will be used as icon. 


\begin{DoxyParams}{Parameters}
{\em obj} & The icon object \\
\hline
{\em file} & The path to file that will be used as icon image \\
\hline
{\em group} & The group that the icon belongs to an edje file\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
({\ttfamily E\+I\+N\+A\+\_\+\+T\+R\+U\+E} = success, {\ttfamily E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E} = error)
\end{DoxyReturn}
\begin{DoxyNote}{Note}
The icon image set by this function can be changed by elm\+\_\+icon\+\_\+standard\+\_\+set().
\end{DoxyNote}
\begin{DoxySeeAlso}{See also}
\hyperlink{group__Icon_gaea8ca3a125bf863ff5c1750a754fe4f4}{elm\+\_\+icon\+\_\+file\+\_\+get()}
\end{DoxySeeAlso}
\begin{DoxyRefDesc}{Deprecated}
\item[\hyperlink{deprecated__deprecated000047}{Deprecated}]Use \hyperlink{group__Image_gad1a96ede5f513042cef3c1dac4572f73}{elm\+\_\+image\+\_\+file\+\_\+set()} instead.\end{DoxyRefDesc}
\index{Icon@{Icon}!elm\+\_\+icon\+\_\+fill\+\_\+outside\+\_\+get@{elm\+\_\+icon\+\_\+fill\+\_\+outside\+\_\+get}}
\index{elm\+\_\+icon\+\_\+fill\+\_\+outside\+\_\+get@{elm\+\_\+icon\+\_\+fill\+\_\+outside\+\_\+get}!Icon@{Icon}}
\subsubsection[{elm\+\_\+icon\+\_\+fill\+\_\+outside\+\_\+get(const Evas\+\_\+\+Object $\ast$obj)}]{\setlength{\rightskip}{0pt plus 5cm}E\+I\+N\+A\+\_\+\+D\+E\+P\+R\+E\+C\+A\+T\+E\+D Eina\+\_\+\+Bool elm\+\_\+icon\+\_\+fill\+\_\+outside\+\_\+get (
\begin{DoxyParamCaption}
\item[{const Evas\+\_\+\+Object $\ast$}]{obj}
\end{DoxyParamCaption}
)}\label{group__Icon_gacf20468921f4aa7e2d99b89a64de0166}


Get if the object is filled outside. 


\begin{DoxyParams}{Parameters}
{\em obj} & The icon object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
{\ttfamily E\+I\+N\+A\+\_\+\+T\+R\+U\+E} if the object is filled outside, {\ttfamily E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E} otherwise.
\end{DoxyReturn}
\begin{DoxySeeAlso}{See also}
\hyperlink{group__Icon_ga947a7ce58a9951e6544f462474bc555c}{elm\+\_\+icon\+\_\+fill\+\_\+outside\+\_\+set()}
\end{DoxySeeAlso}
\begin{DoxyRefDesc}{Deprecated}
\item[\hyperlink{deprecated__deprecated000058}{Deprecated}]Use elm\+\_\+image\+\_\+fill\+\_\+outside\+\_\+get() instead.\end{DoxyRefDesc}
\index{Icon@{Icon}!elm\+\_\+icon\+\_\+fill\+\_\+outside\+\_\+set@{elm\+\_\+icon\+\_\+fill\+\_\+outside\+\_\+set}}
\index{elm\+\_\+icon\+\_\+fill\+\_\+outside\+\_\+set@{elm\+\_\+icon\+\_\+fill\+\_\+outside\+\_\+set}!Icon@{Icon}}
\subsubsection[{elm\+\_\+icon\+\_\+fill\+\_\+outside\+\_\+set(\+Evas\+\_\+\+Object $\ast$obj, Eina\+\_\+\+Bool fill\+\_\+outside)}]{\setlength{\rightskip}{0pt plus 5cm}E\+I\+N\+A\+\_\+\+D\+E\+P\+R\+E\+C\+A\+T\+E\+D void elm\+\_\+icon\+\_\+fill\+\_\+outside\+\_\+set (
\begin{DoxyParamCaption}
\item[{Evas\+\_\+\+Object $\ast$}]{obj, }
\item[{Eina\+\_\+\+Bool}]{fill\+\_\+outside}
\end{DoxyParamCaption}
)}\label{group__Icon_ga947a7ce58a9951e6544f462474bc555c}


Set if the icon fill the entire object area. 


\begin{DoxyParams}{Parameters}
{\em obj} & The icon object \\
\hline
{\em fill\+\_\+outside} & {\ttfamily E\+I\+N\+A\+\_\+\+T\+R\+U\+E} if the object is filled outside, {\ttfamily E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E} otherwise. Default is {\ttfamily E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E}.\\
\hline
\end{DoxyParams}
When the icon object is resized to a different aspect ratio from the original icon image, the icon image will still keep its aspect. This flag tells how the image should fill the object\textquotesingle{}s area. They are\+: keep the entire icon inside the limits of height and width of the object ({\ttfamily fill\+\_\+outside} is {\ttfamily E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E}) or let the extra width or height go outside of the object, and the icon will fill the entire object ({\ttfamily fill\+\_\+outside} is {\ttfamily E\+I\+N\+A\+\_\+\+T\+R\+U\+E}).

\begin{DoxyNote}{Note}
Unlike \hyperlink{group__Image}{Image}, there\textquotesingle{}s no option in icon to set the aspect ratio retain property to false. Thus, the icon image will always keep its original aspect ratio.
\end{DoxyNote}
\begin{DoxySeeAlso}{See also}
\hyperlink{group__Icon_gacf20468921f4aa7e2d99b89a64de0166}{elm\+\_\+icon\+\_\+fill\+\_\+outside\+\_\+get()}
\end{DoxySeeAlso}
\begin{DoxyRefDesc}{Deprecated}
\item[\hyperlink{deprecated__deprecated000057}{Deprecated}]Use elm\+\_\+image\+\_\+fill\+\_\+outside\+\_\+set() instead.\end{DoxyRefDesc}
\index{Icon@{Icon}!elm\+\_\+icon\+\_\+memfile\+\_\+set@{elm\+\_\+icon\+\_\+memfile\+\_\+set}}
\index{elm\+\_\+icon\+\_\+memfile\+\_\+set@{elm\+\_\+icon\+\_\+memfile\+\_\+set}!Icon@{Icon}}
\subsubsection[{elm\+\_\+icon\+\_\+memfile\+\_\+set(\+Evas\+\_\+\+Object $\ast$obj, const void $\ast$img, size\+\_\+t size, const char $\ast$format, const char $\ast$key)}]{\setlength{\rightskip}{0pt plus 5cm}E\+I\+N\+A\+\_\+\+D\+E\+P\+R\+E\+C\+A\+T\+E\+D Eina\+\_\+\+Bool elm\+\_\+icon\+\_\+memfile\+\_\+set (
\begin{DoxyParamCaption}
\item[{Evas\+\_\+\+Object $\ast$}]{obj, }
\item[{const void $\ast$}]{img, }
\item[{size\+\_\+t}]{size, }
\item[{const char $\ast$}]{format, }
\item[{const char $\ast$}]{key}
\end{DoxyParamCaption}
)}\label{group__Icon_ga9ab6137d507b6b26e3509a8e4d4702b1}


Set a location in memory to be used as an icon. 


\begin{DoxyParams}{Parameters}
{\em obj} & The icon object \\
\hline
{\em img} & The binary data that will be used as an image \\
\hline
{\em size} & The size of binary data {\ttfamily img} \\
\hline
{\em format} & Optional format of {\ttfamily img} to pass to the image loader \\
\hline
{\em key} & Optional key of {\ttfamily img} to pass to the image loader (eg. if {\ttfamily img} is an edje file)\\
\hline
\end{DoxyParams}
The {\ttfamily format} string should be something like \char`\"{}png\char`\"{}, \char`\"{}jpg\char`\"{}, \char`\"{}tga\char`\"{}, \char`\"{}tiff\char`\"{}, \char`\"{}bmp\char`\"{} etc. if it is provided (N\+U\+L\+L if not). This improves the loader performance as it tries the \char`\"{}correct\char`\"{} loader first before trying a range of other possible loaders until one succeeds.

\begin{DoxyReturn}{Returns}
({\ttfamily E\+I\+N\+A\+\_\+\+T\+R\+U\+E} = success, {\ttfamily E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E} = error)
\end{DoxyReturn}
\begin{DoxyNote}{Note}
The icon image set by this function can be changed by elm\+\_\+icon\+\_\+standard\+\_\+set().
\end{DoxyNote}
\begin{DoxyRefDesc}{Deprecated}
\item[\hyperlink{deprecated__deprecated000048}{Deprecated}]Use elm\+\_\+image\+\_\+memfile\+\_\+set() instead.\end{DoxyRefDesc}
\index{Icon@{Icon}!elm\+\_\+icon\+\_\+no\+\_\+scale\+\_\+get@{elm\+\_\+icon\+\_\+no\+\_\+scale\+\_\+get}}
\index{elm\+\_\+icon\+\_\+no\+\_\+scale\+\_\+get@{elm\+\_\+icon\+\_\+no\+\_\+scale\+\_\+get}!Icon@{Icon}}
\subsubsection[{elm\+\_\+icon\+\_\+no\+\_\+scale\+\_\+get(const Evas\+\_\+\+Object $\ast$obj)}]{\setlength{\rightskip}{0pt plus 5cm}E\+I\+N\+A\+\_\+\+D\+E\+P\+R\+E\+C\+A\+T\+E\+D Eina\+\_\+\+Bool elm\+\_\+icon\+\_\+no\+\_\+scale\+\_\+get (
\begin{DoxyParamCaption}
\item[{const Evas\+\_\+\+Object $\ast$}]{obj}
\end{DoxyParamCaption}
)}\label{group__Icon_ga7bafdcd87e80ad6c451e788bdba59bfe}


Get whether scaling is disabled on the object. 


\begin{DoxyParams}{Parameters}
{\em obj} & The icon object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
{\ttfamily E\+I\+N\+A\+\_\+\+T\+R\+U\+E} if scaling is disabled, {\ttfamily E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E} otherwise
\end{DoxyReturn}
\begin{DoxySeeAlso}{See also}
\hyperlink{group__Icon_ga20a619a001f0f67a4fd71cf3bd3ed335}{elm\+\_\+icon\+\_\+no\+\_\+scale\+\_\+set()}
\end{DoxySeeAlso}
\begin{DoxyRefDesc}{Deprecated}
\item[\hyperlink{deprecated__deprecated000053}{Deprecated}]Use elm\+\_\+image\+\_\+no\+\_\+scale\+\_\+get() instead.\end{DoxyRefDesc}
\index{Icon@{Icon}!elm\+\_\+icon\+\_\+no\+\_\+scale\+\_\+set@{elm\+\_\+icon\+\_\+no\+\_\+scale\+\_\+set}}
\index{elm\+\_\+icon\+\_\+no\+\_\+scale\+\_\+set@{elm\+\_\+icon\+\_\+no\+\_\+scale\+\_\+set}!Icon@{Icon}}
\subsubsection[{elm\+\_\+icon\+\_\+no\+\_\+scale\+\_\+set(\+Evas\+\_\+\+Object $\ast$obj, Eina\+\_\+\+Bool no\+\_\+scale)}]{\setlength{\rightskip}{0pt plus 5cm}E\+I\+N\+A\+\_\+\+D\+E\+P\+R\+E\+C\+A\+T\+E\+D void elm\+\_\+icon\+\_\+no\+\_\+scale\+\_\+set (
\begin{DoxyParamCaption}
\item[{Evas\+\_\+\+Object $\ast$}]{obj, }
\item[{Eina\+\_\+\+Bool}]{no\+\_\+scale}
\end{DoxyParamCaption}
)}\label{group__Icon_ga20a619a001f0f67a4fd71cf3bd3ed335}


Disable scaling of this object. 


\begin{DoxyParams}{Parameters}
{\em obj} & The icon object. \\
\hline
{\em no\+\_\+scale} & {\ttfamily E\+I\+N\+A\+\_\+\+T\+R\+U\+E} if the object is not scalable, {\ttfamily E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E} otherwise. Default is {\ttfamily E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E}.\\
\hline
\end{DoxyParams}
This function disables scaling of the icon object through the function \hyperlink{group__Scaling_ga1606f51f88c4d0b58544d36225420a37}{elm\+\_\+object\+\_\+scale\+\_\+set()}. However, this does not affect the object size/resize in any way. For that effect, take a look at \hyperlink{group__Icon_gab4e9af0524f8100ac1f74f0af2631f1e}{elm\+\_\+icon\+\_\+resizable\+\_\+set()}.

\begin{DoxySeeAlso}{See also}
\hyperlink{group__Icon_ga7bafdcd87e80ad6c451e788bdba59bfe}{elm\+\_\+icon\+\_\+no\+\_\+scale\+\_\+get()} 

\hyperlink{group__Icon_gab4e9af0524f8100ac1f74f0af2631f1e}{elm\+\_\+icon\+\_\+resizable\+\_\+set()} 

\hyperlink{group__Scaling_ga1606f51f88c4d0b58544d36225420a37}{elm\+\_\+object\+\_\+scale\+\_\+set()}
\end{DoxySeeAlso}
\begin{DoxyRefDesc}{Deprecated}
\item[\hyperlink{deprecated__deprecated000052}{Deprecated}]Use elm\+\_\+image\+\_\+no\+\_\+scale\+\_\+set() instead.\end{DoxyRefDesc}
\index{Icon@{Icon}!elm\+\_\+icon\+\_\+object\+\_\+get@{elm\+\_\+icon\+\_\+object\+\_\+get}}
\index{elm\+\_\+icon\+\_\+object\+\_\+get@{elm\+\_\+icon\+\_\+object\+\_\+get}!Icon@{Icon}}
\subsubsection[{elm\+\_\+icon\+\_\+object\+\_\+get(\+Evas\+\_\+\+Object $\ast$obj)}]{\setlength{\rightskip}{0pt plus 5cm}E\+I\+N\+A\+\_\+\+D\+E\+P\+R\+E\+C\+A\+T\+E\+D Evas\+\_\+\+Object$\ast$ elm\+\_\+icon\+\_\+object\+\_\+get (
\begin{DoxyParamCaption}
\item[{Evas\+\_\+\+Object $\ast$}]{obj}
\end{DoxyParamCaption}
)}\label{group__Icon_ga6d0566aa2c521c0b3ea1a3d1e3d7ca8f}


Get the image object of the icon. 

D\+O N\+O\+T M\+O\+D\+I\+F\+Y T\+H\+I\+S.


\begin{DoxyParams}{Parameters}
{\em obj} & The icon object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
The internal icon object
\end{DoxyReturn}
\begin{DoxyRefDesc}{Deprecated}
\item[\hyperlink{deprecated__deprecated000061}{Deprecated}]Use elm\+\_\+image\+\_\+object\+\_\+get() instead.\end{DoxyRefDesc}
\index{Icon@{Icon}!elm\+\_\+icon\+\_\+preload\+\_\+disabled\+\_\+set@{elm\+\_\+icon\+\_\+preload\+\_\+disabled\+\_\+set}}
\index{elm\+\_\+icon\+\_\+preload\+\_\+disabled\+\_\+set@{elm\+\_\+icon\+\_\+preload\+\_\+disabled\+\_\+set}!Icon@{Icon}}
\subsubsection[{elm\+\_\+icon\+\_\+preload\+\_\+disabled\+\_\+set(\+Evas\+\_\+\+Object $\ast$obj, Eina\+\_\+\+Bool disabled)}]{\setlength{\rightskip}{0pt plus 5cm}E\+I\+N\+A\+\_\+\+D\+E\+P\+R\+E\+C\+A\+T\+E\+D void elm\+\_\+icon\+\_\+preload\+\_\+disabled\+\_\+set (
\begin{DoxyParamCaption}
\item[{Evas\+\_\+\+Object $\ast$}]{obj, }
\item[{Eina\+\_\+\+Bool}]{disabled}
\end{DoxyParamCaption}
)}\label{group__Icon_ga060c70b2aa9fa4048177536001a44a2c}


Enable or disable preloading of the icon. 


\begin{DoxyParams}{Parameters}
{\em obj} & The icon object \\
\hline
{\em disabled} & If E\+I\+N\+A\+\_\+\+T\+R\+U\+E, preloading will be disabled\\
\hline
\end{DoxyParams}
\begin{DoxyRefDesc}{Deprecated}
\item[\hyperlink{deprecated__deprecated000062}{Deprecated}]Use elm\+\_\+image\+\_\+preload\+\_\+disabled\+\_\+set() instead.\end{DoxyRefDesc}
\index{Icon@{Icon}!elm\+\_\+icon\+\_\+prescale\+\_\+get@{elm\+\_\+icon\+\_\+prescale\+\_\+get}}
\index{elm\+\_\+icon\+\_\+prescale\+\_\+get@{elm\+\_\+icon\+\_\+prescale\+\_\+get}!Icon@{Icon}}
\subsubsection[{elm\+\_\+icon\+\_\+prescale\+\_\+get(const Evas\+\_\+\+Object $\ast$obj)}]{\setlength{\rightskip}{0pt plus 5cm}E\+I\+N\+A\+\_\+\+D\+E\+P\+R\+E\+C\+A\+T\+E\+D int elm\+\_\+icon\+\_\+prescale\+\_\+get (
\begin{DoxyParamCaption}
\item[{const Evas\+\_\+\+Object $\ast$}]{obj}
\end{DoxyParamCaption}
)}\label{group__Icon_ga3ee7dd4f5d9c57b129fa76a29e0629cc}


Get the prescale size for the icon. 


\begin{DoxyParams}{Parameters}
{\em obj} & The icon object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
The prescale size
\end{DoxyReturn}
\begin{DoxySeeAlso}{See also}
\hyperlink{group__Icon_ga31463d82332ee32c010e171aea370b8d}{elm\+\_\+icon\+\_\+prescale\+\_\+set()}
\end{DoxySeeAlso}
\begin{DoxyRefDesc}{Deprecated}
\item[\hyperlink{deprecated__deprecated000060}{Deprecated}]Use \hyperlink{group__Image_ga1aeca8dbe2367d817492099887ca8f2d}{elm\+\_\+image\+\_\+prescale\+\_\+get()} instead.\end{DoxyRefDesc}


References elm\+\_\+image\+\_\+prescale\+\_\+get().

\index{Icon@{Icon}!elm\+\_\+icon\+\_\+prescale\+\_\+set@{elm\+\_\+icon\+\_\+prescale\+\_\+set}}
\index{elm\+\_\+icon\+\_\+prescale\+\_\+set@{elm\+\_\+icon\+\_\+prescale\+\_\+set}!Icon@{Icon}}
\subsubsection[{elm\+\_\+icon\+\_\+prescale\+\_\+set(\+Evas\+\_\+\+Object $\ast$obj, int size)}]{\setlength{\rightskip}{0pt plus 5cm}E\+I\+N\+A\+\_\+\+D\+E\+P\+R\+E\+C\+A\+T\+E\+D void elm\+\_\+icon\+\_\+prescale\+\_\+set (
\begin{DoxyParamCaption}
\item[{Evas\+\_\+\+Object $\ast$}]{obj, }
\item[{int}]{size}
\end{DoxyParamCaption}
)}\label{group__Icon_ga31463d82332ee32c010e171aea370b8d}


Set the prescale size for the icon. 


\begin{DoxyParams}{Parameters}
{\em obj} & The icon object \\
\hline
{\em size} & The prescale size. This value is used for both width and height.\\
\hline
\end{DoxyParams}
This function sets a new size for pixmap representation of the given icon. It allows the icon to be loaded already in the specified size, reducing the memory usage and load time when loading a big icon with load size set to a smaller size.

It\textquotesingle{}s equivalent to the elm\+\_\+bg\+\_\+load\+\_\+size\+\_\+set() function for bg.

\begin{DoxyNote}{Note}
this is just a hint, the real size of the pixmap may differ depending on the type of icon being loaded, being bigger than requested.
\end{DoxyNote}
\begin{DoxySeeAlso}{See also}
\hyperlink{group__Icon_ga3ee7dd4f5d9c57b129fa76a29e0629cc}{elm\+\_\+icon\+\_\+prescale\+\_\+get()} 

elm\+\_\+bg\+\_\+load\+\_\+size\+\_\+set()
\end{DoxySeeAlso}
\begin{DoxyRefDesc}{Deprecated}
\item[\hyperlink{deprecated__deprecated000059}{Deprecated}]Use \hyperlink{group__Image_gafb6dd2b235e25b2bd0b93d82e205a4f6}{elm\+\_\+image\+\_\+prescale\+\_\+set()} instead.\end{DoxyRefDesc}


References elm\+\_\+image\+\_\+prescale\+\_\+set().

\index{Icon@{Icon}!elm\+\_\+icon\+\_\+resizable\+\_\+get@{elm\+\_\+icon\+\_\+resizable\+\_\+get}}
\index{elm\+\_\+icon\+\_\+resizable\+\_\+get@{elm\+\_\+icon\+\_\+resizable\+\_\+get}!Icon@{Icon}}
\subsubsection[{elm\+\_\+icon\+\_\+resizable\+\_\+get(const Evas\+\_\+\+Object $\ast$obj, Eina\+\_\+\+Bool $\ast$size\+\_\+up, Eina\+\_\+\+Bool $\ast$size\+\_\+down)}]{\setlength{\rightskip}{0pt plus 5cm}E\+I\+N\+A\+\_\+\+D\+E\+P\+R\+E\+C\+A\+T\+E\+D void elm\+\_\+icon\+\_\+resizable\+\_\+get (
\begin{DoxyParamCaption}
\item[{const Evas\+\_\+\+Object $\ast$}]{obj, }
\item[{Eina\+\_\+\+Bool $\ast$}]{size\+\_\+up, }
\item[{Eina\+\_\+\+Bool $\ast$}]{size\+\_\+down}
\end{DoxyParamCaption}
)}\label{group__Icon_ga9e49b6205b865de4ea171ae8a6afab95}


Get if the object is (up/down) resizable. 


\begin{DoxyParams}{Parameters}
{\em obj} & The icon object \\
\hline
{\em size\+\_\+up} & A bool to set if the object is resizable up \\
\hline
{\em size\+\_\+down} & A bool to set if the object is resizable down\\
\hline
\end{DoxyParams}
\begin{DoxySeeAlso}{See also}
\hyperlink{group__Icon_gab4e9af0524f8100ac1f74f0af2631f1e}{elm\+\_\+icon\+\_\+resizable\+\_\+set()}
\end{DoxySeeAlso}
\begin{DoxyRefDesc}{Deprecated}
\item[\hyperlink{deprecated__deprecated000055}{Deprecated}]Use elm\+\_\+image\+\_\+resizable\+\_\+get() instead.\end{DoxyRefDesc}
\index{Icon@{Icon}!elm\+\_\+icon\+\_\+resizable\+\_\+set@{elm\+\_\+icon\+\_\+resizable\+\_\+set}}
\index{elm\+\_\+icon\+\_\+resizable\+\_\+set@{elm\+\_\+icon\+\_\+resizable\+\_\+set}!Icon@{Icon}}
\subsubsection[{elm\+\_\+icon\+\_\+resizable\+\_\+set(\+Evas\+\_\+\+Object $\ast$obj, Eina\+\_\+\+Bool size\+\_\+up, Eina\+\_\+\+Bool size\+\_\+down)}]{\setlength{\rightskip}{0pt plus 5cm}E\+I\+N\+A\+\_\+\+D\+E\+P\+R\+E\+C\+A\+T\+E\+D void elm\+\_\+icon\+\_\+resizable\+\_\+set (
\begin{DoxyParamCaption}
\item[{Evas\+\_\+\+Object $\ast$}]{obj, }
\item[{Eina\+\_\+\+Bool}]{size\+\_\+up, }
\item[{Eina\+\_\+\+Bool}]{size\+\_\+down}
\end{DoxyParamCaption}
)}\label{group__Icon_gab4e9af0524f8100ac1f74f0af2631f1e}


Set if the object is (up/down) resizable. 


\begin{DoxyParams}{Parameters}
{\em obj} & The icon object \\
\hline
{\em size\+\_\+up} & A bool to set if the object is resizable up. Default is {\ttfamily E\+I\+N\+A\+\_\+\+T\+R\+U\+E}. \\
\hline
{\em size\+\_\+down} & A bool to set if the object is resizable down. Default is {\ttfamily E\+I\+N\+A\+\_\+\+T\+R\+U\+E}.\\
\hline
\end{DoxyParams}
This function limits the icon object resize ability. If {\ttfamily size\+\_\+up} is set to {\ttfamily E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E}, the object can\textquotesingle{}t have its height or width resized to a value higher than the original icon size. Same is valid for {\ttfamily size\+\_\+down}.

\begin{DoxySeeAlso}{See also}
\hyperlink{group__Icon_ga9e49b6205b865de4ea171ae8a6afab95}{elm\+\_\+icon\+\_\+resizable\+\_\+get()}
\end{DoxySeeAlso}
\begin{DoxyRefDesc}{Deprecated}
\item[\hyperlink{deprecated__deprecated000054}{Deprecated}]Use elm\+\_\+image\+\_\+resizable\+\_\+set() instead.\end{DoxyRefDesc}
\index{Icon@{Icon}!elm\+\_\+icon\+\_\+size\+\_\+get@{elm\+\_\+icon\+\_\+size\+\_\+get}}
\index{elm\+\_\+icon\+\_\+size\+\_\+get@{elm\+\_\+icon\+\_\+size\+\_\+get}!Icon@{Icon}}
\subsubsection[{elm\+\_\+icon\+\_\+size\+\_\+get(const Evas\+\_\+\+Object $\ast$obj, int $\ast$w, int $\ast$h)}]{\setlength{\rightskip}{0pt plus 5cm}E\+I\+N\+A\+\_\+\+D\+E\+P\+R\+E\+C\+A\+T\+E\+D void elm\+\_\+icon\+\_\+size\+\_\+get (
\begin{DoxyParamCaption}
\item[{const Evas\+\_\+\+Object $\ast$}]{obj, }
\item[{int $\ast$}]{w, }
\item[{int $\ast$}]{h}
\end{DoxyParamCaption}
)}\label{group__Icon_ga3246f21dd7f76fe396aec2e642de77bf}


Get the object\textquotesingle{}s image size. 


\begin{DoxyParams}{Parameters}
{\em obj} & The icon object \\
\hline
{\em w} & A pointer to store the width in \\
\hline
{\em h} & A pointer to store the height in\\
\hline
\end{DoxyParams}
\begin{DoxyRefDesc}{Deprecated}
\item[\hyperlink{deprecated__deprecated000056}{Deprecated}]Use elm\+\_\+image\+\_\+object\+\_\+size\+\_\+get() instead.\end{DoxyRefDesc}
\index{Icon@{Icon}!elm\+\_\+icon\+\_\+smooth\+\_\+get@{elm\+\_\+icon\+\_\+smooth\+\_\+get}}
\index{elm\+\_\+icon\+\_\+smooth\+\_\+get@{elm\+\_\+icon\+\_\+smooth\+\_\+get}!Icon@{Icon}}
\subsubsection[{elm\+\_\+icon\+\_\+smooth\+\_\+get(const Evas\+\_\+\+Object $\ast$obj)}]{\setlength{\rightskip}{0pt plus 5cm}E\+I\+N\+A\+\_\+\+D\+E\+P\+R\+E\+C\+A\+T\+E\+D Eina\+\_\+\+Bool elm\+\_\+icon\+\_\+smooth\+\_\+get (
\begin{DoxyParamCaption}
\item[{const Evas\+\_\+\+Object $\ast$}]{obj}
\end{DoxyParamCaption}
)}\label{group__Icon_ga55dcaa0812cd19c48c426338a058bf33}


Get whether smooth scaling is enabled for an icon object. 


\begin{DoxyParams}{Parameters}
{\em obj} & The icon object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
{\ttfamily E\+I\+N\+A\+\_\+\+T\+R\+U\+E} if smooth scaling is enabled, {\ttfamily E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E} otherwise.
\end{DoxyReturn}
\begin{DoxySeeAlso}{See also}
\hyperlink{group__Icon_gada290e2867b9c2548306f7b875dae22d}{elm\+\_\+icon\+\_\+smooth\+\_\+set()}
\end{DoxySeeAlso}
\begin{DoxyRefDesc}{Deprecated}
\item[\hyperlink{deprecated__deprecated000051}{Deprecated}]Use elm\+\_\+image\+\_\+smooth\+\_\+get() instead.\end{DoxyRefDesc}
\index{Icon@{Icon}!elm\+\_\+icon\+\_\+smooth\+\_\+set@{elm\+\_\+icon\+\_\+smooth\+\_\+set}}
\index{elm\+\_\+icon\+\_\+smooth\+\_\+set@{elm\+\_\+icon\+\_\+smooth\+\_\+set}!Icon@{Icon}}
\subsubsection[{elm\+\_\+icon\+\_\+smooth\+\_\+set(\+Evas\+\_\+\+Object $\ast$obj, Eina\+\_\+\+Bool smooth)}]{\setlength{\rightskip}{0pt plus 5cm}E\+I\+N\+A\+\_\+\+D\+E\+P\+R\+E\+C\+A\+T\+E\+D void elm\+\_\+icon\+\_\+smooth\+\_\+set (
\begin{DoxyParamCaption}
\item[{Evas\+\_\+\+Object $\ast$}]{obj, }
\item[{Eina\+\_\+\+Bool}]{smooth}
\end{DoxyParamCaption}
)}\label{group__Icon_gada290e2867b9c2548306f7b875dae22d}


Set the smooth scaling for an icon object. 


\begin{DoxyParams}{Parameters}
{\em obj} & The icon object \\
\hline
{\em smooth} & {\ttfamily E\+I\+N\+A\+\_\+\+T\+R\+U\+E} if smooth scaling should be used, {\ttfamily E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E} otherwise. Default is {\ttfamily E\+I\+N\+A\+\_\+\+T\+R\+U\+E}.\\
\hline
\end{DoxyParams}
Set the scaling algorithm to be used when scaling the icon image. Smooth scaling provides a better resulting image, but is slower.

The smooth scaling should be disabled when making animations that change the icon size, since they will be faster. Animations that don\textquotesingle{}t require resizing of the icon can keep the smooth scaling enabled (even if the icon is already scaled, since the scaled icon image will be cached).

\begin{DoxySeeAlso}{See also}
\hyperlink{group__Icon_ga55dcaa0812cd19c48c426338a058bf33}{elm\+\_\+icon\+\_\+smooth\+\_\+get()}
\end{DoxySeeAlso}
\begin{DoxyRefDesc}{Deprecated}
\item[\hyperlink{deprecated__deprecated000050}{Deprecated}]Use elm\+\_\+image\+\_\+smooth\+\_\+set() instead.\end{DoxyRefDesc}
