\section{Tooltips}
\label{group__Tooltips}\index{Tooltips@{Tooltips}}


The Tooltip is an (internal, for now) smart object used to show a content in a frame on mouse hover of objects(or widgets), with tips/information about them.  


\subsection*{Typedefs}
\begin{DoxyCompactItemize}
\item 
typedef Evas\-\_\-\-Object $\ast$($\ast$ \hyperlink{group__Tooltips_gac5f0b5d4148f18b50b58f4766778cfea}{Elm\-\_\-\-Tooltip\-\_\-\-Content\-\_\-\-Cb} )(void $\ast$data, Evas\-\_\-\-Object $\ast$obj, Evas\-\_\-\-Object $\ast$tooltip)
\begin{DoxyCompactList}\small\item\em Called back when a widget's tooltip is activated and needs content. \end{DoxyCompactList}\item 
typedef Evas\-\_\-\-Object $\ast$($\ast$ \hyperlink{group__Tooltips_ga61723c10b93bab2d0138f675b5581c6c}{Elm\-\_\-\-Tooltip\-\_\-\-Item\-\_\-\-Content\-\_\-\-Cb} )(void $\ast$data, Evas\-\_\-\-Object $\ast$obj, Evas\-\_\-\-Object $\ast$tooltip, void $\ast$item)
\begin{DoxyCompactList}\small\item\em Called back when a widget's item tooltip is activated and needs content. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Functions}
\begin{DoxyCompactItemize}
\item 
void \hyperlink{group__Tooltips_ga39cb2ed8b9aa233c9f4f4e6f2331fee5}{elm\-\_\-object\-\_\-tooltip\-\_\-show} (Evas\-\_\-\-Object $\ast$obj)
\begin{DoxyCompactList}\small\item\em Force show tooltip of object. \end{DoxyCompactList}\item 
void \hyperlink{group__Tooltips_gae58e8a6559f45ab89ad34bb567ea4d68}{elm\-\_\-object\-\_\-tooltip\-\_\-hide} (Evas\-\_\-\-Object $\ast$obj)
\begin{DoxyCompactList}\small\item\em Force hide tooltip of object. \end{DoxyCompactList}\item 
void \hyperlink{group__Tooltips_ga9c7ff33c2e32a3dd5b5b2817393d540f}{elm\-\_\-object\-\_\-tooltip\-\_\-text\-\_\-set} (Evas\-\_\-\-Object $\ast$obj, const char $\ast$text)
\begin{DoxyCompactList}\small\item\em Set the text to be displayed inside the tooltip. \end{DoxyCompactList}\item 
void \hyperlink{group__Tooltips_ga48abfdf4d0296fe7241bfbeb7756aae8}{elm\-\_\-object\-\_\-tooltip\-\_\-content\-\_\-cb\-\_\-set} (Evas\-\_\-\-Object $\ast$obj, \hyperlink{group__Tooltips_gac5f0b5d4148f18b50b58f4766778cfea}{Elm\-\_\-\-Tooltip\-\_\-\-Content\-\_\-\-Cb} func, const void $\ast$data, Evas\-\_\-\-Smart\-\_\-\-Cb del\-\_\-cb)
\begin{DoxyCompactList}\small\item\em Set the content to be shown in the tooltip object. \end{DoxyCompactList}\item 
void \hyperlink{group__Tooltips_gaaecd5662e5859fe32315eca8561712be}{elm\-\_\-object\-\_\-tooltip\-\_\-unset} (Evas\-\_\-\-Object $\ast$obj)
\begin{DoxyCompactList}\small\item\em Unset tooltip from object. \end{DoxyCompactList}\item 
void \hyperlink{group__Tooltips_gaeda013d8330b2d394155b809f77869d6}{elm\-\_\-object\-\_\-tooltip\-\_\-style\-\_\-set} (Evas\-\_\-\-Object $\ast$obj, const char $\ast$style)
\begin{DoxyCompactList}\small\item\em Sets a different style for this object tooltip. \end{DoxyCompactList}\item 
const char $\ast$ \hyperlink{group__Tooltips_ga689b4374c6cfa0085d911116549ffc58}{elm\-\_\-object\-\_\-tooltip\-\_\-style\-\_\-get} (const Evas\-\_\-\-Object $\ast$obj)
\begin{DoxyCompactList}\small\item\em Get the style for this object tooltip. \end{DoxyCompactList}\item 
Eina\-\_\-\-Bool \hyperlink{group__Tooltips_ga80c2ff9caef20371c7cc12d3f09612a2}{elm\-\_\-object\-\_\-tooltip\-\_\-window\-\_\-mode\-\_\-set} (Evas\-\_\-\-Object $\ast$obj, Eina\-\_\-\-Bool disable)
\begin{DoxyCompactList}\small\item\em Disable size restrictions on an object's tooltip. \end{DoxyCompactList}\item 
Eina\-\_\-\-Bool \hyperlink{group__Tooltips_ga0014899c363e973ebc4d8bd0b34ddbe3}{elm\-\_\-object\-\_\-tooltip\-\_\-window\-\_\-mode\-\_\-get} (const Evas\-\_\-\-Object $\ast$obj)
\begin{DoxyCompactList}\small\item\em Retrieve size restriction state of an object's tooltip. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
The Tooltip is an (internal, for now) smart object used to show a content in a frame on mouse hover of objects(or widgets), with tips/information about them. 

