From 1890406cfe2700df5511371ac082ce068697ac32 Mon Sep 17 00:00:00 2001 From: nyamatongwe Date: Sat, 4 Feb 2006 00:02:08 +0000 Subject: Modification from Greg Smith to allow setting text style attributes for calltips as STYLE_CALLTIP and display calltips with tabs to align text. --- doc/ScintillaDoc.html | 61 +++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 47 insertions(+), 14 deletions(-) (limited to 'doc') diff --git a/doc/ScintillaDoc.html b/doc/ScintillaDoc.html index bc630f795..42314186a 100644 --- a/doc/ScintillaDoc.html +++ b/doc/ScintillaDoc.html @@ -38,7 +38,7 @@

Scintilla Documentation

-

Last edited 2/November/2005 NH

+

Last edited 4/February/2006 NH

There is an overview of the internal design of Scintilla.
@@ -1914,6 +1914,17 @@ struct TextToFind { indentation guides. + + STYLE_CALLTIP + + 38 + + Call tips normally use the font attributes defined by STYLE_DEFAULT. + Use of SCI_CALLTIPUSESTYLE + causes call tips to use this style instead. Only the font face name, font size, + foreground and background colours and character set attributes are used. + + STYLE_LASTPREDEFINED @@ -1921,8 +1932,8 @@ struct TextToFind { To make it easier for client code to discover the range of styles that are predefined, this is set to the style number of the last predefined style. This is - currently set to 39 and the last style with an identifier is 37, which reserves space for - future predefined styles. + currently set to 39 and the last style with an identifier is 38, which reserves space + for one future predefined style. @@ -3159,9 +3170,16 @@ struct TextToFind {

Call tips

Call tips are small windows displaying the arguments to a function and are displayed after - the user has typed the name of the function. There is some interaction between call tips and - autocompletion lists in that showing a call tip cancels any active autocompletion list, and - vice versa.

+ the user has typed the name of the function. They normally display characters using the font + facename, size and character set defined by + STYLE_DEFAULT. You can choose to + use STYLE_CALLTIP to define the + facename, size, foreground and background colours and character set with + SCI_CALLTIPUSESTYLE. + This also enables support for Tab characters. + + There is some interaction between call tips and autocompletion lists in that showing a + call tip cancels any active autocompletion list, and vice versa.

Call tips can highlight part of the text within them. You could use this to highlight the current argument to a function by counting the number of commas (or whatever separator your @@ -3192,17 +3210,22 @@ struct TextToFind { SCI_CALLTIPSETBACK(int colour)
SCI_CALLTIPSETFORE(int colour)
SCI_CALLTIPSETFOREHLT(int colour)
+ SCI_CALLTIPUSESTYLE(int tabsize)
- -

SCI_CALLTIPSHOW(int posStart, const char *definition)
This message starts the process by displaying the call tip window. If a call tip is already active, this has no effect.
posStart is the position in the document at which to align the call tip. The call - tip text is aligned to start 1 line below this character.
+ tip text is aligned to start 1 line below this character unless you have included up and/or + down arrows in the call tip text in which case the tip is aligned to the right-hand edge of + the rightmost arrow. The assumption is that you will start the text with something like + "\001 1 of 3 \002".
definition is the call tip text. This can contain multiple lines separated by - '\n' (Line Feed, ASCII code 10) characters.

+ '\n' (Line Feed, ASCII code 10) characters. Do not include '\r' (Carriage Return, ASCII + code 13), as this will most likely print as an empty box. '\t' (Tab, ASCII code 9) is + supported if you set a tabsize with + SCI_CALLTIPUSESTYLE.

SCI_CALLTIPCANCEL
This message cancels any displayed call tip. Scintilla will also cancel call tips for you if @@ -3233,14 +3256,24 @@ struct TextToFind {

SCI_CALLTIPSETBACK(int colour)
The background colour of call tips can be set with this message; the default colour is white. - It is not a good idea to set a dark colour as the background as the unselected text is drawn in - mid gray and the selected text in a dark blue.

+ It is not a good idea to set a dark colour as the background as the default colour for normal + calltip text is mid gray and the defaultcolour for highlighted text is dark blue. This also + sets the background colour of STYLE_CALLTIP.

SCI_CALLTIPSETFORE(int colour)
- The colour of call tip text can be set with this message; the default colour is mid gray.

+ The colour of call tip text can be set with this message; the default colour is mid gray. + This also sets the foreground colour of STYLE_CALLTIP.

SCI_CALLTIPSETFOREHLT(int colour)
- The colour of highlighted call tip text can be set with this message; the default colour is dark blue.

+ The colour of highlighted call tip text can be set with this message; the default colour + is dark blue.

+ +

SCI_CALLTIPUSESTYLE(int tabsize)
+ This message changes the style used for call tips from STYLE_DEFAULT to + STYLE_CALLTIP and sets a tab size in screen pixels. If tabsize is + less than 1, Tab characters are not treated specially. Once this call has been used, the + call tip foreground and background colours are also taken from the style.

+

Keyboard commands

-- cgit v1.2.3