\section{Index}
\label{group__Index}\index{Index@{Index}}
\subsection*{Functions}
\begin{DoxyCompactItemize}
\item 
E\+O\+A\+P\+I void \hyperlink{group__Index_ga2948edcd0e9d24ab1daae55ab043e217}{elm\+\_\+obj\+\_\+index\+\_\+autohide\+\_\+disabled\+\_\+set} (Eina\+\_\+\+Bool disabled)
\begin{DoxyCompactList}\small\item\em Enable or disable auto hiding feature for a given index widget. \end{DoxyCompactList}\item 
E\+O\+A\+P\+I Eina\+\_\+\+Bool \hyperlink{group__Index_gab898191aa43b9644939e96a58ba63cfb}{elm\+\_\+obj\+\_\+index\+\_\+autohide\+\_\+disabled\+\_\+get} (void)
\begin{DoxyCompactList}\small\item\em Get whether auto hiding feature is enabled or not for a given index widget. \end{DoxyCompactList}\item 
E\+O\+A\+P\+I void \hyperlink{group__Index_gab1bf407171eed21f024ebe6a8bbc7530}{elm\+\_\+obj\+\_\+index\+\_\+omit\+\_\+enabled\+\_\+set} (Eina\+\_\+\+Bool enabled)
\begin{DoxyCompactList}\small\item\em Enable or disable omit feature for a given index widget. \end{DoxyCompactList}\item 
E\+O\+A\+P\+I Eina\+\_\+\+Bool \hyperlink{group__Index_ga676741d03a394815bedc26f9623b3166}{elm\+\_\+obj\+\_\+index\+\_\+omit\+\_\+enabled\+\_\+get} (void)
\begin{DoxyCompactList}\small\item\em Get whether omit feature is enabled or not for a given index widget. \end{DoxyCompactList}\item 
E\+O\+A\+P\+I void \hyperlink{group__Index_ga3e423ce741e6efd55409dbefb42630c1}{elm\+\_\+obj\+\_\+index\+\_\+horizontal\+\_\+set} (Eina\+\_\+\+Bool horizontal)
\begin{DoxyCompactList}\small\item\em Enable or disable horizontal mode on the index object. \end{DoxyCompactList}\item 
E\+O\+A\+P\+I Eina\+\_\+\+Bool \hyperlink{group__Index_ga2899442dee209332c7b665fddaa24f73}{elm\+\_\+obj\+\_\+index\+\_\+horizontal\+\_\+get} (void)
\begin{DoxyCompactList}\small\item\em Get a value whether horizontal mode is enabled or not. \end{DoxyCompactList}\item 
E\+O\+A\+P\+I void \hyperlink{group__Index_ga26bd79b193afc066c3879633e98bbba7}{elm\+\_\+obj\+\_\+index\+\_\+delay\+\_\+change\+\_\+time\+\_\+set} (double dtime)
\begin{DoxyCompactList}\small\item\em Set a delay change time for index object. \end{DoxyCompactList}\item 
E\+O\+A\+P\+I double \hyperlink{group__Index_ga868f5eac9259cede9eb6dfbf42faf8ee}{elm\+\_\+obj\+\_\+index\+\_\+delay\+\_\+change\+\_\+time\+\_\+get} (void)
\begin{DoxyCompactList}\small\item\em Get a delay change time for index object. \end{DoxyCompactList}\item 
E\+O\+A\+P\+I void \hyperlink{group__Index_ga07c136658bfdc559039dbeefd45313d9}{elm\+\_\+obj\+\_\+index\+\_\+indicator\+\_\+disabled\+\_\+set} (Eina\+\_\+\+Bool disabled)
\begin{DoxyCompactList}\small\item\em Set the indicator as to be disabled. \end{DoxyCompactList}\item 
E\+O\+A\+P\+I Eina\+\_\+\+Bool \hyperlink{group__Index_gaef593dd55d186821cfc8369d83c8abbd}{elm\+\_\+obj\+\_\+index\+\_\+indicator\+\_\+disabled\+\_\+get} (void)
\begin{DoxyCompactList}\small\item\em Get the value of indicator\textquotesingle{}s disabled status. \end{DoxyCompactList}\item 
E\+O\+A\+P\+I void \hyperlink{group__Index_gab87367c1ec331e5a3b5932f2182f8734}{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+level\+\_\+set} (int level)
\begin{DoxyCompactList}\small\item\em Set the items level for a given index widget. \end{DoxyCompactList}\item 
E\+O\+A\+P\+I int \hyperlink{group__Index_gafc18b2d5558ac9d86ffcdb1b4d22c66d}{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+level\+\_\+get} (void)
\begin{DoxyCompactList}\small\item\em Get the items level set for a given index widget. \end{DoxyCompactList}\item 
E\+O\+A\+P\+I void \hyperlink{group__Index_gae8504f9144be0c32c1288e855137ff16}{elm\+\_\+obj\+\_\+index\+\_\+level\+\_\+go} (int level)
\begin{DoxyCompactList}\small\item\em Flush the changes made to the index items so they work correctly. \end{DoxyCompactList}\item 
E\+O\+A\+P\+I \hyperlink{group__General_ga13a0c231414b86e62f68afe3c6fb462b}{Elm\+\_\+\+Object\+\_\+\+Item} $\ast$ \hyperlink{group__Index_gaf620fc1fe9083c185ac8b16c3c8eb680}{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+prepend} (const char $\ast$letter, Evas\+\_\+\+Smart\+\_\+\+Cb func, const void $\ast$data)
\begin{DoxyCompactList}\small\item\em Prepend a new item on a given index widget. \end{DoxyCompactList}\item 
E\+O\+A\+P\+I void \hyperlink{group__Index_ga86db51d5e9ddd52c229f1ff6a32263c6}{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+clear} (void)
\begin{DoxyCompactList}\small\item\em Removes {\bfseries all} items from a given index widget. \end{DoxyCompactList}\item 
E\+O\+A\+P\+I \hyperlink{group__General_ga13a0c231414b86e62f68afe3c6fb462b}{Elm\+\_\+\+Object\+\_\+\+Item} $\ast$ \hyperlink{group__Index_ga0c27c8ceab3fb9f4378218a0bb860dc7}{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+insert\+\_\+after} (\hyperlink{group__General_ga13a0c231414b86e62f68afe3c6fb462b}{Elm\+\_\+\+Object\+\_\+\+Item} $\ast$after, const char $\ast$letter, Evas\+\_\+\+Smart\+\_\+\+Cb func, const void $\ast$data)
\begin{DoxyCompactList}\small\item\em Insert a new item into the index object after item {\ttfamily after}. \end{DoxyCompactList}\item 
E\+O\+A\+P\+I \hyperlink{group__General_ga13a0c231414b86e62f68afe3c6fb462b}{Elm\+\_\+\+Object\+\_\+\+Item} $\ast$ \hyperlink{group__Index_ga2f47388ce1f420de6e3006a8adf56f0a}{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+find} (const void $\ast$data)
\begin{DoxyCompactList}\small\item\em Find a given index widget\textquotesingle{}s item, {\bfseries using item data}. \end{DoxyCompactList}\item 
E\+O\+A\+P\+I \hyperlink{group__General_ga13a0c231414b86e62f68afe3c6fb462b}{Elm\+\_\+\+Object\+\_\+\+Item} $\ast$ \hyperlink{group__Index_ga7af4814a4377e72846bd0b56788021ab}{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+insert\+\_\+before} (\hyperlink{group__General_ga13a0c231414b86e62f68afe3c6fb462b}{Elm\+\_\+\+Object\+\_\+\+Item} $\ast$before, const char $\ast$letter, Evas\+\_\+\+Smart\+\_\+\+Cb func, const void $\ast$data)
\begin{DoxyCompactList}\small\item\em Insert a new item into the index object before item {\ttfamily before}. \end{DoxyCompactList}\item 
E\+O\+A\+P\+I \hyperlink{group__General_ga13a0c231414b86e62f68afe3c6fb462b}{Elm\+\_\+\+Object\+\_\+\+Item} $\ast$ \hyperlink{group__Index_ga5fcfbd4546f6d337391db6443bb81315}{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+append} (const char $\ast$letter, Evas\+\_\+\+Smart\+\_\+\+Cb func, const void $\ast$data)
\begin{DoxyCompactList}\small\item\em Append a new item on a given index widget. \end{DoxyCompactList}\item 
E\+O\+A\+P\+I \hyperlink{group__General_ga13a0c231414b86e62f68afe3c6fb462b}{Elm\+\_\+\+Object\+\_\+\+Item} $\ast$ \hyperlink{group__Index_ga3a6acc2dc6181db11616e852632b2e73}{elm\+\_\+obj\+\_\+index\+\_\+selected\+\_\+item\+\_\+get} (int level)
\begin{DoxyCompactList}\small\item\em Returns the last selected item, for a given index widget. \end{DoxyCompactList}\item 
E\+O\+A\+P\+I \hyperlink{group__General_ga13a0c231414b86e62f68afe3c6fb462b}{Elm\+\_\+\+Object\+\_\+\+Item} $\ast$ \hyperlink{group__Index_gaf3b2bf9cdcf74436548462ccbc3107fc}{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+sorted\+\_\+insert} (const char $\ast$letter, Evas\+\_\+\+Smart\+\_\+\+Cb func, const void $\ast$data, Eina\+\_\+\+Compare\+\_\+\+Cb cmp\+\_\+func, Eina\+\_\+\+Compare\+\_\+\+Cb cmp\+\_\+data\+\_\+func)
\begin{DoxyCompactList}\small\item\em Insert a new item into the given index widget, using {\ttfamily cmp\+\_\+func} function to sort items (by item handles). \end{DoxyCompactList}\item 
void \hyperlink{group__Index_ga6569179b38d11fb5fb1286815cf846fb}{elm\+\_\+index\+\_\+autohide\+\_\+disabled\+\_\+set} (Elm\+\_\+\+Index $\ast$obj, Eina\+\_\+\+Bool disabled)
\begin{DoxyCompactList}\small\item\em Enable or disable auto hiding feature for a given index widget. \end{DoxyCompactList}\item 
Eina\+\_\+\+Bool \hyperlink{group__Index_ga4b1a080a5ddba56e53d16f97cdcfb3a1}{elm\+\_\+index\+\_\+autohide\+\_\+disabled\+\_\+get} (const Elm\+\_\+\+Index $\ast$obj)
\begin{DoxyCompactList}\small\item\em Get whether auto hiding feature is enabled or not for a given index widget. \end{DoxyCompactList}\item 
void \hyperlink{group__Index_gaae1377e77395cab18ba7a68bc6e0f66f}{elm\+\_\+index\+\_\+omit\+\_\+enabled\+\_\+set} (Elm\+\_\+\+Index $\ast$obj, Eina\+\_\+\+Bool enabled)
\begin{DoxyCompactList}\small\item\em Enable or disable omit feature for a given index widget. \end{DoxyCompactList}\item 
Eina\+\_\+\+Bool \hyperlink{group__Index_ga53c51630158c198ada3463a046e11bf3}{elm\+\_\+index\+\_\+omit\+\_\+enabled\+\_\+get} (const Elm\+\_\+\+Index $\ast$obj)
\begin{DoxyCompactList}\small\item\em Get whether omit feature is enabled or not for a given index widget. \end{DoxyCompactList}\item 
void \hyperlink{group__Index_gab692af2d53bdfb5d043fccb84a0fc681}{elm\+\_\+index\+\_\+horizontal\+\_\+set} (Elm\+\_\+\+Index $\ast$obj, Eina\+\_\+\+Bool horizontal)
\begin{DoxyCompactList}\small\item\em Enable or disable horizontal mode on the index object. \end{DoxyCompactList}\item 
Eina\+\_\+\+Bool \hyperlink{group__Index_gaf48b49e2ad3fe94ab8dfbe01d8b4fe77}{elm\+\_\+index\+\_\+horizontal\+\_\+get} (const Elm\+\_\+\+Index $\ast$obj)
\begin{DoxyCompactList}\small\item\em Get a value whether horizontal mode is enabled or not. \end{DoxyCompactList}\item 
void \hyperlink{group__Index_gaf4ee573a9b2bce298115ea65cacd2d0c}{elm\+\_\+index\+\_\+delay\+\_\+change\+\_\+time\+\_\+set} (Elm\+\_\+\+Index $\ast$obj, double dtime)
\begin{DoxyCompactList}\small\item\em Set a delay change time for index object. \end{DoxyCompactList}\item 
double \hyperlink{group__Index_ga462ca31df319b26068c3a3bd719b12a1}{elm\+\_\+index\+\_\+delay\+\_\+change\+\_\+time\+\_\+get} (const Elm\+\_\+\+Index $\ast$obj)
\begin{DoxyCompactList}\small\item\em Get a delay change time for index object. \end{DoxyCompactList}\item 
void \hyperlink{group__Index_ga91a560f52fbbd4701eb0fbdc6fd00021}{elm\+\_\+index\+\_\+indicator\+\_\+disabled\+\_\+set} (Elm\+\_\+\+Index $\ast$obj, Eina\+\_\+\+Bool disabled)
\begin{DoxyCompactList}\small\item\em Set the indicator as to be disabled. \end{DoxyCompactList}\item 
Eina\+\_\+\+Bool \hyperlink{group__Index_gab34a2f658cc248f3f569d8dc05069d47}{elm\+\_\+index\+\_\+indicator\+\_\+disabled\+\_\+get} (const Elm\+\_\+\+Index $\ast$obj)
\begin{DoxyCompactList}\small\item\em Get the value of indicator\textquotesingle{}s disabled status. \end{DoxyCompactList}\item 
void \hyperlink{group__Index_ga2c11e086e69792d90864fbf259b3ca2d}{elm\+\_\+index\+\_\+item\+\_\+level\+\_\+set} (Elm\+\_\+\+Index $\ast$obj, int level)
\begin{DoxyCompactList}\small\item\em Set the items level for a given index widget. \end{DoxyCompactList}\item 
int \hyperlink{group__Index_ga545438c3478927e96e168c04df253477}{elm\+\_\+index\+\_\+item\+\_\+level\+\_\+get} (const Elm\+\_\+\+Index $\ast$obj)
\begin{DoxyCompactList}\small\item\em Get the items level set for a given index widget. \end{DoxyCompactList}\item 
void \hyperlink{group__Index_ga3bb92a868f63463403668a4bbcda21d1}{elm\+\_\+index\+\_\+level\+\_\+go} (Elm\+\_\+\+Index $\ast$obj, int level)
\begin{DoxyCompactList}\small\item\em Flush the changes made to the index items so they work correctly. \end{DoxyCompactList}\item 
\hyperlink{group__General_ga13a0c231414b86e62f68afe3c6fb462b}{Elm\+\_\+\+Object\+\_\+\+Item} $\ast$ \hyperlink{group__Index_gaa8b9c57438e6d25be306431fd83b339a}{elm\+\_\+index\+\_\+item\+\_\+prepend} (Elm\+\_\+\+Index $\ast$obj, const char $\ast$letter, Evas\+\_\+\+Smart\+\_\+\+Cb func, const void $\ast$data)
\begin{DoxyCompactList}\small\item\em Prepend a new item on a given index widget. \end{DoxyCompactList}\item 
void \hyperlink{group__Index_ga9c0c1ff500522b62a674b36beafe7a19}{elm\+\_\+index\+\_\+item\+\_\+clear} (Elm\+\_\+\+Index $\ast$obj)
\begin{DoxyCompactList}\small\item\em Removes {\bfseries all} items from a given index widget. \end{DoxyCompactList}\item 
\hyperlink{group__General_ga13a0c231414b86e62f68afe3c6fb462b}{Elm\+\_\+\+Object\+\_\+\+Item} $\ast$ \hyperlink{group__Index_ga72579e5f95f26f99be39fbe73a7a90ca}{elm\+\_\+index\+\_\+item\+\_\+insert\+\_\+after} (Elm\+\_\+\+Index $\ast$obj, \hyperlink{group__General_ga13a0c231414b86e62f68afe3c6fb462b}{Elm\+\_\+\+Object\+\_\+\+Item} $\ast$after, const char $\ast$letter, Evas\+\_\+\+Smart\+\_\+\+Cb func, const void $\ast$data)
\begin{DoxyCompactList}\small\item\em Insert a new item into the index object after item {\ttfamily after}. \end{DoxyCompactList}\item 
\hyperlink{group__General_ga13a0c231414b86e62f68afe3c6fb462b}{Elm\+\_\+\+Object\+\_\+\+Item} $\ast$ \hyperlink{group__Index_ga452b9d17cb79974ba1c5d2a0e8fca7d4}{elm\+\_\+index\+\_\+item\+\_\+find} (Elm\+\_\+\+Index $\ast$obj, const void $\ast$data)
\begin{DoxyCompactList}\small\item\em Find a given index widget\textquotesingle{}s item, {\bfseries using item data}. \end{DoxyCompactList}\item 
\hyperlink{group__General_ga13a0c231414b86e62f68afe3c6fb462b}{Elm\+\_\+\+Object\+\_\+\+Item} $\ast$ \hyperlink{group__Index_gaefa0d98f90029402f3b420f2ddf4a208}{elm\+\_\+index\+\_\+item\+\_\+insert\+\_\+before} (Elm\+\_\+\+Index $\ast$obj, \hyperlink{group__General_ga13a0c231414b86e62f68afe3c6fb462b}{Elm\+\_\+\+Object\+\_\+\+Item} $\ast$before, const char $\ast$letter, Evas\+\_\+\+Smart\+\_\+\+Cb func, const void $\ast$data)
\begin{DoxyCompactList}\small\item\em Insert a new item into the index object before item {\ttfamily before}. \end{DoxyCompactList}\item 
\hyperlink{group__General_ga13a0c231414b86e62f68afe3c6fb462b}{Elm\+\_\+\+Object\+\_\+\+Item} $\ast$ \hyperlink{group__Index_gaa53c8b41672887b5045e475a6015e245}{elm\+\_\+index\+\_\+item\+\_\+append} (Elm\+\_\+\+Index $\ast$obj, const char $\ast$letter, Evas\+\_\+\+Smart\+\_\+\+Cb func, const void $\ast$data)
\begin{DoxyCompactList}\small\item\em Append a new item on a given index widget. \end{DoxyCompactList}\item 
\hyperlink{group__General_ga13a0c231414b86e62f68afe3c6fb462b}{Elm\+\_\+\+Object\+\_\+\+Item} $\ast$ \hyperlink{group__Index_ga0bddbf11076bb50dcbed91465f22d1c7}{elm\+\_\+index\+\_\+selected\+\_\+item\+\_\+get} (const Elm\+\_\+\+Index $\ast$obj, int level)
\begin{DoxyCompactList}\small\item\em Returns the last selected item, for a given index widget. \end{DoxyCompactList}\item 
\hyperlink{group__General_ga13a0c231414b86e62f68afe3c6fb462b}{Elm\+\_\+\+Object\+\_\+\+Item} $\ast$ \hyperlink{group__Index_gaedecf094a9d0479921b3235a24a61510}{elm\+\_\+index\+\_\+item\+\_\+sorted\+\_\+insert} (Elm\+\_\+\+Index $\ast$obj, const char $\ast$letter, Evas\+\_\+\+Smart\+\_\+\+Cb func, const void $\ast$data, Eina\+\_\+\+Compare\+\_\+\+Cb cmp\+\_\+func, Eina\+\_\+\+Compare\+\_\+\+Cb cmp\+\_\+data\+\_\+func)
\begin{DoxyCompactList}\small\item\em Insert a new item into the given index widget, using {\ttfamily cmp\+\_\+func} function to sort items (by item handles). \end{DoxyCompactList}\item 
E\+O\+A\+P\+I void \hyperlink{group__Index_gaacfacb0b2f84aea6ce543419ec6bfb1e}{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+selected\+\_\+set} (Eina\+\_\+\+Bool selected)
\begin{DoxyCompactList}\small\item\em Set the selected state of an item. \end{DoxyCompactList}\item 
E\+O\+A\+P\+I const char $\ast$ \hyperlink{group__Index_ga26623fc4593ea6c42dabed069f73fe8f}{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+letter\+\_\+get} (void)
\begin{DoxyCompactList}\small\item\em Get the letter (string) set on a given index widget item. \end{DoxyCompactList}\item 
void \hyperlink{group__Index_ga2aa1298d852b47bec2488c5b50ed8c45}{elm\+\_\+index\+\_\+item\+\_\+selected\+\_\+set} (Elm\+\_\+\+Index\+\_\+\+Item $\ast$obj, Eina\+\_\+\+Bool selected)
\begin{DoxyCompactList}\small\item\em Set the selected state of an item. \end{DoxyCompactList}\item 
const char $\ast$ \hyperlink{group__Index_ga5a89c41885d917fc522922bb401d4c3c}{elm\+\_\+index\+\_\+item\+\_\+letter\+\_\+get} (const Elm\+\_\+\+Index\+\_\+\+Item $\ast$obj)
\begin{DoxyCompactList}\small\item\em Get the letter (string) set on a given index widget item. \end{DoxyCompactList}\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}]{\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. \index{Index@{Index}!elm\+\_\+index\+\_\+autohide\+\_\+disabled\+\_\+get@{elm\+\_\+index\+\_\+autohide\+\_\+disabled\+\_\+get}}
\index{elm\+\_\+index\+\_\+autohide\+\_\+disabled\+\_\+get@{elm\+\_\+index\+\_\+autohide\+\_\+disabled\+\_\+get}!Index@{Index}}
\subsubsection[{elm\+\_\+index\+\_\+autohide\+\_\+disabled\+\_\+get}]{\setlength{\rightskip}{0pt plus 5cm}Eina\+\_\+\+Bool elm\+\_\+index\+\_\+autohide\+\_\+disabled\+\_\+get (
\begin{DoxyParamCaption}
\item[{const Elm\+\_\+\+Index $\ast$}]{obj}
\end{DoxyParamCaption}
)}\label{group__Index_ga4b1a080a5ddba56e53d16f97cdcfb3a1}


Get whether auto hiding feature is enabled or not for a given index widget. 

\begin{DoxyReturn}{Returns}
{\ttfamily E\+I\+N\+A\+\_\+\+T\+R\+U\+E}, if auto hiding is disabled, {\ttfamily E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E} otherwise
\end{DoxyReturn}
\begin{DoxySeeAlso}{See also}
\hyperlink{group__Index_ga6569179b38d11fb5fb1286815cf846fb}{elm\+\_\+index\+\_\+autohide\+\_\+disabled\+\_\+set()} for more details 
\end{DoxySeeAlso}


References elm\+\_\+obj\+\_\+index\+\_\+autohide\+\_\+disabled\+\_\+get().

\index{Index@{Index}!elm\+\_\+index\+\_\+autohide\+\_\+disabled\+\_\+set@{elm\+\_\+index\+\_\+autohide\+\_\+disabled\+\_\+set}}
\index{elm\+\_\+index\+\_\+autohide\+\_\+disabled\+\_\+set@{elm\+\_\+index\+\_\+autohide\+\_\+disabled\+\_\+set}!Index@{Index}}
\subsubsection[{elm\+\_\+index\+\_\+autohide\+\_\+disabled\+\_\+set}]{\setlength{\rightskip}{0pt plus 5cm}void elm\+\_\+index\+\_\+autohide\+\_\+disabled\+\_\+set (
\begin{DoxyParamCaption}
\item[{Elm\+\_\+\+Index $\ast$}]{obj, }
\item[{Eina\+\_\+\+Bool}]{disabled}
\end{DoxyParamCaption}
)}\label{group__Index_ga6569179b38d11fb5fb1286815cf846fb}


Enable or disable auto hiding feature for a given index widget. 

\begin{DoxySeeAlso}{See also}
\hyperlink{group__Index_ga4b1a080a5ddba56e53d16f97cdcfb3a1}{elm\+\_\+index\+\_\+autohide\+\_\+disabled\+\_\+get()}
\end{DoxySeeAlso}

\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em disabled} & {\ttfamily E\+I\+N\+A\+\_\+\+T\+R\+U\+E} to disable auto hiding, {\ttfamily E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E} to enable \\
\hline
\end{DoxyParams}


