From 0f6f6a89b5267f05a5fe14c58756b4274e2b1adc Mon Sep 17 00:00:00 2001 From: Neil Date: Fri, 9 Apr 2021 09:49:27 +1000 Subject: Document element colours. --- doc/ScintillaDoc.html | 154 ++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 129 insertions(+), 25 deletions(-) (limited to 'doc/ScintillaDoc.html') diff --git a/doc/ScintillaDoc.html b/doc/ScintillaDoc.html index b8484e507..f3b26b88f 100644 --- a/doc/ScintillaDoc.html +++ b/doc/ScintillaDoc.html @@ -18,6 +18,7 @@ A:visited { color: blue; } A:hover { text-decoration: underline ! important; } A.message { text-decoration: none; font-weight: bold; font-family: Menlo,Consolas,Bitstream Vera Sans Mono,Courier New,monospace; } + A.element { text-decoration: none; font-weight: bold; font-family: Menlo,Consolas,Bitstream Vera Sans Mono,Courier New,monospace; } A.seealso { text-decoration: none; font-weight: bold; font-family: Menlo,Consolas,Bitstream Vera Sans Mono,Courier New,monospace; } A.toc { text-decoration: none; } A.jump { text-decoration: none; } @@ -119,7 +120,7 @@

Scintilla Documentation

-

Last edited 3 April 2021 NH

+

Last edited 9 April 2021 NH

Scintilla 5 has moved the lexers from Scintilla into a new Lexilla project.
@@ -358,110 +359,114 @@ ○ Style definition - ○ Caret, selection, and hotspot styles + ○ Element colours + ○ Caret, selection, and hotspot styles + ○ Character representations ○ Margins - ○ Annotations - + ○ Annotations + ○ Other settings ○ Brace highlighting - ○ Tabs and Indentation - Guides - + ○ Tabs and Indentation + Guides + ○ Markers ○ Indicators - ○ Autocompletion - + ○ Autocompletion + ○ User lists ○ Call tips - ○ Keyboard commands - + ○ Keyboard commands + ○ Key bindings ○ Popup edit menu - ○ Macro recording - + ○ Macro recording + ○ Printing ○ Direct access - ○ Multiple views - + ○ Multiple views + ○ Background loading and saving ○ Folding - ○ Line wrapping - + ○ Line wrapping + ○ Zooming ○ Long lines - ○ Accessibility - + ○ Accessibility + ○ Lexer ○ Lexer objects - ○ Notifications - + ○ Notifications + ○ Images ○ GTK - ○ Provisional messages - + + ○ Provisional messages + ○ Deprecated messages ○ Edit messages never supported by Scintilla - ○ Removed features - + + ○ Removed features + ○ Building Scintilla ○ End of Line Annotations @@ -3207,6 +3212,92 @@ struct Sci_TextToFind { may change and an underline appear to indicate that these areas are sensitive to clicking. This may be used to allow hyperlinks to other documents.

+

Element colours

+ +

The colours of some visual elements can be changed with these methods. + The available elements often have a defined default colour, sometimes from the system but also from Scintilla. + There may be a range of colours and setting an element colour overrides these colours.

+ + + SCI_SETELEMENTCOLOUR(int element, colouralpha colourElement)
+ SCI_GETELEMENTCOLOUR(int element) → colouralpha
+ SCI_RESETELEMENTCOLOUR(int element)
+ SCI_GETELEMENTISSET(int element) → bool
+ SCI_GETELEMENTALLOWSTRANSLUCENT(int element) → bool
+ + +

+ SCI_SETELEMENTCOLOUR(int element, colouralpha colourElement)
+ SCI_GETELEMENTCOLOUR(int element) → colouralpha
+ This changes the colour of the indicated visual element overriding any current colour. + If the element supports translucency, then the alpha portion of the value is used. + An opaque alpha value (0xff) should always be included when an opaque colour is desired as the value 0 + is completely transparent and thus invisible. +

+ +

+ SCI_RESETELEMENTCOLOUR(int element)
+ This removes the element colour returning to the default colour or set of colours. +

+ +

+ SCI_GETELEMENTISSET(int element) → bool
+ Returns true when an element colour has been set. When false indicates that a default colour or set of colours is displayed. +

+ +

+ SCI_GETELEMENTALLOWSTRANSLUCENT(int element) → bool
+ Returns true when the element currently allows translucent drawing when an alpha component is included. + This may change based on circumstances - different platforms or graphics technologies may implement translucency + and newer versions of Scintilla may implement translucency for elements that did not previously support it. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
SC_ELEMENT_*ValueTranslucent?PlatformsDescription
SC_ELEMENT_LIST0OpaqueWin32Text colour in autocompletion lists
SC_ELEMENT_LIST_BACK1OpaqueWin32Background colour of autocompletion lists
SC_ELEMENT_LIST_SELECTED2OpaqueWin32Text colour of selected item in autocompletion lists
SC_ELEMENT_LIST_SELECTED_BACK3OpaqueWin32Background colour of selected item in autocompletion lists
+

Caret, selection, and hotspot styles

The selection is shown by changing the foreground and/or background colours. If one of these @@ -5209,6 +5300,10 @@ struct Sci_TextToFind { SCI_AUTOCGETMAXHEIGHT → int
SCI_AUTOCSETMAXWIDTH(int characterCount)
SCI_AUTOCGETMAXWIDTH → int
+ SC_ELEMENT_LIST : colouralpha
+ SC_ELEMENT_LIST_BACK : colouralpha
+ SC_ELEMENT_LIST_SELECTED : colouralpha
+ SC_ELEMENT_LIST_SELECTED_BACK : colouralpha

SCI_AUTOCSHOW(position lengthEntered, const char *itemList)
@@ -5378,6 +5473,15 @@ struct Sci_TextToFind { the available width are indicated by the presence of ellipsis.

+

+ SC_ELEMENT_LIST : colouralpha
+ SC_ELEMENT_LIST_BACK : colouralpha
+ SC_ELEMENT_LIST_SELECTED : colouralpha
+ SC_ELEMENT_LIST_SELECTED_BACK : colouralpha
+ The colours used for autocompletion lists may be customized on Win32 using + SCI_SETELEMENTCOLOUR. +

+

User lists

User lists use the same internal mechanisms as autocompletion lists, and all the calls -- cgit v1.2.3