aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/ScintillaDoc.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ScintillaDoc.html')
-rw-r--r--doc/ScintillaDoc.html67
1 files changed, 57 insertions, 10 deletions
diff --git a/doc/ScintillaDoc.html b/doc/ScintillaDoc.html
index 53bf4e794..19d351ccb 100644
--- a/doc/ScintillaDoc.html
+++ b/doc/ScintillaDoc.html
@@ -3173,7 +3173,8 @@ struct Sci_TextToFind {
a visible margin will be displayed as changes in background colour in the text. A width in
pixels can be set for each margin. Margins with a zero width are ignored completely. You can
choose if a mouse click in a margin sends a <a class="message"
- href="#SCN_MARGINCLICK"><code>SCN_MARGINCLICK</code></a> notification to the container or
+ href="#SCN_MARGINCLICK"><code>SCN_MARGINCLICK</code></a> or <a class="message"
+ href="#SCN_MARGINRIGHTCLICK"><code>SCN_MARGINRIGHTCLICK</code></a> notification to the container or
selects a line of text.</p>
<p>Using a margin number outside the valid range has no
@@ -3283,7 +3284,8 @@ struct Sci_TextToFind {
<b id="SCI_GETMARGINSENSITIVEN">SCI_GETMARGINSENSITIVEN(int margin) &rarr; bool</b><br />
Each of the five margins can be set sensitive or insensitive to mouse clicks. A click in a
sensitive margin sends a <a class="message"
- href="#SCN_MARGINCLICK"><code>SCN_MARGINCLICK</code></a> <a class="jump"
+ href="#SCN_MARGINCLICK"><code>SCN_MARGINCLICK</code></a> or <a class="message"
+ href="#SCN_MARGINRIGHTCLICK"><code>SCN_MARGINRIGHTCLICK</code></a> <a class="jump"
href="#Notifications">notification</a> to the container. Margins that are not sensitive act as
selection margins which make it easy to select ranges of lines. By default, all margins are
insensitive.</p>
@@ -5255,15 +5257,58 @@ struct Sci_TextToFind {
<h2 id="PopupEditMenu">Popup edit menu</h2>
- <code><a class="message" href="#SCI_USEPOPUP">SCI_USEPOPUP(bool allowPopUp)</a><br />
+ <code><a class="message" href="#SCI_USEPOPUP">SCI_USEPOPUP(int displayPopUpMode)</a><br />
</code>
- <p><b id="SCI_USEPOPUP">SCI_USEPOPUP(bool allowPopUp)</b><br />
+ <p><b id="SCI_USEPOPUP">SCI_USEPOPUP(int popUpMode)</b><br />
Clicking the wrong button on the mouse pops up a short default editing menu. This may be
- turned off with <code>SCI_USEPOPUP(0)</code>. If you turn it off, context menu commands (in
+ turned off with <code>SCI_USEPOPUP(SC_POPUP_NEVER)</code>. If you turn it off, context menu commands (in
Windows, <code>WM_CONTEXTMENU</code>) will not be handled by Scintilla, so the parent of the
Scintilla window will have the opportunity to handle the message.</p>
+ <table cellpadding="1" cellspacing="2" border="0" summary="Display context menu mode">
+ <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_POPUP_NEVER</code></td>
+
+ <td align="center">0x01</td>
+
+ <td>Never show default editing menu.</td>
+
+ </tr>
+
+ <tr>
+ <td align="left"><code>SC_POPUP_ALL</code></td>
+
+ <td align="center">0x02</td>
+
+ <td>Show default editing menu if clicking on scintilla.</td>
+
+ </tr>
+
+ <tr>
+ <td align="left"><code>SC_POPUP_TEXT</code></td>
+
+ <td align="center">0x04</td>
+
+ <td>Show default editing menu only if clicking on text area.</td>
+
+ </tr>
+
+ </tbody>
+ </table>
+
<h2 id="MacroRecording">Macro recording</h2>
<p>Start and stop macro recording mode. In macro recording mode, actions are reported to the
@@ -6804,9 +6849,9 @@ struct SCNotification {
struct Sci_NotifyHeader nmhdr;
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_MARGINRIGHTCLICK, SCN_NEEDSHOWN, SCN_DWELLSTART, SCN_DWELLEND, */
+ /* SCN_CALLTIPCLICK, SCN_HOTSPOTCLICK, SCN_HOTSPOTDOUBLECLICK, */
+ /* SCN_HOTSPOTRELEASECLICK, SCN_INDICATORCLICK, SCN_INDICATORRELEASE, */
/* SCN_USERLISTSELECTION, SCN_AUTOCSELECTION */
int ch;
@@ -6828,7 +6873,7 @@ struct SCNotification {
Sci_Position line; /* SCN_MODIFIED */
int foldLevelNow; /* SCN_MODIFIED */
int foldLevelPrev; /* SCN_MODIFIED */
- int margin; /* SCN_MARGINCLICK */
+ int margin; /* SCN_MARGINCLICK, SCN_MARGINRIGHTCLICK */
int listType; /* SCN_USERLISTSELECTION */
int x; /* SCN_DWELLSTART, SCN_DWELLEND */
int y; /* SCN_DWELLSTART, SCN_DWELLEND */
@@ -6873,6 +6918,7 @@ struct SCNotification {
<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 />
+ <a class="message" href="#SCN_MARGINRIGHTCLICK">SCN_MARGINRIGHTCLICK</a><br />
</code>
<p>The following <code>SCI_*</code> messages are associated with these notifications:</p>
@@ -7432,7 +7478,8 @@ href="#SCI_POSITIONFROMLINE">SCI_POSITIONFROMLINE</a>(lineNumber);
</table>
<p><b id="SCN_MARGINCLICK">SCN_MARGINCLICK</b><br />
- This notification tells the container that the mouse was clicked inside a <a class="jump"
+ <b id="SCN_MARGINRIGHTCLICK">SCN_MARGINRIGHTCLICK</b><br />
+ These notifications tell the container that the mouse was clicked or right clicked inside a <a class="jump"
href="#Margins">margin</a> that was marked as sensitive (see <a class="message"
href="#SCI_SETMARGINSENSITIVEN"><code>SCI_SETMARGINSENSITIVEN</code></a>). This can be used to
perform folding or to place breakpoints. The following <code>SCNotification</code> fields are