\section{Scrollhints}
\label{group__Scrollhints}\index{Scrollhints@{Scrollhints}}


Objects when inside a scroller can scroll, but this may not always be desirable in certain situations.  


\subsection*{Functions}
\begin{DoxyCompactItemize}
\item 
void \hyperlink{group__Scrollhints_ga78a8be314f38d32af65ed2e377ca8cd9}{elm\+\_\+object\+\_\+scroll\+\_\+hold\+\_\+push} (Evas\+\_\+\+Object $\ast$obj)
\begin{DoxyCompactList}\small\item\em Push the scroll hold by 1. \end{DoxyCompactList}\item 
void \hyperlink{group__Scrollhints_ga929a2fe5c870684671aefe6991a87fa5}{elm\+\_\+object\+\_\+scroll\+\_\+hold\+\_\+pop} (Evas\+\_\+\+Object $\ast$obj)
\begin{DoxyCompactList}\small\item\em Pop the scroll hold by 1. \end{DoxyCompactList}\item 
int \hyperlink{group__Scrollhints_gaf115e5746d7b4846a30452beae11c64b}{elm\+\_\+object\+\_\+scroll\+\_\+hold\+\_\+get} (const Evas\+\_\+\+Object $\ast$obj)
\begin{DoxyCompactList}\small\item\em Get the scroll hold by 1. \end{DoxyCompactList}\item 
void \hyperlink{group__Scrollhints_ga8f0c08f3e7e62191c9635b0a0bfce82b}{elm\+\_\+object\+\_\+scroll\+\_\+freeze\+\_\+push} (Evas\+\_\+\+Object $\ast$obj)
\begin{DoxyCompactList}\small\item\em Push the scroll freeze by 1. \end{DoxyCompactList}\item 
void \hyperlink{group__Scrollhints_ga5a99d1f4c4d16a308e96cab873f40e88}{elm\+\_\+object\+\_\+scroll\+\_\+freeze\+\_\+pop} (Evas\+\_\+\+Object $\ast$obj)
\begin{DoxyCompactList}\small\item\em Pop the scroll freeze by 1. \end{DoxyCompactList}\item 
int \hyperlink{group__Scrollhints_ga51ae9da17ac7949d7a0910b4fde9d64b}{elm\+\_\+object\+\_\+scroll\+\_\+freeze\+\_\+get} (const Evas\+\_\+\+Object $\ast$obj)
\begin{DoxyCompactList}\small\item\em Get the scroll freeze by 1. \end{DoxyCompactList}\item 
void \hyperlink{group__Scrollhints_ga89f6f3eb8329f9e2769f746f2ea4e9de}{elm\+\_\+object\+\_\+scroll\+\_\+lock\+\_\+x\+\_\+set} (Evas\+\_\+\+Object $\ast$obj, Eina\+\_\+\+Bool lock)
\begin{DoxyCompactList}\small\item\em Lock the scrolling of the given widget (and thus all parents) \end{DoxyCompactList}\item 
void \hyperlink{group__Scrollhints_ga2921fe28d0d7109341b6f9d6e5571e31}{elm\+\_\+object\+\_\+scroll\+\_\+lock\+\_\+y\+\_\+set} (Evas\+\_\+\+Object $\ast$obj, Eina\+\_\+\+Bool lock)
\begin{DoxyCompactList}\small\item\em Lock the scrolling of the given widget (and thus all parents) \end{DoxyCompactList}\item 
Eina\+\_\+\+Bool \hyperlink{group__Scrollhints_ga020fbafc00374f1ee9efe9b95a8743ca}{elm\+\_\+object\+\_\+scroll\+\_\+lock\+\_\+x\+\_\+get} (const Evas\+\_\+\+Object $\ast$obj)
\begin{DoxyCompactList}\small\item\em Get the scrolling lock of the given widget. \end{DoxyCompactList}\item 
Eina\+\_\+\+Bool \hyperlink{group__Scrollhints_gab00003a1bb8b3f5931e25a13d1803289}{elm\+\_\+object\+\_\+scroll\+\_\+lock\+\_\+y\+\_\+get} (const Evas\+\_\+\+Object $\ast$obj)
\begin{DoxyCompactList}\small\item\em Get the scrolling lock of the given widget. \end{DoxyCompactList}\item 
void \hyperlink{group__Scrollhints_ga9b576810646d222f0447602a893a2f73}{elm\+\_\+object\+\_\+scroll\+\_\+item\+\_\+loop\+\_\+enabled\+\_\+set} (Evas\+\_\+\+Object $\ast$obj, Eina\+\_\+\+Bool enable)
\begin{DoxyCompactList}\small\item\em Enable item loop feature of the given widget. \end{DoxyCompactList}\item 
Eina\+\_\+\+Bool \hyperlink{group__Scrollhints_ga1a73e571ef6f33f48b9af2f16e67f61d}{elm\+\_\+object\+\_\+scroll\+\_\+item\+\_\+loop\+\_\+enabled\+\_\+get} (const Evas\+\_\+\+Object $\ast$obj)
\begin{DoxyCompactList}\small\item\em Get the item loop enable status of the given widget. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
Objects when inside a scroller can scroll, but this may not always be desirable in certain situations. 

