From 74a12e8f40cbc552a6882096dc0a616c5cd77837 Mon Sep 17 00:00:00 2001 From: Neil Date: Wed, 7 Dec 2016 10:25:35 +1100 Subject: Using alternating row shades for tables and contrasting headers. Fixed some inconsistent styling. Use circles for bullets. Explain int type more accurately. --- doc/ScintillaDoc.html | 234 ++++++++++++++++++++++++++++---------------------- 1 file changed, 132 insertions(+), 102 deletions(-) (limited to 'doc') diff --git a/doc/ScintillaDoc.html b/doc/ScintillaDoc.html index f35eef4ad..05145f4fa 100644 --- a/doc/ScintillaDoc.html +++ b/doc/ScintillaDoc.html @@ -23,6 +23,34 @@ A.jump { text-decoration: none; } LI.message { text-decoration: none; font-weight: bold; font-family: Menlo,Consolas,Bitstream Vera Sans Mono,Courier New,monospace; } H2 { background: #E0EAFF; } + + table { + border: 0px; + border-collapse: collapse; + } + + table.categories { + border: 0px; + border-collapse: collapse; + } + table.categories td { + padding: 4px 12px; + } + + table.standard { + border-collapse: collapse; + } + table.standard th { + background: #404040; + color: #FFFFFF; + padding: 1px 5px 1px 5px; + } + table.standard tr:nth-child(odd) {background: #D7D7D7} + table.standard tr:nth-child(even) {background: #F0F0F0} + table.standard td { + padding: 1px 5px 1px 5px; + } + .S0 { color: #808080; } @@ -88,7 +116,7 @@

Scintilla Documentation

-

Last edited 4 December 2016 NH

+

Last edited 7 December 2016 NH

There is an overview of the internal design of Scintilla.
@@ -146,23 +174,24 @@ enhancement of messages without the risk of breaking existing code. Common argument types are:

- +
- + - + - + - + - + - + - + - + @@ -213,161 +242,161 @@

Contents

-
boolbool Arguments expect the values 0 for false and 1 for true.
intintArguments are 32-bit signed integers.Arguments are 32-bit or 64-bit signed integers depending on the platform. + Equivalent to intptr_t.
const char *const char * Arguments point at text that is being passed to Scintilla but not modified. The text may be zero terminated or another argument may specify the character count, the @@ -170,7 +199,7 @@
char *char * Arguments point at text buffers that Scintilla will fill with text. In some cases, another argument will tell Scintilla the buffer size. In others, you must make sure that @@ -181,7 +210,7 @@
colourcolour Colours are set using the RGB format (Red, Green, Blue). The intensity of each colour is set in the range 0 to 255. If you have three such intensities, they are combined as: @@ -192,7 +221,7 @@
alphaalpha Translucency is set using an alpha value. Alpha ranges from 0 (SC_ALPHA_TRANSPARENT) which is completely transparent to @@ -203,7 +232,7 @@
<unused><unused> This is an unused argument. Setting it to 0 will ensure compatibility with future enhancements.
+
- - + - + - + - + - + - + - + - - + - + - + - + - + - + - + - + - + - + - + - + - + - - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - + - + @@ -729,7 +758,7 @@ struct Sci_TextRange { Several of the search routines use flag options, which include a simple regular expression search. Combine the flag options by adding them:

-
o Text retrieval and + ○ Text retrieval and modificationo Searching and replacing○ Searching and replacingo Overtype○ Overtype
o Cut, copy and paste○ Cut, copy and pasteo Error handling○ Error handlingo Undo and Redo○ Undo and Redo
o Selection and information○ Selection and informationo Multiple Selection and Virtual Space○ Multiple Selection and Virtual Spaceo Scrolling and automatic + ○ Scrolling and automatic scrolling
o White space○ White spaceo Cursor○ Cursoro Mouse capture○ Mouse capture
o Line endings○ Line endingso Words○ Wordso Styling○ Styling
o Style definition○ Style definitiono Caret, selection, and hotspot styles○ Caret, selection, and hotspot styleso Character representations○ Character representations
o Margins○ Marginso Annotations○ Annotationso Other settings○ Other settings
o Brace highlighting○ Brace highlightingo Tabs and Indentation + ○ Tabs and Indentation Guideso Markers○ Markers
o Indicators○ Indicatorso Autocompletion○ Autocompletiono User lists○ User lists
o Call tips○ Call tipso Keyboard commands○ Keyboard commandso Key bindings○ Key bindings
o Popup edit menu○ Popup edit menuo Macro recording○ Macro recordingo Printing○ Printing
o Direct access○ Direct accesso Multiple views○ Multiple viewso Background loading and saving○ Background loading and saving
o Folding○ Foldingo Line wrapping○ Line wrappingo Zooming○ Zooming
o Long lines○ Long lineso Lexer○ Lexero Lexer objects○ Lexer objects
o Notifications○ Notificationso Accessibility○ Accessibilityo Images○ Images
o GTK+○ GTK+o Provisional messages○ Provisional messageso Deprecated messages○ Deprecated messages
o Edit messages never + ○ Edit messages never supported by Scintillao Removed features○ Removed featureso Building Scintilla○ Building Scintilla
+
@@ -781,7 +810,7 @@ struct Sci_TextRange {

In a regular expression, using Scintilla's base implementation, special characters interpreted are:

-
SCFIND_MATCHCASE
+
@@ -1027,28 +1056,28 @@ struct Sci_TextToFind { The currently defined statuses are:

-
.
+
- + - + - + - + @@ -1274,7 +1303,7 @@ struct Sci_TextToFind { current position. They do not make the caret visible. The table shows the positions of the anchor and the current position after using these messages.

-
SC_STATUS_OKSC_STATUS_OK 0 No failures
SC_STATUS_FAILURESC_STATUS_FAILURE 1 Generic failure
SC_STATUS_BADALLOCSC_STATUS_BADALLOC 2 Memory is exhausted
SC_STATUS_WARN_REGEXSC_STATUS_WARN_REGEX 1001 Regular expression is invalid
+
@@ -1810,7 +1839,7 @@ struct Sci_TextToFind { CARET_SLOP, CARET_STRICT, CARET_JUMPS and CARET_EVEN.

- +
@@ -1850,8 +1879,9 @@ struct Sci_TextToFind {
CARET_SLOP
+
- +
@@ -2125,7 +2155,7 @@ struct Sci_TextToFind { class="jump" href="#LineEndings">end of line characters. The two messages set and get the white space display mode. The viewWS argument can be one of:

-
slop
+
@@ -2183,7 +2213,7 @@ struct Sci_TextToFind { These two messages get and set how tab characters are drawn when white space is visible. The tabDrawMode argument can be one of:

-
SCWS_INVISIBLE
+
@@ -2229,7 +2259,7 @@ struct Sci_TextToFind { cursor. You set the cursor type with SCI_SETCURSOR. The cursorType argument can be:

-
SCTD_LONGARROW
+
@@ -2408,7 +2438,7 @@ struct Sci_TextToFind { the position and true or false is the state of onlyWordCharacters:

-
SC_CURSORNORMAL
+
@@ -2621,7 +2651,7 @@ struct Sci_TextToFind { predefined numbered styles starting at 32, The following STYLE_* constants are defined.

-
Initial state
+
@@ -2869,7 +2899,7 @@ struct Sci_TextToFind { The default character set is SC_CHARSET_DEFAULT.

SC_CHARSET_ANSI and SC_CHARSET_DEFAULT specify European Windows code page 1252 unless the code page is set.

-
STYLE_DEFAULT
+
@@ -3482,7 +3512,7 @@ struct Sci_TextToFind { The two messages set and get the annotation display mode. The visible argument can be one of:

-
Character Set Windows
+
@@ -3830,7 +3860,7 @@ struct Sci_TextToFind {

There are 4 indentation guide views. SC_IV_NONE turns the feature off but the other 3 states determine how far the guides appear on empty lines.

-
ANNOTATION_HIDDEN
+
@@ -3988,7 +4018,7 @@ struct Sci_TextToFind { Macintosh), plus/minus shows folded lines as '+' and opened folds as '-', Circle tree, Box tree.

-
SC_IV_NONE
+
@@ -4262,7 +4292,7 @@ struct Sci_TextToFind { Indicator samples

-
SC_MARKNUM_*
+
@@ -5328,7 +5358,7 @@ struct Sci_TextToFind { Windows, WM_CONTEXTMENU) will not be handled by Scintilla, so the parent of the Scintilla window will have the opportunity to handle the message.

-
Symbol
+
@@ -5471,7 +5501,7 @@ struct Sci_RangeToFormat { you use a dark or black screen background. Printing white on black uses up toner and ink very many times faster than the other way around. You can set the mode to one of:

-
Symbol
+
@@ -5855,7 +5885,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ flags determine where folding lines are drawn:

-
Symbol
+
@@ -5947,7 +5977,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){

SCI_FOLDDISPLAYTEXTSETSTYLE(int style)
This message changes the appearance of fold text tags.

-
Symbol
+
@@ -6001,7 +6031,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){

To affect the entire document call SCI_FOLDALL. With SC_FOLDACTION_TOGGLE the first fold header in the document is examined to decide whether to expand or contract.

-
Symbol
+
@@ -6051,7 +6081,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ like to add or change click behaviour such as showing method headers only when Shift+Alt is used in conjunction with a click.

-
Symbol
+
@@ -6168,7 +6198,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ You can enable the drawing of visual flags to indicate a line is wrapped. Bits set in wrapVisualFlags determine which visual flags are drawn.

-
Symbol
+
@@ -6212,7 +6242,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ Bits set in wrapVisualFlagsLocation set the location to near the text for the corresponding visual flag.

-
Symbol
+
@@ -6249,7 +6279,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ The modes are:

-
Symbol
+
@@ -6295,7 +6325,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ SCI_GETLAYOUTCACHE → int
You can set cacheMode to one of the symbols in the table:

-
Symbol
+
@@ -6406,7 +6436,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ These two messages set and get the mode used to display long lines. You can set one of the values in the table:

-
Symbol
+
@@ -7071,7 +7101,7 @@ href="#SCI_POSITIONFROMLINE">SCI_POSITIONFROMLINE(lineNumber); Either the text or styling of the document has changed or the selection range or scroll position has changed. Now would be a good time to update any container UI elements that depend on document or view state. The updated field is set to the bit set of things changed since the previous notification.

-
Symbol
+
@@ -7131,7 +7161,7 @@ href="#SCI_POSITIONFROMLINE">SCI_POSITIONFROMLINE(lineNumber); while in a SCN_MODIFIED event. The SCNotification fields used are:

-
Symbol
+
@@ -7204,7 +7234,7 @@ href="#SCI_POSITIONFROMLINE">SCI_POSITIONFROMLINE(lineNumber); SC_PERFORMED_* bits tell you if the action was done by the user, or the result of Undo or Redo of a previous action.

-
Field
+
@@ -7509,7 +7539,7 @@ href="#SCI_POSITIONFROMLINE">SCI_POSITIONFROMLINE(lineNumber); Editor::NotifyMacroRecord. The fields of SCNotification set in this notification are:

-
Symbol
+
@@ -7547,7 +7577,7 @@ href="#SCI_POSITIONFROMLINE">SCI_POSITIONFROMLINE(lineNumber); perform folding or to place breakpoints. The following SCNotification fields are used:

-
Field
+
@@ -7605,7 +7635,7 @@ for line = lineStart to lineEnd do SCI_ENSUREVISIBLE(line) next The user has selected an item in a user list. The SCNotification fields used are:

-
Field
+
@@ -7666,7 +7696,7 @@ for line = lineStart to lineEnd do SCI_ENSUREVISIBLE(line) next key press indicates the dwell is over. Both notifications set the same fields in SCNotification:

-
Field
+
@@ -7742,7 +7772,7 @@ for line = lineStart to lineEnd do SCI_ENSUREVISIBLE(line) next SCI_AUTOCCANCEL message before returning from the notification. The SCNotification fields used are:

-
Field
+
@@ -7777,7 +7807,7 @@ for line = lineStart to lineEnd do SCI_ENSUREVISIBLE(line) next
Field

- +
-- cgit v1.2.3
Symbol