From 440e6883c5563a04ba46de3dbe4949f20cde5124 Mon Sep 17 00:00:00 2001 From: nyamatongwe Date: Wed, 24 Apr 2013 16:33:36 +1000 Subject: Cosmetic: remove line-end whitespace. --- doc/ScintillaDoc.html | 74 +++++++++++++++++++++++++-------------------------- 1 file changed, 37 insertions(+), 37 deletions(-) (limited to 'doc/ScintillaDoc.html') diff --git a/doc/ScintillaDoc.html b/doc/ScintillaDoc.html index 1c2dd7c2f..495d81639 100644 --- a/doc/ScintillaDoc.html +++ b/doc/ScintillaDoc.html @@ -323,7 +323,7 @@ o Provisional messages o Deprecated messages - + @@ -560,7 +560,7 @@ SCI_RELEASEALLEXTENDEDSTYLES releases any extended styles allocated by the container. SCI_ALLOCATEEXTENDEDSTYLES allocates a range of style numbers after the byte style values and returns the number of the first allocated style. - Ranges for margin and annotation styles should be allocated before calling + Ranges for margin and annotation styles should be allocated before calling SCI_MARGINSETSTYLEOFFSET or SCI_ANNOTATIONSETSTYLEOFFSET.

@@ -2207,7 +2207,7 @@ struct Sci_TextToFind {

Scintilla can handle the major line end conventions and, depending on settings and the current lexer also support additional Unicode line ends.

- +

Scintilla can interpret any of the Macintosh (\r), Unix (\n) and Windows (\r\n) line ends. When the user presses the Enter key, one of these line @@ -2559,7 +2559,7 @@ struct Sci_TextToFind {

The weight or boldness of a font can be set with SCI_STYLESETBOLD or SCI_STYLESETWEIGHT. The weight is a number between 1 and 999 with 1 being very light and 999 very heavy. While any value can be used, fonts often only support between 2 and 4 weights with three weights - being common enough to have symbolic names: + being common enough to have symbolic names: SC_WEIGHT_NORMAL (400), SC_WEIGHT_SEMIBOLD (600), and SC_WEIGHT_BOLD (700). @@ -2999,10 +2999,10 @@ struct Sci_TextToFind {

SCI_SETMARGINOPTIONS(int marginOptions)
SCI_GETMARGINOPTIONS
- Define margin options by enabling appropriate bit flags. At the moment, only one flag is available - SC_MARGINOPTION_SUBLINESELECT=1, which controls how wrapped lines are selected when clicking - on margin in front of them. If SC_MARGINOPTION_SUBLINESELECT is set only sub line of wrapped - line is selected, otherwise whole wrapped line is selected. Margin options are set to + Define margin options by enabling appropriate bit flags. At the moment, only one flag is available + SC_MARGINOPTION_SUBLINESELECT=1, which controls how wrapped lines are selected when clicking + on margin in front of them. If SC_MARGINOPTION_SUBLINESELECT is set only sub line of wrapped + line is selected, otherwise whole wrapped line is selected. Margin options are set to SC_MARGINOPTION_NONE=0 by default.

@@ -3224,7 +3224,7 @@ struct Sci_TextToFind {

SCI_GETWORDCHARS(<unused>, char *characters)
This fills the characters parameter with all the characters included in words. - The characters parameter must be large enough to hold all of the characters. + The characters parameter must be large enough to hold all of the characters. If the characters parameter is 0 then the length that should be allocated to store the entire set is returned.

@@ -3637,7 +3637,7 @@ struct Sci_TextToFind {

SCI_MARKERDEFINEPIXMAP(int markerNumber, const char *xpm)
- Markers can be set to pixmaps with this message. The + Markers can be set to pixmaps with this message. The XPM format is used for the pixmap. Pixmaps use the SC_MARK_PIXMAP marker symbol.

@@ -3646,9 +3646,9 @@ struct Sci_TextToFind { SCI_RGBAIMAGESETHEIGHT(int height)
SCI_RGBAIMAGESETSCALE(int scalePercent)
SCI_MARKERDEFINERGBAIMAGE(int markerNumber, const char *pixels)
- Markers can be set to translucent pixmaps with this message. The + Markers can be set to translucent pixmaps with this message. The RGBA format is used for the pixmap. - The width and height must previously been set with the SCI_RGBAIMAGESETWIDTH and + The width and height must previously been set with the SCI_RGBAIMAGESETWIDTH and SCI_RGBAIMAGESETHEIGHT messages.

A scale factor in percent may be set with SCI_RGBAIMAGESETSCALE. This is useful on OS X with a retina display where each display unit is 2 pixels: use a factor of 200 so that each image pixel is dsplayed using a screen pixel. @@ -4027,7 +4027,7 @@ struct Sci_TextToFind {

SCI_FINDINDICATORSHOW(int start, int end)
SCI_FINDINDICATORFLASH(int start, int end)
These two messages show and animate the find indicator. The indicator remains visible with - SCI_FINDINDICATORSHOW and fades out after showing for half a second with + SCI_FINDINDICATORSHOW and fades out after showing for half a second with SCI_FINDINDICATORFLASH. SCI_FINDINDICATORSHOW behaves similarly to the OS X TextEdit and Safari applications and is best suited to editing documentation where the search target is often a word. @@ -4270,10 +4270,10 @@ struct Sci_TextToFind { Autocompletion list items may display an image as well as text. Each image is first registered with an integer type. Then this integer is included in the text of the list separated by a '?' from the text. For example, "fclose?2 fopen" displays image 2 before the string "fclose" and no image before "fopen". - The images are in either the XPM format (SCI_REGISTERIMAGE) or + The images are in either the XPM format (SCI_REGISTERIMAGE) or RGBA format (SCI_REGISTERRGBAIMAGE). For SCI_REGISTERRGBAIMAGE the width and height must previously been set with - the SCI_RGBAIMAGESETWIDTH and + the SCI_RGBAIMAGESETWIDTH and SCI_RGBAIMAGESETHEIGHT messages. The set of registered images can be cleared with SCI_CLEARREGISTEREDIMAGES and the '?' separator changed with SCI_AUTOCSETTYPESEPARATOR. @@ -4433,7 +4433,7 @@ struct Sci_TextToFind {

SCI_CALLTIPSETPOSITION(bool above)
By default the calltip is displayed below the text, setting above to true (1) will display it above the text.

- +

Keyboard commands

@@ -4748,7 +4748,7 @@ struct Sci_TextToFind {

The modifiers are a combination of zero or more of SCMOD_ALT, SCMOD_CTRL, SCMOD_SHIFT, and SCMOD_META. - On OS X, the Command key is mapped to SCMOD_CTRL and the Control key to + On OS X, the Command key is mapped to SCMOD_CTRL and the Control key to SCMOD_META. If you are building a table, you might want to use SCMOD_NORM, which has the value 0, to mean no modifiers.

@@ -4851,7 +4851,7 @@ struct Sci_RangeToFormat { The Surface IDs are not really used for measurement (bDraw=0) but can be set to a bitmap context (created with CGBitmapContextCreate) to avoid runtime warnings.

-

On GTK+, the surface IDs to use can be found from the printing context with +

On GTK+, the surface IDs to use can be found from the printing context with gtk_print_context_get_cairo_context(context).

chrg.cpMin and chrg.cpMax define the start position and maximum @@ -5024,7 +5024,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){

SCI_GETRANGEPOINTER provides direct access to just the range requested. The gap is not moved unless it is within the requested range so this call - can be faster than SCI_GETCHARACTERPOINTER. + can be faster than SCI_GETCHARACTERPOINTER. This can be used by application code that is able to act on blocks of text or ranges of lines.

SCI_GETGAPPOSITION returns the current gap position. @@ -5387,7 +5387,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){

- +

SCI_EXPANDCHILDREN(int line, int level)
This is used to respond to a change to a line causing its fold level or whether it is a header to change, perhaps when adding or removing a '{'.

@@ -6331,7 +6331,7 @@ To allow lexers to determine the end position of a line and thus more easily sup };
-

The ILexer, ILexerWithSubStyles, IDocument, and +

The ILexer, ILexerWithSubStyles, IDocument, and IDocumentWithLineEnd interfaces may be expanded in the future with extended versions (ILexer2...). The Version method indicates which interface is @@ -6436,11 +6436,11 @@ struct SCNotification {

SCI_SETIDENTIFIER(int identifier)
SCI_GETIDENTIFIER
- These two messages set and get the identifier of the Scintilla instance which is included in notifications as the - idFrom field. + These two messages set and get the identifier of the Scintilla instance which is included in notifications as the + idFrom field. When an application creates multiple Scintilla widgets, this allows the source of each notification to be found. - On Windows, this value is initialised in the CreateWindow call and stored as the - GWLP_ID attribute of the window. + On Windows, this value is initialised in the CreateWindow call and stored as the + GWLP_ID attribute of the window. The value should be small, preferrably less than 16 bits, rather than a pointer as some of the functions will only transmit 16 or 32 bits.

@@ -7165,17 +7165,17 @@ for line = lineStart to lineEnd do SCI_ENSUREVISIBLE(line) next

SCN_AUTOCCHARDELETED
The user deleted a character while autocompletion list was active. There is no other information in SCNotification.

- +

Images

- +

Two formats are supported for images used in margin markers and autocompletion lists, RGBA and XPM.

RGBA

- +

The RGBA format allows translucency with an alpha value for each pixel. It is simpler than XPM and more capable.

- +

The data is a sequence of 4 byte pixel values starting with the pixels for the top line, with the leftmost pixel first, then continuing with the pixels for subsequent lines. There is no gap between lines for alignment reasons.

@@ -7184,22 +7184,22 @@ for line = lineStart to lineEnd do SCI_ENSUREVISIBLE(line) next The colour bytes are not premultiplied by the alpha value. That is, a fully red pixel that is 25% opaque will be [FF, 00, 00, 3F]

-

Since the RGBA pixel data does not include any size information the - width and height must previously been set with the - SCI_RGBAIMAGESETWIDTH and +

Since the RGBA pixel data does not include any size information the + width and height must previously been set with the + SCI_RGBAIMAGESETWIDTH and SCI_RGBAIMAGESETHEIGHT messages.

- +

GUI platforms often include functions for reading image file formats like PNG into memory in the RGBA form or a similar form. If there is no suitable platform support, the LodePNG and picoPNG libraries are small libraries for loading and decoding PNG files available under a BSD-style license.

- +

RGBA format is supported on Windows, GTK+ and OS X Cocoa.

XPM

- -

The XPM format is - described here. + +

The XPM format is + described here. Scintilla is only able to handle XPM pixmaps that use one character per pixel with no named colours. There may be a completely transparent colour named "None".

There are two forms of data structure used for XPM images, the first "lines form" format is well suited -- cgit v1.2.3