This allows an object to hint to itself and parents to \char`\"{}not scroll\char`\"{} in one of 2 ways. If any child object of a scroller has pushed a scroll freeze or hold then it affects all parent scrollers until all children have released them.


\begin{DoxyEnumerate}
\item To hold on scrolling. This means just flicking and dragging may no longer scroll, but pressing/dragging near an edge of the scroller will still scroll. This is automatically used by the entry object when selecting text.
\item To totally freeze scrolling. This means it stops. until popped/released. 
\end{DoxyEnumerate}

\subsection{Function Documentation}
\index{Scrollhints@{Scrollhints}!elm\+\_\+object\+\_\+scroll\+\_\+freeze\+\_\+get@{elm\+\_\+object\+\_\+scroll\+\_\+freeze\+\_\+get}}
\index{elm\+\_\+object\+\_\+scroll\+\_\+freeze\+\_\+get@{elm\+\_\+object\+\_\+scroll\+\_\+freeze\+\_\+get}!Scrollhints@{Scrollhints}}
\subsubsection[{elm\+\_\+object\+\_\+scroll\+\_\+freeze\+\_\+get(const Evas\+\_\+\+Object $\ast$obj)}]{\setlength{\rightskip}{0pt plus 5cm}int elm\+\_\+object\+\_\+scroll\+\_\+freeze\+\_\+get (
\begin{DoxyParamCaption}
\item[{const Evas\+\_\+\+Object $\ast$}]{obj}
\end{DoxyParamCaption}
)}\label{group__Scrollhints_ga51ae9da17ac7949d7a0910b4fde9d64b}


Get the scroll freeze by 1. 

This gets the scroll freeze count by one.


\begin{DoxyParams}{Parameters}
{\em obj} & The object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
The scroll freeze count 
\end{DoxyReturn}
\begin{DoxySince}{Since}
1.\+7 
\end{DoxySince}
\index{Scrollhints@{Scrollhints}!elm\+\_\+object\+\_\+scroll\+\_\+freeze\+\_\+pop@{elm\+\_\+object\+\_\+scroll\+\_\+freeze\+\_\+pop}}
\index{elm\+\_\+object\+\_\+scroll\+\_\+freeze\+\_\+pop@{elm\+\_\+object\+\_\+scroll\+\_\+freeze\+\_\+pop}!Scrollhints@{Scrollhints}}
\subsubsection[{elm\+\_\+object\+\_\+scroll\+\_\+freeze\+\_\+pop(\+Evas\+\_\+\+Object $\ast$obj)}]{\setlength{\rightskip}{0pt plus 5cm}void elm\+\_\+object\+\_\+scroll\+\_\+freeze\+\_\+pop (
\begin{DoxyParamCaption}
\item[{Evas\+\_\+\+Object $\ast$}]{obj}
\end{DoxyParamCaption}
)}\label{group__Scrollhints_ga5a99d1f4c4d16a308e96cab873f40e88}


