--- a/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.Refactoring.html Wed Jan 02 10:54:38 2013 +0100 +++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.Refactoring.html Sat Feb 09 11:31:54 2013 +0100 @@ -1,8 +1,7 @@ -<?xml version="1.0" encoding="utf-8"?> -<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' -'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> +<!DOCTYPE html> <html><head> <title>Plugin_Refactoring_Rope.RefactoringRope.Refactoring</title> +<meta charset="UTF-8"> <style> body { background: #EDECE6; @@ -51,6 +50,10 @@ <table> <tr><td>None</td></tr> </table> +<h3>Class Methods</h3> +<table> +<tr><td>None</td></tr> +</table> <h3>Methods</h3> <table> <tr> @@ -114,6 +117,9 @@ <td><a href="#Refactoring.__getFileUndoList">__getFileUndoList</a></td> <td>Private slot to get a list of undoable changes.</td> </tr><tr> +<td><a href="#Refactoring.__getOffset">__getOffset</a></td> +<td>Private method to get the offset into the text treating CRLF as ONE character.</td> +</tr><tr> <td><a href="#Refactoring.__importsExpandStar">__importsExpandStar</a></td> <td>Private slot to expand star imports.</td> </tr><tr> @@ -247,6 +253,10 @@ <td>Public method to refresh modified editors.</td> </tr> </table> +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> <a NAME="Refactoring.__init__" ID="Refactoring.__init__"></a> <h4>Refactoring (Constructor)</h4> <b>Refactoring</b>(<i>plugin, parent=None</i>) @@ -437,6 +447,29 @@ <dd> list of change objects (list of rope.base.change.Change) </dd> +</dl><a NAME="Refactoring.__getOffset" ID="Refactoring.__getOffset"></a> +<h4>Refactoring.__getOffset</h4> +<b>__getOffset</b>(<i>editor, line, index</i>) +<p> + Private method to get the offset into the text treating CRLF as ONE character. +</p><p> + Note: rope seems to convert all EOL styles to just \n. +</p><dl> +<dt><i>editor</i></dt> +<dd> +reference to the editor (Editor) +</dd><dt><i>line</i></dt> +<dd> +line for the offset (integer) +</dd><dt><i>index</i></dt> +<dd> +index into line for the offset (integer) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +rope compliant offset into the file (integer) +</dd> </dl><a NAME="Refactoring.__importsExpandStar" ID="Refactoring.__importsExpandStar"></a> <h4>Refactoring.__importsExpandStar</h4> <b>__importsExpandStar</b>(<i></i>)