References elm\+\_\+obj\+\_\+index\+\_\+autohide\+\_\+disabled\+\_\+set().

\index{Index@{Index}!elm\+\_\+index\+\_\+delay\+\_\+change\+\_\+time\+\_\+get@{elm\+\_\+index\+\_\+delay\+\_\+change\+\_\+time\+\_\+get}}
\index{elm\+\_\+index\+\_\+delay\+\_\+change\+\_\+time\+\_\+get@{elm\+\_\+index\+\_\+delay\+\_\+change\+\_\+time\+\_\+get}!Index@{Index}}
\subsubsection[{elm\+\_\+index\+\_\+delay\+\_\+change\+\_\+time\+\_\+get}]{\setlength{\rightskip}{0pt plus 5cm}double elm\+\_\+index\+\_\+delay\+\_\+change\+\_\+time\+\_\+get (
\begin{DoxyParamCaption}
\item[{const Elm\+\_\+\+Index $\ast$}]{obj}
\end{DoxyParamCaption}
)}\label{group__Index_ga462ca31df319b26068c3a3bd719b12a1}


Get a delay change time for index object. 

\begin{DoxyReturn}{Returns}
delay change time in seconds
\end{DoxyReturn}
\begin{DoxySeeAlso}{See also}
\hyperlink{group__Index_gaf4ee573a9b2bce298115ea65cacd2d0c}{elm\+\_\+index\+\_\+delay\+\_\+change\+\_\+time\+\_\+set} 
\end{DoxySeeAlso}


