\section{KText\-Editor::Mark\-Interface Class Reference}
\label{classKTextEditor_1_1MarkInterface}\index{KTextEditor::MarkInterface@{KTextEditor::MarkInterface}}
This is an interface to enable marks to be made in the iconborder of the {\bf Document}{\rm (p.\,\pageref{classKTextEditor_1_1Document})} class.  


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

\subsection*{Public Types}
\begin{CompactItemize}
\item 
enum {\bf Mark\-Types} \{ \par
{\bf mark\-Type01} =  0x1, 
{\bf mark\-Type02} =  0x2, 
{\bf mark\-Type03} =  0x4, 
{\bf mark\-Type04} =  0x8, 
\par
{\bf mark\-Type05} =  0x10, 
{\bf mark\-Type06} =  0x20, 
{\bf mark\-Type07} =  0x40, 
{\bf mark\-Type08} =  0x80, 
\par
{\bf mark\-Type09} =  0x100, 
{\bf mark\-Type10} =  0x200, 
{\bf mark\-Type11} =  0x400, 
{\bf mark\-Type12} =  0x800, 
\par
{\bf mark\-Type13} =  0x1000, 
{\bf mark\-Type14} =  0x2000, 
{\bf mark\-Type15} =  0x4000, 
{\bf mark\-Type16} =  0x8000, 
\par
{\bf mark\-Type17} =  0x10000, 
{\bf mark\-Type18} =  0x20000, 
{\bf mark\-Type19} =  0x40000, 
{\bf mark\-Type20} =  0x80000, 
\par
{\bf mark\-Type21} =  0x100000, 
{\bf mark\-Type22} =  0x200000, 
{\bf mark\-Type23} =  0x400000, 
{\bf mark\-Type24} =  0x800000, 
\par
{\bf mark\-Type25} =  0x1000000, 
{\bf mark\-Type26} =  0x2000000, 
{\bf mark\-Type27} =  0x4000000, 
{\bf mark\-Type28} =  0x8000000, 
\par
{\bf mark\-Type29} =  0x10000000, 
{\bf mark\-Type30} =  0x20000000, 
{\bf mark\-Type31} =  0x40000000, 
{\bf mark\-Type32} =  0x80000000, 
\par
{\bf Bookmark} =  mark\-Type01, 
{\bf Breakpoint\-Active} =  mark\-Type02, 
{\bf Breakpoint\-Reached} =  mark\-Type03, 
{\bf Breakpoint\-Disabled} =  mark\-Type04, 
\par
{\bf Execution} =  mark\-Type05, 
{\bf Warning} =  mark\-Type06, 
{\bf Error} =  mark\-Type07
 \}
\end{CompactItemize}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
unsigned int {\bf mark\-Interface\-Number} () const \label{classKTextEditor_1_1MarkInterface_a2}

\item 
virtual uint {\bf mark} (uint line)=0
\item 
virtual void {\bf set\-Mark} (uint line, uint mark\-Type)=0
\item 
virtual void {\bf clear\-Mark} (uint line)=0
\item 
virtual void {\bf add\-Mark} (uint line, uint mark\-Type)=0\label{classKTextEditor_1_1MarkInterface_a6}

\item 
virtual void {\bf remove\-Mark} (uint line, uint mark\-Type)=0
\item 
virtual {\bf QPtr\-List}$<$ KText\-Editor::Mark $>$ {\bf marks} ()=0
\item 
virtual void {\bf clear\-Marks} ()=0
\item 
virtual void {\bf marks\-Changed} ()=0\label{classKTextEditor_1_1MarkInterface_a10}

\end{CompactItemize}
\subsection*{Static Public Member Functions}
\begin{CompactItemize}
\item 
static int {\bf reserved\-Markers\-Count} ()
\end{CompactItemize}
\subsection*{Protected Member Functions}
\begin{CompactItemize}
\item 
void {\bf set\-Mark\-Interface\-DCOPSuffix} (const {\bf QCString} \&suffix)\label{classKTextEditor_1_1MarkInterface_b0}

\end{CompactItemize}
\subsection*{Friends}
\begin{CompactItemize}
\item 
class {\bf Private\-Mark\-Interface}\label{classKTextEditor_1_1MarkInterface_n0}

\end{CompactItemize}


\subsection{Detailed Description}
This is an interface to enable marks to be made in the iconborder of the {\bf Document}{\rm (p.\,\pageref{classKTextEditor_1_1Document})} class. 



Definition at line 42 of file markinterface.h.

\subsection{Member Enumeration Documentation}
\index{KTextEditor::MarkInterface@{KText\-Editor::Mark\-Interface}!MarkTypes@{MarkTypes}}
\index{MarkTypes@{MarkTypes}!KTextEditor::MarkInterface@{KText\-Editor::Mark\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}enum {\bf KText\-Editor::Mark\-Interface::Mark\-Types}}\label{classKTextEditor_1_1MarkInterface_w39}


Pre-defined mark types. 

