diff options
Diffstat (limited to 'doc/ScintillaDoc.html')
| -rw-r--r-- | doc/ScintillaDoc.html | 126 |
1 files changed, 87 insertions, 39 deletions
diff --git a/doc/ScintillaDoc.html b/doc/ScintillaDoc.html index 8a8eddbff..ce0758bc0 100644 --- a/doc/ScintillaDoc.html +++ b/doc/ScintillaDoc.html @@ -270,136 +270,140 @@ <tr> <td>○ <a class="toc" href="#SelectionAndInformation">Selection and information</a></td> - <td>○ <a class="toc" href="#MultipleSelectionAndVirtualSpace">Multiple Selection and Virtual Space</a></td> + <td>○ <a class="toc" href="#ByCharacterOrCodeUnit">By character or UTF-16 code unit</a></td> - <td>○ <a class="toc" href="#ScrollingAndAutomaticScrolling">Scrolling and automatic + <td>○ <a class="toc" href="#MultipleSelectionAndVirtualSpace">Multiple Selection and Virtual Space</a></td> scrolling</a></td> </tr> <tr> + <td>○ <a class="toc" href="#ScrollingAndAutomaticScrolling">Scrolling and automatic + <td>○ <a class="toc" href="#WhiteSpace">White space</a></td> <td>○ <a class="toc" href="#Cursor">Cursor</a></td> - <td>○ <a class="toc" href="#MouseCapture">Mouse capture</a></td> - </tr> <tr> + <td>○ <a class="toc" href="#MouseCapture">Mouse capture</a></td> + <td>○ <a class="toc" href="#LineEndings">Line endings</a></td> <td>○ <a class="toc" href="#Words">Words</a></td> - <td>○ <a class="toc" href="#Styling">Styling</a></td> - </tr> <tr> + <td>○ <a class="toc" href="#Styling">Styling</a></td> + <td>○ <a class="toc" href="#StyleDefinition">Style definition</a></td> <td>○ <a class="toc" href="#CaretAndSelectionStyles">Caret, selection, and hotspot styles</a></td> - <td>○ <a class="toc" href="#CharacterRepresentations">Character representations</a></td> - </tr> <tr> + <td>○ <a class="toc" href="#CharacterRepresentations">Character representations</a></td> + <td>○ <a class="toc" href="#Margins">Margins</a></td> <td>○ <a class="toc" href="#Annotations">Annotations</a></td> - <td>○ <a class="toc" href="#OtherSettings">Other settings</a></td> - </tr> <tr> + <td>○ <a class="toc" href="#OtherSettings">Other settings</a></td> + <td>○ <a class="toc" href="#BraceHighlighting">Brace highlighting</a></td> <td>○ <a class="toc" href="#TabsAndIndentationGuides">Tabs and Indentation Guides</a></td> - <td>○ <a class="toc" href="#Markers">Markers</a></td> - </tr> <tr> + <td>○ <a class="toc" href="#Markers">Markers</a></td> + <td>○ <a class="toc" href="#Indicators">Indicators</a></td> <td>○ <a class="toc" href="#Autocompletion">Autocompletion</a></td> - <td>○ <a class="toc" href="#UserLists">User lists</a></td> - </tr> <tr> + <td>○ <a class="toc" href="#UserLists">User lists</a></td> + <td>○ <a class="toc" href="#CallTips">Call tips</a></td> <td>○ <a class="toc" href="#KeyboardCommands">Keyboard commands</a></td> - <td>○ <a class="toc" href="#KeyBindings">Key bindings</a></td> - </tr> <tr> + <td>○ <a class="toc" href="#KeyBindings">Key bindings</a></td> + <td>○ <a class="toc" href="#PopupEditMenu">Popup edit menu</a></td> <td>○ <a class="toc" href="#MacroRecording">Macro recording</a></td> - <td>○ <a class="toc" href="#Printing">Printing</a></td> - </tr> <tr> + <td>○ <a class="toc" href="#Printing">Printing</a></td> + <td>○ <a class="toc" href="#DirectAccess">Direct access</a></td> <td>○ <a class="toc" href="#MultipleViews">Multiple views</a></td> - <td>○ <a class="toc" href="#BackgroundLoadSave">Background loading and saving</a></td> - </tr> <tr> + <td>○ <a class="toc" href="#BackgroundLoadSave">Background loading and saving</a></td> + <td>○ <a class="toc" href="#Folding">Folding</a></td> <td>○ <a class="toc" href="#LineWrapping">Line wrapping</a></td> - <td>○ <a class="toc" href="#Zooming">Zooming</a></td> - </tr> <tr> + <td>○ <a class="toc" href="#Zooming">Zooming</a></td> + <td>○ <a class="toc" href="#LongLines">Long lines</a></td> <td>○ <a class="toc" href="#Accessibility">Accessibility</a></td> - <td>○ <a class="toc" href="#Lexer">Lexer</a></td> - </tr> <tr> + <td>○ <a class="toc" href="#Lexer">Lexer</a></td> + <td>○ <a class="toc" href="#LexerObjects">Lexer objects</a></td> <td>○ <a class="toc" href="#Notifications">Notifications</a></td> - <td>○ <a class="toc" href="#Images">Images</a></td> - </tr> <tr> + <td>○ <a class="toc" href="#Images">Images</a></td> + <td>○ <a class="toc" href="#GTK">GTK+</a></td> <td>○ <a class="toc" href="#ProvisionalMessages"><span class="provisional">Provisional messages</span></a></td> - <td>○ <a class="toc" href="#DeprecatedMessages">Deprecated messages</a></td> - </tr> <tr> + <td>○ <a class="toc" href="#DeprecatedMessages">Deprecated messages</a></td> + <td>○ <a class="toc" href="#EditMessagesNeverSupportedByScintilla">Edit messages never supported by Scintilla</a></td> <td>○ <a class="toc" href="#RemovedFeatures">Removed features</a></td> + </tr> + <tr> <td>○ <a class="toc" href="#BuildingScintilla">Building Scintilla</a></td> </tr> @@ -1229,8 +1233,6 @@ struct Sci_TextToFind { <a class="message" href="#SCI_MOVECARETINSIDEVIEW">SCI_MOVECARETINSIDEVIEW</a><br /> <a class="message" href="#SCI_POSITIONBEFORE">SCI_POSITIONBEFORE(int pos) → position</a><br /> <a class="message" href="#SCI_POSITIONAFTER">SCI_POSITIONAFTER(int pos) → position</a><br /> - <a class="message" href="#SCI_POSITIONRELATIVE">SCI_POSITIONRELATIVE(int pos, int relative) → position</a><br /> - <a class="message" href="#SCI_COUNTCHARACTERS">SCI_COUNTCHARACTERS(int start, int end) → int</a><br /> <a class="message" href="#SCI_TEXTWIDTH">SCI_TEXTWIDTH(int style, const char *text) → int</a><br /> <a class="message" href="#SCI_TEXTHEIGHT">SCI_TEXTHEIGHT(int line) → int</a><br /> <a class="message" href="#SCI_CHOOSECARETX">SCI_CHOOSECARETX</a><br /> @@ -1448,15 +1450,6 @@ struct Sci_TextToFind { If called with a position within a multi byte character will return the position of the start/end of that character.</p> - <p><b id="SCI_POSITIONRELATIVE">SCI_POSITIONRELATIVE(int pos, int relative) → position</b><br /> - Count a number of whole characters before or after the argument position and return that position. - The minimum position returned is 0 and the maximum is the last position in the document. - If the position goes past the document end then 0 is returned. - </p> - - <p><b id="SCI_COUNTCHARACTERS">SCI_COUNTCHARACTERS(int start, int end) → int</b><br /> - Returns the number of whole characters between two positions..</p> - <p><b id="SCI_TEXTWIDTH">SCI_TEXTWIDTH(int style, const char *text) → int</b><br /> This returns the pixel width of a string drawn in the given <code class="parameter">style</code> which can be used, for example, to decide how wide to make the line number margin in order to display a @@ -1527,6 +1520,61 @@ struct Sci_TextToFind { When this option is turned off, mouse selections will always stick to the mode the selection was started in. It is off by default.</p> + <h2 id="ByCharacterOrCodeUnit">By character or UTF-16 code unit</h2> + + <p>Most Scintilla APIs use byte positions but some applications want to use positions based on counting + (UTF-32) characters or (UTF-16) code units + or need to communicate with other code written in terms of characters or code units. + With only byte positions, this may require examining many bytes to count characters or code units in the document + but this may be sped up in some cases by indexing the line starts by character or code unit.</p> + + <code> + <a class="message" href="#SCI_POSITIONRELATIVE">SCI_POSITIONRELATIVE(int pos, int relative) → position</a><br /> + <a class="message" href="#SCI_POSITIONRELATIVECODEUNITS">SCI_POSITIONRELATIVECODEUNITS(int pos, int relative) → position</a><br /> + <a class="message" href="#SCI_COUNTCHARACTERS">SCI_COUNTCHARACTERS(int start, int end) → int</a><br /> + <a class="message" href="#SCI_COUNTCODEUNITS">SCI_COUNTCODEUNITS(int start, int end) → int</a><br /> + <a class="message" href="#SCI_GETLINECHARACTERINDEX">SCI_GETLINECHARACTERINDEX → int</a><br /> + <a class="message" href="#SCI_ALLOCATELINECHARACTERINDEX">SCI_ALLOCATELINECHARACTERINDEX(int lineCharacterIndex)</a><br /> + <a class="message" href="#SCI_RELEASELINECHARACTERINDEX">SCI_RELEASELINECHARACTERINDEX(int lineCharacterIndex)</a><br /> + <a class="message" href="#SCI_LINEFROMINDEXPOSITION">SCI_LINEFROMINDEXPOSITION(int pos, int lineCharacterIndex) → int</a><br /> + <a class="message" href="#SCI_INDEXPOSITIONFROMLINE">SCI_INDEXPOSITIONFROMLINE(int line, int lineCharacterIndex) → int</a><br /> + </code> + + <p><b id="SCI_POSITIONRELATIVE">SCI_POSITIONRELATIVE(int pos, int relative) → position</b><br /> + Count a number of whole characters before or after the argument position and return that position. + The minimum position returned is 0 and the maximum is the last position in the document. + If the position goes past the document end then 0 is returned. + </p> + + <p><b id="SCI_COUNTCHARACTERS">SCI_COUNTCHARACTERS(int start, int end) → int</b><br /> + Returns the number of whole characters between two positions.</p> + + <p><b id="SCI_POSITIONRELATIVECODEUNITS">SCI_POSITIONRELATIVECODEUNITS(int pos, int relative) → int</b><br /> + <b id="SCI_COUNTCODEUNITS">SCI_COUNTCODEUNITS(int start, int end) → int</b><br /> + These are the UTF-16 versions of <code>SCI_POSITIONRELATIVE</code> and <code>SCI_COUNTCHARACTERS</code> + working in terms of UTF-16 code units.</p> + + <p><b id="SCI_GETLINECHARACTERINDEX">SCI_GETLINECHARACTERINDEX → int</b><br /> + Returns which if any indexes are active. It may be <code>SC_LINECHARACTERINDEX_NONE(0)</code> or one or more + of <code>SC_LINECHARACTERINDEX_UTF32(1)</code> if whole characters are indexed or + <code>SC_LINECHARACTERINDEX_UTF16(2)</code> if UTF-16 code units are indexed. + Character indexes are currently only supported for UTF-8 documents.</p> + + <p><b id="SCI_ALLOCATELINECHARACTERINDEX">SCI_ALLOCATELINECHARACTERINDEX(int lineCharacterIndex)</b><br /> + <b id="SCI_RELEASELINECHARACTERINDEX">SCI_RELEASELINECHARACTERINDEX(int lineCharacterIndex)</b><br /> + Allocate or release one or more indexes using same enumeration as <code>SCI_GETLINECHARACTERINDEX</code>. + Different aspects of an application may need indexes for different periods and should allocate for those periods. + Indexes use additional memory so releasing them can help minimize memory but they also take time to recalculate. + Scintilla may also allocate indexes to support features like accessibility or input method editors. + Only one index of each type is created for a document at a time.</p> + + <p><b id="SCI_LINEFROMINDEXPOSITION">SCI_LINEFROMINDEXPOSITION(int pos, int lineCharacterIndex) → int</b><br /> + <b id="SCI_INDEXPOSITIONFROMLINE">SCI_INDEXPOSITIONFROMLINE(int line, int lineCharacterIndex) → int</b><br /> + The document line of a particular character or code unit may be found by calling <code>SCI_LINEFROMINDEXPOSITION</code> with one of + <code>SC_LINECHARACTERINDEX_UTF32(1)</code> or <code>SC_LINECHARACTERINDEX_UTF16(2)</code>. + The inverse action, finds the starting position of a document line either in characters or code units from the document start by calling + <code>SCI_INDEXPOSITIONFROMLINE</code> with the same <code class="parameter">lineCharacterIndex</code> argument.</p> + <h2 id="MultipleSelectionAndVirtualSpace">Multiple Selection and Virtual Space</h2> <code> |