References elm\+\_\+obj\+\_\+index\+\_\+delay\+\_\+change\+\_\+time\+\_\+get().

\index{Index@{Index}!elm\+\_\+index\+\_\+delay\+\_\+change\+\_\+time\+\_\+set@{elm\+\_\+index\+\_\+delay\+\_\+change\+\_\+time\+\_\+set}}
\index{elm\+\_\+index\+\_\+delay\+\_\+change\+\_\+time\+\_\+set@{elm\+\_\+index\+\_\+delay\+\_\+change\+\_\+time\+\_\+set}!Index@{Index}}
\subsubsection[{elm\+\_\+index\+\_\+delay\+\_\+change\+\_\+time\+\_\+set}]{\setlength{\rightskip}{0pt plus 5cm}void elm\+\_\+index\+\_\+delay\+\_\+change\+\_\+time\+\_\+set (
\begin{DoxyParamCaption}
\item[{Elm\+\_\+\+Index $\ast$}]{obj, }
\item[{double}]{dtime}
\end{DoxyParamCaption}
)}\label{group__Index_gaf4ee573a9b2bce298115ea65cacd2d0c}


Set a delay change time for index object. 

\begin{DoxyNote}{Note}
delay time is 0.\+2 sec by default.
\end{DoxyNote}
\begin{DoxySeeAlso}{See also}
\hyperlink{group__Index_ga462ca31df319b26068c3a3bd719b12a1}{elm\+\_\+index\+\_\+delay\+\_\+change\+\_\+time\+\_\+get}
\end{DoxySeeAlso}

\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em dtime} & The delay change time to set. \\
\hline
\end{DoxyParams}


References elm\+\_\+obj\+\_\+index\+\_\+delay\+\_\+change\+\_\+time\+\_\+set().

\index{Index@{Index}!elm\+\_\+index\+\_\+horizontal\+\_\+get@{elm\+\_\+index\+\_\+horizontal\+\_\+get}}
\index{elm\+\_\+index\+\_\+horizontal\+\_\+get@{elm\+\_\+index\+\_\+horizontal\+\_\+get}!Index@{Index}}
\subsubsection[{elm\+\_\+index\+\_\+horizontal\+\_\+get}]{\setlength{\rightskip}{0pt plus 5cm}Eina\+\_\+\+Bool elm\+\_\+index\+\_\+horizontal\+\_\+get (
\begin{DoxyParamCaption}
\item[{const Elm\+\_\+\+Index $\ast$}]{obj}
\end{DoxyParamCaption}
)}\label{group__Index_gaf48b49e2ad3fe94ab8dfbe01d8b4fe77}


Get a value whether horizontal mode is enabled or not. 

\begin{DoxyReturn}{Returns}
{\ttfamily E\+I\+N\+A\+\_\+\+T\+R\+U\+E} means horizontal mode selection is enabled. {\ttfamily E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E} indicates it\textquotesingle{}s disabled. If {\ttfamily obj} is {\ttfamily N\+U\+L\+L}, {\ttfamily E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E} is returned.
\end{DoxyReturn}
\begin{DoxySeeAlso}{See also}
\hyperlink{group__Index_gab692af2d53bdfb5d043fccb84a0fc681}{elm\+\_\+index\+\_\+horizontal\+\_\+set()} for details. 
\end{DoxySeeAlso}


References elm\+\_\+obj\+\_\+index\+\_\+horizontal\+\_\+get().

\index{Index@{Index}!elm\+\_\+index\+\_\+horizontal\+\_\+set@{elm\+\_\+index\+\_\+horizontal\+\_\+set}}
\index{elm\+\_\+index\+\_\+horizontal\+\_\+set@{elm\+\_\+index\+\_\+horizontal\+\_\+set}!Index@{Index}}
\subsubsection[{elm\+\_\+index\+\_\+horizontal\+\_\+set}]{\setlength{\rightskip}{0pt plus 5cm}void elm\+\_\+index\+\_\+horizontal\+\_\+set (
\begin{DoxyParamCaption}
\item[{Elm\+\_\+\+Index $\ast$}]{obj, }
\item[{Eina\+\_\+\+Bool}]{horizontal}
\end{DoxyParamCaption}
)}\label{group__Index_gab692af2d53bdfb5d043fccb84a0fc681}


Enable or disable horizontal mode on the index object. 

\begin{DoxyNote}{Note}
Vertical mode is set by default.
\end{DoxyNote}
On horizontal mode items are displayed on index from left to right, instead of from top to bottom. Also, the index will scroll horizontally.

\begin{DoxySeeAlso}{See also}
\hyperlink{group__Index_gaf48b49e2ad3fe94ab8dfbe01d8b4fe77}{elm\+\_\+index\+\_\+horizontal\+\_\+get()}
\end{DoxySeeAlso}

\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em horizontal} & {\ttfamily E\+I\+N\+A\+\_\+\+T\+R\+U\+E} to enable horizontal or {\ttfamily E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E} to disable it, i.\+e., to enable vertical mode. it\textquotesingle{}s an area one \hyperlink{group__Fingers}{finger} wide on the bottom side of the index widget\textquotesingle{}s container. \\
\hline
\end{DoxyParams}


References elm\+\_\+obj\+\_\+index\+\_\+horizontal\+\_\+set().

\index{Index@{Index}!elm\+\_\+index\+\_\+indicator\+\_\+disabled\+\_\+get@{elm\+\_\+index\+\_\+indicator\+\_\+disabled\+\_\+get}}
\index{elm\+\_\+index\+\_\+indicator\+\_\+disabled\+\_\+get@{elm\+\_\+index\+\_\+indicator\+\_\+disabled\+\_\+get}!Index@{Index}}
\subsubsection[{elm\+\_\+index\+\_\+indicator\+\_\+disabled\+\_\+get}]{\setlength{\rightskip}{0pt plus 5cm}Eina\+\_\+\+Bool elm\+\_\+index\+\_\+indicator\+\_\+disabled\+\_\+get (
\begin{DoxyParamCaption}
\item[{const Elm\+\_\+\+Index $\ast$}]{obj}
\end{DoxyParamCaption}
)}\label{group__Index_gab34a2f658cc248f3f569d8dc05069d47}


Get the value of indicator\textquotesingle{}s disabled status. 

\begin{DoxyReturn}{Returns}
E\+I\+N\+A\+\_\+\+T\+R\+U\+E if the indicator is disabled.
\end{DoxyReturn}
\begin{DoxySeeAlso}{See also}
\hyperlink{group__Index_ga91a560f52fbbd4701eb0fbdc6fd00021}{elm\+\_\+index\+\_\+indicator\+\_\+disabled\+\_\+set()} 
\end{DoxySeeAlso}


References elm\+\_\+obj\+\_\+index\+\_\+indicator\+\_\+disabled\+\_\+get().

\index{Index@{Index}!elm\+\_\+index\+\_\+indicator\+\_\+disabled\+\_\+set@{elm\+\_\+index\+\_\+indicator\+\_\+disabled\+\_\+set}}
\index{elm\+\_\+index\+\_\+indicator\+\_\+disabled\+\_\+set@{elm\+\_\+index\+\_\+indicator\+\_\+disabled\+\_\+set}!Index@{Index}}
\subsubsection[{elm\+\_\+index\+\_\+indicator\+\_\+disabled\+\_\+set}]{\setlength{\rightskip}{0pt plus 5cm}void elm\+\_\+index\+\_\+indicator\+\_\+disabled\+\_\+set (
\begin{DoxyParamCaption}
\item[{Elm\+\_\+\+Index $\ast$}]{obj, }
\item[{Eina\+\_\+\+Bool}]{disabled}
\end{DoxyParamCaption}
)}\label{group__Index_ga91a560f52fbbd4701eb0fbdc6fd00021}


Set the indicator as to be disabled. 

In Index widget, Indicator notes popup text, which shows a letter has been selecting.

\begin{DoxySeeAlso}{See also}
\hyperlink{group__Index_gab34a2f658cc248f3f569d8dc05069d47}{elm\+\_\+index\+\_\+indicator\+\_\+disabled\+\_\+get()}
\end{DoxySeeAlso}

\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em disabled} & {\ttfamily E\+I\+N\+A\+\_\+\+T\+R\+U\+E} to disable it, {\ttfamily E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E} to enable it \\
\hline
\end{DoxyParams}


References elm\+\_\+obj\+\_\+index\+\_\+indicator\+\_\+disabled\+\_\+set().

\index{Index@{Index}!elm\+\_\+index\+\_\+item\+\_\+append@{elm\+\_\+index\+\_\+item\+\_\+append}}
\index{elm\+\_\+index\+\_\+item\+\_\+append@{elm\+\_\+index\+\_\+item\+\_\+append}!Index@{Index}}
\subsubsection[{elm\+\_\+index\+\_\+item\+\_\+append}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Elm\+\_\+\+Object\+\_\+\+Item}$\ast$ elm\+\_\+index\+\_\+item\+\_\+append (
\begin{DoxyParamCaption}
\item[{Elm\+\_\+\+Index $\ast$}]{obj, }
\item[{const char $\ast$}]{letter, }
\item[{Evas\+\_\+\+Smart\+\_\+\+Cb}]{func, }
\item[{const void $\ast$}]{data}
\end{DoxyParamCaption}
)}\label{group__Index_gaa53c8b41672887b5045e475a6015e245}


Append a new item on a given index widget. 

\begin{DoxyReturn}{Returns}
A handle to the item added or {\ttfamily N\+U\+L\+L}, on errors
\end{DoxyReturn}
Despite the most common usage of the {\ttfamily letter} argument is for single char strings, one could use arbitrary strings as index entries.

{\ttfamily item} will be the pointer returned back on {\ttfamily \char`\"{}changed\char`\"{}}, {\ttfamily \char`\"{}delay,changed\char`\"{}} and {\ttfamily \char`\"{}selected\char`\"{}} smart events.


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em letter} & Letter under which the item should be indexed \\
\hline
\mbox{\tt in}  & {\em func} & The function to call when the item is selected. \\
\hline
\mbox{\tt in}  & {\em data} & The item data to set for the index\textquotesingle{}s item \\
\hline
\end{DoxyParams}


References elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+append().

