--- a/Documentation/Source/eric5.QScintilla.QsciScintillaCompat.html Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.QScintilla.QsciScintillaCompat.html Thu Jan 14 18:35:52 2010 +0000
@@ -22,7 +22,7 @@
<body><a NAME="top" ID="top"></a>
<h1>eric5.QScintilla.QsciScintillaCompat</h1>
<p>
-Module implementing a compatability interface class to QsciScintilla.
+Module implementing a compatability interface class to QsciScintilla.
</p>
<h3>Global Attributes</h3>
<table>
@@ -32,25 +32,25 @@
<table>
<tr>
<td><a href="#QsciScintillaCompat">QsciScintillaCompat</a></td>
-<td>Class implementing a compatability interface to QsciScintilla.</td>
+<td>Class implementing a compatability interface to QsciScintilla.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr>
<td><a href="#QSCINTILLA_VERSION">QSCINTILLA_VERSION</a></td>
-<td>Module function to return the QScintilla version.</td>
+<td>Module function to return the QScintilla version.</td>
</tr>
</table>
<hr /><hr />
<a NAME="QsciScintillaCompat" ID="QsciScintillaCompat"></a>
<h2>QsciScintillaCompat</h2>
<p>
- Class implementing a compatability interface to QsciScintilla.
+ Class implementing a compatability interface to QsciScintilla.
</p><p>
- This class implements all the functions, that were added to
- QsciScintilla incrementally. This class ensures compatibility
- to older versions of QsciScintilla.
+ This class implements all the functions, that were added to
+ QsciScintilla incrementally. This class ensures compatibility
+ to older versions of QsciScintilla.
</p>
<h3>Derived from</h3>
QsciScintilla
@@ -62,1034 +62,1034 @@
<table>
<tr>
<td><a href="#QsciScintillaCompat.__init__">QsciScintillaCompat</a></td>
-<td>Constructor</td>
+<td>Constructor</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.__doSearchTarget">__doSearchTarget</a></td>
-<td>Private method to perform the search in target.</td>
+<td>Private method to perform the search in target.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.byteAt">byteAt</a></td>
-<td>Public method to get the raw character (bytes) at a position in the text.</td>
+<td>Public method to get the raw character (bytes) at a position in the text.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.charAt">charAt</a></td>
-<td>Public method to get the character at a position in the text observing multibyte characters.</td>
+<td>Public method to get the character at a position in the text observing multibyte characters.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.clearAllIndicators">clearAllIndicators</a></td>
-<td>Public method to clear all occurrences of an indicator.</td>
+<td>Public method to clear all occurrences of an indicator.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.clearAlternateKeys">clearAlternateKeys</a></td>
-<td>Protected method to clear the alternate key commands.</td>
+<td>Protected method to clear the alternate key commands.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.clearIndicator">clearIndicator</a></td>
-<td>Public method to clear an indicator for the given range.</td>
+<td>Public method to clear an indicator for the given range.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.clearIndicatorRange">clearIndicatorRange</a></td>
-<td>Public method to clear an indicator for the given range.</td>
+<td>Public method to clear an indicator for the given range.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.clearKeys">clearKeys</a></td>
-<td>Protected method to clear the key commands.</td>
+<td>Protected method to clear the key commands.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.clearStyles">clearStyles</a></td>
-<td>Public method to set the styles according the selected Qt style.</td>
+<td>Public method to set the styles according the selected Qt style.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.currentPosition">currentPosition</a></td>
-<td>Public method to get the current position.</td>
+<td>Public method to get the current position.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.currentStyle">currentStyle</a></td>
-<td>Public method to get the style at the current position.</td>
+<td>Public method to get the style at the current position.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.delete">delete</a></td>
-<td>Public method to delete the character to the right of the cursor.</td>
+<td>Public method to delete the character to the right of the cursor.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.deleteBack">deleteBack</a></td>
-<td>Public method to delete the character to the left of the cursor.</td>
+<td>Public method to delete the character to the left of the cursor.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.deleteLineLeft">deleteLineLeft</a></td>
-<td>Public method to delete the line to the left of the cursor.</td>
+<td>Public method to delete the line to the left of the cursor.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.deleteLineRight">deleteLineRight</a></td>
-<td>Public method to delete the line to the right of the cursor.</td>
+<td>Public method to delete the line to the right of the cursor.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.deleteWordLeft">deleteWordLeft</a></td>
-<td>Public method to delete the word to the left of the cursor.</td>
+<td>Public method to delete the word to the left of the cursor.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.deleteWordRight">deleteWordRight</a></td>
-<td>Public method to delete the word to the right of the cursor.</td>
+<td>Public method to delete the word to the right of the cursor.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.detectEolString">detectEolString</a></td>
-<td>Public method to determine the eol string used.</td>
+<td>Public method to determine the eol string used.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.editorCommand">editorCommand</a></td>
-<td>Public method to perform a simple editor command.</td>
+<td>Public method to perform a simple editor command.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.extendSelectionLeft">extendSelectionLeft</a></td>
-<td>Public method to extend the selection one character to the left.</td>
+<td>Public method to extend the selection one character to the left.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.extendSelectionRight">extendSelectionRight</a></td>
-<td>Public method to extend the selection one character to the right.</td>
+<td>Public method to extend the selection one character to the right.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.extendSelectionToBOL">extendSelectionToBOL</a></td>
-<td>Public method to extend the selection to the beginning of the line.</td>
+<td>Public method to extend the selection to the beginning of the line.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.extendSelectionToEOL">extendSelectionToEOL</a></td>
-<td>Public method to extend the selection to the end of the line.</td>
+<td>Public method to extend the selection to the end of the line.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.extendSelectionWordLeft">extendSelectionWordLeft</a></td>
-<td>Public method to extend the selection one word to the left.</td>
+<td>Public method to extend the selection one word to the left.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.extendSelectionWordRight">extendSelectionWordRight</a></td>
-<td>Public method to extend the selection one word to the right.</td>
+<td>Public method to extend the selection one word to the right.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.findFirstTarget">findFirstTarget</a></td>
-<td>Public method to search in a specified range of text without setting the selection.</td>
+<td>Public method to search in a specified range of text without setting the selection.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.findNextTarget">findNextTarget</a></td>
-<td>Public method to find the next occurrence in the target range.</td>
+<td>Public method to find the next occurrence in the target range.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.foldExpandedAt">foldExpandedAt</a></td>
-<td>Public method to determine, if a fold is expanded.</td>
+<td>Public method to determine, if a fold is expanded.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.foldFlagsAt">foldFlagsAt</a></td>
-<td>Public method to get the fold flags of a line of the document.</td>
+<td>Public method to get the fold flags of a line of the document.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.foldHeaderAt">foldHeaderAt</a></td>
-<td>Public method to determine, if a line of the document is a fold header line.</td>
+<td>Public method to determine, if a line of the document is a fold header line.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.foldLevelAt">foldLevelAt</a></td>
-<td>Public method to get the fold level of a line of the document.</td>
+<td>Public method to get the fold level of a line of the document.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.getEndStyled">getEndStyled</a></td>
-<td>Public method to get the last styled position.</td>
+<td>Public method to get the last styled position.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.getEolIndicator">getEolIndicator</a></td>
-<td>Public method to get the eol indicator for the current eol mode.</td>
+<td>Public method to get the eol indicator for the current eol mode.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.getFileName">getFileName</a></td>
-<td>Public method to return the name of the file being displayed.</td>
+<td>Public method to return the name of the file being displayed.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.getFoundTarget">getFoundTarget</a></td>
-<td>Public method to get the recently found target.</td>
+<td>Public method to get the recently found target.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.getLineSeparator">getLineSeparator</a></td>
-<td>Public method to get the line separator for the current eol mode.</td>
+<td>Public method to get the line separator for the current eol mode.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.getZoom">getZoom</a></td>
-<td>Public method used to retrieve the current zoom factor.</td>
+<td>Public method used to retrieve the current zoom factor.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.hasIndicator">hasIndicator</a></td>
-<td>Public method to test for the existence of an indicator.</td>
+<td>Public method to test for the existence of an indicator.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.indentationGuideView">indentationGuideView</a></td>
-<td>Public method to get the indentation guide view.</td>
+<td>Public method to get the indentation guide view.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.indicatorDefine">indicatorDefine</a></td>
-<td>Public method to define the appearance of an indicator.</td>
+<td>Public method to define the appearance of an indicator.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.lineAt">lineAt</a></td>
-<td>Public method to calculate the line at a position.</td>
+<td>Public method to calculate the line at a position.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.lineEndPosition">lineEndPosition</a></td>
-<td>Public method to determine the line end position of the given line.</td>
+<td>Public method to determine the line end position of the given line.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.lineIndexFromPosition">lineIndexFromPosition</a></td>
-<td>Public method to convert an absolute position to line and index.</td>
+<td>Public method to convert an absolute position to line and index.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.linesOnScreen">linesOnScreen</a></td>
-<td>Public method to get the amount of visible lines.</td>
+<td>Public method to get the amount of visible lines.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.monospacedStyles">monospacedStyles</a></td>
-<td>Public method to set the current style to be monospaced.</td>
+<td>Public method to set the current style to be monospaced.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.moveCursorLeft">moveCursorLeft</a></td>
-<td>Public method to move the cursor left.</td>
+<td>Public method to move the cursor left.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.moveCursorRight">moveCursorRight</a></td>
-<td>Public method to move the cursor right.</td>
+<td>Public method to move the cursor right.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.moveCursorToEOL">moveCursorToEOL</a></td>
-<td>Public method to move the cursor to the end of line.</td>
+<td>Public method to move the cursor to the end of line.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.moveCursorWordLeft">moveCursorWordLeft</a></td>
-<td>Public method to move the cursor left one word.</td>
+<td>Public method to move the cursor left one word.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.moveCursorWordRight">moveCursorWordRight</a></td>
-<td>Public method to move the cursor right one word.</td>
+<td>Public method to move the cursor right one word.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.newLineBelow">newLineBelow</a></td>
-<td>Public method to insert a new line below the current one.</td>
+<td>Public method to insert a new line below the current one.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.positionAfter">positionAfter</a></td>
-<td>Public method to get the position after the given position taking into account multibyte characters.</td>
+<td>Public method to get the position after the given position taking into account multibyte characters.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.positionBefore">positionBefore</a></td>
-<td>Public method to get the position before the given position taking into account multibyte characters.</td>
+<td>Public method to get the position before the given position taking into account multibyte characters.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.positionFromLineIndex">positionFromLineIndex</a></td>
-<td>Public method to convert line and index to an absolute position.</td>
+<td>Public method to convert line and index to an absolute position.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.positionFromPoint">positionFromPoint</a></td>
-<td>Public method to calculate the scintilla position from a point in the window.</td>
+<td>Public method to calculate the scintilla position from a point in the window.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.replaceTarget">replaceTarget</a></td>
-<td>Public method to replace the string found by the last search in target.</td>
+<td>Public method to replace the string found by the last search in target.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.scrollVertical">scrollVertical</a></td>
-<td>Public method to scroll the text area.</td>
+<td>Public method to scroll the text area.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.setCurrentIndicator">setCurrentIndicator</a></td>
-<td>Public method to set the current indicator.</td>
+<td>Public method to set the current indicator.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.setEolModeByEolString">setEolModeByEolString</a></td>
-<td>Public method to set the eol mode given the eol string.</td>
+<td>Public method to set the eol mode given the eol string.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.setIndentationGuideView">setIndentationGuideView</a></td>
-<td>Public method to set the view of the indentation guides.</td>
+<td>Public method to set the view of the indentation guides.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.setIndicator">setIndicator</a></td>
-<td>Public method to set an indicator for the given range.</td>
+<td>Public method to set an indicator for the given range.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.setIndicatorRange">setIndicatorRange</a></td>
-<td>Public method to set an indicator for the given range.</td>
+<td>Public method to set an indicator for the given range.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.setLexer">setLexer</a></td>
-<td>Public method to set the lexer.</td>
+<td>Public method to set the lexer.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.setStyleBits">setStyleBits</a></td>
-<td>Public method to set the number of bits to be used for styling.</td>
+<td>Public method to set the number of bits to be used for styling.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.setStyling">setStyling</a></td>
-<td>Public method to style some text.</td>
+<td>Public method to style some text.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.startStyling">startStyling</a></td>
-<td>Public method to prepare styling.</td>
+<td>Public method to prepare styling.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.styleAt">styleAt</a></td>
-<td>Public method to get the style at a position in the text.</td>
+<td>Public method to get the style at a position in the text.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.zoomIn">zoomIn</a></td>
-<td>Public method used to increase the zoom factor.</td>
+<td>Public method used to increase the zoom factor.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.zoomOut">zoomOut</a></td>
-<td>Public method used to decrease the zoom factor.</td>
+<td>Public method used to decrease the zoom factor.</td>
</tr><tr>
<td><a href="#QsciScintillaCompat.zoomTo">zoomTo</a></td>
-<td>Public method used to zoom to a specific zoom factor.</td>
+<td>Public method used to zoom to a specific zoom factor.</td>
</tr>
</table>
<a NAME="QsciScintillaCompat.__init__" ID="QsciScintillaCompat.__init__"></a>
<h4>QsciScintillaCompat (Constructor)</h4>
<b>QsciScintillaCompat</b>(<i>parent = None</i>)
<p>
- Constructor
+ Constructor
</p><dl>
<dt><i>parent</i></dt>
<dd>
-parent widget (QWidget)
+parent widget (QWidget)
</dd><dt><i>name</i></dt>
<dd>
-name of this instance (string)
+name of this instance (string)
</dd><dt><i>flags</i></dt>
<dd>
-window flags
+window flags
</dd>
</dl><a NAME="QsciScintillaCompat.__doSearchTarget" ID="QsciScintillaCompat.__doSearchTarget"></a>
<h4>QsciScintillaCompat.__doSearchTarget</h4>
<b>__doSearchTarget</b>(<i></i>)
<p>
- Private method to perform the search in target.
+ Private method to perform the search in target.
</p><dl>
<dt>Returns:</dt>
<dd>
-flag indicating a successful search (boolean)
+flag indicating a successful search (boolean)
</dd>
</dl><a NAME="QsciScintillaCompat.byteAt" ID="QsciScintillaCompat.byteAt"></a>
<h4>QsciScintillaCompat.byteAt</h4>
<b>byteAt</b>(<i>pos</i>)
<p>
- Public method to get the raw character (bytes) at a position in the text.
+ Public method to get the raw character (bytes) at a position in the text.
</p><dl>
<dt><i>pos</i></dt>
<dd>
-position in the text (integer)
+position in the text (integer)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-raw character at the requested position or empty bytes, if the position
- is negative or past the end of the document (bytes)
+raw character at the requested position or empty bytes, if the position
+ is negative or past the end of the document (bytes)
</dd>
</dl><a NAME="QsciScintillaCompat.charAt" ID="QsciScintillaCompat.charAt"></a>
<h4>QsciScintillaCompat.charAt</h4>
<b>charAt</b>(<i>pos</i>)
<p>
- Public method to get the character at a position in the text observing
- multibyte characters.
+ Public method to get the character at a position in the text observing
+ multibyte characters.
</p><dl>
<dt><i>pos</i></dt>
<dd>
-position in the text (integer)
+position in the text (integer)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-character at the requested position or empty string, if the position
- is negative or past the end of the document (string)
+character at the requested position or empty string, if the position
+ is negative or past the end of the document (string)
</dd>
</dl><a NAME="QsciScintillaCompat.clearAllIndicators" ID="QsciScintillaCompat.clearAllIndicators"></a>
<h4>QsciScintillaCompat.clearAllIndicators</h4>
<b>clearAllIndicators</b>(<i>indicator</i>)
<p>
- Public method to clear all occurrences of an indicator.
+ Public method to clear all occurrences of an indicator.
</p><dl>
<dt><i>indicator</i></dt>
<dd>
-number of the indicator (integer,
- QsciScintilla.INDIC_CONTAINER .. QsciScintilla.INDIC_MAX)
+number of the indicator (integer,
+ QsciScintilla.INDIC_CONTAINER .. QsciScintilla.INDIC_MAX)
</dd>
</dl><a NAME="QsciScintillaCompat.clearAlternateKeys" ID="QsciScintillaCompat.clearAlternateKeys"></a>
<h4>QsciScintillaCompat.clearAlternateKeys</h4>
<b>clearAlternateKeys</b>(<i></i>)
<p>
- Protected method to clear the alternate key commands.
+ Protected method to clear the alternate key commands.
</p><a NAME="QsciScintillaCompat.clearIndicator" ID="QsciScintillaCompat.clearIndicator"></a>
<h4>QsciScintillaCompat.clearIndicator</h4>
<b>clearIndicator</b>(<i>indicator, sline, sindex, eline, eindex</i>)
<p>
- Public method to clear an indicator for the given range.
+ Public method to clear an indicator for the given range.
</p><dl>
<dt><i>indicator</i></dt>
<dd>
-number of the indicator (integer,
- QsciScintilla.INDIC_CONTAINER .. QsciScintilla.INDIC_MAX)
+number of the indicator (integer,
+ QsciScintilla.INDIC_CONTAINER .. QsciScintilla.INDIC_MAX)
</dd><dt><i>sline</i></dt>
<dd>
-line number of the indicator start (integer)
+line number of the indicator start (integer)
</dd><dt><i>sindex</i></dt>
<dd>
-index of the indicator start (integer)
+index of the indicator start (integer)
</dd><dt><i>eline</i></dt>
<dd>
-line number of the indicator end (integer)
+line number of the indicator end (integer)
</dd><dt><i>eindex</i></dt>
<dd>
-index of the indicator end (integer)
+index of the indicator end (integer)
</dd>
</dl><a NAME="QsciScintillaCompat.clearIndicatorRange" ID="QsciScintillaCompat.clearIndicatorRange"></a>
<h4>QsciScintillaCompat.clearIndicatorRange</h4>
<b>clearIndicatorRange</b>(<i>indicator, spos, length</i>)
<p>
- Public method to clear an indicator for the given range.
+ Public method to clear an indicator for the given range.
</p><dl>
<dt><i>indicator</i></dt>
<dd>
-number of the indicator (integer,
- QsciScintilla.INDIC_CONTAINER .. QsciScintilla.INDIC_MAX)
+number of the indicator (integer,
+ QsciScintilla.INDIC_CONTAINER .. QsciScintilla.INDIC_MAX)
</dd><dt><i>spos</i></dt>
<dd>
-position of the indicator start (integer)
+position of the indicator start (integer)
</dd><dt><i>length</i></dt>
<dd>
-length of the indicator (integer)
+length of the indicator (integer)
</dd>
</dl><a NAME="QsciScintillaCompat.clearKeys" ID="QsciScintillaCompat.clearKeys"></a>
<h4>QsciScintillaCompat.clearKeys</h4>
<b>clearKeys</b>(<i></i>)
<p>
- Protected method to clear the key commands.
+ Protected method to clear the key commands.
</p><a NAME="QsciScintillaCompat.clearStyles" ID="QsciScintillaCompat.clearStyles"></a>
<h4>QsciScintillaCompat.clearStyles</h4>
<b>clearStyles</b>(<i></i>)
<p>
- Public method to set the styles according the selected Qt style.
+ Public method to set the styles according the selected Qt style.
</p><a NAME="QsciScintillaCompat.currentPosition" ID="QsciScintillaCompat.currentPosition"></a>
<h4>QsciScintillaCompat.currentPosition</h4>
<b>currentPosition</b>(<i></i>)
<p>
- Public method to get the current position.
+ Public method to get the current position.
</p><dl>
<dt>Returns:</dt>
<dd>
-absolute position of the cursor (integer)
+absolute position of the cursor (integer)
</dd>
</dl><a NAME="QsciScintillaCompat.currentStyle" ID="QsciScintillaCompat.currentStyle"></a>
<h4>QsciScintillaCompat.currentStyle</h4>
<b>currentStyle</b>(<i></i>)
<p>
- Public method to get the style at the current position.
+ Public method to get the style at the current position.
</p><dl>
<dt>Returns:</dt>
<dd>
-style at the current position (integer)
+style at the current position (integer)
</dd>
</dl><a NAME="QsciScintillaCompat.delete" ID="QsciScintillaCompat.delete"></a>
<h4>QsciScintillaCompat.delete</h4>
<b>delete</b>(<i></i>)
<p>
- Public method to delete the character to the right of the cursor.
+ Public method to delete the character to the right of the cursor.
</p><a NAME="QsciScintillaCompat.deleteBack" ID="QsciScintillaCompat.deleteBack"></a>
<h4>QsciScintillaCompat.deleteBack</h4>
<b>deleteBack</b>(<i></i>)
<p>
- Public method to delete the character to the left of the cursor.
+ Public method to delete the character to the left of the cursor.
</p><a NAME="QsciScintillaCompat.deleteLineLeft" ID="QsciScintillaCompat.deleteLineLeft"></a>
<h4>QsciScintillaCompat.deleteLineLeft</h4>
<b>deleteLineLeft</b>(<i></i>)
<p>
- Public method to delete the line to the left of the cursor.
+ Public method to delete the line to the left of the cursor.
</p><a NAME="QsciScintillaCompat.deleteLineRight" ID="QsciScintillaCompat.deleteLineRight"></a>
<h4>QsciScintillaCompat.deleteLineRight</h4>
<b>deleteLineRight</b>(<i></i>)
<p>
- Public method to delete the line to the right of the cursor.
+ Public method to delete the line to the right of the cursor.
</p><a NAME="QsciScintillaCompat.deleteWordLeft" ID="QsciScintillaCompat.deleteWordLeft"></a>
<h4>QsciScintillaCompat.deleteWordLeft</h4>
<b>deleteWordLeft</b>(<i></i>)
<p>
- Public method to delete the word to the left of the cursor.
+ Public method to delete the word to the left of the cursor.
</p><a NAME="QsciScintillaCompat.deleteWordRight" ID="QsciScintillaCompat.deleteWordRight"></a>
<h4>QsciScintillaCompat.deleteWordRight</h4>
<b>deleteWordRight</b>(<i></i>)
<p>
- Public method to delete the word to the right of the cursor.
+ Public method to delete the word to the right of the cursor.
</p><a NAME="QsciScintillaCompat.detectEolString" ID="QsciScintillaCompat.detectEolString"></a>
<h4>QsciScintillaCompat.detectEolString</h4>
<b>detectEolString</b>(<i>txt</i>)
<p>
- Public method to determine the eol string used.
+ Public method to determine the eol string used.
</p><dl>
<dt><i>txt</i></dt>
<dd>
-text from which to determine the eol string (string)
+text from which to determine the eol string (string)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-eol string (string)
+eol string (string)
</dd>
</dl><a NAME="QsciScintillaCompat.editorCommand" ID="QsciScintillaCompat.editorCommand"></a>
<h4>QsciScintillaCompat.editorCommand</h4>
<b>editorCommand</b>(<i>cmd</i>)
<p>
- Public method to perform a simple editor command.
+ Public method to perform a simple editor command.
</p><dl>
<dt><i>cmd</i></dt>
<dd>
-the scintilla command to be performed
+the scintilla command to be performed
</dd>
</dl><a NAME="QsciScintillaCompat.extendSelectionLeft" ID="QsciScintillaCompat.extendSelectionLeft"></a>
<h4>QsciScintillaCompat.extendSelectionLeft</h4>
<b>extendSelectionLeft</b>(<i></i>)
<p>
- Public method to extend the selection one character to the left.
+ Public method to extend the selection one character to the left.
</p><a NAME="QsciScintillaCompat.extendSelectionRight" ID="QsciScintillaCompat.extendSelectionRight"></a>
<h4>QsciScintillaCompat.extendSelectionRight</h4>
<b>extendSelectionRight</b>(<i></i>)
<p>
- Public method to extend the selection one character to the right.
+ Public method to extend the selection one character to the right.
</p><a NAME="QsciScintillaCompat.extendSelectionToBOL" ID="QsciScintillaCompat.extendSelectionToBOL"></a>
<h4>QsciScintillaCompat.extendSelectionToBOL</h4>
<b>extendSelectionToBOL</b>(<i></i>)
<p>
- Public method to extend the selection to the beginning of the line.
+ Public method to extend the selection to the beginning of the line.
</p><a NAME="QsciScintillaCompat.extendSelectionToEOL" ID="QsciScintillaCompat.extendSelectionToEOL"></a>
<h4>QsciScintillaCompat.extendSelectionToEOL</h4>
<b>extendSelectionToEOL</b>(<i></i>)
<p>
- Public method to extend the selection to the end of the line.
+ Public method to extend the selection to the end of the line.
</p><a NAME="QsciScintillaCompat.extendSelectionWordLeft" ID="QsciScintillaCompat.extendSelectionWordLeft"></a>
<h4>QsciScintillaCompat.extendSelectionWordLeft</h4>
<b>extendSelectionWordLeft</b>(<i></i>)
<p>
- Public method to extend the selection one word to the left.
+ Public method to extend the selection one word to the left.
</p><a NAME="QsciScintillaCompat.extendSelectionWordRight" ID="QsciScintillaCompat.extendSelectionWordRight"></a>
<h4>QsciScintillaCompat.extendSelectionWordRight</h4>
<b>extendSelectionWordRight</b>(<i></i>)
<p>
- Public method to extend the selection one word to the right.
+ Public method to extend the selection one word to the right.
</p><a NAME="QsciScintillaCompat.findFirstTarget" ID="QsciScintillaCompat.findFirstTarget"></a>
<h4>QsciScintillaCompat.findFirstTarget</h4>
<b>findFirstTarget</b>(<i>expr_, re_, cs_, wo_, begline = -1, begindex = -1, endline = -1, endindex = -1, ws_ = False</i>)
<p>
- Public method to search in a specified range of text without
- setting the selection.
+ Public method to search in a specified range of text without
+ setting the selection.
</p><dl>
<dt><i>expr_</i></dt>
<dd>
-search expression (string)
+search expression (string)
</dd><dt><i>re_</i></dt>
<dd>
-flag indicating a regular expression (boolean)
+flag indicating a regular expression (boolean)
</dd><dt><i>cs_</i></dt>
<dd>
-flag indicating a case sensitive search (boolean)
+flag indicating a case sensitive search (boolean)
</dd><dt><i>wo_</i></dt>
<dd>
-flag indicating a word only search (boolean)
+flag indicating a word only search (boolean)
</dd><dt><i>begline=</i></dt>
<dd>
-line number to start from (-1 to indicate current
- position) (integer)
+line number to start from (-1 to indicate current
+ position) (integer)
</dd><dt><i>begindex=</i></dt>
<dd>
-index to start from (-1 to indicate current
- position) (integer)
+index to start from (-1 to indicate current
+ position) (integer)
</dd><dt><i>endline=</i></dt>
<dd>
-line number to stop at (-1 to indicate end of
- document) (integer)
+line number to stop at (-1 to indicate end of
+ document) (integer)
</dd><dt><i>endindex=</i></dt>
<dd>
-index number to stop at (-1 to indicate end of
- document) (integer)
+index number to stop at (-1 to indicate end of
+ document) (integer)
</dd><dt><i>ws_=</i></dt>
<dd>
-flag indicating a word start search (boolean)
+flag indicating a word start search (boolean)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-flag indicating a successful search (boolean)
+flag indicating a successful search (boolean)
</dd>
</dl><a NAME="QsciScintillaCompat.findNextTarget" ID="QsciScintillaCompat.findNextTarget"></a>
<h4>QsciScintillaCompat.findNextTarget</h4>
<b>findNextTarget</b>(<i></i>)
<p>
- Public method to find the next occurrence in the target range.
+ Public method to find the next occurrence in the target range.
</p><dl>
<dt>Returns:</dt>
<dd>
-flag indicating a successful search (boolean)
+flag indicating a successful search (boolean)
</dd>
</dl><a NAME="QsciScintillaCompat.foldExpandedAt" ID="QsciScintillaCompat.foldExpandedAt"></a>
<h4>QsciScintillaCompat.foldExpandedAt</h4>
<b>foldExpandedAt</b>(<i>line</i>)
<p>
- Public method to determine, if a fold is expanded.
+ Public method to determine, if a fold is expanded.
</p><dl>
<dt><i>line</i></dt>
<dd>
-line number (integer)
+line number (integer)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-flag indicating the fold expansion state of the line (boolean)
+flag indicating the fold expansion state of the line (boolean)
</dd>
</dl><a NAME="QsciScintillaCompat.foldFlagsAt" ID="QsciScintillaCompat.foldFlagsAt"></a>
<h4>QsciScintillaCompat.foldFlagsAt</h4>
<b>foldFlagsAt</b>(<i>line</i>)
<p>
- Public method to get the fold flags of a line of the document.
+ Public method to get the fold flags of a line of the document.
</p><dl>
<dt><i>line</i></dt>
<dd>
-line number (integer)
+line number (integer)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-fold flags of the given line (integer)
+fold flags of the given line (integer)
</dd>
</dl><a NAME="QsciScintillaCompat.foldHeaderAt" ID="QsciScintillaCompat.foldHeaderAt"></a>
<h4>QsciScintillaCompat.foldHeaderAt</h4>
<b>foldHeaderAt</b>(<i>line</i>)
<p>
- Public method to determine, if a line of the document is a fold header line.
+ Public method to determine, if a line of the document is a fold header line.
</p><dl>
<dt><i>line</i></dt>
<dd>
-line number (integer)
+line number (integer)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-flag indicating a fold header line (boolean)
+flag indicating a fold header line (boolean)
</dd>
</dl><a NAME="QsciScintillaCompat.foldLevelAt" ID="QsciScintillaCompat.foldLevelAt"></a>
<h4>QsciScintillaCompat.foldLevelAt</h4>
<b>foldLevelAt</b>(<i>line</i>)
<p>
- Public method to get the fold level of a line of the document.
+ Public method to get the fold level of a line of the document.
</p><dl>
<dt><i>line</i></dt>
<dd>
-line number (integer)
+line number (integer)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-fold level of the given line (integer)
+fold level of the given line (integer)
</dd>
</dl><a NAME="QsciScintillaCompat.getEndStyled" ID="QsciScintillaCompat.getEndStyled"></a>
<h4>QsciScintillaCompat.getEndStyled</h4>
<b>getEndStyled</b>(<i></i>)
<p>
- Public method to get the last styled position.
+ Public method to get the last styled position.
</p><a NAME="QsciScintillaCompat.getEolIndicator" ID="QsciScintillaCompat.getEolIndicator"></a>
<h4>QsciScintillaCompat.getEolIndicator</h4>
<b>getEolIndicator</b>(<i></i>)
<p>
- Public method to get the eol indicator for the current eol mode.
+ Public method to get the eol indicator for the current eol mode.
</p><dl>
<dt>Returns:</dt>
<dd>
-eol indicator (string)
+eol indicator (string)
</dd>
</dl><a NAME="QsciScintillaCompat.getFileName" ID="QsciScintillaCompat.getFileName"></a>
<h4>QsciScintillaCompat.getFileName</h4>
<b>getFileName</b>(<i></i>)
<p>
- Public method to return the name of the file being displayed.
+ Public method to return the name of the file being displayed.
</p><dl>
<dt>Returns:</dt>
<dd>
-filename of the displayed file (string)
+filename of the displayed file (string)
</dd>
</dl><a NAME="QsciScintillaCompat.getFoundTarget" ID="QsciScintillaCompat.getFoundTarget"></a>
<h4>QsciScintillaCompat.getFoundTarget</h4>
<b>getFoundTarget</b>(<i></i>)
<p>
- Public method to get the recently found target.
+ Public method to get the recently found target.
</p><dl>
<dt>Returns:</dt>
<dd>
-found target as a tuple of starting position and target length
- (integer, integer)
+found target as a tuple of starting position and target length
+ (integer, integer)
</dd>
</dl><a NAME="QsciScintillaCompat.getLineSeparator" ID="QsciScintillaCompat.getLineSeparator"></a>
<h4>QsciScintillaCompat.getLineSeparator</h4>
<b>getLineSeparator</b>(<i></i>)
<p>
- Public method to get the line separator for the current eol mode.
+ Public method to get the line separator for the current eol mode.
</p><dl>
<dt>Returns:</dt>
<dd>
-eol string (string)
+eol string (string)
</dd>
</dl><a NAME="QsciScintillaCompat.getZoom" ID="QsciScintillaCompat.getZoom"></a>
<h4>QsciScintillaCompat.getZoom</h4>
<b>getZoom</b>(<i></i>)
<p>
- Public method used to retrieve the current zoom factor.
+ Public method used to retrieve the current zoom factor.
</p><dl>
<dt>Returns:</dt>
<dd>
-zoom factor (int)
+zoom factor (int)
</dd>
</dl><a NAME="QsciScintillaCompat.hasIndicator" ID="QsciScintillaCompat.hasIndicator"></a>
<h4>QsciScintillaCompat.hasIndicator</h4>
<b>hasIndicator</b>(<i>indicator, pos</i>)
<p>
- Public method to test for the existence of an indicator.
+ Public method to test for the existence of an indicator.
</p><dl>
<dt><i>indicator</i></dt>
<dd>
-number of the indicator (integer,
- QsciScintilla.INDIC_CONTAINER .. QsciScintilla.INDIC_MAX)
+number of the indicator (integer,
+ QsciScintilla.INDIC_CONTAINER .. QsciScintilla.INDIC_MAX)
</dd><dt><i>pos</i></dt>
<dd>
-position to test (integer)
+position to test (integer)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-flag indicating the existence of the indicator (boolean)
+flag indicating the existence of the indicator (boolean)
</dd>
</dl><a NAME="QsciScintillaCompat.indentationGuideView" ID="QsciScintillaCompat.indentationGuideView"></a>
<h4>QsciScintillaCompat.indentationGuideView</h4>
<b>indentationGuideView</b>(<i></i>)
<p>
- Public method to get the indentation guide view.
+ Public method to get the indentation guide view.
</p><dl>
<dt>Returns:</dt>
<dd>
-indentation guide view (SC_IV_NONE, SC_IV_REAL,
- SC_IV_LOOKFORWARD or SC_IV_LOOKBOTH)
+indentation guide view (SC_IV_NONE, SC_IV_REAL,
+ SC_IV_LOOKFORWARD or SC_IV_LOOKBOTH)
</dd>
</dl><a NAME="QsciScintillaCompat.indicatorDefine" ID="QsciScintillaCompat.indicatorDefine"></a>
<h4>QsciScintillaCompat.indicatorDefine</h4>
<b>indicatorDefine</b>(<i>indicator, style, color</i>)
<p>
- Public method to define the appearance of an indicator.
+ Public method to define the appearance of an indicator.
</p><dl>
<dt><i>indicator</i></dt>
<dd>
-number of the indicator (integer,
- QsciScintilla.INDIC_CONTAINER .. QsciScintilla.INDIC_MAX)
+number of the indicator (integer,
+ QsciScintilla.INDIC_CONTAINER .. QsciScintilla.INDIC_MAX)
</dd><dt><i>style</i></dt>
<dd>
-style to be used for the indicator (QsciScintilla.INDIC_PLAIN,
- QsciScintilla.INDIC_SQUIGGLE, QsciScintilla.INDIC_TT,
- QsciScintilla.INDIC_DIAGONAL, QsciScintilla.INDIC_STRIKE,
- QsciScintilla.INDIC_HIDDEN, QsciScintilla.INDIC_BOX,
- QsciScintilla.INDIC_ROUNDBOX)
+style to be used for the indicator (QsciScintilla.INDIC_PLAIN,
+ QsciScintilla.INDIC_SQUIGGLE, QsciScintilla.INDIC_TT,
+ QsciScintilla.INDIC_DIAGONAL, QsciScintilla.INDIC_STRIKE,
+ QsciScintilla.INDIC_HIDDEN, QsciScintilla.INDIC_BOX,
+ QsciScintilla.INDIC_ROUNDBOX)
</dd><dt><i>color</i></dt>
<dd>
-color to be used by the indicator (QColor)
+color to be used by the indicator (QColor)
</dd>
</dl><dl>
<dt>Raises <b>ValueError</b>:</dt>
<dd>
-the indicator or style are not valid
+the indicator or style are not valid
</dd>
</dl><a NAME="QsciScintillaCompat.lineAt" ID="QsciScintillaCompat.lineAt"></a>
<h4>QsciScintillaCompat.lineAt</h4>
<b>lineAt</b>(<i>pos</i>)
<p>
- Public method to calculate the line at a position.
+ Public method to calculate the line at a position.
</p><p>
- This variant is able to calculate the line for positions in the
- margins and for empty lines.
+ This variant is able to calculate the line for positions in the
+ margins and for empty lines.
</p><dl>
<dt><i>pos</i></dt>
<dd>
-position to calculate the line for (integer or QPoint)
+position to calculate the line for (integer or QPoint)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-linenumber at position or -1, if there is no line at pos
- (integer, zero based)
+linenumber at position or -1, if there is no line at pos
+ (integer, zero based)
</dd>
</dl><a NAME="QsciScintillaCompat.lineEndPosition" ID="QsciScintillaCompat.lineEndPosition"></a>
<h4>QsciScintillaCompat.lineEndPosition</h4>
<b>lineEndPosition</b>(<i>line</i>)
<p>
- Public method to determine the line end position of the given line.
+ Public method to determine the line end position of the given line.
</p><dl>
<dt><i>line</i></dt>
<dd>
-line number (integer)
+line number (integer)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-position of the line end disregarding line end characters (integer)
+position of the line end disregarding line end characters (integer)
</dd>
</dl><a NAME="QsciScintillaCompat.lineIndexFromPosition" ID="QsciScintillaCompat.lineIndexFromPosition"></a>
<h4>QsciScintillaCompat.lineIndexFromPosition</h4>
<b>lineIndexFromPosition</b>(<i>pos</i>)
<p>
- Public method to convert an absolute position to line and index.
+ Public method to convert an absolute position to line and index.
</p><dl>
<dt><i>pos</i></dt>
<dd>
-absolute position in the editor (integer)
+absolute position in the editor (integer)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-tuple of line number (integer) and index number (integer)
+tuple of line number (integer) and index number (integer)
</dd>
</dl><a NAME="QsciScintillaCompat.linesOnScreen" ID="QsciScintillaCompat.linesOnScreen"></a>
<h4>QsciScintillaCompat.linesOnScreen</h4>
<b>linesOnScreen</b>(<i></i>)
<p>
- Public method to get the amount of visible lines.
+ Public method to get the amount of visible lines.
</p><dl>
<dt>Returns:</dt>
<dd>
-amount of visible lines (integer)
+amount of visible lines (integer)
</dd>
</dl><a NAME="QsciScintillaCompat.monospacedStyles" ID="QsciScintillaCompat.monospacedStyles"></a>
<h4>QsciScintillaCompat.monospacedStyles</h4>
<b>monospacedStyles</b>(<i>font</i>)
<p>
- Public method to set the current style to be monospaced.
+ Public method to set the current style to be monospaced.
</p><dl>
<dt><i>font</i></dt>
<dd>
-font to be used (QFont)
+font to be used (QFont)
</dd>
</dl><a NAME="QsciScintillaCompat.moveCursorLeft" ID="QsciScintillaCompat.moveCursorLeft"></a>
<h4>QsciScintillaCompat.moveCursorLeft</h4>
<b>moveCursorLeft</b>(<i></i>)
<p>
- Public method to move the cursor left.
+ Public method to move the cursor left.
</p><a NAME="QsciScintillaCompat.moveCursorRight" ID="QsciScintillaCompat.moveCursorRight"></a>
<h4>QsciScintillaCompat.moveCursorRight</h4>
<b>moveCursorRight</b>(<i></i>)
<p>
- Public method to move the cursor right.
+ Public method to move the cursor right.
</p><a NAME="QsciScintillaCompat.moveCursorToEOL" ID="QsciScintillaCompat.moveCursorToEOL"></a>
<h4>QsciScintillaCompat.moveCursorToEOL</h4>
<b>moveCursorToEOL</b>(<i></i>)
<p>
- Public method to move the cursor to the end of line.
+ Public method to move the cursor to the end of line.
</p><a NAME="QsciScintillaCompat.moveCursorWordLeft" ID="QsciScintillaCompat.moveCursorWordLeft"></a>
<h4>QsciScintillaCompat.moveCursorWordLeft</h4>
<b>moveCursorWordLeft</b>(<i></i>)
<p>
- Public method to move the cursor left one word.
+ Public method to move the cursor left one word.
</p><a NAME="QsciScintillaCompat.moveCursorWordRight" ID="QsciScintillaCompat.moveCursorWordRight"></a>
<h4>QsciScintillaCompat.moveCursorWordRight</h4>
<b>moveCursorWordRight</b>(<i></i>)
<p>
- Public method to move the cursor right one word.
+ Public method to move the cursor right one word.
</p><a NAME="QsciScintillaCompat.newLineBelow" ID="QsciScintillaCompat.newLineBelow"></a>
<h4>QsciScintillaCompat.newLineBelow</h4>
<b>newLineBelow</b>(<i></i>)
<p>
- Public method to insert a new line below the current one.
+ Public method to insert a new line below the current one.
</p><a NAME="QsciScintillaCompat.positionAfter" ID="QsciScintillaCompat.positionAfter"></a>
<h4>QsciScintillaCompat.positionAfter</h4>
<b>positionAfter</b>(<i>pos</i>)
<p>
- Public method to get the position after the given position taking into account
- multibyte characters.
+ Public method to get the position after the given position taking into account
+ multibyte characters.
</p><dl>
<dt><i>pos</i></dt>
<dd>
-position (integer)
+position (integer)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-position after the given one (integer)
+position after the given one (integer)
</dd>
</dl><a NAME="QsciScintillaCompat.positionBefore" ID="QsciScintillaCompat.positionBefore"></a>
<h4>QsciScintillaCompat.positionBefore</h4>
<b>positionBefore</b>(<i>pos</i>)
<p>
- Public method to get the position before the given position taking into account
- multibyte characters.
+ Public method to get the position before the given position taking into account
+ multibyte characters.
</p><dl>
<dt><i>pos</i></dt>
<dd>
-position (integer)
+position (integer)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-position before the given one (integer)
+position before the given one (integer)
</dd>
</dl><a NAME="QsciScintillaCompat.positionFromLineIndex" ID="QsciScintillaCompat.positionFromLineIndex"></a>
<h4>QsciScintillaCompat.positionFromLineIndex</h4>
<b>positionFromLineIndex</b>(<i>line, index</i>)
<p>
- Public method to convert line and index to an absolute position.
+ Public method to convert line and index to an absolute position.
</p><dl>
<dt><i>line</i></dt>
<dd>
-line number (integer)
+line number (integer)
</dd><dt><i>index</i></dt>
<dd>
-index number (integer)
+index number (integer)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-absolute position in the editor (integer)
+absolute position in the editor (integer)
</dd>
</dl><a NAME="QsciScintillaCompat.positionFromPoint" ID="QsciScintillaCompat.positionFromPoint"></a>
<h4>QsciScintillaCompat.positionFromPoint</h4>
<b>positionFromPoint</b>(<i>point</i>)
<p>
- Public method to calculate the scintilla position from a point in the window.
+ Public method to calculate the scintilla position from a point in the window.
</p><dl>
<dt><i>point</i></dt>
<dd>
-point in the window (QPoint)
+point in the window (QPoint)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-scintilla position (integer) or -1 to indicate, that the point is not
- near any character
+scintilla position (integer) or -1 to indicate, that the point is not
+ near any character
</dd>
</dl><a NAME="QsciScintillaCompat.replaceTarget" ID="QsciScintillaCompat.replaceTarget"></a>
<h4>QsciScintillaCompat.replaceTarget</h4>
<b>replaceTarget</b>(<i>replaceStr</i>)
<p>
- Public method to replace the string found by the last search in target.
+ Public method to replace the string found by the last search in target.
</p><dl>
<dt><i>replaceStr</i></dt>
<dd>
-replacement string or regexp (string)
+replacement string or regexp (string)
</dd>
</dl><a NAME="QsciScintillaCompat.scrollVertical" ID="QsciScintillaCompat.scrollVertical"></a>
<h4>QsciScintillaCompat.scrollVertical</h4>
<b>scrollVertical</b>(<i>lines</i>)
<p>
- Public method to scroll the text area.
+ Public method to scroll the text area.
</p><dl>
<dt><i>lines</i></dt>
<dd>
-number of lines to scroll (negative scrolls up,
- positive scrolls down) (integer)
+number of lines to scroll (negative scrolls up,
+ positive scrolls down) (integer)
</dd>
</dl><a NAME="QsciScintillaCompat.setCurrentIndicator" ID="QsciScintillaCompat.setCurrentIndicator"></a>
<h4>QsciScintillaCompat.setCurrentIndicator</h4>
<b>setCurrentIndicator</b>(<i>indicator</i>)
<p>
- Public method to set the current indicator.
+ Public method to set the current indicator.
</p><dl>
<dt><i>indicator</i></dt>
<dd>
-number of the indicator (integer,
- QsciScintilla.INDIC_CONTAINER .. QsciScintilla.INDIC_MAX)
+number of the indicator (integer,
+ QsciScintilla.INDIC_CONTAINER .. QsciScintilla.INDIC_MAX)
</dd>
</dl><dl>
<dt>Raises <b>ValueError</b>:</dt>
<dd>
-the indicator or style are not valid
+the indicator or style are not valid
</dd>
</dl><a NAME="QsciScintillaCompat.setEolModeByEolString" ID="QsciScintillaCompat.setEolModeByEolString"></a>
<h4>QsciScintillaCompat.setEolModeByEolString</h4>
<b>setEolModeByEolString</b>(<i>eolStr</i>)
<p>
- Public method to set the eol mode given the eol string.
+ Public method to set the eol mode given the eol string.
</p><dl>
<dt><i>eolStr</i></dt>
<dd>
-eol string (string)
+eol string (string)
</dd>
</dl><a NAME="QsciScintillaCompat.setIndentationGuideView" ID="QsciScintillaCompat.setIndentationGuideView"></a>
<h4>QsciScintillaCompat.setIndentationGuideView</h4>
<b>setIndentationGuideView</b>(<i>view</i>)
<p>
- Public method to set the view of the indentation guides.
+ Public method to set the view of the indentation guides.
</p><dl>
<dt><i>view</i></dt>
<dd>
-view of the indentation guides (SC_IV_NONE, SC_IV_REAL,
- SC_IV_LOOKFORWARD or SC_IV_LOOKBOTH)
+view of the indentation guides (SC_IV_NONE, SC_IV_REAL,
+ SC_IV_LOOKFORWARD or SC_IV_LOOKBOTH)
</dd>
</dl><a NAME="QsciScintillaCompat.setIndicator" ID="QsciScintillaCompat.setIndicator"></a>
<h4>QsciScintillaCompat.setIndicator</h4>
<b>setIndicator</b>(<i>indicator, sline, sindex, eline, eindex</i>)
<p>
- Public method to set an indicator for the given range.
+ Public method to set an indicator for the given range.
</p><dl>
<dt><i>indicator</i></dt>
<dd>
-number of the indicator (integer,
- QsciScintilla.INDIC_CONTAINER .. QsciScintilla.INDIC_MAX)
+number of the indicator (integer,
+ QsciScintilla.INDIC_CONTAINER .. QsciScintilla.INDIC_MAX)
</dd><dt><i>sline</i></dt>
<dd>
-line number of the indicator start (integer)
+line number of the indicator start (integer)
</dd><dt><i>sindex</i></dt>
<dd>
-index of the indicator start (integer)
+index of the indicator start (integer)
</dd><dt><i>eline</i></dt>
<dd>
-line number of the indicator end (integer)
+line number of the indicator end (integer)
</dd><dt><i>eindex</i></dt>
<dd>
-index of the indicator end (integer)
+index of the indicator end (integer)
</dd>
</dl><dl>
<dt>Raises <b>ValueError</b>:</dt>
<dd>
-the indicator or style are not valid
+the indicator or style are not valid
</dd>
</dl><a NAME="QsciScintillaCompat.setIndicatorRange" ID="QsciScintillaCompat.setIndicatorRange"></a>
<h4>QsciScintillaCompat.setIndicatorRange</h4>
<b>setIndicatorRange</b>(<i>indicator, spos, length</i>)
<p>
- Public method to set an indicator for the given range.
+ Public method to set an indicator for the given range.
</p><dl>
<dt><i>indicator</i></dt>
<dd>
-number of the indicator (integer,
- QsciScintilla.INDIC_CONTAINER .. QsciScintilla.INDIC_MAX)
+number of the indicator (integer,
+ QsciScintilla.INDIC_CONTAINER .. QsciScintilla.INDIC_MAX)
</dd><dt><i>spos</i></dt>
<dd>
-position of the indicator start (integer)
+position of the indicator start (integer)
</dd><dt><i>length</i></dt>
<dd>
-length of the indicator (integer)
+length of the indicator (integer)
</dd>
</dl><dl>
<dt>Raises <b>ValueError</b>:</dt>
<dd>
-the indicator or style are not valid
+the indicator or style are not valid
</dd>
</dl><a NAME="QsciScintillaCompat.setLexer" ID="QsciScintillaCompat.setLexer"></a>
<h4>QsciScintillaCompat.setLexer</h4>
<b>setLexer</b>(<i>lex = None</i>)
<p>
- Public method to set the lexer.
+ Public method to set the lexer.
</p><dl>
<dt><i>lex</i></dt>
<dd>
-the lexer to be set or None to reset it.
+the lexer to be set or None to reset it.
</dd>
</dl><a NAME="QsciScintillaCompat.setStyleBits" ID="QsciScintillaCompat.setStyleBits"></a>
<h4>QsciScintillaCompat.setStyleBits</h4>
<b>setStyleBits</b>(<i>bits</i>)
<p>
- Public method to set the number of bits to be used for styling.
+ Public method to set the number of bits to be used for styling.
</p><a NAME="QsciScintillaCompat.setStyling" ID="QsciScintillaCompat.setStyling"></a>
<h4>QsciScintillaCompat.setStyling</h4>
<b>setStyling</b>(<i>length, style</i>)
<p>
- Public method to style some text.
+ Public method to style some text.
</p><dl>
<dt><i>length</i></dt>
<dd>
-length of text to style (integer)
+length of text to style (integer)
</dd><dt><i>style</i></dt>
<dd>
-style to set for text (integer)
+style to set for text (integer)
</dd>
</dl><a NAME="QsciScintillaCompat.startStyling" ID="QsciScintillaCompat.startStyling"></a>
<h4>QsciScintillaCompat.startStyling</h4>
<b>startStyling</b>(<i>pos, mask</i>)
<p>
- Public method to prepare styling.
+ Public method to prepare styling.
</p><dl>
<dt><i>pos</i></dt>
<dd>
-styling positition to start at (integer)
+styling positition to start at (integer)
</dd><dt><i>mask</i></dt>
<dd>
-mask of bits to use for styling (integer)
+mask of bits to use for styling (integer)
</dd>
</dl><a NAME="QsciScintillaCompat.styleAt" ID="QsciScintillaCompat.styleAt"></a>
<h4>QsciScintillaCompat.styleAt</h4>
<b>styleAt</b>(<i>pos</i>)
<p>
- Public method to get the style at a position in the text.
+ Public method to get the style at a position in the text.
</p><dl>
<dt><i>pos</i></dt>
<dd>
-position in the text (integer)
+position in the text (integer)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-style at the requested position or 0, if the position
- is negative or past the end of the document (integer)
+style at the requested position or 0, if the position
+ is negative or past the end of the document (integer)
</dd>
</dl><a NAME="QsciScintillaCompat.zoomIn" ID="QsciScintillaCompat.zoomIn"></a>
<h4>QsciScintillaCompat.zoomIn</h4>
<b>zoomIn</b>(<i>zoom = 1</i>)
<p>
- Public method used to increase the zoom factor.
+ Public method used to increase the zoom factor.
</p><dl>
<dt><i>zoom</i></dt>
<dd>
-zoom factor increment
+zoom factor increment
</dd>
</dl><a NAME="QsciScintillaCompat.zoomOut" ID="QsciScintillaCompat.zoomOut"></a>
<h4>QsciScintillaCompat.zoomOut</h4>
<b>zoomOut</b>(<i>zoom = 1</i>)
<p>
- Public method used to decrease the zoom factor.
+ Public method used to decrease the zoom factor.
</p><dl>
<dt><i>zoom</i></dt>
<dd>
-zoom factor decrement
+zoom factor decrement
</dd>
</dl><a NAME="QsciScintillaCompat.zoomTo" ID="QsciScintillaCompat.zoomTo"></a>
<h4>QsciScintillaCompat.zoomTo</h4>
<b>zoomTo</b>(<i>zoom</i>)
<p>
- Public method used to zoom to a specific zoom factor.
+ Public method used to zoom to a specific zoom factor.
</p><dl>
<dt><i>zoom</i></dt>
<dd>
-zoom factor
+zoom factor
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1098,14 +1098,14 @@
<h2>QSCINTILLA_VERSION</h2>
<b>QSCINTILLA_VERSION</b>(<i></i>)
<p>
- Module function to return the QScintilla version.
+ Module function to return the QScintilla version.
</p><p>
- If the installed QScintilla is a snapshot version, then assume it is
- of the latest release and return a version number of 0x99999.
+ If the installed QScintilla is a snapshot version, then assume it is
+ of the latest release and return a version number of 0x99999.
</p><dl>
<dt>Returns:</dt>
<dd>
-QScintilla version (integer)
+QScintilla version (integer)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