\subsection{Typedef Documentation}
\index{Tooltips@{Tooltips}!Elm\-\_\-\-Tooltip\-\_\-\-Content\-\_\-\-Cb@{Elm\-\_\-\-Tooltip\-\_\-\-Content\-\_\-\-Cb}}
\index{Elm\-\_\-\-Tooltip\-\_\-\-Content\-\_\-\-Cb@{Elm\-\_\-\-Tooltip\-\_\-\-Content\-\_\-\-Cb}!Tooltips@{Tooltips}}
\subsubsection[{Elm\-\_\-\-Tooltip\-\_\-\-Content\-\_\-\-Cb}]{\setlength{\rightskip}{0pt plus 5cm}typedef Evas\-\_\-\-Object$\ast$($\ast$ Elm\-\_\-\-Tooltip\-\_\-\-Content\-\_\-\-Cb)(void $\ast$data, Evas\-\_\-\-Object $\ast$obj, Evas\-\_\-\-Object $\ast$tooltip)}\label{group__Tooltips_gac5f0b5d4148f18b50b58f4766778cfea}


Called back when a widget's tooltip is activated and needs content. 


\begin{DoxyParams}{Parameters}
{\em data} & user-\/data given to \hyperlink{group__Tooltips_ga48abfdf4d0296fe7241bfbeb7756aae8}{elm\-\_\-object\-\_\-tooltip\-\_\-content\-\_\-cb\-\_\-set()} \\
\hline
{\em obj} & owner widget. \\
\hline
{\em tooltip} & The tooltip object (affix content to this!) \\
\hline
\end{DoxyParams}
\index{Tooltips@{Tooltips}!Elm\-\_\-\-Tooltip\-\_\-\-Item\-\_\-\-Content\-\_\-\-Cb@{Elm\-\_\-\-Tooltip\-\_\-\-Item\-\_\-\-Content\-\_\-\-Cb}}
\index{Elm\-\_\-\-Tooltip\-\_\-\-Item\-\_\-\-Content\-\_\-\-Cb@{Elm\-\_\-\-Tooltip\-\_\-\-Item\-\_\-\-Content\-\_\-\-Cb}!Tooltips@{Tooltips}}
\subsubsection[{Elm\-\_\-\-Tooltip\-\_\-\-Item\-\_\-\-Content\-\_\-\-Cb}]{\setlength{\rightskip}{0pt plus 5cm}typedef Evas\-\_\-\-Object$\ast$($\ast$ Elm\-\_\-\-Tooltip\-\_\-\-Item\-\_\-\-Content\-\_\-\-Cb)(void $\ast$data, Evas\-\_\-\-Object $\ast$obj, Evas\-\_\-\-Object $\ast$tooltip, void $\ast$item)}\label{group__Tooltips_ga61723c10b93bab2d0138f675b5581c6c}