\index{Index@{Index}!elm\+\_\+index\+\_\+item\+\_\+clear@{elm\+\_\+index\+\_\+item\+\_\+clear}}
\index{elm\+\_\+index\+\_\+item\+\_\+clear@{elm\+\_\+index\+\_\+item\+\_\+clear}!Index@{Index}}
\subsubsection[{elm\+\_\+index\+\_\+item\+\_\+clear}]{\setlength{\rightskip}{0pt plus 5cm}void elm\+\_\+index\+\_\+item\+\_\+clear (
\begin{DoxyParamCaption}
\item[{Elm\+\_\+\+Index $\ast$}]{obj}
\end{DoxyParamCaption}
)}\label{group__Index_ga9c0c1ff500522b62a674b36beafe7a19}


Removes {\bfseries all} items from a given index widget. 

If deletion callbacks are set, via elm\+\_\+object\+\_\+item\+\_\+del\+\_\+cb\+\_\+set(), that callback function will be called for each item in {\ttfamily obj}. 

References elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+clear().

\index{Index@{Index}!elm\+\_\+index\+\_\+item\+\_\+find@{elm\+\_\+index\+\_\+item\+\_\+find}}
\index{elm\+\_\+index\+\_\+item\+\_\+find@{elm\+\_\+index\+\_\+item\+\_\+find}!Index@{Index}}
\subsubsection[{elm\+\_\+index\+\_\+item\+\_\+find}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Elm\+\_\+\+Object\+\_\+\+Item}$\ast$ elm\+\_\+index\+\_\+item\+\_\+find (
\begin{DoxyParamCaption}
\item[{Elm\+\_\+\+Index $\ast$}]{obj, }
\item[{const void $\ast$}]{data}
\end{DoxyParamCaption}
)}\label{group__Index_ga452b9d17cb79974ba1c5d2a0e8fca7d4}


Find a given index widget\textquotesingle{}s item, {\bfseries using item data}. 

\begin{DoxyReturn}{Returns}
The index item handle, if found, or {\ttfamily N\+U\+L\+L} otherwise
\end{DoxyReturn}

\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em data} & The item data pointed to by the desired index item \\
\hline
\end{DoxyParams}


References elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+find().

\index{Index@{Index}!elm\+\_\+index\+\_\+item\+\_\+insert\+\_\+after@{elm\+\_\+index\+\_\+item\+\_\+insert\+\_\+after}}
\index{elm\+\_\+index\+\_\+item\+\_\+insert\+\_\+after@{elm\+\_\+index\+\_\+item\+\_\+insert\+\_\+after}!Index@{Index}}
\subsubsection[{elm\+\_\+index\+\_\+item\+\_\+insert\+\_\+after}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Elm\+\_\+\+Object\+\_\+\+Item}$\ast$ elm\+\_\+index\+\_\+item\+\_\+insert\+\_\+after (
\begin{DoxyParamCaption}
\item[{Elm\+\_\+\+Index $\ast$}]{obj, }
\item[{{\bf Elm\+\_\+\+Object\+\_\+\+Item} $\ast$}]{after, }
\item[{const char $\ast$}]{letter, }
\item[{Evas\+\_\+\+Smart\+\_\+\+Cb}]{func, }
\item[{const void $\ast$}]{data}
\end{DoxyParamCaption}
)}\label{group__Index_ga72579e5f95f26f99be39fbe73a7a90ca}


Insert a new item into the index object after item {\ttfamily after}. 

\begin{DoxyReturn}{Returns}
A handle to the item added or {\ttfamily N\+U\+L\+L}, on errors
\end{DoxyReturn}
Despite the most common usage of the {\ttfamily letter} argument is for single char strings, one could use arbitrary strings as index entries.

{\ttfamily item} will be the pointer returned back on {\ttfamily \char`\"{}changed\char`\"{}}, {\ttfamily \char`\"{}delay,changed\char`\"{}} and {\ttfamily \char`\"{}selected\char`\"{}} smart events.

\begin{DoxyNote}{Note}
If {\ttfamily relative} is {\ttfamily N\+U\+L\+L} this function will behave as \hyperlink{group__Index_gaa53c8b41672887b5045e475a6015e245}{elm\+\_\+index\+\_\+item\+\_\+append()}.
\end{DoxyNote}

\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em after} & The index item to insert after. \\
\hline
\mbox{\tt in}  & {\em letter} & Letter under which the item should be indexed \\
\hline
\mbox{\tt in}  & {\em func} & The function to call when the item is clicked. \\
\hline
\mbox{\tt in}  & {\em data} & The item data to set for the index\textquotesingle{}s item \\
\hline
\end{DoxyParams}


References elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+insert\+\_\+after().

\index{Index@{Index}!elm\+\_\+index\+\_\+item\+\_\+insert\+\_\+before@{elm\+\_\+index\+\_\+item\+\_\+insert\+\_\+before}}
\index{elm\+\_\+index\+\_\+item\+\_\+insert\+\_\+before@{elm\+\_\+index\+\_\+item\+\_\+insert\+\_\+before}!Index@{Index}}
\subsubsection[{elm\+\_\+index\+\_\+item\+\_\+insert\+\_\+before}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Elm\+\_\+\+Object\+\_\+\+Item}$\ast$ elm\+\_\+index\+\_\+item\+\_\+insert\+\_\+before (
\begin{DoxyParamCaption}
\item[{Elm\+\_\+\+Index $\ast$}]{obj, }
\item[{{\bf Elm\+\_\+\+Object\+\_\+\+Item} $\ast$}]{before, }
\item[{const char $\ast$}]{letter, }
\item[{Evas\+\_\+\+Smart\+\_\+\+Cb}]{func, }
\item[{const void $\ast$}]{data}
\end{DoxyParamCaption}
)}\label{group__Index_gaefa0d98f90029402f3b420f2ddf4a208}


Insert a new item into the index object before item {\ttfamily before}. 

\begin{DoxyReturn}{Returns}
A handle to the item added or {\ttfamily N\+U\+L\+L}, on errors
\end{DoxyReturn}
Despite the most common usage of the {\ttfamily letter} argument is for single char strings, one could use arbitrary strings as index entries.

{\ttfamily item} will be the pointer returned back on {\ttfamily \char`\"{}changed\char`\"{}}, {\ttfamily \char`\"{}delay,changed\char`\"{}} and {\ttfamily \char`\"{}selected\char`\"{}} smart events.

\begin{DoxyNote}{Note}
If {\ttfamily relative} is {\ttfamily N\+U\+L\+L} this function will behave as \hyperlink{group__Index_gaa8b9c57438e6d25be306431fd83b339a}{elm\+\_\+index\+\_\+item\+\_\+prepend()}.
\end{DoxyNote}

\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em before} & The index item to insert after. \\
\hline
\mbox{\tt in}  & {\em letter} & Letter under which the item should be indexed \\
\hline
\mbox{\tt in}  & {\em func} & The function to call when the item is clicked. \\
\hline
\mbox{\tt in}  & {\em data} & The item data to set for the index\textquotesingle{}s item \\
\hline
\end{DoxyParams}


References elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+insert\+\_\+before().

\index{Index@{Index}!elm\+\_\+index\+\_\+item\+\_\+letter\+\_\+get@{elm\+\_\+index\+\_\+item\+\_\+letter\+\_\+get}}
\index{elm\+\_\+index\+\_\+item\+\_\+letter\+\_\+get@{elm\+\_\+index\+\_\+item\+\_\+letter\+\_\+get}!Index@{Index}}
\subsubsection[{elm\+\_\+index\+\_\+item\+\_\+letter\+\_\+get}]{\setlength{\rightskip}{0pt plus 5cm}const char$\ast$ elm\+\_\+index\+\_\+item\+\_\+letter\+\_\+get (
\begin{DoxyParamCaption}
\item[{const Elm\+\_\+\+Index\+\_\+\+Item $\ast$}]{obj}
\end{DoxyParamCaption}
)}\label{group__Index_ga5a89c41885d917fc522922bb401d4c3c}


Get the letter (string) set on a given index widget item. 

\begin{DoxyReturn}{Returns}
The letter string set on {\ttfamily item} 
\end{DoxyReturn}


References elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+letter\+\_\+get().

\index{Index@{Index}!elm\+\_\+index\+\_\+item\+\_\+level\+\_\+get@{elm\+\_\+index\+\_\+item\+\_\+level\+\_\+get}}
\index{elm\+\_\+index\+\_\+item\+\_\+level\+\_\+get@{elm\+\_\+index\+\_\+item\+\_\+level\+\_\+get}!Index@{Index}}
\subsubsection[{elm\+\_\+index\+\_\+item\+\_\+level\+\_\+get}]{\setlength{\rightskip}{0pt plus 5cm}int elm\+\_\+index\+\_\+item\+\_\+level\+\_\+get (
\begin{DoxyParamCaption}
\item[{const Elm\+\_\+\+Index $\ast$}]{obj}
\end{DoxyParamCaption}
)}\label{group__Index_ga545438c3478927e96e168c04df253477}


Get the items level set for a given index widget. 

\begin{DoxyReturn}{Returns}
{\ttfamily 0} or {\ttfamily 1}, which are the levels {\ttfamily obj} might be at.
\end{DoxyReturn}
\begin{DoxySeeAlso}{See also}
\hyperlink{group__Index_ga2c11e086e69792d90864fbf259b3ca2d}{elm\+\_\+index\+\_\+item\+\_\+level\+\_\+set()} for more information 
\end{DoxySeeAlso}


References elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+level\+\_\+get().

\index{Index@{Index}!elm\+\_\+index\+\_\+item\+\_\+level\+\_\+set@{elm\+\_\+index\+\_\+item\+\_\+level\+\_\+set}}
\index{elm\+\_\+index\+\_\+item\+\_\+level\+\_\+set@{elm\+\_\+index\+\_\+item\+\_\+level\+\_\+set}!Index@{Index}}
\subsubsection[{elm\+\_\+index\+\_\+item\+\_\+level\+\_\+set}]{\setlength{\rightskip}{0pt plus 5cm}void elm\+\_\+index\+\_\+item\+\_\+level\+\_\+set (
\begin{DoxyParamCaption}
\item[{Elm\+\_\+\+Index $\ast$}]{obj, }
\item[{int}]{level}
\end{DoxyParamCaption}
)}\label{group__Index_ga2c11e086e69792d90864fbf259b3ca2d}


Set the items level for a given index widget. 

\begin{DoxySeeAlso}{See also}
\hyperlink{group__Index_ga545438c3478927e96e168c04df253477}{elm\+\_\+index\+\_\+item\+\_\+level\+\_\+get()}
\end{DoxySeeAlso}

\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em level} & {\ttfamily 0} or {\ttfamily 1}, the currently implemented levels. \\
\hline
\end{DoxyParams}


References elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+level\+\_\+set().

\index{Index@{Index}!elm\+\_\+index\+\_\+item\+\_\+prepend@{elm\+\_\+index\+\_\+item\+\_\+prepend}}
\index{elm\+\_\+index\+\_\+item\+\_\+prepend@{elm\+\_\+index\+\_\+item\+\_\+prepend}!Index@{Index}}
\subsubsection[{elm\+\_\+index\+\_\+item\+\_\+prepend}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Elm\+\_\+\+Object\+\_\+\+Item}$\ast$ elm\+\_\+index\+\_\+item\+\_\+prepend (
\begin{DoxyParamCaption}
\item[{Elm\+\_\+\+Index $\ast$}]{obj, }
\item[{const char $\ast$}]{letter, }
\item[{Evas\+\_\+\+Smart\+\_\+\+Cb}]{func, }
\item[{const void $\ast$}]{data}
\end{DoxyParamCaption}
)}\label{group__Index_gaa8b9c57438e6d25be306431fd83b339a}


Prepend a new item on a given index widget. 

\begin{DoxyReturn}{Returns}
A handle to the item added or {\ttfamily N\+U\+L\+L}, on errors
\end{DoxyReturn}
Despite the most common usage of the {\ttfamily letter} argument is for single char strings, one could use arbitrary strings as index entries.