To create a non-standard mark type, use {\bf Mark\-Interface\-Extension}{\rm (p.\,\pageref{classKTextEditor_1_1MarkInterfaceExtension})}. To add a new standard mark type, edit this interface to document the type. \begin{Desc}
\item[Enumeration values: ]\par
\begin{description}
\index{markType01@{markType01}!KTextEditor::MarkInterface@{KTextEditor::MarkInterface}}\index{KTextEditor::MarkInterface@{KTextEditor::MarkInterface}!markType01@{markType01}}\item[{\em 
mark\-Type01\label{classKTextEditor_1_1MarkInterface_w39w0}
}]Bookmark. \index{markType02@{markType02}!KTextEditor::MarkInterface@{KTextEditor::MarkInterface}}\index{KTextEditor::MarkInterface@{KTextEditor::MarkInterface}!markType02@{markType02}}\item[{\em 
mark\-Type02\label{classKTextEditor_1_1MarkInterface_w39w1}
}]Breakpoint active. \index{markType03@{markType03}!KTextEditor::MarkInterface@{KTextEditor::MarkInterface}}\index{KTextEditor::MarkInterface@{KTextEditor::MarkInterface}!markType03@{markType03}}\item[{\em 
mark\-Type03\label{classKTextEditor_1_1MarkInterface_w39w2}
}]Breakpoint reached. \index{markType04@{markType04}!KTextEditor::MarkInterface@{KTextEditor::MarkInterface}}\index{KTextEditor::MarkInterface@{KTextEditor::MarkInterface}!markType04@{markType04}}\item[{\em 
mark\-Type04\label{classKTextEditor_1_1MarkInterface_w39w3}
}]Breakpoint disabled. \index{markType05@{markType05}!KTextEditor::MarkInterface@{KTextEditor::MarkInterface}}\index{KTextEditor::MarkInterface@{KTextEditor::MarkInterface}!markType05@{markType05}}\item[{\em 
mark\-Type05\label{classKTextEditor_1_1MarkInterface_w39w4}
}]Execution mark. \index{markType06@{markType06}!KTextEditor::MarkInterface@{KTextEditor::MarkInterface}}\index{KTextEditor::MarkInterface@{KTextEditor::MarkInterface}!markType06@{markType06}}\item[{\em 
mark\-Type06\label{classKTextEditor_1_1MarkInterface_w39w5}
}]Warning. \index{markType07@{markType07}!KTextEditor::MarkInterface@{KTextEditor::MarkInterface}}\index{KTextEditor::MarkInterface@{KTextEditor::MarkInterface}!markType07@{markType07}}\item[{\em 
mark\-Type07\label{classKTextEditor_1_1MarkInterface_w39w6}
}]Error. \end{description}
\end{Desc}



Definition at line 103 of file markinterface.h.

\subsection{Member Function Documentation}
\index{KTextEditor::MarkInterface@{KText\-Editor::Mark\-Interface}!mark@{mark}}
\index{mark@{mark}!KTextEditor::MarkInterface@{KText\-Editor::Mark\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual uint KText\-Editor::Mark\-Interface::mark (uint {\em line})\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKTextEditor_1_1MarkInterface_a3}


\begin{Desc}
\item[Returns:]a uint representing the marks set in {\tt line} OR'ed togeather. \end{Desc}
\index{KTextEditor::MarkInterface@{KText\-Editor::Mark\-Interface}!setMark@{setMark}}
\index{setMark@{setMark}!KTextEditor::MarkInterface@{KText\-Editor::Mark\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void KText\-Editor::Mark\-Interface::set\-Mark (uint {\em line}, uint {\em mark\-Type})\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKTextEditor_1_1MarkInterface_a4}


Adds a mark of type {\tt mark\-Type} to {\tt line}. 

Has no effect if the line allready contains a mark of that type. \index{KTextEditor::MarkInterface@{KText\-Editor::Mark\-Interface}!clearMark@{clearMark}}
\index{clearMark@{clearMark}!KTextEditor::MarkInterface@{KText\-Editor::Mark\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void KText\-Editor::Mark\-Interface::clear\-Mark (uint {\em line})\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKTextEditor_1_1MarkInterface_a5}


Clears all marks set in {\tt line}. 

\index{KTextEditor::MarkInterface@{KText\-Editor::Mark\-Interface}!removeMark@{removeMark}}
\index{removeMark@{removeMark}!KTextEditor::MarkInterface@{KText\-Editor::Mark\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void KText\-Editor::Mark\-Interface::remove\-Mark (uint {\em line}, uint {\em mark\-Type})\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKTextEditor_1_1MarkInterface_a7}


Removes any mark of type {\tt mark\-Type} from {\tt line}. 

\index{KTextEditor::MarkInterface@{KText\-Editor::Mark\-Interface}!marks@{marks}}
\index{marks@{marks}!KTextEditor::MarkInterface@{KText\-Editor::Mark\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual {\bf QPtr\-List}$<$KText\-Editor::Mark$>$ KText\-Editor::Mark\-Interface::marks ()\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKTextEditor_1_1MarkInterface_a8}


\begin{Desc}
\item[Returns:]a list of all marks in the document \end{Desc}
\index{KTextEditor::MarkInterface@{KText\-Editor::Mark\-Interface}!clearMarks@{clearMarks}}
\index{clearMarks@{clearMarks}!KTextEditor::MarkInterface@{KText\-Editor::Mark\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void KText\-Editor::Mark\-Interface::clear\-Marks ()\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKTextEditor_1_1MarkInterface_a9}


Clears all marks in the document. 

\index{KTextEditor::MarkInterface@{KText\-Editor::Mark\-Interface}!reservedMarkersCount@{reservedMarkersCount}}
\index{reservedMarkersCount@{reservedMarkersCount}!KTextEditor::MarkInterface@{KText\-Editor::Mark\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int Mark\-Interface::reserved\-Markers\-Count ()\hspace{0.3cm}{\tt  [static]}}\label{classKTextEditor_1_1MarkInterface_e0}


get the number of predefined marker types we have so far. 

\begin{Desc}
\item[Note:]If you change this you have to make sure katepart supports the new size! \end{Desc}
\begin{Desc}
\item[Returns:]number of reserved marker types \end{Desc}
\begin{Desc}
\item[Since:]3.3 \end{Desc}


Definition at line 71 of file markinterface.cpp.

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