Called back when a widget's item tooltip is activated and needs content. 


\begin{DoxyParams}{Parameters}
{\em data} & user-\/data given to \hyperlink{group__Tooltips_ga48abfdf4d0296fe7241bfbeb7756aae8}{elm\-\_\-object\-\_\-tooltip\-\_\-content\-\_\-cb\-\_\-set()} \\
\hline
{\em obj} & owner widget. \\
\hline
{\em tooltip} & The tooltip object (affix content to this!) \\
\hline
{\em item} & context dependent item. As an example, if tooltip was set on elm\-\_\-list item, then it is of this type. \\
\hline
\end{DoxyParams}


\subsection{Function Documentation}
\index{Tooltips@{Tooltips}!elm\-\_\-object\-\_\-tooltip\-\_\-content\-\_\-cb\-\_\-set@{elm\-\_\-object\-\_\-tooltip\-\_\-content\-\_\-cb\-\_\-set}}
\index{elm\-\_\-object\-\_\-tooltip\-\_\-content\-\_\-cb\-\_\-set@{elm\-\_\-object\-\_\-tooltip\-\_\-content\-\_\-cb\-\_\-set}!Tooltips@{Tooltips}}
\subsubsection[{elm\-\_\-object\-\_\-tooltip\-\_\-content\-\_\-cb\-\_\-set}]{\setlength{\rightskip}{0pt plus 5cm}E\-A\-P\-I void elm\-\_\-object\-\_\-tooltip\-\_\-content\-\_\-cb\-\_\-set (
\begin{DoxyParamCaption}
\item[{Evas\-\_\-\-Object $\ast$}]{obj, }
\item[{{\bf Elm\-\_\-\-Tooltip\-\_\-\-Content\-\_\-\-Cb}}]{func, }
\item[{const void $\ast$}]{data, }
\item[{Evas\-\_\-\-Smart\-\_\-\-Cb}]{del\-\_\-cb}
\end{DoxyParamCaption}
)}\label{group__Tooltips_ga48abfdf4d0296fe7241bfbeb7756aae8}


Set the content to be shown in the tooltip object. 

Setup the tooltip to object. The object can have only one tooltip, so any previous tooltip data is removed. {\ttfamily func}(with {\ttfamily data}) will be called every time that need show the tooltip and it should return a valid Evas\-\_\-\-Object. This object is then managed fully by tooltip system and is deleted when the tooltip is gone.


\begin{DoxyParams}{Parameters}
{\em obj} & the object being attached a tooltip. \\
\hline
{\em func} & the function used to create the tooltip contents. \\
\hline
{\em data} & what to provide to {\itshape func} as callback data/context. \\
\hline
{\em del\-\_\-cb} & called when data is not needed anymore, either when another callback replaces {\ttfamily func}, the tooltip is unset with \hyperlink{group__Tooltips_gaaecd5662e5859fe32315eca8561712be}{elm\-\_\-object\-\_\-tooltip\-\_\-unset()} or the owner object {\itshape obj} dies. This callback receives as the first parameter the given {\itshape data}, and {\ttfamily event\-\_\-info} is N\-U\-L\-L. \\
\hline
\end{DoxyParams}


Referenced by elm\-\_\-object\-\_\-tooltip\-\_\-text\-\_\-set().