{\ttfamily item} will be the pointer returned back on {\ttfamily \char`\"{}changed\char`\"{}}, {\ttfamily \char`\"{}delay,changed\char`\"{}} and {\ttfamily \char`\"{}selected\char`\"{}} smart events.


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em letter} & Letter under which the item should be indexed \\
\hline
\mbox{\tt in}  & {\em func} & The function to call when the item is selected. \\
\hline
\mbox{\tt in}  & {\em data} & The item data to set for the index\textquotesingle{}s item \\
\hline
\end{DoxyParams}


References elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+prepend().

\index{Index@{Index}!elm\+\_\+index\+\_\+item\+\_\+selected\+\_\+set@{elm\+\_\+index\+\_\+item\+\_\+selected\+\_\+set}}
\index{elm\+\_\+index\+\_\+item\+\_\+selected\+\_\+set@{elm\+\_\+index\+\_\+item\+\_\+selected\+\_\+set}!Index@{Index}}
\subsubsection[{elm\+\_\+index\+\_\+item\+\_\+selected\+\_\+set}]{\setlength{\rightskip}{0pt plus 5cm}void elm\+\_\+index\+\_\+item\+\_\+selected\+\_\+set (
\begin{DoxyParamCaption}
\item[{Elm\+\_\+\+Index\+\_\+\+Item $\ast$}]{obj, }
\item[{Eina\+\_\+\+Bool}]{selected}
\end{DoxyParamCaption}
)}\label{group__Index_ga2aa1298d852b47bec2488c5b50ed8c45}


Set the selected state of an item. 

This sets the selected state of the given item {\ttfamily it}. {\ttfamily E\+I\+N\+A\+\_\+\+T\+R\+U\+E} for selected, {\ttfamily E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E} for not selected.

If a new item is selected the previously selected will be unselected. Previously selected item can be get with function \hyperlink{group__Index_ga0bddbf11076bb50dcbed91465f22d1c7}{elm\+\_\+index\+\_\+selected\+\_\+item\+\_\+get()}.

Selected items will be highlighted.

\begin{DoxySeeAlso}{See also}
\hyperlink{group__Index_ga0bddbf11076bb50dcbed91465f22d1c7}{elm\+\_\+index\+\_\+selected\+\_\+item\+\_\+get()}
\end{DoxySeeAlso}

\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em selected} & E\+I\+N\+A\+\_\+\+T\+R\+U\+E if selected E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E otherwise \\
\hline
\end{DoxyParams}


References elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+selected\+\_\+set().

\index{Index@{Index}!elm\+\_\+index\+\_\+item\+\_\+sorted\+\_\+insert@{elm\+\_\+index\+\_\+item\+\_\+sorted\+\_\+insert}}
\index{elm\+\_\+index\+\_\+item\+\_\+sorted\+\_\+insert@{elm\+\_\+index\+\_\+item\+\_\+sorted\+\_\+insert}!Index@{Index}}
\subsubsection[{elm\+\_\+index\+\_\+item\+\_\+sorted\+\_\+insert}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Elm\+\_\+\+Object\+\_\+\+Item}$\ast$ elm\+\_\+index\+\_\+item\+\_\+sorted\+\_\+insert (
\begin{DoxyParamCaption}
\item[{Elm\+\_\+\+Index $\ast$}]{obj, }
\item[{const char $\ast$}]{letter, }
\item[{Evas\+\_\+\+Smart\+\_\+\+Cb}]{func, }
\item[{const void $\ast$}]{data, }
\item[{Eina\+\_\+\+Compare\+\_\+\+Cb}]{cmp\+\_\+func, }
\item[{Eina\+\_\+\+Compare\+\_\+\+Cb}]{cmp\+\_\+data\+\_\+func}
\end{DoxyParamCaption}
)}\label{group__Index_gaedecf094a9d0479921b3235a24a61510}


Insert a new item into the given index widget, using {\ttfamily cmp\+\_\+func} function to sort items (by item handles). 

\begin{DoxyReturn}{Returns}
A handle to the item added or {\ttfamily N\+U\+L\+L}, on errors
\end{DoxyReturn}
Despite the most common usage of the {\ttfamily letter} argument is for single char strings, one could use arbitrary strings as index entries.

{\ttfamily item} will be the pointer returned back on {\ttfamily \char`\"{}changed\char`\"{}}, {\ttfamily \char`\"{}delay,changed\char`\"{}} and {\ttfamily \char`\"{}selected\char`\"{}} smart events.


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em letter} & Letter under which the item should be indexed \\
\hline
\mbox{\tt in}  & {\em func} & The function to call when the item is clicked. \\
\hline
\mbox{\tt in}  & {\em data} & The item data to set for the index\textquotesingle{}s item \\
\hline
\mbox{\tt in}  & {\em cmp\+\_\+func} & The comparing function to be used to sort index items {\bfseries by index item handles} \\
\hline
\mbox{\tt in}  & {\em cmp\+\_\+data\+\_\+func} & A {\bfseries fallback} function to be called for the sorting of index items {\bfseries by item data}). It will be used when {\ttfamily cmp\+\_\+func} returns {\ttfamily 0} (equality), which means an index item with provided item data already exists. To decide which data item should be pointed to by the index item in question, {\ttfamily cmp\+\_\+data\+\_\+func} will be used. If {\ttfamily cmp\+\_\+data\+\_\+func} returns a non-\/negative value, the previous index item data will be replaced by the given {\ttfamily item} pointer. If the previous data need to be freed, it should be done by the {\ttfamily cmp\+\_\+data\+\_\+func} function, because all references to it will be lost. If this function is not provided ({\ttfamily N\+U\+L\+L} is given), index items will be {\bfseries duplicated}, if {\ttfamily cmp\+\_\+func} returns {\ttfamily 0}. \\
\hline
\end{DoxyParams}


References elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+sorted\+\_\+insert().

\index{Index@{Index}!elm\+\_\+index\+\_\+level\+\_\+go@{elm\+\_\+index\+\_\+level\+\_\+go}}
\index{elm\+\_\+index\+\_\+level\+\_\+go@{elm\+\_\+index\+\_\+level\+\_\+go}!Index@{Index}}
\subsubsection[{elm\+\_\+index\+\_\+level\+\_\+go}]{\setlength{\rightskip}{0pt plus 5cm}void elm\+\_\+index\+\_\+level\+\_\+go (
\begin{DoxyParamCaption}
\item[{Elm\+\_\+\+Index $\ast$}]{obj, }
\item[{int}]{level}
\end{DoxyParamCaption}
)}\label{group__Index_ga3bb92a868f63463403668a4bbcda21d1}


Flush the changes made to the index items so they work correctly. 

This flushes any changes made to items indicating the object is ready to go. You should call this before any changes you expect to work. This is similar to \hyperlink{group__List_ga016361621126444b003a71dc8ff75627}{elm\+\_\+list\+\_\+go()}.

\begin{DoxyWarning}{Warning}
If not called, it won\textquotesingle{}t display the index properly.
\end{DoxyWarning}

\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em level} & The index level (one of {\ttfamily 0} or {\ttfamily 1}) where changes were made \\
\hline
\end{DoxyParams}


References elm\+\_\+obj\+\_\+index\+\_\+level\+\_\+go().

\index{Index@{Index}!elm\+\_\+index\+\_\+omit\+\_\+enabled\+\_\+get@{elm\+\_\+index\+\_\+omit\+\_\+enabled\+\_\+get}}
\index{elm\+\_\+index\+\_\+omit\+\_\+enabled\+\_\+get@{elm\+\_\+index\+\_\+omit\+\_\+enabled\+\_\+get}!Index@{Index}}
\subsubsection[{elm\+\_\+index\+\_\+omit\+\_\+enabled\+\_\+get}]{\setlength{\rightskip}{0pt plus 5cm}Eina\+\_\+\+Bool elm\+\_\+index\+\_\+omit\+\_\+enabled\+\_\+get (
\begin{DoxyParamCaption}
\item[{const Elm\+\_\+\+Index $\ast$}]{obj}
\end{DoxyParamCaption}
)}\label{group__Index_ga53c51630158c198ada3463a046e11bf3}


Get whether omit feature is enabled or not for a given index widget. 

\begin{DoxyReturn}{Returns}
{\ttfamily E\+I\+N\+A\+\_\+\+T\+R\+U\+E}, if omit feature is enabled, {\ttfamily E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E} otherwise
\end{DoxyReturn}
\begin{DoxySeeAlso}{See also}
\hyperlink{group__Index_gaae1377e77395cab18ba7a68bc6e0f66f}{elm\+\_\+index\+\_\+omit\+\_\+enabled\+\_\+set()}
\end{DoxySeeAlso}
\begin{DoxySince}{Since}
1.\+8 
\end{DoxySince}


References elm\+\_\+obj\+\_\+index\+\_\+omit\+\_\+enabled\+\_\+get().

\index{Index@{Index}!elm\+\_\+index\+\_\+omit\+\_\+enabled\+\_\+set@{elm\+\_\+index\+\_\+omit\+\_\+enabled\+\_\+set}}
\index{elm\+\_\+index\+\_\+omit\+\_\+enabled\+\_\+set@{elm\+\_\+index\+\_\+omit\+\_\+enabled\+\_\+set}!Index@{Index}}
\subsubsection[{elm\+\_\+index\+\_\+omit\+\_\+enabled\+\_\+set}]{\setlength{\rightskip}{0pt plus 5cm}void elm\+\_\+index\+\_\+omit\+\_\+enabled\+\_\+set (
\begin{DoxyParamCaption}
\item[{Elm\+\_\+\+Index $\ast$}]{obj, }
\item[{Eina\+\_\+\+Bool}]{enabled}
\end{DoxyParamCaption}
)}\label{group__Index_gaae1377e77395cab18ba7a68bc6e0f66f}


Enable or disable omit feature for a given index widget. 

\begin{DoxySeeAlso}{See also}
\hyperlink{group__Index_ga53c51630158c198ada3463a046e11bf3}{elm\+\_\+index\+\_\+omit\+\_\+enabled\+\_\+get()}
\end{DoxySeeAlso}
\begin{DoxySince}{Since}
1.\+8
\end{DoxySince}

\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em enabled} & {\ttfamily E\+I\+N\+A\+\_\+\+T\+R\+U\+E} to enable omit feature, {\ttfamily E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E} to disable \\
\hline
\end{DoxyParams}


References elm\+\_\+obj\+\_\+index\+\_\+omit\+\_\+enabled\+\_\+set().

\index{Index@{Index}!elm\+\_\+index\+\_\+selected\+\_\+item\+\_\+get@{elm\+\_\+index\+\_\+selected\+\_\+item\+\_\+get}}
\index{elm\+\_\+index\+\_\+selected\+\_\+item\+\_\+get@{elm\+\_\+index\+\_\+selected\+\_\+item\+\_\+get}!Index@{Index}}
\subsubsection[{elm\+\_\+index\+\_\+selected\+\_\+item\+\_\+get}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Elm\+\_\+\+Object\+\_\+\+Item}$\ast$ elm\+\_\+index\+\_\+selected\+\_\+item\+\_\+get (
\begin{DoxyParamCaption}
\item[{const Elm\+\_\+\+Index $\ast$}]{obj, }
\item[{int}]{level}
\end{DoxyParamCaption}
)}\label{group__Index_ga0bddbf11076bb50dcbed91465f22d1c7}


Returns the last selected item, for a given index widget. 

\begin{DoxyReturn}{Returns}
The last item {\bfseries selected} on {\ttfamily obj} (or {\ttfamily N\+U\+L\+L}, on errors).
\end{DoxyReturn}

\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em level} & {\ttfamily 0} or {\ttfamily 1}, the currently implemented levels. \\
\hline
\end{DoxyParams}


References elm\+\_\+obj\+\_\+index\+\_\+selected\+\_\+item\+\_\+get().