Pop the scroll freeze by 1. 

This decrements the scroll freeze count by one. If it is more than 0 it will take effect on the parents of the indicated object.


\begin{DoxyParams}{Parameters}
{\em obj} & The object \\
\hline
\end{DoxyParams}
\index{Scrollhints@{Scrollhints}!elm\+\_\+object\+\_\+scroll\+\_\+freeze\+\_\+push@{elm\+\_\+object\+\_\+scroll\+\_\+freeze\+\_\+push}}
\index{elm\+\_\+object\+\_\+scroll\+\_\+freeze\+\_\+push@{elm\+\_\+object\+\_\+scroll\+\_\+freeze\+\_\+push}!Scrollhints@{Scrollhints}}
\subsubsection[{elm\+\_\+object\+\_\+scroll\+\_\+freeze\+\_\+push(\+Evas\+\_\+\+Object $\ast$obj)}]{\setlength{\rightskip}{0pt plus 5cm}void elm\+\_\+object\+\_\+scroll\+\_\+freeze\+\_\+push (
\begin{DoxyParamCaption}
\item[{Evas\+\_\+\+Object $\ast$}]{obj}
\end{DoxyParamCaption}
)}\label{group__Scrollhints_ga8f0c08f3e7e62191c9635b0a0bfce82b}


Push the scroll freeze by 1. 

This increments the scroll freeze count by one. If it is more than 0 it will take effect on the parents of the indicated object.


\begin{DoxyParams}{Parameters}
{\em obj} & The object \\
\hline
\end{DoxyParams}
\index{Scrollhints@{Scrollhints}!elm\+\_\+object\+\_\+scroll\+\_\+hold\+\_\+get@{elm\+\_\+object\+\_\+scroll\+\_\+hold\+\_\+get}}
\index{elm\+\_\+object\+\_\+scroll\+\_\+hold\+\_\+get@{elm\+\_\+object\+\_\+scroll\+\_\+hold\+\_\+get}!Scrollhints@{Scrollhints}}
\subsubsection[{elm\+\_\+object\+\_\+scroll\+\_\+hold\+\_\+get(const Evas\+\_\+\+Object $\ast$obj)}]{\setlength{\rightskip}{0pt plus 5cm}int elm\+\_\+object\+\_\+scroll\+\_\+hold\+\_\+get (
\begin{DoxyParamCaption}
\item[{const Evas\+\_\+\+Object $\ast$}]{obj}
\end{DoxyParamCaption}
)}\label{group__Scrollhints_gaf115e5746d7b4846a30452beae11c64b}


Get the scroll hold by 1. 

This gets the scroll hold count by one.


\begin{DoxyParams}{Parameters}
{\em obj} & The object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
The scroll hold count 
\end{DoxyReturn}
\begin{DoxySince}{Since}
1.\+7 
\end{DoxySince}
\index{Scrollhints@{Scrollhints}!elm\+\_\+object\+\_\+scroll\+\_\+hold\+\_\+pop@{elm\+\_\+object\+\_\+scroll\+\_\+hold\+\_\+pop}}
\index{elm\+\_\+object\+\_\+scroll\+\_\+hold\+\_\+pop@{elm\+\_\+object\+\_\+scroll\+\_\+hold\+\_\+pop}!Scrollhints@{Scrollhints}}
\subsubsection[{elm\+\_\+object\+\_\+scroll\+\_\+hold\+\_\+pop(\+Evas\+\_\+\+Object $\ast$obj)}]{\setlength{\rightskip}{0pt plus 5cm}void elm\+\_\+object\+\_\+scroll\+\_\+hold\+\_\+pop (
\begin{DoxyParamCaption}
\item[{Evas\+\_\+\+Object $\ast$}]{obj}
\end{DoxyParamCaption}
)}\label{group__Scrollhints_ga929a2fe5c870684671aefe6991a87fa5}


