\section{KText\-Editor::Block\-Selection\-Interface Class Reference}
\label{classKTextEditor_1_1BlockSelectionInterface}\index{KTextEditor::BlockSelectionInterface@{KTextEditor::BlockSelectionInterface}}
An interface for the {\bf Document}{\rm (p.\,\pageref{classKTextEditor_1_1Document})} class which allows the selection method to be changed between selecting rectangular blocks of text and normal mode (all text between the start cursor and the current cursor).  


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

\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
unsigned int {\bf block\-Selection\-Interface\-Number} () const \label{classKTextEditor_1_1BlockSelectionInterface_a2}

\item 
virtual bool {\bf block\-Selection\-Mode} ()=0
\item 
virtual bool {\bf set\-Block\-Selection\-Mode} (bool on)=0
\item 
virtual bool {\bf toggle\-Block\-Selection\-Mode} ()=0
\end{CompactItemize}
\subsection*{Protected Member Functions}
\begin{CompactItemize}
\item 
void {\bf set\-Block\-Selection\-Interface\-DCOPSuffix} (const {\bf QCString} \&suffix)\label{classKTextEditor_1_1BlockSelectionInterface_b0}

\end{CompactItemize}
\subsection*{Friends}
\begin{CompactItemize}
\item 
class {\bf Private\-Block\-Selection\-Interface}\label{classKTextEditor_1_1BlockSelectionInterface_n0}

\end{CompactItemize}


\subsection{Detailed Description}
An interface for the {\bf Document}{\rm (p.\,\pageref{classKTextEditor_1_1Document})} class which allows the selection method to be changed between selecting rectangular blocks of text and normal mode (all text between the start cursor and the current cursor). 



Definition at line 34 of file blockselectioninterface.h.

\subsection{Member Function Documentation}
\index{KTextEditor::BlockSelectionInterface@{KText\-Editor::Block\-Selection\-Interface}!blockSelectionMode@{blockSelectionMode}}
\index{blockSelectionMode@{blockSelectionMode}!KTextEditor::BlockSelectionInterface@{KText\-Editor::Block\-Selection\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual bool KText\-Editor::Block\-Selection\-Interface::block\-Selection\-Mode ()\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKTextEditor_1_1BlockSelectionInterface_a3}


Returns the status of the selection mode - true indicates block selection mode is on. 

If this is true, selections applied via the {\bf Selection\-Interface}{\rm (p.\,\pageref{classKTextEditor_1_1SelectionInterface})} are handled as blockselections and the paste functions of the {\bf Clipboard\-Interface}{\rm (p.\,\pageref{classKTextEditor_1_1ClipboardInterface})} works on rectangular blocks of text rather than normal. (copy too, but thats clear I hope ;) \index{KTextEditor::BlockSelectionInterface@{KText\-Editor::Block\-Selection\-Interface}!setBlockSelectionMode@{setBlockSelectionMode}}
\index{setBlockSelectionMode@{setBlockSelectionMode}!KTextEditor::BlockSelectionInterface@{KText\-Editor::Block\-Selection\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual bool KText\-Editor::Block\-Selection\-Interface::set\-Block\-Selection\-Mode (bool {\em on})\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKTextEditor_1_1BlockSelectionInterface_a4}


Set block selection mode to state \char`\"{}on\char`\"{}. 

\index{KTextEditor::BlockSelectionInterface@{KText\-Editor::Block\-Selection\-Interface}!toggleBlockSelectionMode@{toggleBlockSelectionMode}}
\index{toggleBlockSelectionMode@{toggleBlockSelectionMode}!KTextEditor::BlockSelectionInterface@{KText\-Editor::Block\-Selection\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual bool KText\-Editor::Block\-Selection\-Interface::toggle\-Block\-Selection\-Mode ()\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKTextEditor_1_1BlockSelectionInterface_a5}


toggle block seletion mode 



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