\index{Index@{Index}!elm\+\_\+obj\+\_\+index\+\_\+autohide\+\_\+disabled\+\_\+get@{elm\+\_\+obj\+\_\+index\+\_\+autohide\+\_\+disabled\+\_\+get}}
\index{elm\+\_\+obj\+\_\+index\+\_\+autohide\+\_\+disabled\+\_\+get@{elm\+\_\+obj\+\_\+index\+\_\+autohide\+\_\+disabled\+\_\+get}!Index@{Index}}
\subsubsection[{elm\+\_\+obj\+\_\+index\+\_\+autohide\+\_\+disabled\+\_\+get}]{\setlength{\rightskip}{0pt plus 5cm}E\+O\+A\+P\+I Eina\+\_\+\+Bool elm\+\_\+obj\+\_\+index\+\_\+autohide\+\_\+disabled\+\_\+get (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
)}\label{group__Index_gab898191aa43b9644939e96a58ba63cfb}


Get whether auto hiding feature is enabled or not for a given index widget. 

\begin{DoxyReturn}{Returns}
{\ttfamily E\+I\+N\+A\+\_\+\+T\+R\+U\+E}, if auto hiding is disabled, {\ttfamily E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E} otherwise
\end{DoxyReturn}
\begin{DoxySeeAlso}{See also}
\hyperlink{group__Index_ga6569179b38d11fb5fb1286815cf846fb}{elm\+\_\+index\+\_\+autohide\+\_\+disabled\+\_\+set()} for more details 
\end{DoxySeeAlso}


Referenced by elm\+\_\+index\+\_\+autohide\+\_\+disabled\+\_\+get().

\index{Index@{Index}!elm\+\_\+obj\+\_\+index\+\_\+autohide\+\_\+disabled\+\_\+set@{elm\+\_\+obj\+\_\+index\+\_\+autohide\+\_\+disabled\+\_\+set}}
\index{elm\+\_\+obj\+\_\+index\+\_\+autohide\+\_\+disabled\+\_\+set@{elm\+\_\+obj\+\_\+index\+\_\+autohide\+\_\+disabled\+\_\+set}!Index@{Index}}
\subsubsection[{elm\+\_\+obj\+\_\+index\+\_\+autohide\+\_\+disabled\+\_\+set}]{\setlength{\rightskip}{0pt plus 5cm}E\+O\+A\+P\+I void elm\+\_\+obj\+\_\+index\+\_\+autohide\+\_\+disabled\+\_\+set (
\begin{DoxyParamCaption}
\item[{Eina\+\_\+\+Bool}]{disabled}
\end{DoxyParamCaption}
)}\label{group__Index_ga2948edcd0e9d24ab1daae55ab043e217}


Enable or disable auto hiding feature for a given index widget. 

\begin{DoxySeeAlso}{See also}
\hyperlink{group__Index_ga4b1a080a5ddba56e53d16f97cdcfb3a1}{elm\+\_\+index\+\_\+autohide\+\_\+disabled\+\_\+get()}
\end{DoxySeeAlso}

\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em disabled} & {\ttfamily E\+I\+N\+A\+\_\+\+T\+R\+U\+E} to disable auto hiding, {\ttfamily E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E} to enable \\
\hline
\end{DoxyParams}


Referenced by elm\+\_\+index\+\_\+autohide\+\_\+disabled\+\_\+set().

\index{Index@{Index}!elm\+\_\+obj\+\_\+index\+\_\+delay\+\_\+change\+\_\+time\+\_\+get@{elm\+\_\+obj\+\_\+index\+\_\+delay\+\_\+change\+\_\+time\+\_\+get}}
\index{elm\+\_\+obj\+\_\+index\+\_\+delay\+\_\+change\+\_\+time\+\_\+get@{elm\+\_\+obj\+\_\+index\+\_\+delay\+\_\+change\+\_\+time\+\_\+get}!Index@{Index}}
\subsubsection[{elm\+\_\+obj\+\_\+index\+\_\+delay\+\_\+change\+\_\+time\+\_\+get}]{\setlength{\rightskip}{0pt plus 5cm}E\+O\+A\+P\+I double elm\+\_\+obj\+\_\+index\+\_\+delay\+\_\+change\+\_\+time\+\_\+get (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
)}\label{group__Index_ga868f5eac9259cede9eb6dfbf42faf8ee}


Get a delay change time for index object. 

\begin{DoxyReturn}{Returns}
delay change time in seconds
\end{DoxyReturn}
\begin{DoxySeeAlso}{See also}
\hyperlink{group__Index_gaf4ee573a9b2bce298115ea65cacd2d0c}{elm\+\_\+index\+\_\+delay\+\_\+change\+\_\+time\+\_\+set} 
\end{DoxySeeAlso}


Referenced by elm\+\_\+index\+\_\+delay\+\_\+change\+\_\+time\+\_\+get().

\index{Index@{Index}!elm\+\_\+obj\+\_\+index\+\_\+delay\+\_\+change\+\_\+time\+\_\+set@{elm\+\_\+obj\+\_\+index\+\_\+delay\+\_\+change\+\_\+time\+\_\+set}}
\index{elm\+\_\+obj\+\_\+index\+\_\+delay\+\_\+change\+\_\+time\+\_\+set@{elm\+\_\+obj\+\_\+index\+\_\+delay\+\_\+change\+\_\+time\+\_\+set}!Index@{Index}}
\subsubsection[{elm\+\_\+obj\+\_\+index\+\_\+delay\+\_\+change\+\_\+time\+\_\+set}]{\setlength{\rightskip}{0pt plus 5cm}E\+O\+A\+P\+I void elm\+\_\+obj\+\_\+index\+\_\+delay\+\_\+change\+\_\+time\+\_\+set (
\begin{DoxyParamCaption}
\item[{double}]{dtime}
\end{DoxyParamCaption}
)}\label{group__Index_ga26bd79b193afc066c3879633e98bbba7}


Set a delay change time for index object. 

\begin{DoxyNote}{Note}
delay time is 0.\+2 sec by default.
\end{DoxyNote}
\begin{DoxySeeAlso}{See also}
\hyperlink{group__Index_ga462ca31df319b26068c3a3bd719b12a1}{elm\+\_\+index\+\_\+delay\+\_\+change\+\_\+time\+\_\+get}
\end{DoxySeeAlso}

\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em dtime} & The delay change time to set. \\
\hline
\end{DoxyParams}


Referenced by elm\+\_\+index\+\_\+delay\+\_\+change\+\_\+time\+\_\+set().

\index{Index@{Index}!elm\+\_\+obj\+\_\+index\+\_\+horizontal\+\_\+get@{elm\+\_\+obj\+\_\+index\+\_\+horizontal\+\_\+get}}
\index{elm\+\_\+obj\+\_\+index\+\_\+horizontal\+\_\+get@{elm\+\_\+obj\+\_\+index\+\_\+horizontal\+\_\+get}!Index@{Index}}
\subsubsection[{elm\+\_\+obj\+\_\+index\+\_\+horizontal\+\_\+get}]{\setlength{\rightskip}{0pt plus 5cm}E\+O\+A\+P\+I Eina\+\_\+\+Bool elm\+\_\+obj\+\_\+index\+\_\+horizontal\+\_\+get (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
)}\label{group__Index_ga2899442dee209332c7b665fddaa24f73}


Get a value whether horizontal mode is enabled or not. 

\begin{DoxyReturn}{Returns}
{\ttfamily E\+I\+N\+A\+\_\+\+T\+R\+U\+E} means horizontal mode selection is enabled. {\ttfamily E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E} indicates it\textquotesingle{}s disabled. If {\ttfamily obj} is {\ttfamily N\+U\+L\+L}, {\ttfamily E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E} is returned.
\end{DoxyReturn}
\begin{DoxySeeAlso}{See also}
\hyperlink{group__Index_gab692af2d53bdfb5d043fccb84a0fc681}{elm\+\_\+index\+\_\+horizontal\+\_\+set()} for details. 
\end{DoxySeeAlso}


Referenced by elm\+\_\+index\+\_\+horizontal\+\_\+get().

\index{Index@{Index}!elm\+\_\+obj\+\_\+index\+\_\+horizontal\+\_\+set@{elm\+\_\+obj\+\_\+index\+\_\+horizontal\+\_\+set}}
\index{elm\+\_\+obj\+\_\+index\+\_\+horizontal\+\_\+set@{elm\+\_\+obj\+\_\+index\+\_\+horizontal\+\_\+set}!Index@{Index}}
\subsubsection[{elm\+\_\+obj\+\_\+index\+\_\+horizontal\+\_\+set}]{\setlength{\rightskip}{0pt plus 5cm}E\+O\+A\+P\+I void elm\+\_\+obj\+\_\+index\+\_\+horizontal\+\_\+set (
\begin{DoxyParamCaption}
\item[{Eina\+\_\+\+Bool}]{horizontal}
\end{DoxyParamCaption}
)}\label{group__Index_ga3e423ce741e6efd55409dbefb42630c1}


Enable or disable horizontal mode on the index object. 

\begin{DoxyNote}{Note}
Vertical mode is set by default.
\end{DoxyNote}
On horizontal mode items are displayed on index from left to right, instead of from top to bottom. Also, the index will scroll horizontally.

\begin{DoxySeeAlso}{See also}
\hyperlink{group__Index_gaf48b49e2ad3fe94ab8dfbe01d8b4fe77}{elm\+\_\+index\+\_\+horizontal\+\_\+get()}
\end{DoxySeeAlso}

\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em horizontal} & {\ttfamily E\+I\+N\+A\+\_\+\+T\+R\+U\+E} to enable horizontal or {\ttfamily E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E} to disable it, i.\+e., to enable vertical mode. it\textquotesingle{}s an area one \hyperlink{group__Fingers}{finger} wide on the bottom side of the index widget\textquotesingle{}s container. \\
\hline
\end{DoxyParams}


Referenced by elm\+\_\+index\+\_\+horizontal\+\_\+set().

\index{Index@{Index}!elm\+\_\+obj\+\_\+index\+\_\+indicator\+\_\+disabled\+\_\+get@{elm\+\_\+obj\+\_\+index\+\_\+indicator\+\_\+disabled\+\_\+get}}
\index{elm\+\_\+obj\+\_\+index\+\_\+indicator\+\_\+disabled\+\_\+get@{elm\+\_\+obj\+\_\+index\+\_\+indicator\+\_\+disabled\+\_\+get}!Index@{Index}}
\subsubsection[{elm\+\_\+obj\+\_\+index\+\_\+indicator\+\_\+disabled\+\_\+get}]{\setlength{\rightskip}{0pt plus 5cm}E\+O\+A\+P\+I Eina\+\_\+\+Bool elm\+\_\+obj\+\_\+index\+\_\+indicator\+\_\+disabled\+\_\+get (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
)}\label{group__Index_gaef593dd55d186821cfc8369d83c8abbd}


Get the value of indicator\textquotesingle{}s disabled status. 

\begin{DoxyReturn}{Returns}
E\+I\+N\+A\+\_\+\+T\+R\+U\+E if the indicator is disabled.
\end{DoxyReturn}
\begin{DoxySeeAlso}{See also}
\hyperlink{group__Index_ga91a560f52fbbd4701eb0fbdc6fd00021}{elm\+\_\+index\+\_\+indicator\+\_\+disabled\+\_\+set()} 
\end{DoxySeeAlso}


Referenced by elm\+\_\+index\+\_\+indicator\+\_\+disabled\+\_\+get().

\index{Index@{Index}!elm\+\_\+obj\+\_\+index\+\_\+indicator\+\_\+disabled\+\_\+set@{elm\+\_\+obj\+\_\+index\+\_\+indicator\+\_\+disabled\+\_\+set}}
\index{elm\+\_\+obj\+\_\+index\+\_\+indicator\+\_\+disabled\+\_\+set@{elm\+\_\+obj\+\_\+index\+\_\+indicator\+\_\+disabled\+\_\+set}!Index@{Index}}
\subsubsection[{elm\+\_\+obj\+\_\+index\+\_\+indicator\+\_\+disabled\+\_\+set}]{\setlength{\rightskip}{0pt plus 5cm}E\+O\+A\+P\+I void elm\+\_\+obj\+\_\+index\+\_\+indicator\+\_\+disabled\+\_\+set (
\begin{DoxyParamCaption}
\item[{Eina\+\_\+\+Bool}]{disabled}
\end{DoxyParamCaption}
)}\label{group__Index_ga07c136658bfdc559039dbeefd45313d9}