Pop the scroll hold by 1. 

This decrements the scroll hold count by one. If it is more than 0 it will take effect on the parents of the indicated object.


\begin{DoxyParams}{Parameters}
{\em obj} & The object \\
\hline
\end{DoxyParams}
\index{Scrollhints@{Scrollhints}!elm\+\_\+object\+\_\+scroll\+\_\+hold\+\_\+push@{elm\+\_\+object\+\_\+scroll\+\_\+hold\+\_\+push}}
\index{elm\+\_\+object\+\_\+scroll\+\_\+hold\+\_\+push@{elm\+\_\+object\+\_\+scroll\+\_\+hold\+\_\+push}!Scrollhints@{Scrollhints}}
\subsubsection[{elm\+\_\+object\+\_\+scroll\+\_\+hold\+\_\+push(\+Evas\+\_\+\+Object $\ast$obj)}]{\setlength{\rightskip}{0pt plus 5cm}void elm\+\_\+object\+\_\+scroll\+\_\+hold\+\_\+push (
\begin{DoxyParamCaption}
\item[{Evas\+\_\+\+Object $\ast$}]{obj}
\end{DoxyParamCaption}
)}\label{group__Scrollhints_ga78a8be314f38d32af65ed2e377ca8cd9}


Push the scroll hold by 1. 

This increments the scroll hold count by one. If it is more than 0 it will take effect on the parents of the indicated object.


\begin{DoxyParams}{Parameters}
{\em obj} & The object \\
\hline
\end{DoxyParams}
\index{Scrollhints@{Scrollhints}!elm\+\_\+object\+\_\+scroll\+\_\+item\+\_\+loop\+\_\+enabled\+\_\+get@{elm\+\_\+object\+\_\+scroll\+\_\+item\+\_\+loop\+\_\+enabled\+\_\+get}}
\index{elm\+\_\+object\+\_\+scroll\+\_\+item\+\_\+loop\+\_\+enabled\+\_\+get@{elm\+\_\+object\+\_\+scroll\+\_\+item\+\_\+loop\+\_\+enabled\+\_\+get}!Scrollhints@{Scrollhints}}
\subsubsection[{elm\+\_\+object\+\_\+scroll\+\_\+item\+\_\+loop\+\_\+enabled\+\_\+get(const Evas\+\_\+\+Object $\ast$obj)}]{\setlength{\rightskip}{0pt plus 5cm}Eina\+\_\+\+Bool elm\+\_\+object\+\_\+scroll\+\_\+item\+\_\+loop\+\_\+enabled\+\_\+get (
\begin{DoxyParamCaption}
\item[{const Evas\+\_\+\+Object $\ast$}]{obj}
\end{DoxyParamCaption}
)}\label{group__Scrollhints_ga1a73e571ef6f33f48b9af2f16e67f61d}


Get the item loop enable status of the given widget. 

This gets the item loop enabled status.