\index{Tooltips@{Tooltips}!elm\-\_\-object\-\_\-tooltip\-\_\-hide@{elm\-\_\-object\-\_\-tooltip\-\_\-hide}}
\index{elm\-\_\-object\-\_\-tooltip\-\_\-hide@{elm\-\_\-object\-\_\-tooltip\-\_\-hide}!Tooltips@{Tooltips}}
\subsubsection[{elm\-\_\-object\-\_\-tooltip\-\_\-hide}]{\setlength{\rightskip}{0pt plus 5cm}E\-A\-P\-I void elm\-\_\-object\-\_\-tooltip\-\_\-hide (
\begin{DoxyParamCaption}
\item[{Evas\-\_\-\-Object $\ast$}]{obj}
\end{DoxyParamCaption}
)}\label{group__Tooltips_gae58e8a6559f45ab89ad34bb567ea4d68}


Force hide tooltip of object. 


\begin{DoxyParams}{Parameters}
{\em obj} & Target object\\
\hline
\end{DoxyParams}
Force hide the tooltip and (re)enable future mouse interations. \index{Tooltips@{Tooltips}!elm\-\_\-object\-\_\-tooltip\-\_\-show@{elm\-\_\-object\-\_\-tooltip\-\_\-show}}
\index{elm\-\_\-object\-\_\-tooltip\-\_\-show@{elm\-\_\-object\-\_\-tooltip\-\_\-show}!Tooltips@{Tooltips}}
\subsubsection[{elm\-\_\-object\-\_\-tooltip\-\_\-show}]{\setlength{\rightskip}{0pt plus 5cm}E\-A\-P\-I void elm\-\_\-object\-\_\-tooltip\-\_\-show (
\begin{DoxyParamCaption}
\item[{Evas\-\_\-\-Object $\ast$}]{obj}
\end{DoxyParamCaption}
)}\label{group__Tooltips_ga39cb2ed8b9aa233c9f4f4e6f2331fee5}


Force show tooltip of object. 


\begin{DoxyParams}{Parameters}
{\em obj} & Target object\\
\hline
\end{DoxyParams}
Force show the tooltip and disable hide on mouse\-\_\-out. If another content is set as tooltip, the visible tooltip will hididen and showed again with new content. This can force show more than one tooltip at a time. \index{Tooltips@{Tooltips}!elm\-\_\-object\-\_\-tooltip\-\_\-style\-\_\-get@{elm\-\_\-object\-\_\-tooltip\-\_\-style\-\_\-get}}
\index{elm\-\_\-object\-\_\-tooltip\-\_\-style\-\_\-get@{elm\-\_\-object\-\_\-tooltip\-\_\-style\-\_\-get}!Tooltips@{Tooltips}}
\subsubsection[{elm\-\_\-object\-\_\-tooltip\-\_\-style\-\_\-get}]{\setlength{\rightskip}{0pt plus 5cm}const char$\ast$ elm\-\_\-object\-\_\-tooltip\-\_\-style\-\_\-get (
\begin{DoxyParamCaption}
\item[{const Evas\-\_\-\-Object $\ast$}]{obj}
\end{DoxyParamCaption}
)}\label{group__Tooltips_ga689b4374c6cfa0085d911116549ffc58}


Get the style for this object tooltip. 


\begin{DoxyParams}{Parameters}
{\em obj} & an object with tooltip already set. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
style the theme style in use, defaults to \char`\"{}default\char`\"{}. If the object does not have a tooltip set, then N\-U\-L\-L is returned. 
\end{DoxyReturn}
\index{Tooltips@{Tooltips}!elm\-\_\-object\-\_\-tooltip\-\_\-style\-\_\-set@{elm\-\_\-object\-\_\-tooltip\-\_\-style\-\_\-set}}
\index{elm\-\_\-object\-\_\-tooltip\-\_\-style\-\_\-set@{elm\-\_\-object\-\_\-tooltip\-\_\-style\-\_\-set}!Tooltips@{Tooltips}}
\subsubsection[{elm\-\_\-object\-\_\-tooltip\-\_\-style\-\_\-set}]{\setlength{\rightskip}{0pt plus 5cm}void elm\-\_\-object\-\_\-tooltip\-\_\-style\-\_\-set (
\begin{DoxyParamCaption}
\item[{Evas\-\_\-\-Object $\ast$}]{obj, }
\item[{const char $\ast$}]{style}
\end{DoxyParamCaption}
)}\label{group__Tooltips_gaeda013d8330b2d394155b809f77869d6}


