diff options
Diffstat (limited to 'scintilla/doc/ScintillaDoc.html')
| -rw-r--r-- | scintilla/doc/ScintillaDoc.html | 380 |
1 files changed, 182 insertions, 198 deletions
diff --git a/scintilla/doc/ScintillaDoc.html b/scintilla/doc/ScintillaDoc.html index 080cea3..c24f52d 100644 --- a/scintilla/doc/ScintillaDoc.html +++ b/scintilla/doc/ScintillaDoc.html @@ -82,7 +82,7 @@ <h1>Scintilla Documentation</h1> - <p>Last edited 11 June 2015 NH</p> + <p>Last edited 31 July 2015 NH</p> <p>There is <a class="jump" href="Design.html">an overview of the internal design of Scintilla</a>.<br /> @@ -575,10 +575,14 @@ These structures are defined to be exactly the same shape as the Win32 <code>TEXTRANGE</code> and <code>CHARRANGE</code>, so that older code that treats Scintilla as a RichEdit will work.</p> + <p>In a future release the type <code>Sci_PositionCR</code> will be redefined to be 64-bits when Scintilla is + built for 64-bits on all platforms.</p> <pre> +typedef long Sci_PositionCR; + struct Sci_CharacterRange { - long cpMin; - long cpMax; + Sci_PositionCR cpMin; + Sci_PositionCR cpMax; }; struct Sci_TextRange { @@ -1646,6 +1650,9 @@ struct Sci_TextToFind { Any selection apart from the main selection is called an additional selection. The calls in the previous section operate on the main selection. There is always at least one selection. + The selection can be simplified down to just the main selection by + <a class="message" href="#SCI_CANCEL"><code>SCI_CANCEL</code></a> + which is normally mapped to the Esc key. </p> <p> @@ -1673,7 +1680,9 @@ struct Sci_TextToFind { <p> <b id="SCI_SETADDITIONALSELECTIONTYPING">SCI_SETADDITIONALSELECTIONTYPING(bool additionalSelectionTyping)</b><br /> <b id="SCI_GETADDITIONALSELECTIONTYPING">SCI_GETADDITIONALSELECTIONTYPING</b><br /> - Whether typing, backspace, or delete works with multiple selections simultaneously.</p> + Whether typing, new line, cursor left/right/up/down, backspace, delete, home, and end work + with multiple selections simultaneously. + Also allows selection and word and line deletion commands.</p> <p> <b id="SCI_SETMULTIPASTE">SCI_SETMULTIPASTE(int multiPaste)</b><br /> @@ -2694,8 +2703,8 @@ struct Sci_TextToFind { <p><b id="SCI_STYLESETCASE">SCI_STYLESETCASE(int styleNumber, int caseMode)</b><br /> <b id="SCI_STYLEGETCASE">SCI_STYLEGETCASE(int styleNumber)</b><br /> The value of caseMode determines how text is displayed. You can set upper case - (<code>SC_CASE_UPPER</code>, 1) or lower case (<code>SC_CASE_LOWER</code>, 2) or display - normally (<code>SC_CASE_MIXED</code>, 0). This does not change the stored text, only how it is + (<code>SC_CASE_UPPER</code>, 1) or lower case (<code>SC_CASE_LOWER</code>, 2) or camel case (<code>SC_CASE_CAMEL</code>, 3) + or display normally (<code>SC_CASE_MIXED</code>, 0). This does not change the stored text, only how it is displayed.</p> <p><b id="SCI_STYLESETVISIBLE">SCI_STYLESETVISIBLE(int styleNumber, bool visible)</b><br /> @@ -3636,7 +3645,7 @@ struct Sci_TextToFind { colour)</a><br /> <a class="message" href="#SCI_MARKERSETBACKSELECTED">SCI_MARKERSETBACKSELECTED(int markerNumber, int colour)</a><br /> - <a class="message" href="#SCI_MARKERENABLEHIGHLIGHT">SCI_MARKERENABLEHIGHLIGHT(int enabled)</a><br /> + <a class="message" href="#SCI_MARKERENABLEHIGHLIGHT">SCI_MARKERENABLEHIGHLIGHT(bool enabled)</a><br /> <a class="message" href="#SCI_MARKERSETALPHA">SCI_MARKERSETALPHA(int markerNumber, int alpha)</a><br /> <a class="message" href="#SCI_MARKERADD">SCI_MARKERADD(int line, int markerNumber)</a><br /> @@ -4320,8 +4329,10 @@ struct Sci_TextToFind { <p>When the user makes a selection from the list the container is sent a <code><a class="message" href="#SCN_AUTOCSELECTION">SCN_AUTOCSELECTION</a></code> <a class="jump" href="#Notifications">notification message</a>. On return from the notification Scintilla will insert - the selected text unless the autocompletion list has been cancelled, for example by the container sending - <code><a class="message" href="#SCI_AUTOCCANCEL">SCI_AUTOCCANCEL</a></code>.</p> + the selected text and the container is sent a <code><a class="message" + href="#SCN_AUTOCCOMPLETED">SCN_AUTOCCOMPLETED</a></code> <a class="jump" + href="#Notifications">notification message</a> unless the autocompletion list has been cancelled, for example by the container sending + <code><a class="message" href="#SCI_AUTOCCANCEL">SCI_AUTOCCANCEL</a></code>. </p> <p>To make use of autocompletion you must monitor each character added to the document. See <code>SciTEBase::CharAdded()</code> in SciTEBase.cxx for an example of autocompletion.</p> @@ -4550,10 +4561,10 @@ struct Sci_TextToFind { <p>o The <code><a class="message" href="#SCI_AUTOCSETCHOOSESINGLE">SCI_AUTOCSETCHOOSESINGLE</a></code> message has no effect.<br /> - o When the user makes a selection you are sent a <code><a class="message" + o When the user makes a selection you are sent a <code><a class="jump" href="#SCN_USERLISTSELECTION">SCN_USERLISTSELECTION</a></code> <a class="jump" - href="#Notifications">notification message</a> rather than <code><a class="message" - href="#SCN_AUTOCSELECTION">SCN_AUTOCSELECTION</a></code>.</p> + href="#Notifications">notification message</a> rather than <code><a class="jump" + href="#SCN_AUTOCSELECTION">SCN_AUTOCSELECTION</a></code>.<br> <p>BEWARE: if you have set fillup characters or stop characters, these will still be active with the user list, and may result in items being selected or the user list cancelled due to @@ -4967,6 +4978,10 @@ struct Sci_TextToFind { by binding the <code>home</code> and <code>end</code> keys to these commands. </p> + <p class="message" id="SCI_CANCEL">The <code>SCI_CANCEL</code> command cancels autocompletion and + calltip display and drops any additional selections. + </p> + <h2 id="KeyBindings">Key bindings</h2> <p>There is a default binding of keys to commands that is defined in the Scintilla source in @@ -6325,62 +6340,34 @@ SCI_METHOD<span class="S0"> </span>PropertyNames<span class="S10">()</span> <span class="S0"> </span><span class="S5">virtual</span> <span class="S0"> </span><span class="S5">const</span><span class="S0"> </span><span class="S5">char</span><span class="S0"> </span><span class="S10">*</span><span class="S0"> </span>SCI_METHOD<span class="S0"> </span>DescribeProperty<span class="S10">(</span><span class="S5">const</span><span class="S0"> </span><span class="S5">char</span><span class="S0"> </span><span class="S10">*</span>name<span class="S10">)</span><span class="S0"> </span><span class="S10">=</span><span class="S0"> </span><span class="S4">0</span><span class="S10">;</span><br /> <span class="S0"> </span><span class="S5">virtual</span> -<span class="S0"> </span><span class="S5">int</span><span class="S0"> </span>SCI_METHOD -<span class="S0"> </span>PropertySet<span class="S10">(</span><span class="S5">const</span> -<span class="S0"> </span><span class="S5">char</span> -<span class="S0"> </span><span class="S10">*</span>key<span class="S10">,</span> -<span class="S0"> </span><span class="S5">const</span><span class="S0"> </span> -<span class="S5">char</span><span class="S0"> </span><span class="S10">*</span>val<span class="S10">)</span> -<span class="S0"> </span><span class="S10">=</span> -<span class="S0"> </span><span class="S4">0</span><span class="S10">;</span><br /> -<span class="S0"> </span><span class="S5">virtual</span><span class="S0"> </span> -<span class="S5">const</span><span class="S0"> </span><span class="S5">char</span><span class="S0"> </span> -<span class="S10">*</span><span class="S0"> </span>SCI_METHOD<span class="S0"> </span>DescribeWordListSets<span class="S10">()</span> -<span class="S0"> </span><span class="S10">=</span><span class="S0"> </span> -<span class="S4">0</span><span class="S10">;</span><br /> +<span class="S0"> </span>Sci_Position<span class="S0"> </span>SCI_METHOD +<span class="S0"> </span>PropertySet<span class="S10">(</span><span class="S5">const</span><span class="S0"> </span><span class="S5">char</span><span class="S0"> </span><span class="S10">*</span>key<span class="S10">,</span><span class="S0"> </span><span class="S5">const</span><span class="S0"> </span><span class="S5">char</span><span class="S0"> </span><span class="S10">*</span>val<span class="S10">)</span><span class="S0"> </span><span class="S10">=</span><span class="S0"> </span><span class="S4">0</span><span class="S10">;</span><br /> <span class="S0"> </span><span class="S5">virtual</span> -<span class="S0"> </span><span class="S5">int</span><span class="S0"> </span>SCI_METHOD -<span class="S0"> </span>WordListSet<span class="S10">(</span><span class="S5">int</span> -<span class="S0"> </span>n<span class="S10">,</span> -<span class="S0"> </span><span class="S5">const</span><span class="S0"> </span> -<span class="S5">char</span><span class="S0"> </span><span class="S10">*</span>wl<span class="S10">)</span> -<span class="S0"> </span><span class="S10">=</span> -<span class="S0"> </span><span class="S4">0</span><span class="S10">;</span><br /> +<span class="S0"> </span><span class="S5">const</span><span class="S0"> </span><span class="S5">char</span><span class="S0"> </span><span class="S10">*</span><span class="S0"> </span>SCI_METHOD +<span class="S0"> </span>DescribeWordListSets<span class="S10">()</span><span class="S0"> </span><span class="S10">=</span><span class="S0"> </span><span class="S4">0</span><span class="S10">;</span><br /> +<span class="S0"> </span><span class="S5">virtual</span> +<span class="S0"> </span>Sci_Position<span class="S0"> </span>SCI_METHOD +<span class="S0"> </span>WordListSet<span class="S10">(</span><span class="S5">int</span><span class="S0"> </span>n<span class="S10">,</span><span class="S0"> </span><span class="S5">const</span><span class="S0"> </span><span class="S5">char</span><span class="S0"> </span><span class="S10">*</span>wl<span class="S10">)</span><span class="S0"> </span><span class="S10">=</span><span class="S0"> </span><span class="S4">0</span><span class="S10">;</span><br /> <span class="S0"> </span><span class="S5">virtual</span> <span class="S0"> </span><span class="S5">void</span><span class="S0"> </span>SCI_METHOD -<span class="S0"> </span>Lex<span class="S10">(</span><span class="S5">unsigned</span> -<span class="S0"> </span><span class="S5">int</span> -<span class="S0"> </span>startPos<span class="S10">,</span> -<span class="S0"> </span><span class="S5">int</span> -<span class="S0"> </span>lengthDoc<span class="S10">,</span><span class="S0"> -</span><span class="S5">int</span><span class="S0"> </span>initStyle<span class="S10">,</span> -<span class="S0"> </span>IDocument<span class="S0"> -</span><span class="S10">*</span>pAccess<span class="S10">)</span> -<span class="S0"> </span><span class="S10">=</span><span class="S0"> </span> -<span class="S4">0</span><span class="S10">;</span><br /> +<span class="S0"> </span>Lex<span class="S10">(</span>Sci_PositionU<span class="S0"> </span>startPos<span class="S10">,</span><span class="S0"> </span>Sci_Position<span class="S0"> </span>lengthDoc<span class="S10">,</span><span class="S0"> </span><span class="S5">int</span><span class="S0"> </span>initStyle<span class="S10">,</span><span class="S0"> </span>IDocument<span class="S0"> </span><span class="S10">*</span>pAccess<span class="S10">)</span><span class="S0"> </span><span class="S10">=</span><span class="S0"> </span><span class="S4">0</span><span class="S10">;</span><br /> <span class="S0"> </span><span class="S5">virtual</span> <span class="S0"> </span><span class="S5">void</span><span class="S0"> </span>SCI_METHOD -<span class="S0"> </span>Fold<span class="S10">(</span><span class="S5">unsigned</span> -<span class="S0"> </span><span class="S5">int</span><span class="S0"> </span>startPos<span class="S10">,</span> -<span class="S0"> </span><span class="S5">int</span> -<span class="S0"> </span>lengthDoc<span class="S10">,</span><span class="S0"> -</span><span class="S5">int</span><span class="S0"> </span>initStyle<span class="S10">,</span> -<span class="S0"> </span>IDocument<span class="S0"> -</span><span class="S10">*</span>pAccess<span class="S10">)</span> -<span class="S0"> </span><span class="S10">=</span><span class="S0"> </span> -<span class="S4">0</span><span class="S10">;</span><br /> +<span class="S0"> </span>Fold<span class="S10">(</span>Sci_PositionU<span class="S0"> </span>startPos<span class="S10">,</span><span class="S0"> </span>Sci_Position<span class="S0"> </span>lengthDoc<span class="S10">,</span><span class="S0"> </span><span class="S5">int</span><span class="S0"> </span>initStyle<span class="S10">,</span><span class="S0"> </span>IDocument<span class="S0"> </span><span class="S10">*</span>pAccess<span class="S10">)</span><span class="S0"> </span><span class="S10">=</span><span class="S0"> </span><span class="S4">0</span><span class="S10">;</span><br /> <span class="S0"> </span><span class="S5">virtual</span> -<span class="S0"> </span><span class="S5">void</span><span class="S0"> </span> -<span class="S10">*</span><span class="S0"> </span>SCI_METHOD<span class="S0"> -</span>PrivateCall<span class="S10">(</span><span class="S5">int</span> -<span class="S0"> </span>operation<span class="S10">,</span><span class="S0"> -</span><span class="S5">void</span><span class="S0"> </span> -<span class="S10">*</span>pointer<span class="S10">)</span><span class="S0"> </span> -<span class="S10">=</span><span class="S0"> </span><span class="S4">0</span><span class="S10">;</span><br /> +<span class="S0"> </span><span class="S5">void</span><span class="S0"> </span><span class="S10">*</span><span class="S0"> </span>SCI_METHOD +<span class="S0"> </span>PrivateCall<span class="S10">(</span><span class="S5">int</span><span class="S0"> </span>operation<span class="S10">,</span><span class="S0"> </span><span class="S5">void</span><span class="S0"> </span><span class="S10">*</span>pointer<span class="S10">)</span><span class="S0"> </span><span class="S10">=</span><span class="S0"> </span><span class="S4">0</span><span class="S10">;</span><br /> <span class="S10">};</span><br /> </div> <p> +The types <code>Sci_Position</code> and <code>Sci_PositionU</code> are used for positions and line numbers in the document. +Before release 3.6.0 the types <code>int</code> and <code>unsigned int</code> were used instead and, for 3.6.0, +<code>Sci_Position</code> is defined as <code>int</code> and <code>Sci_PositionU</code> is defined as <code>unsigned int</code>. +In a future release, 64-bit builds will define these as 64-bit types to allow documents larger than 2 GB. +</p> + +<p> The return values from PropertySet and WordListSet are used to indicate whether the change requires performing lexing or folding over any of the document. It is the position at which to restart lexing and folding or -1 if the change does not require any extra work on the document. @@ -6433,134 +6420,29 @@ To allow lexers to report which line ends they support, and to support substyles <h4>IDocument</h4> <div class="highlighted"> -<span class="S5">class</span><span class="S0"> </span>IDocument -<span class="S0"> </span><span class="S10">{</span><br /> +<span class="S5">class</span><span class="S0"> </span>IDocument<span class="S0"> </span><span class="S10">{</span><br /> <span class="S5">public</span><span class="S10">:</span><br /> -<span class="S0"> </span><span class="S5">virtual</span> -<span class="S0"> </span><span class="S5">int</span><span class="S0"> </span>SCI_METHOD -<span class="S0"> </span>Version<span class="S10">()</span><span class="S0"> </span> -<span class="S5">const</span><span class="S0"> </span><span class="S10">=</span> -<span class="S0"> </span><span class="S4">0</span><span class="S10">;</span><br /> -<span class="S0"> </span><span class="S5">virtual</span> -<span class="S0"> </span><span class="S5">void</span><span class="S0"> </span>SCI_METHOD -<span class="S0"> </span>SetErrorStatus<span class="S10">(</span><span class="S5">int</span> -<span class="S0"> </span>status<span class="S10">)</span> -<span class="S0"> </span><span class="S10">=</span><span class="S0"> </span> -<span class="S4">0</span><span class="S10">;</span><br /> -<span class="S0"> </span><span class="S5">virtual</span> -<span class="S0"> </span><span class="S5">int</span><span class="S0"> </span>SCI_METHOD -<span class="S0"> </span>Length<span class="S10">()</span><span class="S0"> </span> -<span class="S5">const</span><span class="S0"> </span><span class="S10">=</span> -<span class="S0"> </span><span class="S4">0</span><span class="S10">;</span><br /> -<span class="S0"> </span><span class="S5">virtual</span> -<span class="S0"> </span><span class="S5">void</span><span class="S0"> </span>SCI_METHOD -<span class="S0"> </span>GetCharRange<span class="S10">(</span><span class="S5">char</span> -<span class="S0"> </span><span class="S10">*</span>buffer<span class="S10">,</span> -<span class="S0"> </span><span class="S5">int</span><span class="S0"> </span> -position<span class="S10">,</span><span class="S0"> </span> -<span class="S5">int</span><span class="S0"> </span>lengthRetrieve<span class="S10">)</span> -<span class="S0"> </span><span class="S5">const</span> -<span class="S0"> </span><span class="S10">=</span><span class="S0"> </span> -<span class="S4">0</span><span class="S10">;</span><br /> -<span class="S0"> </span><span class="S5">virtual</span> -<span class="S0"> </span><span class="S5">char</span><span class="S0"> </span>SCI_METHOD -<span class="S0"> </span>StyleAt<span class="S10">(</span><span class="S5">int</span> -<span class="S0"> </span>position<span class="S10">)</span><span class="S0"> </span> -<span class="S5">const</span><span class="S0"> </span><span class="S10">=</span> -<span class="S0"> </span><span class="S4">0</span><span class="S10">;</span><br /> -<span class="S0"> </span><span class="S5">virtual</span> -<span class="S0"> </span><span class="S5">int</span><span class="S0"> </span>SCI_METHOD -<span class="S0"> </span>LineFromPosition<span class="S10">(</span><span class="S5">int</span><span class="S0"> </span>position<span class="S10">)</span> -<span class="S0"> </span><span class="S5">const</span><span class="S0"> </span><span class="S10">=</span> -<span class="S0"> </span><span class="S4">0</span><span class="S10">;</span><br /> -<span class="S0"> </span><span class="S5">virtual</span><span class="S0"> </span> -<span class="S5">int</span><span class="S0"> </span>SCI_METHOD -<span class="S0"> </span>LineStart<span class="S10">(</span><span class="S5">int</span><span class="S0"> </span>line<span class="S10">)</span> -<span class="S0"> </span><span class="S5">const</span><span class="S0"> </span><span class="S10">=</span> -<span class="S0"> </span><span class="S4">0</span><span class="S10">;</span><br /> -<span class="S0"> </span><span class="S5">virtual</span><span class="S0"> </span> -<span class="S5">int</span><span class="S0"> </span>SCI_METHOD -<span class="S0"> </span>GetLevel<span class="S10">(</span><span class="S5">int</span><span class="S0"> </span>line<span class="S10">)</span> -<span class="S0"> </span> -<span class="S5">const</span><span class="S0"> </span><span class="S10">=</span><span class="S0"> </span> -<span class="S4">0</span><span class="S10">;</span><br /> -<span class="S0"> </span><span class="S5">virtual</span><span class="S0"> </span> -<span class="S5">int</span><span class="S0"> </span>SCI_METHOD -<span class="S0"> </span>SetLevel<span class="S10">(</span><span class="S5">int</span> -<span class="S0"> </span>line<span class="S10">,</span><span class="S0"> </span> -<span class="S5">int</span><span class="S0"> </span>level<span class="S10">)</span> -<span class="S0"> </span><span class="S10">=</span><span class="S0"> </span> -<span class="S4">0</span><span class="S10">;</span><br /> -<span class="S0"> </span><span class="S5">virtual</span> -<span class="S0"> </span><span class="S5">int</span><span class="S0"> </span>SCI_METHOD -<span class="S0"> </span>GetLineState<span class="S10">(</span><span class="S5">int</span> -<span class="S0"> </span>line<span class="S10">)</span> -<span class="S0"> </span><span class="S5">const</span><span class="S0"> </span> -<span class="S10">=</span><span class="S0"> </span><span class="S4">0</span> -<span class="S10">;</span><br /> -<span class="S0"> </span><span class="S5">virtual</span> -<span class="S0"> </span><span class="S5">int</span><span class="S0"> </span>SCI_METHOD -<span class="S0"> </span>SetLineState<span class="S10">(</span><span class="S5">int</span> -<span class="S0"> </span>line<span class="S10">,</span> -<span class="S0"> </span><span class="S5">int</span><span class="S0"> </span>state<span class="S10">)</span> -<span class="S0"> </span><span class="S10">=</span> -<span class="S0"> </span><span class="S4">0</span><span class="S10">;</span><br /> -<span class="S0"> </span><span class="S5">virtual</span> -<span class="S0"> </span><span class="S5">void</span><span class="S0"> </span>SCI_METHOD -<span class="S0"> </span>StartStyling<span class="S10">(</span><span class="S5">int</span> -<span class="S0"> </span>position<span class="S10">,</span> -<span class="S0"> </span><span class="S5">char</span><span class="S0"> </span>mask<span class="S10">)</span> -<span class="S0"> </span><span class="S10">=</span> -<span class="S0"> </span><span class="S4">0</span><span class="S10">;</span><br /> -<span class="S0"> </span><span class="S5">virtual</span><span class="S0"> </span><span class="S5">bool</span> -<span class="S0"> </span>SCI_METHOD -<span class="S0"> </span>SetStyleFor<span class="S10">(</span><span class="S5">int</span> -<span class="S0"> </span>length<span class="S10">,</span> -<span class="S0"> </span><span class="S5">char</span><span class="S0"> </span>style<span class="S10">)</span> -<span class="S0"> </span><span class="S10">=</span><span class="S0"> </span><span class="S4">0</span> -<span class="S10">;</span><br /> - <span class="S0"> </span><span class="S5">virtual</span> -<span class="S0"> </span><span class="S5">bool</span><span class="S0"> </span>SCI_METHOD -<span class="S0"> </span>SetStyles<span class="S10">(</span><span class="S5">int</span> -<span class="S0"> </span>length<span class="S10">,</span><span class="S0"> </span> -<span class="S5">const</span><span class="S0"> </span><span class="S5">char</span> -<span class="S0"> </span><span class="S10">*</span>styles<span class="S10">)</span> -<span class="S0"> </span><span class="S10">=</span><span class="S0"> </span> -<span class="S4">0</span><span class="S10">;</span><br /> -<span class="S0"> </span><span class="S5">virtual</span><span class="S0"> </span><span class="S5">void</span> -<span class="S0"> </span>SCI_METHOD -<span class="S0"> </span>DecorationSetCurrentIndicator<span class="S10">(</span><span class="S5">int</span> -<span class="S0"> </span>indicator<span class="S10">)</span> -<span class="S0"> </span><span class="S10">=</span> -<span class="S0"> </span><span class="S4">0</span><span class="S10">;</span><br /> -<span class="S0"> </span><span class="S5">virtual</span> -<span class="S0"> </span><span class="S5">void</span><span class="S0"> </span>SCI_METHOD -<span class="S0"> </span>DecorationFillRange<span class="S10">(</span><span class="S5">int</span> -<span class="S0"> </span>position<span class="S10">,</span> -<span class="S0"> </span><span class="S5">int</span><span class="S0"> </span>value<span class="S10">,</span> -<span class="S0"> </span><span class="S5">int</span><span class="S0"> </span>fillLength<span class="S10">)</span> -<span class="S0"> - </span><span class="S10">=</span><span class="S0"> </span> -<span class="S4">0</span><span class="S10">;</span><br /> -<span class="S0"> </span><span class="S5">virtual</span> -<span class="S0"> </span><span class="S5">void</span><span class="S0"> </span>SCI_METHOD -<span class="S0"> </span>ChangeLexerState<span class="S10">(</span><span class="S5">int</span> -<span class="S0"> </span>start<span class="S10">,</span> -<span class="S0"> </span><span class="S5">int</span><span class="S0"> </span>end<span class="S10">)</span> -<span class="S0"> </span><span class="S10">=</span> -<span class="S0"> </span><span class="S4">0</span><span class="S10">;</span><br /> -<span class="S0"> </span><span class="S5">virtual</span> -<span class="S0"> </span><span class="S5">int</span><span class="S0"> </span>SCI_METHOD -<span class="S0"> </span>CodePage<span class="S10">()</span><span class="S0"> - </span><span class="S5">const</span><span class="S0"> </span> -<span class="S10">=</span><span class="S0"> </span><span class="S4">0</span> -<span class="S10">;</span><br /> -<span class="S0"> </span><span class="S5">virtual</span><span class="S0"> </span><span class="S5">bool</span> -<span class="S0"> </span>SCI_METHOD -<span class="S0"> </span>IsDBCSLeadByte<span class="S10">(</span><span class="S5">char</span> -<span class="S0"> </span>ch<span class="S10">)</span> -<span class="S0"> </span><span class="S5">const</span><span class="S0"> </span><span class="S10">=</span> -<span class="S0"> </span><span class="S4">0</span><span class="S10">;</span><br /> +<span class="S0"> </span><span class="S5">virtual</span><span class="S0"> </span><span class="S5">int</span><span class="S0"> </span>SCI_METHOD<span class="S0"> </span>Version<span class="S10">()</span><span class="S0"> </span><span class="S5">const</span><span class="S0"> </span><span class="S10">=</span><span class="S0"> </span><span class="S4">0</span><span class="S10">;</span><br /> +<span class="S0"> </span><span class="S5">virtual</span><span class="S0"> </span><span class="S5">void</span><span class="S0"> </span>SCI_METHOD<span class="S0"> </span>SetErrorStatus<span class="S10">(</span><span class="S5">int</span><span class="S0"> </span>status<span class="S10">)</span><span class="S0"> </span><span class="S10">=</span><span class="S0"> </span><span class="S4">0</span><span class="S10">;</span><br /> +<span class="S0"> </span><span class="S5">virtual</span><span class="S0"> </span>Sci_Position<span class="S0"> </span>SCI_METHOD<span class="S0"> </span>Length<span class="S10">()</span><span class="S0"> </span><span class="S5">const</span><span class="S0"> </span><span class="S10">=</span><span class="S0"> </span><span class="S4">0</span><span class="S10">;</span><br /> +<span class="S0"> </span><span class="S5">virtual</span><span class="S0"> </span><span class="S5">void</span><span class="S0"> </span>SCI_METHOD<span class="S0"> </span>GetCharRange<span class="S10">(</span><span class="S5">char</span><span class="S0"> </span><span class="S10">*</span>buffer<span class="S10">,</span><span class="S0"> </span>Sci_Position<span class="S0"> </span>position<span class="S10">,</span><span class="S0"> </span>Sci_Position<span class="S0"> </span>lengthRetrieve<span class="S10">)</span><span class="S0"> </span><span class="S5">const</span><span class="S0"> </span><span class="S10">=</span><span class="S0"> </span><span class="S4">0</span><span class="S10">;</span><br /> +<span class="S0"> </span><span class="S5">virtual</span><span class="S0"> </span><span class="S5">char</span><span class="S0"> </span>SCI_METHOD<span class="S0"> </span>StyleAt<span class="S10">(</span>Sci_Position<span class="S0"> </span>position<span class="S10">)</span><span class="S0"> </span><span class="S5">const</span><span class="S0"> </span><span class="S10">=</span><span class="S0"> </span><span class="S4">0</span><span class="S10">;</span><br /> +<span class="S0"> </span><span class="S5">virtual</span><span class="S0"> </span>Sci_Position<span class="S0"> </span>SCI_METHOD<span class="S0"> </span>LineFromPosition<span class="S10">(</span>Sci_Position<span class="S0"> </span>position<span class="S10">)</span><span class="S0"> </span><span class="S5">const</span><span class="S0"> </span><span class="S10">=</span><span class="S0"> </span><span class="S4">0</span><span class="S10">;</span><br /> +<span class="S0"> </span><span class="S5">virtual</span><span class="S0"> </span>Sci_Position<span class="S0"> </span>SCI_METHOD<span class="S0"> </span>LineStart<span class="S10">(</span>Sci_Position<span class="S0"> </span>line<span class="S10">)</span><span class="S0"> </span><span class="S5">const</span><span class="S0"> </span><span class="S10">=</span><span class="S0"> </span><span class="S4">0</span><span class="S10">;</span><br /> +<span class="S0"> </span><span class="S5">virtual</span><span class="S0"> </span><span class="S5">int</span><span class="S0"> </span>SCI_METHOD<span class="S0"> </span>GetLevel<span class="S10">(</span>Sci_Position<span class="S0"> </span>line<span class="S10">)</span><span class="S0"> </span><span class="S5">const</span><span class="S0"> </span><span class="S10">=</span><span class="S0"> </span><span class="S4">0</span><span class="S10">;</span><br /> +<span class="S0"> </span><span class="S5">virtual</span><span class="S0"> </span><span class="S5">int</span><span class="S0"> </span>SCI_METHOD<span class="S0"> </span>SetLevel<span class="S10">(</span>Sci_Position<span class="S0"> </span>line<span class="S10">,</span><span class="S0"> </span><span class="S5">int</span><span class="S0"> </span>level<span class="S10">)</span><span class="S0"> </span><span class="S10">=</span><span class="S0"> </span><span class="S4">0</span><span class="S10">;</span><br /> +<span class="S0"> </span><span class="S5">virtual</span><span class="S0"> </span><span class="S5">int</span><span class="S0"> </span>SCI_METHOD<span class="S0"> </span>GetLineState<span class="S10">(</span>Sci_Position<span class="S0"> </span>line<span class="S10">)</span><span class="S0"> </span><span class="S5">const</span><span class="S0"> </span><span class="S10">=</span><span class="S0"> </span><span class="S4">0</span><span class="S10">;</span><br /> +<span class="S0"> </span><span class="S5">virtual</span><span class="S0"> </span><span class="S5">int</span><span class="S0"> </span>SCI_METHOD<span class="S0"> </span>SetLineState<span class="S10">(</span>Sci_Position<span class="S0"> </span>line<span class="S10">,</span><span class="S0"> </span><span class="S5">int</span><span class="S0"> </span>state<span class="S10">)</span><span class="S0"> </span><span class="S10">=</span><span class="S0"> </span><span class="S4">0</span><span class="S10">;</span><br /> +<span class="S0"> </span><span class="S5">virtual</span><span class="S0"> </span><span class="S5">void</span><span class="S0"> </span>SCI_METHOD<span class="S0"> </span>StartStyling<span class="S10">(</span>Sci_Position<span class="S0"> </span>position<span class="S10">,</span><span class="S0"> </span><span class="S5">char</span><span class="S0"> </span>mask<span class="S10">)</span><span class="S0"> </span><span class="S10">=</span><span class="S0"> </span><span class="S4">0</span><span class="S10">;</span><br /> +<span class="S0"> </span><span class="S5">virtual</span><span class="S0"> </span><span class="S5">bool</span><span class="S0"> </span>SCI_METHOD<span class="S0"> </span>SetStyleFor<span class="S10">(</span>Sci_Position<span class="S0"> </span>length<span class="S10">,</span><span class="S0"> </span><span class="S5">char</span><span class="S0"> </span>style<span class="S10">)</span><span class="S0"> </span><span class="S10">=</span><span class="S0"> </span><span class="S4">0</span><span class="S10">;</span><br /> +<span class="S0"> </span><span class="S5">virtual</span><span class="S0"> </span><span class="S5">bool</span><span class="S0"> </span>SCI_METHOD<span class="S0"> </span>SetStyles<span class="S10">(</span>Sci_Position<span class="S0"> </span>length<span class="S10">,</span><span class="S0"> </span><span class="S5">const</span><span class="S0"> </span><span class="S5">char</span><span class="S0"> </span><span class="S10">*</span>styles<span class="S10">)</span><span class="S0"> </span><span class="S10">=</span><span class="S0"> </span><span class="S4">0</span><span class="S10">;</span><br /> +<span class="S0"> </span><span class="S5">virtual</span><span class="S0"> </span><span class="S5">void</span><span class="S0"> </span>SCI_METHOD<span class="S0"> </span>DecorationSetCurrentIndicator<span class="S10">(</span><span class="S5">int</span><span class="S0"> </span>indicator<span class="S10">)</span><span class="S0"> </span><span class="S10">=</span><span class="S0"> </span><span class="S4">0</span><span class="S10">;</span><br /> +<span class="S0"> </span><span class="S5">virtual</span><span class="S0"> </span><span class="S5">void</span><span class="S0"> </span>SCI_METHOD<span class="S0"> </span>DecorationFillRange<span class="S10">(</span>Sci_Position<span class="S0"> </span>position<span class="S10">,</span><span class="S0"> </span><span class="S5">int</span><span class="S0"> </span>value<span class="S10">,</span><span class="S0"> </span>Sci_Position<span class="S0"> </span>fillLength<span class="S10">)</span><span class="S0"> </span><span class="S10">=</span><span class="S0"> </span><span class="S4">0</span><span class="S10">;</span><br /> +<span class="S0"> </span><span class="S5">virtual</span><span class="S0"> </span><span class="S5">void</span><span class="S0"> </span>SCI_METHOD<span class="S0"> </span>ChangeLexerState<span class="S10">(</span>Sci_Position<span class="S0"> </span>start<span class="S10">,</span><span class="S0"> </span>Sci_Position<span class="S0"> </span>end<span class="S10">)</span><span class="S0"> </span><span class="S10">=</span><span class="S0"> </span><span class="S4">0</span><span class="S10">;</span><br /> +<span class="S0"> </span><span class="S5">virtual</span><span class="S0"> </span><span class="S5">int</span><span class="S0"> </span>SCI_METHOD<span class="S0"> </span>CodePage<span class="S10">()</span><span class="S0"> </span><span class="S5">const</span><span class="S0"> </span><span class="S10">=</span><span class="S0"> </span><span class="S4">0</span><span class="S10">;</span><br /> +<span class="S0"> </span><span class="S5">virtual</span><span class="S0"> </span><span class="S5">bool</span><span class="S0"> </span>SCI_METHOD<span class="S0"> </span>IsDBCSLeadByte<span class="S10">(</span><span class="S5">char</span><span class="S0"> </span>ch<span class="S10">)</span><span class="S0"> </span><span class="S5">const</span><span class="S0"> </span><span class="S10">=</span><span class="S0"> </span><span class="S4">0</span><span class="S10">;</span><br /> +<span class="S0"> </span><span class="S5">virtual</span><span class="S0"> </span><span class="S5">const</span><span class="S0"> </span><span class="S5">char</span><span class="S0"> </span><span class="S10">*</span><span class="S0"> </span>SCI_METHOD<span class="S0"> </span>BufferPointer<span class="S10">()</span><span class="S0"> </span><span class="S10">=</span><span class="S0"> </span><span class="S4">0</span><span class="S10">;</span><br /> +<span class="S0"> </span><span class="S5">virtual</span><span class="S0"> </span><span class="S5">int</span><span class="S0"> </span>SCI_METHOD<span class="S0"> </span>GetLineIndentation<span class="S10">(</span>Sci_Position<span class="S0"> </span>line<span class="S10">)</span><span class="S0"> </span><span class="S10">=</span><span class="S0"> </span><span class="S4">0</span><span class="S10">;</span><br /> <span class="S10">};</span><br /> </div> @@ -6598,9 +6480,9 @@ bytes in the character. <div class="highlighted"> <span class="S5">class</span><span class="S0"> </span>IDocumentWithLineEnd<span class="S0"> </span><span class="S10">:</span><span class="S0"> </span><span class="S5">public</span><span class="S0"> </span>IDocument<span class="S0"> </span><span class="S10">{</span><br /> <span class="S5">public</span><span class="S10">:</span><br /> -<span class="S0"> </span><span class="S5">virtual</span><span class="S0"> </span><span class="S5">int</span><span class="S0"> </span>SCI_METHOD<span class="S0"> </span>LineEnd<span class="S10">(</span><span class="S5">int</span><span class="S0"> </span>line<span class="S10">)</span><span class="S0"> </span><span class="S5">const</span><span class="S0"> </span><span class="S10">=</span><span class="S0"> </span><span class="S4">0</span><span class="S10">;</span><br /> -<span class="S0"> </span><span class="S5">virtual</span><span class="S0"> </span><span class="S5">int</span><span class="S0"> </span>SCI_METHOD<span class="S0"> </span>GetRelativePosition<span class="S10">(</span><span class="S5">int</span><span class="S0"> </span>positionStart<span class="S10">,</span><span class="S0"> </span><span class="S5">int</span><span class="S0"> </span>characterOffset<span class="S10">)</span><span class="S0"> </span><span class="S5">const</span><span class="S0"> </span><span class="S10">=</span><span class="S0"> </span><span class="S4">0</span><span class="S10">;</span><br /> -<span class="S0"> </span><span class="S5">virtual</span><span class="S0"> </span><span class="S5">int</span><span class="S0"> </span>SCI_METHOD<span class="S0"> </span>GetCharacterAndWidth<span class="S10">(</span><span class="S5">int</span><span class="S0"> </span>position<span class="S10">,</span><span class="S0"> </span><span class="S5">int</span><span class="S0"> </span><span class="S10">*</span>pWidth<span class="S10">)</span><span class="S0"> </span><span class="S5">const</span><span class="S0"> </span><span class="S10">=</span><span class="S0"> </span><span class="S4">0</span><span class="S10">;</span><br /> +<span class="S0"> </span><span class="S5">virtual</span><span class="S0"> </span>Sci_Position<span class="S0"> </span>SCI_METHOD<span class="S0"> </span>LineEnd<span class="S10">(</span>Sci_Position<span class="S0"> </span>line<span class="S10">)</span><span class="S0"> </span><span class="S5">const</span><span class="S0"> </span><span class="S10">=</span><span class="S0"> </span><span class="S4">0</span><span class="S10">;</span><br /> +<span class="S0"> </span><span class="S5">virtual</span><span class="S0"> </span>Sci_Position<span class="S0"> </span>SCI_METHOD<span class="S0"> </span>GetRelativePosition<span class="S10">(</span>Sci_Position<span class="S0"> </span>positionStart<span class="S10">,</span><span class="S0"> </span>Sci_Position<span class="S0"> </span>characterOffset<span class="S10">)</span><span class="S0"> </span><span class="S5">const</span><span class="S0"> </span><span class="S10">=</span><span class="S0"> </span><span class="S4">0</span><span class="S10">;</span><br /> +<span class="S0"> </span><span class="S5">virtual</span><span class="S0"> </span><span class="S5">int</span><span class="S0"> </span>SCI_METHOD<span class="S0"> </span>GetCharacterAndWidth<span class="S10">(</span>Sci_Position<span class="S0"> </span>position<span class="S10">,</span><span class="S0"> </span>Sci_Position<span class="S0"> </span><span class="S10">*</span>pWidth<span class="S10">)</span><span class="S0"> </span><span class="S5">const</span><span class="S0"> </span><span class="S10">=</span><span class="S0"> </span><span class="S4">0</span><span class="S10">;</span><br /> <span class="S10">};</span><br /> </div> @@ -6625,7 +6507,7 @@ implemented and thus which methods may be called.</p> <p>The container is passed a <code>SCNotification</code> structure containing information about the event.</p> <pre id="SCNotification"> -struct NotifyHeader { // This matches the Win32 NMHDR structure +struct Sci_NotifyHeader { // This matches the Win32 NMHDR structure void *hwndFrom; // environment specific window handle/pointer uptr_t idFrom; // CtrlID of the window issuing the notification unsigned int code; // The SCN_* notification code @@ -6633,14 +6515,16 @@ struct NotifyHeader { // This matches the Win32 NMHDR structure struct SCNotification { struct Sci_NotifyHeader nmhdr; - int position; + Sci_Position position; /* SCN_STYLENEEDED, SCN_DOUBLECLICK, SCN_MODIFIED, SCN_MARGINCLICK, */ /* SCN_NEEDSHOWN, SCN_DWELLSTART, SCN_DWELLEND, SCN_CALLTIPCLICK, */ /* SCN_HOTSPOTCLICK, SCN_HOTSPOTDOUBLECLICK, SCN_HOTSPOTRELEASECLICK, */ /* SCN_INDICATORCLICK, SCN_INDICATORRELEASE, */ /* SCN_USERLISTSELECTION, SCN_AUTOCSELECTION */ - int ch; /* SCN_CHARADDED, SCN_KEY */ + int ch; + /* SCN_CHARADDED, SCN_KEY, SCN_AUTOCCOMPLETE, SCN_AUTOCSELECTION, */ + /* SCN_USERLISTSELECTION */ int modifiers; /* SCN_KEY, SCN_DOUBLECLICK, SCN_HOTSPOTCLICK, SCN_HOTSPOTDOUBLECLICK, */ /* SCN_HOTSPOTRELEASECLICK, SCN_INDICATORCLICK, SCN_INDICATORRELEASE, */ @@ -6649,12 +6533,12 @@ struct SCNotification { const char *text; /* SCN_MODIFIED, SCN_USERLISTSELECTION, SCN_AUTOCSELECTION, SCN_URIDROPPED */ - int length; /* SCN_MODIFIED */ - int linesAdded; /* SCN_MODIFIED */ + Sci_Position length; /* SCN_MODIFIED */ + Sci_Position linesAdded; /* SCN_MODIFIED */ int message; /* SCN_MACRORECORD */ uptr_t wParam; /* SCN_MACRORECORD */ sptr_t lParam; /* SCN_MACRORECORD */ - int line; /* SCN_MODIFIED */ + Sci_Position line; /* SCN_MODIFIED */ int foldLevelNow; /* SCN_MODIFIED */ int foldLevelPrev; /* SCN_MODIFIED */ int margin; /* SCN_MARGINCLICK */ @@ -6664,6 +6548,9 @@ struct SCNotification { int token; /* SCN_MODIFIED with SC_MOD_CONTAINER */ int annotationLinesAdded; /* SCN_MODIFIED with SC_MOD_CHANGEANNOTATION */ int updated; /* SCN_UPDATEUI */ + int listCompletionMethod; + /* SCN_AUTOCSELECTION, SCN_AUTOCCOMPLETED, SCN_USERLISTSELECTION */ + }; </pre> @@ -6698,6 +6585,7 @@ struct SCNotification { <a class="message" href="#SCN_AUTOCCHARDELETED">SCN_AUTOCCHARDELETED</a><br /> <a class="message" href="#SCN_FOCUSIN">SCN_FOCUSIN</a><br /> <a class="message" href="#SCN_FOCUSOUT">SCN_FOCUSOUT</a><br /> + <a class="message" href="#SCN_AUTOCCOMPLETED">SCN_AUTOCCOMPLETED</a><br /> </code> <p>The following <code>SCI_*</code> messages are associated with these notifications:</p> @@ -6874,7 +6762,7 @@ href="#SCI_POSITIONFROMLINE">SCI_POSITIONFROMLINE</a>(lineNumber); <tr> <td align="left"><code>length</code></td> - <td align="left">Length of the change in cells or characters when the text or styling + <td align="left">Length of the change in bytes when the text or styling changes. Set to 0 if not used.</td> </tr> @@ -7042,7 +6930,7 @@ href="#SCI_POSITIONFROMLINE">SCI_POSITIONFROMLINE</a>(lineNumber); <td>Text is about to be inserted into the document.</td> - <td><code>position, if performed by user then text in cells, length in cells</code></td> + <td><code>position, if performed by user then text in bytes, length in bytes</code></td> </tr> <tr> @@ -7350,11 +7238,24 @@ for line = lineStart to lineEnd do SCI_ENSUREVISIBLE(line) next <td align="left">The position the list was displayed at.</td> </tr> + <tr> + <td align="left"><code>ch</code></td> + + <td align="left">If a fillup character was the method of selection, the used + character, otherwise 0.</td> + </tr> + <tr> + <td align="left"><code>listCompletionMethod</code></td> + + <td align="left">A value indicating the way in which the completion + occurred. See the table below.</td> + </tr> </tbody> </table> <br /> - - + + See the <code><a class="jump" href="#SCN_AUTOCCOMPLETED">SCN_AUTOCCOMPLETED</a></code> notification + for the possible values for <code>listCompletionMethod.</code> <p><b id="SCN_URIDROPPED">SCN_URIDROPPED</b><br /> Only on the GTK+ version. Indicates that the user has dragged a URI such as a file name or Web address onto Scintilla. The container could interpret this as a request to open the file. The @@ -7465,6 +7366,82 @@ for line = lineStart to lineEnd do SCI_ENSUREVISIBLE(line) next <td align="left">The text of the selection.</td> </tr> + <tr> + <td align="left"><code>ch</code></td> + + <td align="left">If a fillup character was the method of selection, the used + character, otherwise 0.</td> + </tr> + <tr> + <td align="left"><code>listCompletionMethod</code></td> + + <td align="left">A value indicating the way in which the completion + occurred. See the table below.</td> + </tr> + </tbody> + </table> + <br /> + <table cellpadding="1" cellspacing="2" border="0" summary="Modify notification type flags"> + <tbody> + <tr> + <th align="left">Symbol</th> + + <th>Value</th> + + <th align="left">Meaning</th> + + </tr> + </tbody> + + <tbody valign="top"> + <tr> + <td align="left"><code>SC_AC_FILLUP</code></td> + + <td align="center">0x01</td> + + <td>A fillup character triggered the completion. The character used is + in ch. </td> + + </tr> + + <tr> + <td align="left"><code>SC_AC_DOUBLECLICK</code></td> + + <td align="center">0x02</td> + + <td>A double-click triggered the completion. ch is 0.</td> + + </tr> + + <tr> + <td align="left"><code>SC_AC_TAB</code></td> + + <td align="center">0x04</td> + + <td>The tab key or SCI_TAB triggered the completion. ch is 0.</td> + + </tr> + + <tr> + <td align="left"><code>SC_AC_NEWLINE</code></td> + + <td align="center">0x08</td> + + <td>A new line or SCI_NEWLINE triggered the completion. ch is 0.</td> + + </tr> + + <tr> + <td align="left"><code>SC_AC_COMMAND</code></td> + + <td align="center">0x10</td> + + <td>The + <code> + <a class="message" href="#SCI_AUTOCSELECT">SCI_AUTOCSELECT</a></code> message + triggered the completion. ch is 0.</td> + + </tr> </tbody> </table> @@ -7481,6 +7458,13 @@ for line = lineStart to lineEnd do SCI_ENSUREVISIBLE(line) next <code>SCN_FOCUSIN</code> (2028) is fired when Scintilla receives focus and <code>SCN_FOCUSOUT</code> (2029) when it loses focus.</p> + <p><b id="SCN_AUTOCCOMPLETED">SCN_AUTOCCOMPLETED<br /> + </b>This notification is generated after an autocompletion has inserted its + text. The fields are identical to the + <code> + <a class="jump" href="#SCN_AUTOCSELECTION">SCN_AUTOCSELECTION</a></code> + notification.</p> + <h2 id="Images">Images</h2> <p>Two formats are supported for images used in margin markers and autocompletion lists, RGBA and XPM.</p> |