\begin{DoxyParams}{Parameters}
{\em obj} & The object\\
\hline
\end{DoxyParams}
\begin{DoxySeeAlso}{See also}
elm\+\_\+objecdt\+\_\+scroll\+\_\+item\+\_\+enabled\+\_\+set() 
\end{DoxySeeAlso}
\begin{DoxySince}{Since}
1.\+10 
\end{DoxySince}
\index{Scrollhints@{Scrollhints}!elm\+\_\+object\+\_\+scroll\+\_\+item\+\_\+loop\+\_\+enabled\+\_\+set@{elm\+\_\+object\+\_\+scroll\+\_\+item\+\_\+loop\+\_\+enabled\+\_\+set}}
\index{elm\+\_\+object\+\_\+scroll\+\_\+item\+\_\+loop\+\_\+enabled\+\_\+set@{elm\+\_\+object\+\_\+scroll\+\_\+item\+\_\+loop\+\_\+enabled\+\_\+set}!Scrollhints@{Scrollhints}}
\subsubsection[{elm\+\_\+object\+\_\+scroll\+\_\+item\+\_\+loop\+\_\+enabled\+\_\+set(\+Evas\+\_\+\+Object $\ast$obj, Eina\+\_\+\+Bool enable)}]{\setlength{\rightskip}{0pt plus 5cm}void elm\+\_\+object\+\_\+scroll\+\_\+item\+\_\+loop\+\_\+enabled\+\_\+set (
\begin{DoxyParamCaption}
\item[{Evas\+\_\+\+Object $\ast$}]{obj, }
\item[{Eina\+\_\+\+Bool}]{enable}
\end{DoxyParamCaption}
)}\label{group__Scrollhints_ga9b576810646d222f0447602a893a2f73}


Enable item loop feature of the given widget. 

If {\ttfamily enable} is {\ttfamily E\+I\+N\+A\+\_\+\+T\+R\+U\+E}, item selection/focus will loop internally. This means if arrow keys are pressed at end of scroller\textquotesingle{}s item, screen is moved to opposite side.


\begin{DoxyParams}{Parameters}
{\em obj} & The object \\
\hline
{\em enable} & item loop feature ({\ttfamily E\+I\+N\+A\+\_\+\+T\+R\+U\+E} == enable, {\ttfamily E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E} == disable)\\
\hline
\end{DoxyParams}
\begin{DoxySeeAlso}{See also}
\hyperlink{group__Scrollhints_ga1a73e571ef6f33f48b9af2f16e67f61d}{elm\+\_\+object\+\_\+scroll\+\_\+item\+\_\+loop\+\_\+enabled\+\_\+get()} 
\end{DoxySeeAlso}
\begin{DoxySince}{Since}
1.\+10 
\end{DoxySince}
\index{Scrollhints@{Scrollhints}!elm\+\_\+object\+\_\+scroll\+\_\+lock\+\_\+x\+\_\+get@{elm\+\_\+object\+\_\+scroll\+\_\+lock\+\_\+x\+\_\+get}}
\index{elm\+\_\+object\+\_\+scroll\+\_\+lock\+\_\+x\+\_\+get@{elm\+\_\+object\+\_\+scroll\+\_\+lock\+\_\+x\+\_\+get}!Scrollhints@{Scrollhints}}
\subsubsection[{elm\+\_\+object\+\_\+scroll\+\_\+lock\+\_\+x\+\_\+get(const Evas\+\_\+\+Object $\ast$obj)}]{\setlength{\rightskip}{0pt plus 5cm}Eina\+\_\+\+Bool elm\+\_\+object\+\_\+scroll\+\_\+lock\+\_\+x\+\_\+get (
\begin{DoxyParamCaption}
\item[{const Evas\+\_\+\+Object $\ast$}]{obj}
\end{DoxyParamCaption}
)}\label{group__Scrollhints_ga020fbafc00374f1ee9efe9b95a8743ca}


Get the scrolling lock of the given widget. 

This gets the lock for X axis scrolling.


\begin{DoxyParams}{Parameters}
{\em obj} & The object \\
\hline
\end{DoxyParams}
\index{Scrollhints@{Scrollhints}!elm\+\_\+object\+\_\+scroll\+\_\+lock\+\_\+x\+\_\+set@{elm\+\_\+object\+\_\+scroll\+\_\+lock\+\_\+x\+\_\+set}}
\index{elm\+\_\+object\+\_\+scroll\+\_\+lock\+\_\+x\+\_\+set@{elm\+\_\+object\+\_\+scroll\+\_\+lock\+\_\+x\+\_\+set}!Scrollhints@{Scrollhints}}
\subsubsection[{elm\+\_\+object\+\_\+scroll\+\_\+lock\+\_\+x\+\_\+set(\+Evas\+\_\+\+Object $\ast$obj, Eina\+\_\+\+Bool lock)}]{\setlength{\rightskip}{0pt plus 5cm}void elm\+\_\+object\+\_\+scroll\+\_\+lock\+\_\+x\+\_\+set (
\begin{DoxyParamCaption}
\item[{Evas\+\_\+\+Object $\ast$}]{obj, }
\item[{Eina\+\_\+\+Bool}]{lock}
\end{DoxyParamCaption}
)}\label{group__Scrollhints_ga89f6f3eb8329f9e2769f746f2ea4e9de}


