\section{Index}
\label{group__Index}\index{Index@{Index}}
\subsection*{Functions}
\begin{DoxyCompactItemize}
\item 
Evas\+\_\+\+Object $\ast$ \hyperlink{group__Index_gaf7fda3a54ca154cdc754326137f3737e}{elm\+\_\+index\+\_\+add} (Evas\+\_\+\+Object $\ast$parent)
\begin{DoxyCompactList}\small\item\em Add a new index widget to the given parent Elementary (container) object. \end{DoxyCompactList}\end{DoxyCompactItemize}


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


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


An index widget gives you an index for fast access to whichever group of other U\+I items one might have. It\textquotesingle{}s a list of text items (usually letters, for alphabetically ordered access).

Index widgets are by default hidden and just appear when the user clicks over it\textquotesingle{}s reserved area in the canvas. In its default theme, it\textquotesingle{}s an area one \hyperlink{group__Fingers}{finger} wide on the right side of the index widget\textquotesingle{}s container.

When items on the index are selected, smart callbacks get called, so that its user can make other container objects to show a given area or child object depending on the index item selected. You\textquotesingle{}d probably be using an index together with \hyperlink{group__List}{lists}, \hyperlink{group__Genlist}{generic lists} or \hyperlink{group__Gengrid}{general grids}.

This widget inherits from the \hyperlink{group__Layout}{Layout} one, so that all the functions acting on it also work for index objects.

This widget emits the following signals, besides the ones sent from Layout\+:
\begin{DoxyItemize}
\item {\ttfamily \char`\"{}changed\char`\"{}} -\/ When the selected index item changes. {\ttfamily event\+\_\+info} is the selected item\textquotesingle{}s data pointer.
\item {\ttfamily \char`\"{}delay,changed\char`\"{}} -\/ When the selected index item changes, but after a small idling period. {\ttfamily event\+\_\+info} is the selected item\textquotesingle{}s data pointer.
\item {\ttfamily \char`\"{}selected\char`\"{}} -\/ When the user releases a mouse button and selects an item. {\ttfamily event\+\_\+info} is the selected item\textquotesingle{}s pointer.
\item {\ttfamily \char`\"{}level,up\char`\"{}} -\/ when the user moves a finger from the first level to the second level
\item {\ttfamily \char`\"{}level,down\char`\"{}} -\/ when the user moves a finger from the second level to the first level
\item {\ttfamily \char`\"{}language,changed\char`\"{}} -\/ the program\textquotesingle{}s language changed
\item {\ttfamily \char`\"{}focused\char`\"{}} -\/ When the index has received focus. (since 1.\+8)
\item {\ttfamily \char`\"{}unfocused\char`\"{}} -\/ When the index has lost focus. (since 1.\+8)
\end{DoxyItemize}

The {\ttfamily \char`\"{}delay,changed\char`\"{}} event is so that it\textquotesingle{}ll wait a small time before actually reporting those events and, moreover, just the last event happening on those time frames will actually be reported.

Supported elm\+\_\+object\+\_\+item common A\+P\+Is \begin{DoxyItemize}
\item elm\+\_\+object\+\_\+item\+\_\+del\end{DoxyItemize}
Here are some examples on its usage\+: \begin{DoxyItemize}
\item \hyperlink{index_example_01}{Index widget example 1} \item \hyperlink{index_example_02}{Index widget example 2} \end{DoxyItemize}


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


Add a new index widget to the given parent Elementary (container) object. 


\begin{DoxyParams}{Parameters}
{\em parent} & The parent object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
a new index widget handle or {\ttfamily N\+U\+L\+L}, on errors
\end{DoxyReturn}
This function inserts a new index widget on the canvas. 