Sets a different style for this object tooltip. 

\begin{DoxyNote}{Note}
before you set a style you should define a tooltip with \hyperlink{group__Tooltips_ga48abfdf4d0296fe7241bfbeb7756aae8}{elm\-\_\-object\-\_\-tooltip\-\_\-content\-\_\-cb\-\_\-set()} or \hyperlink{group__Tooltips_ga9c7ff33c2e32a3dd5b5b2817393d540f}{elm\-\_\-object\-\_\-tooltip\-\_\-text\-\_\-set()}.
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em obj} & an object with tooltip already set. \\
\hline
{\em style} & the theme style to use (default, transparent, ...) \\
\hline
\end{DoxyParams}
\index{Tooltips@{Tooltips}!elm\-\_\-object\-\_\-tooltip\-\_\-text\-\_\-set@{elm\-\_\-object\-\_\-tooltip\-\_\-text\-\_\-set}}
\index{elm\-\_\-object\-\_\-tooltip\-\_\-text\-\_\-set@{elm\-\_\-object\-\_\-tooltip\-\_\-text\-\_\-set}!Tooltips@{Tooltips}}
\subsubsection[{elm\-\_\-object\-\_\-tooltip\-\_\-text\-\_\-set}]{\setlength{\rightskip}{0pt plus 5cm}E\-A\-P\-I void elm\-\_\-object\-\_\-tooltip\-\_\-text\-\_\-set (
\begin{DoxyParamCaption}
\item[{Evas\-\_\-\-Object $\ast$}]{obj, }
\item[{const char $\ast$}]{text}
\end{DoxyParamCaption}
)}\label{group__Tooltips_ga9c7ff33c2e32a3dd5b5b2817393d540f}


Set the text to be displayed inside the tooltip. 

Set the text to be shown in the tooltip object.


\begin{DoxyParams}{Parameters}
{\em obj} & The tooltip object. \\
\hline
{\em text} & The text to be displayed.\\
\hline
{\em obj} & Target object \\
\hline
{\em text} & The text to set in the content\\
\hline
\end{DoxyParams}
Setup the text as tooltip to object. The object can have only one tooltip, so any previous tooltip data is removed. This method call internaly the elm\-\_\-tooltip\-\_\-content\-\_\-cb\-\_\-set(). 

References elm\-\_\-object\-\_\-tooltip\-\_\-content\-\_\-cb\-\_\-set().

\index{Tooltips@{Tooltips}!elm\-\_\-object\-\_\-tooltip\-\_\-unset@{elm\-\_\-object\-\_\-tooltip\-\_\-unset}}
\index{elm\-\_\-object\-\_\-tooltip\-\_\-unset@{elm\-\_\-object\-\_\-tooltip\-\_\-unset}!Tooltips@{Tooltips}}
\subsubsection[{elm\-\_\-object\-\_\-tooltip\-\_\-unset}]{\setlength{\rightskip}{0pt plus 5cm}E\-A\-P\-I void elm\-\_\-object\-\_\-tooltip\-\_\-unset (
\begin{DoxyParamCaption}
\item[{Evas\-\_\-\-Object $\ast$}]{obj}
\end{DoxyParamCaption}
)}\label{group__Tooltips_gaaecd5662e5859fe32315eca8561712be}


Unset tooltip from object. 