Lock the scrolling of the given widget (and thus all parents) 

This locks the given object from scrolling in the X axis (and implicitly also locks all parent scrollers too from doing the same).


\begin{DoxyParams}{Parameters}
{\em obj} & The object \\
\hline
{\em lock} & The lock state (1 == locked, 0 == unlocked) \\
\hline
\end{DoxyParams}
\index{Scrollhints@{Scrollhints}!elm\+\_\+object\+\_\+scroll\+\_\+lock\+\_\+y\+\_\+get@{elm\+\_\+object\+\_\+scroll\+\_\+lock\+\_\+y\+\_\+get}}
\index{elm\+\_\+object\+\_\+scroll\+\_\+lock\+\_\+y\+\_\+get@{elm\+\_\+object\+\_\+scroll\+\_\+lock\+\_\+y\+\_\+get}!Scrollhints@{Scrollhints}}
\subsubsection[{elm\+\_\+object\+\_\+scroll\+\_\+lock\+\_\+y\+\_\+get(const Evas\+\_\+\+Object $\ast$obj)}]{\setlength{\rightskip}{0pt plus 5cm}Eina\+\_\+\+Bool elm\+\_\+object\+\_\+scroll\+\_\+lock\+\_\+y\+\_\+get (
\begin{DoxyParamCaption}
\item[{const Evas\+\_\+\+Object $\ast$}]{obj}
\end{DoxyParamCaption}
)}\label{group__Scrollhints_gab00003a1bb8b3f5931e25a13d1803289}


Get the scrolling lock of the given widget. 

This gets the lock for Y axis scrolling.


\begin{DoxyParams}{Parameters}
{\em obj} & The object \\
\hline
\end{DoxyParams}
\index{Scrollhints@{Scrollhints}!elm\+\_\+object\+\_\+scroll\+\_\+lock\+\_\+y\+\_\+set@{elm\+\_\+object\+\_\+scroll\+\_\+lock\+\_\+y\+\_\+set}}
\index{elm\+\_\+object\+\_\+scroll\+\_\+lock\+\_\+y\+\_\+set@{elm\+\_\+object\+\_\+scroll\+\_\+lock\+\_\+y\+\_\+set}!Scrollhints@{Scrollhints}}
\subsubsection[{elm\+\_\+object\+\_\+scroll\+\_\+lock\+\_\+y\+\_\+set(\+Evas\+\_\+\+Object $\ast$obj, Eina\+\_\+\+Bool lock)}]{\setlength{\rightskip}{0pt plus 5cm}void elm\+\_\+object\+\_\+scroll\+\_\+lock\+\_\+y\+\_\+set (
\begin{DoxyParamCaption}
\item[{Evas\+\_\+\+Object $\ast$}]{obj, }
\item[{Eina\+\_\+\+Bool}]{lock}
\end{DoxyParamCaption}
)}\label{group__Scrollhints_ga2921fe28d0d7109341b6f9d6e5571e31}


Lock the scrolling of the given widget (and thus all parents) 

This locks the given object from scrolling in the Y axis (and implicitly also locks all parent scrollers too from doing the same).


\begin{DoxyParams}{Parameters}
{\em obj} & The object \\
\hline
{\em lock} & The lock state (1 == locked, 0 == unlocked) \\
\hline
\end{DoxyParams}