Set the indicator as to be disabled. 

In Index widget, Indicator notes popup text, which shows a letter has been selecting.

\begin{DoxySeeAlso}{See also}
\hyperlink{group__Index_gab34a2f658cc248f3f569d8dc05069d47}{elm\+\_\+index\+\_\+indicator\+\_\+disabled\+\_\+get()}
\end{DoxySeeAlso}

\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em disabled} & {\ttfamily E\+I\+N\+A\+\_\+\+T\+R\+U\+E} to disable it, {\ttfamily E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E} to enable it \\
\hline
\end{DoxyParams}


Referenced by elm\+\_\+index\+\_\+indicator\+\_\+disabled\+\_\+set().

\index{Index@{Index}!elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+append@{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+append}}
\index{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+append@{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+append}!Index@{Index}}
\subsubsection[{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+append}]{\setlength{\rightskip}{0pt plus 5cm}E\+O\+A\+P\+I {\bf Elm\+\_\+\+Object\+\_\+\+Item}$\ast$ elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+append (
\begin{DoxyParamCaption}
\item[{const char $\ast$}]{letter, }
\item[{Evas\+\_\+\+Smart\+\_\+\+Cb}]{func, }
\item[{const void $\ast$}]{data}
\end{DoxyParamCaption}
)}\label{group__Index_ga5fcfbd4546f6d337391db6443bb81315}


Append a new item on a given index widget. 

\begin{DoxyReturn}{Returns}
A handle to the item added or {\ttfamily N\+U\+L\+L}, on errors
\end{DoxyReturn}
Despite the most common usage of the {\ttfamily letter} argument is for single char strings, one could use arbitrary strings as index entries.

{\ttfamily item} will be the pointer returned back on {\ttfamily \char`\"{}changed\char`\"{}}, {\ttfamily \char`\"{}delay,changed\char`\"{}} and {\ttfamily \char`\"{}selected\char`\"{}} smart events.


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em letter} & Letter under which the item should be indexed \\
\hline
\mbox{\tt in}  & {\em func} & The function to call when the item is selected. \\
\hline
\mbox{\tt in}  & {\em data} & The item data to set for the index\textquotesingle{}s item \\
\hline
\end{DoxyParams}


Referenced by elm\+\_\+index\+\_\+item\+\_\+append().

\index{Index@{Index}!elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+clear@{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+clear}}
\index{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+clear@{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+clear}!Index@{Index}}
\subsubsection[{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+clear}]{\setlength{\rightskip}{0pt plus 5cm}E\+O\+A\+P\+I void elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+clear (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
)}\label{group__Index_ga86db51d5e9ddd52c229f1ff6a32263c6}


Removes {\bfseries all} items from a given index widget. 

If deletion callbacks are set, via elm\+\_\+object\+\_\+item\+\_\+del\+\_\+cb\+\_\+set(), that callback function will be called for each item in {\ttfamily obj}. 

Referenced by elm\+\_\+index\+\_\+item\+\_\+clear().

\index{Index@{Index}!elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+find@{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+find}}
\index{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+find@{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+find}!Index@{Index}}
\subsubsection[{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+find}]{\setlength{\rightskip}{0pt plus 5cm}E\+O\+A\+P\+I {\bf Elm\+\_\+\+Object\+\_\+\+Item}$\ast$ elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+find (
\begin{DoxyParamCaption}
\item[{const void $\ast$}]{data}
\end{DoxyParamCaption}
)}\label{group__Index_ga2f47388ce1f420de6e3006a8adf56f0a}


Find a given index widget\textquotesingle{}s item, {\bfseries using item data}. 

\begin{DoxyReturn}{Returns}
The index item handle, if found, or {\ttfamily N\+U\+L\+L} otherwise
\end{DoxyReturn}

\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em data} & The item data pointed to by the desired index item \\
\hline
\end{DoxyParams}


Referenced by elm\+\_\+index\+\_\+item\+\_\+find().

\index{Index@{Index}!elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+insert\+\_\+after@{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+insert\+\_\+after}}
\index{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+insert\+\_\+after@{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+insert\+\_\+after}!Index@{Index}}
\subsubsection[{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+insert\+\_\+after}]{\setlength{\rightskip}{0pt plus 5cm}E\+O\+A\+P\+I {\bf Elm\+\_\+\+Object\+\_\+\+Item}$\ast$ elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+insert\+\_\+after (
\begin{DoxyParamCaption}
\item[{{\bf Elm\+\_\+\+Object\+\_\+\+Item} $\ast$}]{after, }
\item[{const char $\ast$}]{letter, }
\item[{Evas\+\_\+\+Smart\+\_\+\+Cb}]{func, }
\item[{const void $\ast$}]{data}
\end{DoxyParamCaption}
)}\label{group__Index_ga0c27c8ceab3fb9f4378218a0bb860dc7}


Insert a new item into the index object after item {\ttfamily after}. 

\begin{DoxyReturn}{Returns}
A handle to the item added or {\ttfamily N\+U\+L\+L}, on errors
\end{DoxyReturn}
Despite the most common usage of the {\ttfamily letter} argument is for single char strings, one could use arbitrary strings as index entries.

{\ttfamily item} will be the pointer returned back on {\ttfamily \char`\"{}changed\char`\"{}}, {\ttfamily \char`\"{}delay,changed\char`\"{}} and {\ttfamily \char`\"{}selected\char`\"{}} smart events.

\begin{DoxyNote}{Note}
If {\ttfamily relative} is {\ttfamily N\+U\+L\+L} this function will behave as \hyperlink{group__Index_gaa53c8b41672887b5045e475a6015e245}{elm\+\_\+index\+\_\+item\+\_\+append()}.
\end{DoxyNote}

\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em after} & The index item to insert after. \\
\hline
\mbox{\tt in}  & {\em letter} & Letter under which the item should be indexed \\
\hline
\mbox{\tt in}  & {\em func} & The function to call when the item is clicked. \\
\hline
\mbox{\tt in}  & {\em data} & The item data to set for the index\textquotesingle{}s item \\
\hline
\end{DoxyParams}


Referenced by elm\+\_\+index\+\_\+item\+\_\+insert\+\_\+after().

\index{Index@{Index}!elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+insert\+\_\+before@{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+insert\+\_\+before}}
\index{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+insert\+\_\+before@{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+insert\+\_\+before}!Index@{Index}}
\subsubsection[{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+insert\+\_\+before}]{\setlength{\rightskip}{0pt plus 5cm}E\+O\+A\+P\+I {\bf Elm\+\_\+\+Object\+\_\+\+Item}$\ast$ elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+insert\+\_\+before (
\begin{DoxyParamCaption}
\item[{{\bf Elm\+\_\+\+Object\+\_\+\+Item} $\ast$}]{before, }
\item[{const char $\ast$}]{letter, }
\item[{Evas\+\_\+\+Smart\+\_\+\+Cb}]{func, }
\item[{const void $\ast$}]{data}
\end{DoxyParamCaption}
)}\label{group__Index_ga7af4814a4377e72846bd0b56788021ab}


Insert a new item into the index object before item {\ttfamily before}. 

\begin{DoxyReturn}{Returns}
A handle to the item added or {\ttfamily N\+U\+L\+L}, on errors
\end{DoxyReturn}
Despite the most common usage of the {\ttfamily letter} argument is for single char strings, one could use arbitrary strings as index entries.

{\ttfamily item} will be the pointer returned back on {\ttfamily \char`\"{}changed\char`\"{}}, {\ttfamily \char`\"{}delay,changed\char`\"{}} and {\ttfamily \char`\"{}selected\char`\"{}} smart events.

\begin{DoxyNote}{Note}
If {\ttfamily relative} is {\ttfamily N\+U\+L\+L} this function will behave as \hyperlink{group__Index_gaa8b9c57438e6d25be306431fd83b339a}{elm\+\_\+index\+\_\+item\+\_\+prepend()}.
\end{DoxyNote}

\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em before} & The index item to insert after. \\
\hline
\mbox{\tt in}  & {\em letter} & Letter under which the item should be indexed \\
\hline
\mbox{\tt in}  & {\em func} & The function to call when the item is clicked. \\
\hline
\mbox{\tt in}  & {\em data} & The item data to set for the index\textquotesingle{}s item \\
\hline
\end{DoxyParams}


Referenced by elm\+\_\+index\+\_\+item\+\_\+insert\+\_\+before().

\index{Index@{Index}!elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+letter\+\_\+get@{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+letter\+\_\+get}}
\index{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+letter\+\_\+get@{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+letter\+\_\+get}!Index@{Index}}
\subsubsection[{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+letter\+\_\+get}]{\setlength{\rightskip}{0pt plus 5cm}E\+O\+A\+P\+I const char$\ast$ elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+letter\+\_\+get (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
)}\label{group__Index_ga26623fc4593ea6c42dabed069f73fe8f}


Get the letter (string) set on a given index widget item. 

\begin{DoxyReturn}{Returns}
The letter string set on {\ttfamily item} 
\end{DoxyReturn}


Referenced by elm\+\_\+index\+\_\+item\+\_\+letter\+\_\+get().

\index{Index@{Index}!elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+level\+\_\+get@{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+level\+\_\+get}}
\index{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+level\+\_\+get@{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+level\+\_\+get}!Index@{Index}}
\subsubsection[{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+level\+\_\+get}]{\setlength{\rightskip}{0pt plus 5cm}E\+O\+A\+P\+I int elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+level\+\_\+get (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
)}\label{group__Index_gafc18b2d5558ac9d86ffcdb1b4d22c66d}


Get the items level set for a given index widget. 

\begin{DoxyReturn}{Returns}
{\ttfamily 0} or {\ttfamily 1}, which are the levels {\ttfamily obj} might be at.
\end{DoxyReturn}
\begin{DoxySeeAlso}{See also}
\hyperlink{group__Index_ga2c11e086e69792d90864fbf259b3ca2d}{elm\+\_\+index\+\_\+item\+\_\+level\+\_\+set()} for more information 
\end{DoxySeeAlso}


Referenced by elm\+\_\+index\+\_\+item\+\_\+level\+\_\+get().

\index{Index@{Index}!elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+level\+\_\+set@{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+level\+\_\+set}}
\index{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+level\+\_\+set@{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+level\+\_\+set}!Index@{Index}}
\subsubsection[{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+level\+\_\+set}]{\setlength{\rightskip}{0pt plus 5cm}E\+O\+A\+P\+I void elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+level\+\_\+set (
\begin{DoxyParamCaption}
\item[{int}]{level}
\end{DoxyParamCaption}
)}\label{group__Index_gab87367c1ec331e5a3b5932f2182f8734}


Set the items level for a given index widget. 

\begin{DoxySeeAlso}{See also}
\hyperlink{group__Index_ga545438c3478927e96e168c04df253477}{elm\+\_\+index\+\_\+item\+\_\+level\+\_\+get()}
\end{DoxySeeAlso}

\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em level} & {\ttfamily 0} or {\ttfamily 1}, the currently implemented levels. \\
\hline
\end{DoxyParams}


Referenced by elm\+\_\+index\+\_\+item\+\_\+level\+\_\+set().

\index{Index@{Index}!elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+prepend@{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+prepend}}
\index{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+prepend@{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+prepend}!Index@{Index}}
\subsubsection[{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+prepend}]{\setlength{\rightskip}{0pt plus 5cm}E\+O\+A\+P\+I {\bf Elm\+\_\+\+Object\+\_\+\+Item}$\ast$ elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+prepend (
\begin{DoxyParamCaption}
\item[{const char $\ast$}]{letter, }
\item[{Evas\+\_\+\+Smart\+\_\+\+Cb}]{func, }
\item[{const void $\ast$}]{data}
\end{DoxyParamCaption}
)}\label{group__Index_gaf620fc1fe9083c185ac8b16c3c8eb680}


