<?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" xml:lang="en"> <head> <title>KTextEditor.MovingInterface</title> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta http-equiv="Content-Style-Type" content="text/css" /> <link rel="stylesheet" type="text/css" href="../common/doxygen.css" /> <link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../common/kde.css" /> </head> <body> <div id="container"> <div id="header"> <div id="header_top"> <div> <div> <img alt ="" src="../common/top-kde.jpg"/> KDE 4.9 PyKDE API Reference </div> </div> </div> <div id="header_bottom"> <div id="location"> <ul> <li>KDE's Python API</li> </ul> </div> <div id="menu"> <ul> <li><a href="../modules.html">Overview</a></li> <li><a href="http://techbase.kde.org/Development/Languages/Python">PyKDE Home</a></li> <li><a href="http://kde.org/family/">Sitemap</a></li> <li><a href="http://kde.org/contact/">Contact Us</a></li> </ul> </div> </div> </div> <div id="body_wrapper"> <div id="body"> <div id="right"> <div class="content"> <div id="main"> <div class="clearer"> </div> <h1>MovingInterface Class Reference</h1> <code>from PyKDE4.ktexteditor import *</code> <p> Namespace: <a href="../ktexteditor/KTextEditor.html">KTextEditor</a><br /> <h2>Detailed Description</h2> <p>Document interface for MovingCursor%s and MovingRange%s. </p> <p> This class provides the interface for KTextEditor.Documents to create MovingCursors/Ranges. </p> <p> <dl class="author" compact><dt><b>Author:</b></dt><dd> Christoph Cullmann <cullmann@kde.org> </dd></dl> </p> <p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.5 </dd></dl> </p> <table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Methods</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#MovingInterface">__init__</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="#lastSavedRevision">lastSavedRevision</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#lockRevision">lockRevision</a> (self, long revision)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../ktexteditor/KTextEditor.MovingCursor.html">KTextEditor.MovingCursor</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#newMovingCursor">newMovingCursor</a> (self, <a href="../ktexteditor/KTextEditor.Cursor.html">KTextEditor.Cursor</a> position, <a href="../ktexteditor/KTextEditor.MovingCursor.html#InsertBehavior">KTextEditor.MovingCursor.InsertBehavior</a> insertBehavior=KTextEditor.MovingCursor.MoveOnInsert)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../ktexteditor/KTextEditor.MovingRange.html">KTextEditor.MovingRange</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#newMovingRange">newMovingRange</a> (self, <a href="../ktexteditor/KTextEditor.Range.html">KTextEditor.Range</a> range, <a href="../ktexteditor/KTextEditor.MovingRange.html">KTextEditor.MovingRange.InsertBehaviors</a> insertBehaviors=KTextEditor.MovingRange.DoNotExpand, <a href="../ktexteditor/KTextEditor.MovingRange.html#EmptyBehavior">KTextEditor.MovingRange.EmptyBehavior</a> emptyBehavior=KTextEditor.MovingRange.AllowEmpty)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="#revision">revision</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#transformCursor">transformCursor</a> (self, <a href="../ktexteditor/KTextEditor.Cursor.html">KTextEditor.Cursor</a> cursor, <a href="../ktexteditor/KTextEditor.MovingCursor.html#InsertBehavior">KTextEditor.MovingCursor.InsertBehavior</a> insertBehavior, long fromRevision, long toRevision=-1)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#transformCursor">transformCursor</a> (self, int line, int column, <a href="../ktexteditor/KTextEditor.MovingCursor.html#InsertBehavior">KTextEditor.MovingCursor.InsertBehavior</a> insertBehavior, long fromRevision, long toRevision=-1)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#transformRange">transformRange</a> (self, <a href="../ktexteditor/KTextEditor.Range.html">KTextEditor.Range</a> range, <a href="../ktexteditor/KTextEditor.MovingRange.html">KTextEditor.MovingRange.InsertBehaviors</a> insertBehaviors, <a href="../ktexteditor/KTextEditor.MovingRange.html#EmptyBehavior">KTextEditor.MovingRange.EmptyBehavior</a> emptyBehavior, long fromRevision, long toRevision=-1)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#unlockRevision">unlockRevision</a> (self, long revision)</td></tr> </table> <hr><h2>Method Documentation</h2><a class="anchor" name="MovingInterface"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">__init__</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname"><em>self</em> )</td> <td width="100%"> </td> </tr> </table> </div> <div class="memdoc"><p>Default constructor </p></div></div><a class="anchor" name="lastSavedRevision"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">long lastSavedRevision</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname"><em>self</em> )</td> <td width="100%"> </td> </tr> </table> </div> <div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Last revision the buffer got successful saved <dl class="return" compact><dt><b>Returns:</b></dt><dd> last revision buffer got saved, -1 if none </dd></dl> </p></div></div><a class="anchor" name="lockRevision"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> lockRevision</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype">long </td> <td class="paramname"><em>revision</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Lock a revision, this will keep it around until released again. But all revisions will always be cleared on buffer clear() (and therefor load()) </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>revision</em> </td><td> revision to lock </td></tr> </table></dl> <p> </p></div></div><a class="anchor" name="newMovingCursor"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../ktexteditor/KTextEditor.MovingCursor.html">KTextEditor.MovingCursor</a> newMovingCursor</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../ktexteditor/KTextEditor.Cursor.html">KTextEditor.Cursor</a> </td> <td class="paramname"><em>position</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../ktexteditor/KTextEditor.MovingCursor.html#InsertBehavior">KTextEditor.MovingCursor.InsertBehavior</a> </td> <td class="paramname"><em>insertBehavior=KTextEditor.MovingCursor.MoveOnInsert</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Create a new moving cursor for this document. </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>position</em> </td><td> position of the moving cursor to create <tr><td></td><td valign="top"><em>insertBehavior</em> </td><td> insertion behavior </td></tr> </table></dl> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> new moving cursor for the document </dd></dl> </p></div></div><a class="anchor" name="newMovingRange"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../ktexteditor/KTextEditor.MovingRange.html">KTextEditor.MovingRange</a> newMovingRange</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../ktexteditor/KTextEditor.Range.html">KTextEditor.Range</a> </td> <td class="paramname"><em>range</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../ktexteditor/KTextEditor.MovingRange.html">KTextEditor.MovingRange.InsertBehaviors</a> </td> <td class="paramname"><em>insertBehaviors=KTextEditor.MovingRange.DoNotExpand</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../ktexteditor/KTextEditor.MovingRange.html#EmptyBehavior">KTextEditor.MovingRange.EmptyBehavior</a> </td> <td class="paramname"><em>emptyBehavior=KTextEditor.MovingRange.AllowEmpty</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Create a new moving range for this document. </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>range</em> </td><td> range of the moving range to create <tr><td></td><td valign="top"><em>insertBehaviors</em> </td><td> insertion behaviors <tr><td></td><td valign="top"><em>emptyBehavior</em> </td><td> behavior on becoming empty </td></tr> </table></dl> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> new moving range for the document </dd></dl> </p></div></div><a class="anchor" name="revision"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">long revision</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname"><em>self</em> )</td> <td width="100%"> </td> </tr> </table> </div> <div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Current revision <dl class="return" compact><dt><b>Returns:</b></dt><dd> current revision </dd></dl> </p></div></div><a class="anchor" name="transformCursor"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> transformCursor</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../ktexteditor/KTextEditor.Cursor.html">KTextEditor.Cursor</a> </td> <td class="paramname"><em>cursor</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../ktexteditor/KTextEditor.MovingCursor.html#InsertBehavior">KTextEditor.MovingCursor.InsertBehavior</a> </td> <td class="paramname"><em>insertBehavior</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">long </td> <td class="paramname"><em>fromRevision</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">long </td> <td class="paramname"><em>toRevision=-1</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Transform a cursor from one revision to an other. </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>line</em> </td><td> line number of the cursor to transform <tr><td></td><td valign="top"><em>column</em> </td><td> column number of the cursor to transform <tr><td></td><td valign="top"><em>insertBehavior</em> </td><td> behavior of this cursor on insert of text at its position <tr><td></td><td valign="top"><em>fromRevision</em> </td><td> from this revision we want to transform <tr><td></td><td valign="top"><em>toRevision</em> </td><td> to this revision we want to transform, default of -1 is current revision </td></tr> </table></dl> <p> </p></div></div><a class="anchor" name="transformCursor"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> transformCursor</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>line</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>column</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../ktexteditor/KTextEditor.MovingCursor.html#InsertBehavior">KTextEditor.MovingCursor.InsertBehavior</a> </td> <td class="paramname"><em>insertBehavior</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">long </td> <td class="paramname"><em>fromRevision</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">long </td> <td class="paramname"><em>toRevision=-1</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Transform a cursor from one revision to an other. </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>line</em> </td><td> line number of the cursor to transform <tr><td></td><td valign="top"><em>column</em> </td><td> column number of the cursor to transform <tr><td></td><td valign="top"><em>insertBehavior</em> </td><td> behavior of this cursor on insert of text at its position <tr><td></td><td valign="top"><em>fromRevision</em> </td><td> from this revision we want to transform <tr><td></td><td valign="top"><em>toRevision</em> </td><td> to this revision we want to transform, default of -1 is current revision </td></tr> </table></dl> <p> </p></div></div><a class="anchor" name="transformRange"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> transformRange</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../ktexteditor/KTextEditor.Range.html">KTextEditor.Range</a> </td> <td class="paramname"><em>range</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../ktexteditor/KTextEditor.MovingRange.html">KTextEditor.MovingRange.InsertBehaviors</a> </td> <td class="paramname"><em>insertBehaviors</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../ktexteditor/KTextEditor.MovingRange.html#EmptyBehavior">KTextEditor.MovingRange.EmptyBehavior</a> </td> <td class="paramname"><em>emptyBehavior</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">long </td> <td class="paramname"><em>fromRevision</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">long </td> <td class="paramname"><em>toRevision=-1</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Transform a range from one revision to an other. </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>range</em> </td><td> range to transform <tr><td></td><td valign="top"><em>insertBehaviors</em> </td><td> behavior of this range on insert of text at its position <tr><td></td><td valign="top"><em>emptyBehavior</em> </td><td> behavior on becoming empty <tr><td></td><td valign="top"><em>fromRevision</em> </td><td> from this revision we want to transform <tr><td></td><td valign="top"><em>toRevision</em> </td><td> to this revision we want to transform, default of -1 is current revision </td></tr> </table></dl> <p> </p></div></div><a class="anchor" name="unlockRevision"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> unlockRevision</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype">long </td> <td class="paramname"><em>revision</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Release a revision. </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>revision</em> </td><td> revision to release </td></tr> </table></dl> <p> </p></div></div> </div> </div> </div> <div id="left"> <div class="menu_box"> <div class="nav_list"> <ul> <li><a href="../allclasses.html">Full Index</a></li> </ul> </div> <a name="cp-menu" /><div class="menutitle"><div> <h2 id="cp-menu-project">Modules</h2> </div></div> <div class="nav_list"> <ul><li><a href="../akonadi/index.html">akonadi</a></li> <li><a href="../dnssd/index.html">dnssd</a></li> <li><a href="../kdecore/index.html">kdecore</a></li> <li><a href="../kdeui/index.html">kdeui</a></li> <li><a href="../khtml/index.html">khtml</a></li> <li><a href="../kio/index.html">kio</a></li> <li><a href="../knewstuff/index.html">knewstuff</a></li> <li><a href="../kparts/index.html">kparts</a></li> <li><a href="../kutils/index.html">kutils</a></li> <li><a href="../nepomuk/index.html">nepomuk</a></li> <li><a href="../phonon/index.html">phonon</a></li> <li><a href="../plasma/index.html">plasma</a></li> <li><a href="../polkitqt/index.html">polkitqt</a></li> <li><a href="../solid/index.html">solid</a></li> <li><a href="../soprano/index.html">soprano</a></li> </ul></div></div> </div> </div> <div class="clearer"/> </div> <div id="end_body"></div> </div> <div id="footer"><div id="footer_text"> This documentation is maintained by <a href="mailto:simon@simonzone.com">Simon Edwards</a>.<br /> KDE<sup>®</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>®</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" 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> </body> </html>