\begin{DoxyParams}{Parameters}
{\em obj} & Target object\\
\hline
\end{DoxyParams}
Remove tooltip from object. The callback provided as del\-\_\-cb to \hyperlink{group__Tooltips_ga48abfdf4d0296fe7241bfbeb7756aae8}{elm\-\_\-object\-\_\-tooltip\-\_\-content\-\_\-cb\-\_\-set()} will be called to notify it is not used anymore.

\begin{DoxySeeAlso}{See Also}
\hyperlink{group__Tooltips_ga48abfdf4d0296fe7241bfbeb7756aae8}{elm\-\_\-object\-\_\-tooltip\-\_\-content\-\_\-cb\-\_\-set()} 
\end{DoxySeeAlso}
\index{Tooltips@{Tooltips}!elm\-\_\-object\-\_\-tooltip\-\_\-window\-\_\-mode\-\_\-get@{elm\-\_\-object\-\_\-tooltip\-\_\-window\-\_\-mode\-\_\-get}}
\index{elm\-\_\-object\-\_\-tooltip\-\_\-window\-\_\-mode\-\_\-get@{elm\-\_\-object\-\_\-tooltip\-\_\-window\-\_\-mode\-\_\-get}!Tooltips@{Tooltips}}
\subsubsection[{elm\-\_\-object\-\_\-tooltip\-\_\-window\-\_\-mode\-\_\-get}]{\setlength{\rightskip}{0pt plus 5cm}Eina\-\_\-\-Bool elm\-\_\-object\-\_\-tooltip\-\_\-window\-\_\-mode\-\_\-get (
\begin{DoxyParamCaption}
\item[{const Evas\-\_\-\-Object $\ast$}]{obj}
\end{DoxyParamCaption}
)}\label{group__Tooltips_ga0014899c363e973ebc4d8bd0b34ddbe3}


Retrieve size restriction state of an object's tooltip. 


\begin{DoxyParams}{Parameters}
{\em obj} & The tooltip's anchor object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
If E\-I\-N\-A\-\_\-\-T\-R\-U\-E, size restrictions are disabled
\end{DoxyReturn}
This function returns whether a tooltip is allowed to expand beyond its parent window's canvas. It will instead be limited only by the size of the display. \index{Tooltips@{Tooltips}!elm\-\_\-object\-\_\-tooltip\-\_\-window\-\_\-mode\-\_\-set@{elm\-\_\-object\-\_\-tooltip\-\_\-window\-\_\-mode\-\_\-set}}
\index{elm\-\_\-object\-\_\-tooltip\-\_\-window\-\_\-mode\-\_\-set@{elm\-\_\-object\-\_\-tooltip\-\_\-window\-\_\-mode\-\_\-set}!Tooltips@{Tooltips}}
\subsubsection[{elm\-\_\-object\-\_\-tooltip\-\_\-window\-\_\-mode\-\_\-set}]{\setlength{\rightskip}{0pt plus 5cm}Eina\-\_\-\-Bool elm\-\_\-object\-\_\-tooltip\-\_\-window\-\_\-mode\-\_\-set (
\begin{DoxyParamCaption}
\item[{Evas\-\_\-\-Object $\ast$}]{obj, }
\item[{Eina\-\_\-\-Bool}]{disable}
\end{DoxyParamCaption}
)}\label{group__Tooltips_ga80c2ff9caef20371c7cc12d3f09612a2}


Disable size restrictions on an object's tooltip. 


\begin{DoxyParams}{Parameters}
{\em obj} & The tooltip's anchor object \\
\hline
{\em disable} & If E\-I\-N\-A\-\_\-\-T\-R\-U\-E, size restrictions are disabled \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
E\-I\-N\-A\-\_\-\-F\-A\-L\-S\-E on failure, E\-I\-N\-A\-\_\-\-T\-R\-U\-E on success
\end{DoxyReturn}
This function allows a tooltip to expand beyond its parent window's canvas. It will instead be limited only by the size of the display. 