<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en_US" xml:lang="en_US">
<head>
<title>interfaces/ktexteditor: KTextEditor::BlockSelectionInterface Class Reference (interfaces/ktexteditor)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" comment "ICRAonline DE v2.0" l gen true for "http://www.kde.org" r (nz 1 vz 1 lz 1 oz 1 cb 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://www.kde.org" r (n 0 s 0 v 0 l 0))' />
<meta name="trademark" content="KDE e.V." />
<meta name="description" content="K Desktop Environment Homepage, KDE.org" />
<meta name="MSSmartTagsPreventParsing" content="true" />
<meta name="robots" content="all" />
<link rel="shortcut icon" href="../../../favicon.ico" />
<link rel="stylesheet" media="screen" type="text/css" title="APIDOX" href="doxygen.css" />
</head>
<body>
<div id="nav_header_top" align="right">
<a href="#content" class="doNotDisplay" accesskey="2">Skip to main content ::</a>
<a href="../../.."><img id="nav_header_logo" alt="Home" align="left" src="../../../kde_gear_64.png" border="0" /></a>
<span class="doNotDisplay">::</span>
<div id="nav_header_title" align="left">KDE API Reference</div>
</div>
<div id="nav_header_bottom" align="right">
<span class="doNotDisplay">:: <a href="#navigation" accesskey="5">Skip to Link Menu</a><br/></span>
<div id="nav_header_bottom_right" style="text-align: left;">
/ <a href="../../..">API Reference</a>
/ <a href="../../html/index.html">interfaces</a> / <a href=".">ktexteditor</a>
</div>
</div>
<table id="main" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td valign="top" class="menuheader" height="0"></td>
<td id="contentcolumn" valign="top" rowspan="2" >
<div id="content" style="padding-top: 0px;"><div style="width:100%; margin: 0px; padding: 0px;">
<a name="content"></a>
<!-- Generated by Doxygen 1.4.4 -->
<div class="nav">
<a class="el" href="namespaceKTextEditor.html">KTextEditor</a>::<a class="el" href="classKTextEditor_1_1BlockSelectionInterface.html">BlockSelectionInterface</a></div>
<h1>KTextEditor::BlockSelectionInterface Class Reference</h1><!-- doxytag: class="KTextEditor::BlockSelectionInterface" --><code>#include <<a class="el" href="blockselectioninterface_8h-source.html">blockselectioninterface.h</a>></code>
<p>
<a href="classKTextEditor_1_1BlockSelectionInterface-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
An interface for the <a class="el" href="classKTextEditor_1_1Document.html">Document</a> 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).
<p>
<p>
Definition at line <a class="el" href="blockselectioninterface_8h-source.html#l00034">34</a> of file <a class="el" href="blockselectioninterface_8h-source.html">blockselectioninterface.h</a>.<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a0"></a><!-- doxytag: member="KTextEditor::BlockSelectionInterface::BlockSelectionInterface" ref="a0" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classKTextEditor_1_1BlockSelectionInterface.html#a0">BlockSelectionInterface</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1"></a><!-- doxytag: member="KTextEditor::BlockSelectionInterface::~BlockSelectionInterface" ref="a1" args="()" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classKTextEditor_1_1BlockSelectionInterface.html#a1">~BlockSelectionInterface</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2"></a><!-- doxytag: member="KTextEditor::BlockSelectionInterface::blockSelectionInterfaceNumber" ref="a2" args="() const " -->
unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classKTextEditor_1_1BlockSelectionInterface.html#a2">blockSelectionInterfaceNumber</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKTextEditor_1_1BlockSelectionInterface.html#a3">blockSelectionMode</a> ()=0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKTextEditor_1_1BlockSelectionInterface.html#a4">setBlockSelectionMode</a> (bool on)=0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKTextEditor_1_1BlockSelectionInterface.html#a5">toggleBlockSelectionMode</a> ()=0</td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b0"></a><!-- doxytag: member="KTextEditor::BlockSelectionInterface::setBlockSelectionInterfaceDCOPSuffix" ref="b0" args="(const QCString &suffix)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKTextEditor_1_1BlockSelectionInterface.html#b0">setBlockSelectionInterfaceDCOPSuffix</a> (const <a class="elRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> &suffix)</td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="n0"></a><!-- doxytag: member="KTextEditor::BlockSelectionInterface::PrivateBlockSelectionInterface" ref="n0" args="" -->
class </td><td class="memItemRight" valign="bottom"><a class="el" href="classKTextEditor_1_1BlockSelectionInterface.html#n0">PrivateBlockSelectionInterface</a></td></tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a3"></a><!-- doxytag: member="KTextEditor::BlockSelectionInterface::blockSelectionMode" ref="a3" args="()=0" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual bool KTextEditor::BlockSelectionInterface::blockSelectionMode </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Returns the status of the selection mode - true indicates block selection mode is on.
<p>
If this is true, selections applied via the <a class="el" href="classKTextEditor_1_1SelectionInterface.html">SelectionInterface</a> are handled as blockselections and the paste functions of the <a class="el" href="classKTextEditor_1_1ClipboardInterface.html">ClipboardInterface</a> works on rectangular blocks of text rather than normal. (copy too, but thats clear I hope ;) </td>
</tr>
</table>
<a class="anchor" name="a4"></a><!-- doxytag: member="KTextEditor::BlockSelectionInterface::setBlockSelectionMode" ref="a4" args="(bool on)=0" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual bool KTextEditor::BlockSelectionInterface::setBlockSelectionMode </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> <em>on</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Set block selection mode to state "on".
<p>
</td>
</tr>
</table>
<a class="anchor" name="a5"></a><!-- doxytag: member="KTextEditor::BlockSelectionInterface::toggleBlockSelectionMode" ref="a5" args="()=0" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual bool KTextEditor::BlockSelectionInterface::toggleBlockSelectionMode </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
toggle block seletion mode
<p>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="blockselectioninterface_8h-source.html">blockselectioninterface.h</a><li><a class="el" href="blockselectioninterface_8cpp-source.html">blockselectioninterface.cpp</a></ul>
</div></div>
</td>
</tr>
<tr>
<td valign="top" id="leftmenu" width="25%">
<a name="navigation"></a>
<div class="menu_box"><h2>interfaces/ktexteditor</h2>
<div class="nav_list">
<ul><li><a href="index.html">Main Page</a></li><li><a href="namespaces.html">Namespace List</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="files.html">File List</a></li><li><a href="dirs.html">Directories</a></li><li><a href="namespacemembers.html">Namespace Members</a></li><li><a href="functions.html">Class Members</a></li></ul>
<!--
<h2>Class Picker</h2>
<div style="text-align: center;">
<form name="guideform">
<select name="guidelinks" style="width:100%;" onChange="window.location=document.guideform.guidelinks.options[document.guideform.guidelinks.selectedIndex].value">
<option value="annotated.html">-- Choose --</option>
<option value="classEditorChooser__UI.html">editorchooser__ui</option>, <option value="classKTextEditor_1_1BlockSelectionDCOPInterface.html">ktexteditor::blockselectiondcopinterface</option>, <option value="classKTextEditor_1_1BlockSelectionInterface.html">ktexteditor::blockselectioninterface</option>, <option value="classKTextEditor_1_1ClipboardDCOPInterface.html">ktexteditor::clipboarddcopinterface</option>, <option value="classKTextEditor_1_1ClipboardInterface.html">ktexteditor::clipboardinterface</option>, <option value="classKTextEditor_1_1CodeCompletionInterface.html">ktexteditor::codecompletioninterface</option>, <option value="classKTextEditor_1_1CompletionEntry.html">ktexteditor::completionentry</option>, <option value="classKTextEditor_1_1ConfigInterface.html">ktexteditor::configinterface</option>, <option value="classKTextEditor_1_1ConfigInterfaceExtension.html">ktexteditor::configinterfaceextension</option>, <option value="classKTextEditor_1_1ConfigPage.html">ktexteditor::configpage</option>, <option value="classKTextEditor_1_1Cursor.html">ktexteditor::cursor</option>, <option value="classKTextEditor_1_1CursorInterface.html">ktexteditor::cursorinterface</option>, <option value="classKTextEditor_1_1Document.html">ktexteditor::document</option>, <option value="classKTextEditor_1_1DocumentInfoDCOPInterface.html">ktexteditor::documentinfodcopinterface</option>, <option value="classKTextEditor_1_1DocumentInfoInterface.html">ktexteditor::documentinfointerface</option>, <option value="classKTextEditor_1_1DynWordWrapInterface.html">ktexteditor::dynwordwrapinterface</option>, <option value="classKTextEditor_1_1EditDCOPInterface.html">ktexteditor::editdcopinterface</option>, <option value="classKTextEditor_1_1EditInterface.html">ktexteditor::editinterface</option>, <option value="classKTextEditor_1_1EditInterfaceExt.html">ktexteditor::editinterfaceext</option>, <option value="classKTextEditor_1_1Editor.html">ktexteditor::editor</option>, <option value="classKTextEditor_1_1EditorChooser.html">ktexteditor::editorchooser</option>, <option value="classKTextEditor_1_1EncodingDCOPInterface.html">ktexteditor::encodingdcopinterface</option>, <option value="classKTextEditor_1_1EncodingInterface.html">ktexteditor::encodinginterface</option>, <option value="classKTextEditor_1_1HighlightingInterface.html">ktexteditor::highlightinginterface</option>, <option value="classKTextEditor_1_1Mark.html">ktexteditor::mark</option>, <option value="classKTextEditor_1_1MarkInterface.html">ktexteditor::markinterface</option>, <option value="classKTextEditor_1_1MarkInterfaceExtension.html">ktexteditor::markinterfaceextension</option>, <option value="classKTextEditor_1_1Plugin.html">ktexteditor::plugin</option>, <option value="classKTextEditor_1_1PluginViewInterface.html">ktexteditor::pluginviewinterface</option>, <option value="classKTextEditor_1_1PopupMenuInterface.html">ktexteditor::popupmenuinterface</option>, <option value="classKTextEditor_1_1PrintDCOPInterface.html">ktexteditor::printdcopinterface</option>, <option value="classKTextEditor_1_1PrintInterface.html">ktexteditor::printinterface</option>, <option value="classKTextEditor_1_1SearchDCOPInterface.html">ktexteditor::searchdcopinterface</option>, <option value="classKTextEditor_1_1SearchInterface.html">ktexteditor::searchinterface</option>, <option value="classKTextEditor_1_1SelectionDCOPInterface.html">ktexteditor::selectiondcopinterface</option>, <option value="classKTextEditor_1_1SelectionExtDCOPInterface.html">ktexteditor::selectionextdcopinterface</option>, <option value="classKTextEditor_1_1SelectionInterface.html">ktexteditor::selectioninterface</option>, <option value="classKTextEditor_1_1SelectionInterfaceExt.html">ktexteditor::selectioninterfaceext</option>, <option value="classKTextEditor_1_1SessionConfigInterface.html">ktexteditor::sessionconfiginterface</option>, <option value="classKTextEditor_1_1TemplateInterface.html">ktexteditor::templateinterface</option>, <option value="classKTextEditor_1_1TextHintInterface.html">ktexteditor::texthintinterface</option>, <option value="classKTextEditor_1_1UndoDCOPInterface.html">ktexteditor::undodcopinterface</option>, <option value="classKTextEditor_1_1UndoInterface.html">ktexteditor::undointerface</option>, <option value="classKTextEditor_1_1VariableInterface.html">ktexteditor::variableinterface</option>, <option value="classKTextEditor_1_1View.html">ktexteditor::view</option>, <option value="classKTextEditor_1_1ViewCursorDCOPInterface.html">ktexteditor::viewcursordcopinterface</option>, <option value="classKTextEditor_1_1ViewCursorInterface.html">ktexteditor::viewcursorinterface</option>, <option value="classKTextEditor_1_1ViewStatusMsgDCOPInterface.html">ktexteditor::viewstatusmsgdcopinterface</option>, <option value="classKTextEditor_1_1ViewStatusMsgInterface.html">ktexteditor::viewstatusmsginterface</option>, <option value="classKTextEditor_1_1WordWrapInterface.html">ktexteditor::wordwrapinterface</option>,
</select>
</form>
</div>
-->
</div></div>
<div class="menu_box"><h2>API Dox</h2>
<div class="nav_list">
<ul>
<li><a href="../../../arts/html/index.html">arts</a></li><li><a href="../../../dcop/html/index.html">dcop</a></li><li><a href="../../../dnssd/html/index.html">dnssd</a></li><li><a href="../../../interfaces/html/index.html">interfaces</a></li><li> <a href="../../../interfaces/kimproxy/interface/html/index.html">interface</a></li><li> <a href="../../../interfaces/kimproxy/library/html/index.html">library</a></li><li> <a href="../../../interfaces/kspeech/html/index.html">kspeech</a></li><li> <a href="../../../interfaces/ktexteditor/html/index.html">ktexteditor</a></li><li><a href="../../../kabc/html/index.html">kabc</a></li><li><a href="../../../kate/html/index.html">kate</a></li><li><a href="../../../kcmshell/html/index.html">kcmshell</a></li><li><a href="../../../kdecore/html/index.html">kdecore</a></li><li><a href="../../../kded/html/index.html">kded</a></li><li><a href="../../../kdefx/html/index.html">kdefx</a></li><li><a href="../../../kdeprint/html/index.html">kdeprint</a></li><li><a href="../../../kdesu/html/index.html">kdesu</a></li><li><a href="../../../kdeui/html/index.html">kdeui</a></li><li><a href="../../../kdoctools/html/index.html">kdoctools</a></li><li><a href="../../../khtml/html/index.html">khtml</a></li><li><a href="../../../kimgio/html/index.html">kimgio</a></li><li><a href="../../../kinit/html/index.html">kinit</a></li><li><a href="../../../kio/html/index.html">kio</a></li><li> <a href="../../../kio/bookmarks/html/index.html">bookmarks</a></li><li> <a href="../../../kio/httpfilter/html/index.html">httpfilter</a></li><li> <a href="../../../kio/kfile/html/index.html">kfile</a></li><li> <a href="../../../kio/kio/html/index.html">kio</a></li><li> <a href="../../../kio/kioexec/html/index.html">kioexec</a></li><li> <a href="../../../kio/kpasswdserver/html/index.html">kpasswdserver</a></li><li> <a href="../../../kio/kssl/html/index.html">kssl</a></li><li><a href="../../../kioslave/html/index.html">kioslave</a></li><li> <a href="../../../kioslave/http/html/index.html">http</a></li><li><a href="../../../kjs/html/index.html">kjs</a></li><li><a href="../../../kmdi/html/index.html">kmdi</a></li><li> <a href="../../../kmdi/kmdi/html/index.html">kmdi</a></li><li><a href="../../../knewstuff/html/index.html">knewstuff</a></li><li><a href="../../../kparts/html/index.html">kparts</a></li><li><a href="../../../kresources/html/index.html">kresources</a></li><li><a href="../../../kspell2/html/index.html">kspell2</a></li><li><a href="../../../kunittest/html/index.html">kunittest</a></li><li><a href="../../../kutils/html/index.html">kutils</a></li><li><a href="../../../kwallet/html/index.html">kwallet</a></li><li><a href="../../../libkmid/html/index.html">libkmid</a></li><li><a href="../../../libkscreensaver/html/index.html">libkscreensaver</a></li>
</ul></div></div>
</td>
</tr>
</table>
<span class="doNotDisplay">
<a href="http://www.kde.org/" accesskey="8">KDE Home</a> |
<a href="http://accessibility.kde.org/" accesskey="9">KDE Accessibility Home</a> |
<a href="http://www.kde.org/media/accesskeys.php" accesskey="0">Description of Access Keys</a>
</span>
<div style="height: 8px"></div>
<div id="footer">
<div id="footer_left">
Maintained by <a href="mailto:groot@kde.org">Adriaan de Groot</a>
and
<a href="mailto:winter@kde.org">Allen Winter</a>.
<br/>
KDE and K Desktop Environment are trademarks of <a href="http://www.kde.org/areas/kde-ev/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div>
<div id="footer_right"><img src="/media/images/footer_right.png" style="margin: 0px" alt="" /></div>
</div>
<!--
WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL
BE BLOCKED INSTANTLY AND PERMANENTLY!
<a href="mailto:aaaatrap-425acc3b5374943f@kde.org">Block me</a>
WARNING END
-->
</body>
</html>
distrib
>
PLD
>
ac
>
amd64
>
media
>
dist
>
by-pkgid
>
90467ea6a387df728f7218a11e972208
>
files
>
886