Prepend a new item on a given index widget. 

\begin{DoxyReturn}{Returns}
A handle to the item added or {\ttfamily N\+U\+L\+L}, on errors
\end{DoxyReturn}
Despite the most common usage of the {\ttfamily letter} argument is for single char strings, one could use arbitrary strings as index entries.

{\ttfamily item} will be the pointer returned back on {\ttfamily \char`\"{}changed\char`\"{}}, {\ttfamily \char`\"{}delay,changed\char`\"{}} and {\ttfamily \char`\"{}selected\char`\"{}} smart events.


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em letter} & Letter under which the item should be indexed \\
\hline
\mbox{\tt in}  & {\em func} & The function to call when the item is selected. \\
\hline
\mbox{\tt in}  & {\em data} & The item data to set for the index\textquotesingle{}s item \\
\hline
\end{DoxyParams}


Referenced by elm\+\_\+index\+\_\+item\+\_\+prepend().

\index{Index@{Index}!elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+selected\+\_\+set@{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+selected\+\_\+set}}
\index{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+selected\+\_\+set@{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+selected\+\_\+set}!Index@{Index}}
\subsubsection[{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+selected\+\_\+set}]{\setlength{\rightskip}{0pt plus 5cm}E\+O\+A\+P\+I void elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+selected\+\_\+set (
\begin{DoxyParamCaption}
\item[{Eina\+\_\+\+Bool}]{selected}
\end{DoxyParamCaption}
)}\label{group__Index_gaacfacb0b2f84aea6ce543419ec6bfb1e}


Set the selected state of an item. 

This sets the selected state of the given item {\ttfamily it}. {\ttfamily E\+I\+N\+A\+\_\+\+T\+R\+U\+E} for selected, {\ttfamily E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E} for not selected.

If a new item is selected the previously selected will be unselected. Previously selected item can be get with function \hyperlink{group__Index_ga0bddbf11076bb50dcbed91465f22d1c7}{elm\+\_\+index\+\_\+selected\+\_\+item\+\_\+get()}.

Selected items will be highlighted.

\begin{DoxySeeAlso}{See also}
\hyperlink{group__Index_ga0bddbf11076bb50dcbed91465f22d1c7}{elm\+\_\+index\+\_\+selected\+\_\+item\+\_\+get()}
\end{DoxySeeAlso}

\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em selected} & E\+I\+N\+A\+\_\+\+T\+R\+U\+E if selected E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E otherwise \\
\hline
\end{DoxyParams}


Referenced by elm\+\_\+index\+\_\+item\+\_\+selected\+\_\+set().

\index{Index@{Index}!elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+sorted\+\_\+insert@{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+sorted\+\_\+insert}}
\index{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+sorted\+\_\+insert@{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+sorted\+\_\+insert}!Index@{Index}}
\subsubsection[{elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+sorted\+\_\+insert}]{\setlength{\rightskip}{0pt plus 5cm}E\+O\+A\+P\+I {\bf Elm\+\_\+\+Object\+\_\+\+Item}$\ast$ elm\+\_\+obj\+\_\+index\+\_\+item\+\_\+sorted\+\_\+insert (
\begin{DoxyParamCaption}
\item[{const char $\ast$}]{letter, }
\item[{Evas\+\_\+\+Smart\+\_\+\+Cb}]{func, }
\item[{const void $\ast$}]{data, }
\item[{Eina\+\_\+\+Compare\+\_\+\+Cb}]{cmp\+\_\+func, }
\item[{Eina\+\_\+\+Compare\+\_\+\+Cb}]{cmp\+\_\+data\+\_\+func}
\end{DoxyParamCaption}
)}\label{group__Index_gaf3b2bf9cdcf74436548462ccbc3107fc}


Insert a new item into the given index widget, using {\ttfamily cmp\+\_\+func} function to sort items (by item handles). 

\begin{DoxyReturn}{Returns}
A handle to the item added or {\ttfamily N\+U\+L\+L}, on errors
\end{DoxyReturn}
Despite the most common usage of the {\ttfamily letter} argument is for single char strings, one could use arbitrary strings as index entries.

{\ttfamily item} will be the pointer returned back on {\ttfamily \char`\"{}changed\char`\"{}}, {\ttfamily \char`\"{}delay,changed\char`\"{}} and {\ttfamily \char`\"{}selected\char`\"{}} smart events.


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em letter} & Letter under which the item should be indexed \\
\hline
\mbox{\tt in}  & {\em func} & The function to call when the item is clicked. \\
\hline
\mbox{\tt in}  & {\em data} & The item data to set for the index\textquotesingle{}s item \\
\hline
\mbox{\tt in}  & {\em cmp\+\_\+func} & The comparing function to be used to sort index items {\bfseries by index item handles} \\
\hline
\mbox{\tt in}  & {\em cmp\+\_\+data\+\_\+func} & A {\bfseries fallback} function to be called for the sorting of index items {\bfseries by item data}). It will be used when {\ttfamily cmp\+\_\+func} returns {\ttfamily 0} (equality), which means an index item with provided item data already exists. To decide which data item should be pointed to by the index item in question, {\ttfamily cmp\+\_\+data\+\_\+func} will be used. If {\ttfamily cmp\+\_\+data\+\_\+func} returns a non-\/negative value, the previous index item data will be replaced by the given {\ttfamily item} pointer. If the previous data need to be freed, it should be done by the {\ttfamily cmp\+\_\+data\+\_\+func} function, because all references to it will be lost. If this function is not provided ({\ttfamily N\+U\+L\+L} is given), index items will be {\bfseries duplicated}, if {\ttfamily cmp\+\_\+func} returns {\ttfamily 0}. \\
\hline
\end{DoxyParams}


Referenced by elm\+\_\+index\+\_\+item\+\_\+sorted\+\_\+insert().

\index{Index@{Index}!elm\+\_\+obj\+\_\+index\+\_\+level\+\_\+go@{elm\+\_\+obj\+\_\+index\+\_\+level\+\_\+go}}
\index{elm\+\_\+obj\+\_\+index\+\_\+level\+\_\+go@{elm\+\_\+obj\+\_\+index\+\_\+level\+\_\+go}!Index@{Index}}
\subsubsection[{elm\+\_\+obj\+\_\+index\+\_\+level\+\_\+go}]{\setlength{\rightskip}{0pt plus 5cm}E\+O\+A\+P\+I void elm\+\_\+obj\+\_\+index\+\_\+level\+\_\+go (
\begin{DoxyParamCaption}
\item[{int}]{level}
\end{DoxyParamCaption}
)}\label{group__Index_gae8504f9144be0c32c1288e855137ff16}


Flush the changes made to the index items so they work correctly. 

This flushes any changes made to items indicating the object is ready to go. You should call this before any changes you expect to work. This is similar to \hyperlink{group__List_ga016361621126444b003a71dc8ff75627}{elm\+\_\+list\+\_\+go()}.

\begin{DoxyWarning}{Warning}
If not called, it won\textquotesingle{}t display the index properly.
\end{DoxyWarning}

\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em level} & The index level (one of {\ttfamily 0} or {\ttfamily 1}) where changes were made \\
\hline
\end{DoxyParams}


Referenced by elm\+\_\+index\+\_\+level\+\_\+go().

\index{Index@{Index}!elm\+\_\+obj\+\_\+index\+\_\+omit\+\_\+enabled\+\_\+get@{elm\+\_\+obj\+\_\+index\+\_\+omit\+\_\+enabled\+\_\+get}}
\index{elm\+\_\+obj\+\_\+index\+\_\+omit\+\_\+enabled\+\_\+get@{elm\+\_\+obj\+\_\+index\+\_\+omit\+\_\+enabled\+\_\+get}!Index@{Index}}
\subsubsection[{elm\+\_\+obj\+\_\+index\+\_\+omit\+\_\+enabled\+\_\+get}]{\setlength{\rightskip}{0pt plus 5cm}E\+O\+A\+P\+I Eina\+\_\+\+Bool elm\+\_\+obj\+\_\+index\+\_\+omit\+\_\+enabled\+\_\+get (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
)}\label{group__Index_ga676741d03a394815bedc26f9623b3166}


Get whether omit feature is enabled or not for a given index widget. 

\begin{DoxyReturn}{Returns}
{\ttfamily E\+I\+N\+A\+\_\+\+T\+R\+U\+E}, if omit feature is enabled, {\ttfamily E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E} otherwise
\end{DoxyReturn}
\begin{DoxySeeAlso}{See also}
\hyperlink{group__Index_gaae1377e77395cab18ba7a68bc6e0f66f}{elm\+\_\+index\+\_\+omit\+\_\+enabled\+\_\+set()}
\end{DoxySeeAlso}
\begin{DoxySince}{Since}
1.\+8 
\end{DoxySince}


Referenced by elm\+\_\+index\+\_\+omit\+\_\+enabled\+\_\+get().

\index{Index@{Index}!elm\+\_\+obj\+\_\+index\+\_\+omit\+\_\+enabled\+\_\+set@{elm\+\_\+obj\+\_\+index\+\_\+omit\+\_\+enabled\+\_\+set}}
\index{elm\+\_\+obj\+\_\+index\+\_\+omit\+\_\+enabled\+\_\+set@{elm\+\_\+obj\+\_\+index\+\_\+omit\+\_\+enabled\+\_\+set}!Index@{Index}}
\subsubsection[{elm\+\_\+obj\+\_\+index\+\_\+omit\+\_\+enabled\+\_\+set}]{\setlength{\rightskip}{0pt plus 5cm}E\+O\+A\+P\+I void elm\+\_\+obj\+\_\+index\+\_\+omit\+\_\+enabled\+\_\+set (
\begin{DoxyParamCaption}
\item[{Eina\+\_\+\+Bool}]{enabled}
\end{DoxyParamCaption}
)}\label{group__Index_gab1bf407171eed21f024ebe6a8bbc7530}


Enable or disable omit feature for a given index widget. 

\begin{DoxySeeAlso}{See also}
\hyperlink{group__Index_ga53c51630158c198ada3463a046e11bf3}{elm\+\_\+index\+\_\+omit\+\_\+enabled\+\_\+get()}
\end{DoxySeeAlso}
\begin{DoxySince}{Since}
1.\+8
\end{DoxySince}

\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em enabled} & {\ttfamily E\+I\+N\+A\+\_\+\+T\+R\+U\+E} to enable omit feature, {\ttfamily E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E} to disable \\
\hline
\end{DoxyParams}


Referenced by elm\+\_\+index\+\_\+omit\+\_\+enabled\+\_\+set().

\index{Index@{Index}!elm\+\_\+obj\+\_\+index\+\_\+selected\+\_\+item\+\_\+get@{elm\+\_\+obj\+\_\+index\+\_\+selected\+\_\+item\+\_\+get}}
\index{elm\+\_\+obj\+\_\+index\+\_\+selected\+\_\+item\+\_\+get@{elm\+\_\+obj\+\_\+index\+\_\+selected\+\_\+item\+\_\+get}!Index@{Index}}
\subsubsection[{elm\+\_\+obj\+\_\+index\+\_\+selected\+\_\+item\+\_\+get}]{\setlength{\rightskip}{0pt plus 5cm}E\+O\+A\+P\+I {\bf Elm\+\_\+\+Object\+\_\+\+Item}$\ast$ elm\+\_\+obj\+\_\+index\+\_\+selected\+\_\+item\+\_\+get (
\begin{DoxyParamCaption}
\item[{int}]{level}
\end{DoxyParamCaption}
)}\label{group__Index_ga3a6acc2dc6181db11616e852632b2e73}


Returns the last selected item, for a given index widget. 

\begin{DoxyReturn}{Returns}
The last item {\bfseries selected} on {\ttfamily obj} (or {\ttfamily N\+U\+L\+L}, on errors).
\end{DoxyReturn}

\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em level} & {\ttfamily 0} or {\ttfamily 1}, the currently implemented levels. \\
\hline
\end{DoxyParams}


Referenced by elm\+\_\+index\+\_\+selected\+\_\+item\+\_\+get().

