\section{KText\-Editor::Text\-Hint\-Interface Class Reference}
\label{classKTextEditor_1_1TextHintInterface}\index{KTextEditor::TextHintInterface@{KTextEditor::TextHintInterface}}
This is an interface for the {\bf KText\-Editor::View}{\rm (p.\,\pageref{classKTextEditor_1_1View})} class.  


{\tt \#include $<$texthintinterface.h$>$}

\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
virtual void {\bf enable\-Text\-Hints} (int timeout)=0
\item 
virtual void {\bf disable\-Text\-Hints} ()=0
\item 
unsigned int {\bf text\-Hint\-Interface\-Number} () const 
\item 
virtual void {\bf need\-Text\-Hint} (int line, int col, {\bf QString} \&text)=0
\end{CompactItemize}
\subsection*{Friends}
\begin{CompactItemize}
\item 
class {\bf Private\-Text\-Hint\-Interface}\label{classKTextEditor_1_1TextHintInterface_n0}

\end{CompactItemize}


\subsection{Detailed Description}
This is an interface for the {\bf KText\-Editor::View}{\rm (p.\,\pageref{classKTextEditor_1_1View})} class. 



Definition at line 34 of file texthintinterface.h.

\subsection{Member Function Documentation}
\index{KTextEditor::TextHintInterface@{KText\-Editor::Text\-Hint\-Interface}!enableTextHints@{enableTextHints}}
\index{enableTextHints@{enableTextHints}!KTextEditor::TextHintInterface@{KText\-Editor::Text\-Hint\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void KText\-Editor::Text\-Hint\-Interface::enable\-Text\-Hints (int {\em timeout})\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKTextEditor_1_1TextHintInterface_a2}


enable Texthints. 

If they are enabled a signal need\-Text\-Hint is emitted, if the mouse changed the position and a new character is beneath the mouse cursor. The signal is delayed for a certain time, specifiedin the timeout parameter.\index{KTextEditor::TextHintInterface@{KText\-Editor::Text\-Hint\-Interface}!disableTextHints@{disableTextHints}}
\index{disableTextHints@{disableTextHints}!KTextEditor::TextHintInterface@{KText\-Editor::Text\-Hint\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void KText\-Editor::Text\-Hint\-Interface::disable\-Text\-Hints ()\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKTextEditor_1_1TextHintInterface_a3}


Disable texthints. 

Per default they are disabled.\index{KTextEditor::TextHintInterface@{KText\-Editor::Text\-Hint\-Interface}!textHintInterfaceNumber@{textHintInterfaceNumber}}
\index{textHintInterfaceNumber@{textHintInterfaceNumber}!KTextEditor::TextHintInterface@{KText\-Editor::Text\-Hint\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}unsigned int KText\-Editor::Text\-Hint\-Interface::text\-Hint\-Interface\-Number () const}\label{classKTextEditor_1_1TextHintInterface_a4}


This method returns a number, unique during one application run. 



Definition at line 50 of file texthintinterface.cpp.\index{KTextEditor::TextHintInterface@{KText\-Editor::Text\-Hint\-Interface}!needTextHint@{needTextHint}}
\index{needTextHint@{needTextHint}!KTextEditor::TextHintInterface@{KText\-Editor::Text\-Hint\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void KText\-Editor::Text\-Hint\-Interface::need\-Text\-Hint (int {\em line}, int {\em col}, {\bf QString} \& {\em text})\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKTextEditor_1_1TextHintInterface_a5}


emit this signal, if a tooltip text is needed for displaying. 

I you don't want a tooltip to be displayd set text to an emtpy string in a connected slot, otherwise set text to the string you want the editor to display

The documentation for this class was generated from the following files:\begin{CompactItemize}
\item 
texthintinterface.h\item 
texthintinterface.cpp\end{CompactItemize}
