From e86a669c757e195237e44c5fd13786ce39acb3ac Mon Sep 17 00:00:00 2001 From: nyamatongwe Date: Thu, 11 Mar 2010 10:21:29 +0000 Subject: Implemented multipaste as an option. --- doc/ScintillaDoc.html | 126 +++++++++++++++++++++++++++----------------------- 1 file changed, 67 insertions(+), 59 deletions(-) (limited to 'doc') diff --git a/doc/ScintillaDoc.html b/doc/ScintillaDoc.html index 7d6cd8837..9324afda7 100644 --- a/doc/ScintillaDoc.html +++ b/doc/ScintillaDoc.html @@ -71,7 +71,7 @@

The GTK+ version also uses messages in a similar way to the Windows version. This is different to normal GTK+ practice but made it easier to implement rapidly.

-

Scintilla does not properly support right-to-left languages like Arabic and Hebrew. +

Scintilla does not properly support right-to-left languages like Arabic and Hebrew. While text in these languages may appear correct, it is not possible to interact with this text as is normal with other editing components.

@@ -237,7 +237,7 @@ o Key bindings o Popup edit menu - + o Macro recording @@ -245,7 +245,7 @@ o Printing o Direct access - + o Multiple views @@ -253,7 +253,7 @@ o Folding o Line wrapping - + o Zooming @@ -261,7 +261,7 @@ o Long lines o Lexer - + o Notifications @@ -269,7 +269,7 @@ o GTK+ o Deprecated messages - + o Edit messages never supported by Scintilla @@ -751,7 +751,7 @@ struct TextToFind { SCI_REPLACETARGET or SCI_REPLACETARGETRE.

Searching can be performed within the target range with SCI_SEARCHINTARGET, - which uses a counted string to allow searching for null characters. It returns the + which uses a counted string to allow searching for null characters. It returns the position of the start of the matching text range or -1 for failure, in which case the target is not moved. The flags used by SCI_SEARCHINTARGET such as SCFIND_MATCHCASE, SCFIND_WHOLEWORD, SCFIND_WORDSTART, and SCFIND_REGEXP @@ -888,7 +888,7 @@ struct TextToFind {

SCI_SETSTATUS(int status)
SCI_GETSTATUS
If an error occurs, Scintilla may set an internal error number that can be retrieved with - SCI_GETSTATUS. + SCI_GETSTATUS. To clear the error status call SCI_SETSTATUS(0). The currently defined statuses are: @@ -986,12 +986,12 @@ struct TextToFind { combined with the preceding or following operations if they are undone.

SCI_ADDUNDOACTION(int token, int flags)
- The container can add its own actions into the undo stack by calling - SCI_ADDUNDOACTION and an SCN_MODIFIED - notification will be sent to the container with the + The container can add its own actions into the undo stack by calling + SCI_ADDUNDOACTION and an SCN_MODIFIED + notification will be sent to the container with the SC_MOD_CONTAINER - flag when it is time to undo (SC_PERFORMED_UNDO) or - redo (SC_PERFORMED_REDO) the action. The token argument supplied is + flag when it is time to undo (SC_PERFORMED_UNDO) or + redo (SC_PERFORMED_REDO) the action. The token argument supplied is returned in the token field of the notification.

For example, if the container wanted to allow undo and redo of a 'toggle bookmark' command then it could call SCI_ADDUNDOACTION(line, 0) each time the command is performed. @@ -999,13 +999,13 @@ struct TextToFind { the token field. If there are different types of commands or parameters that need to be stored into the undo stack then the container should maintain a stack of its own for the document and use the current position in that stack as the argument to SCI_ADDUNDOACTION(line). - SCI_ADDUNDOACTION commands are not combined together + SCI_ADDUNDOACTION commands are not combined together into a single undo transaction unless grouped with SCI_BEGINUNDOACTION and SCI_ENDUNDOACTION.

-

The flags argument can be UNDO_MAY_COALESCE (1) if the container action may be +

The flags argument can be UNDO_MAY_COALESCE (1) if the container action may be coalesced along with any insertion and deletion actions into a single compound action, otherwise 0. - Coalescing treats coalescible container actions as transparent so will still only group together insertions that + Coalescing treats coalescible container actions as transparent so will still only group together insertions that look like typing or deletions that look like multiple uses of the Backspace or Delete keys.

Selection and information

@@ -1215,15 +1215,15 @@ struct TextToFind { This copies the currently selected text and a terminating 0 byte to the text buffer. The buffer size should be determined by calling with a NULL pointer for the text argument SCI_GETSELTEXT(0,0). - This allows for rectangular and discontiguous selections as well as simple selections. - See Multiple Selection for information on + This allows for rectangular and discontiguous selections as well as simple selections. + See Multiple Selection for information on how multiple and rectangular selections and virtual space are copied.

- -

See also: SCI_GETCURLINE, - SCI_GETLINE, - SCI_GETTEXT, - SCI_GETSTYLEDTEXT, - SCI_GETTEXTRANGE + +

See also: SCI_GETCURLINE, + SCI_GETLINE, + SCI_GETTEXT, + SCI_GETSTYLEDTEXT, + SCI_GETTEXTRANGE

SCI_GETCURLINE(int textLen, char *text)
@@ -1393,7 +1393,7 @@ struct TextToFind { SCI_CHARPOSITIONFROMPOINTCLOSE(int x, int y)
SCI_CHARPOSITIONFROMPOINT finds the closest character to a point and SCI_CHARPOSITIONFROMPOINTCLOSE is similar but returns -1 if the point is outside the - window or not close to any characters. This is similar to the previous methods but finds characters rather than + window or not close to any characters. This is similar to the previous methods but finds characters rather than inter-character positions.

SCI_POINTXFROMPOSITION(<unused>, int pos)
@@ -1419,6 +1419,8 @@ struct TextToFind { SCI_GETMULTIPLESELECTION
SCI_SETADDITIONALSELECTIONTYPING(bool additionalSelectionTyping)
SCI_GETADDITIONALSELECTIONTYPING
+ SCI_SETMULTIPASTE(int multiPaste)
+ SCI_GETMULTIPASTE
SCI_SETVIRTUALSPACEOPTIONS(int virtualSpaceOptions)
SCI_GETVIRTUALSPACEOPTIONS
SCI_SETRECTANGULARSELECTIONMODIFIER(int modifier)
@@ -1474,8 +1476,8 @@ struct TextToFind {

- There may be multiple selections active at one time. - More selections are made by holding down the Ctrl key while dragging with the mouse. + There may be multiple selections active at one time. + More selections are made by holding down the Ctrl key while dragging with the mouse. The most recent selection is the main selection and determines which part of the document is shown automatically. Any selection apart from the main selection is called an additional selection. The calls in the previous section operate on the main selection. @@ -1489,11 +1491,11 @@ struct TextToFind {

- Virtual space is space beyond the end of each line. The caret may be moved into virtual space but no real space will be + Virtual space is space beyond the end of each line. The caret may be moved into virtual space but no real space will be added to the document until there is some text typed or some other text insertion command is used.

- -

When discontiguous selections are copied to the clipboard, each selection is added to the clipboard text + +

When discontiguous selections are copied to the clipboard, each selection is added to the clipboard text in order with no delimiting characters. For rectangular selections the document's line end is added after each line's text. Rectangular selections are always copied from top line to bottom, not in the in order of selection.Virtual space is not copied.

@@ -1508,11 +1510,17 @@ struct TextToFind { SCI_GETADDITIONALSELECTIONTYPING
Whether typing, backspace, or delete works with multiple selections simultaneously.

+

+ SCI_SETMULTIPASTE(int multiPaste)
+ SCI_GETMULTIPASTE
+ When pasting into multiple selections, the pasted text can go into just the main selection with SC_MULTIPASTE_ONCE=0 + or into each selection with SC_MULTIPASTE_EACH=1. SC_MULTIPASTE_ONCE is the default.

+

SCI_SETVIRTUALSPACEOPTIONS(int virtualSpace)
SCI_GETVIRTUALSPACEOPTIONS
- Virtual space can be enabled or disabled for rectangular selections or in other circumstances or in both. - There are two bit flags SCVS_RECTANGULARSELECTION=1 and + Virtual space can be enabled or disabled for rectangular selections or in other circumstances or in both. + There are two bit flags SCVS_RECTANGULARSELECTION=1 and SCVS_USERACCESSIBLE=2 which can be set independently. SCVS_NONE=0, the default, disables all use of virtual space.

@@ -1522,13 +1530,13 @@ struct TextToFind { On GTK+, the key used to indicate that a rectangular selection should be created when combined with a mouse drag can be set. The three possible values are SCMOD_CTRL=2 (default), SCMOD_ALT=4 or SCMOD_SUPER=8. Since SCMOD_ALT is often already used by a window manager, the window manager may need configuring to allow this choice. - SCMOD_SUPER is often a system dependent modifier key such as the Left Windows key on a Windows keyboard or the + SCMOD_SUPER is often a system dependent modifier key such as the Left Windows key on a Windows keyboard or the Command key on a Mac.

SCI_GETSELECTIONS
Return the number of selections currently active.

- +

SCI_CLEARSELECTIONS
Set a single empty selection at 0 as the only selection.

@@ -1539,7 +1547,7 @@ struct TextToFind {

SCI_ADDSELECTION(int caret, int anchor)
- Add a new selection from anchor to caret as the main selection retaining all other + Add a new selection from anchor to caret as the main selection retaining all other selections as additional selections. Since there is always at least one selection, to set a list of selections, the first selection should be added with SCI_SETSELECTION and later selections added with SCI_ADDSELECTION

@@ -1972,7 +1980,7 @@ struct TextToFind { SCI_SETEXTRADESCENT(int extraDescent)
SCI_GETEXTRADESCENT
- +

SCI_SETVIEWWS(int wsMode)
SCI_GETVIEWWS
White space can be made visible which may be useful for languages in which white space is @@ -2033,10 +2041,10 @@ struct TextToFind { SCI_GETEXTRAASCENT
SCI_SETEXTRADESCENT(int extraDescent)
SCI_GETEXTRADESCENT
- Text is drawn with the base of each character on a 'baseline'. The height of a line is found from the maximum - that any style extends above the baseline (its 'ascent'), added to the maximum that any style extends below the + Text is drawn with the base of each character on a 'baseline'. The height of a line is found from the maximum + that any style extends above the baseline (its 'ascent'), added to the maximum that any style extends below the baseline (its 'descent'). - Space may be added to the maximum ascent (SCI_SETEXTRAASCENT) and the + Space may be added to the maximum ascent (SCI_SETEXTRAASCENT) and the maximum descent (SCI_SETEXTRADESCENT) to allow for more space between lines. This may done to make the text easier to read or to accomodate underlines or highlights.

@@ -2643,7 +2651,7 @@ struct TextToFind { is hidden. Margin 1 is set to display non-folding symbols and is given a width of 16 pixels, so it is visible. Margin 2 is set to display the folding symbols, but is given a width of 0, so it is hidden. Of course, you can set the margins to be whatever you wish.

- +

Styled text margins used to show revision and blame information:

Styled text margins used to show revision and blame information

@@ -2757,20 +2765,20 @@ struct TextToFind { SCI_MARGINSETSTYLES(int line, char *styles)
SCI_MARGINGETSTYLES(int line, char *styles)
SCI_MARGINTEXTCLEARALL
- Text margins are created with the type SC_MARGIN_TEXT or SC_MARGIN_RTEXT. + Text margins are created with the type SC_MARGIN_TEXT or SC_MARGIN_RTEXT. A different string may be set for each line with SCI_MARGINSETTEXT. - The whole of the text margin on a line may be displayed in a particular style with - SCI_MARGINSETSTYLE or each character may be individually styled with + The whole of the text margin on a line may be displayed in a particular style with + SCI_MARGINSETSTYLE or each character may be individually styled with SCI_MARGINSETSTYLES which uses an array of bytes with each byte setting the style of the corresponding text byte simlar to SCI_SETSTYLINGEX. - Setting a text margin will cause a + Setting a text margin will cause a SC_MOD_CHANGEMARGIN notification to be sent.

SCI_MARGINSETSTYLEOFFSET(int style)
SCI_MARGINGETSTYLEOFFSET
- Margin styles may be completely separated from standard text styles by setting a style offset. For example, + Margin styles may be completely separated from standard text styles by setting a style offset. For example, SCI_MARGINSETSTYLEOFFSET(256) would allow the margin styles to be numbered from 256 upto 511 so they do not overlap styles set by lexers. Each style number set with SCI_MARGINSETSTYLE or SCI_MARGINSETSTYLES has the offset added before looking up the style. @@ -2779,8 +2787,8 @@ struct TextToFind {

Annotations

Annotations are read-only lines of text underneath each line of editable text. - An annotation may consist of multiple lines separated by '\n'. - Annotations can be used to display an assembler version of code for debugging or to show diagnostic messages inline or to + An annotation may consist of multiple lines separated by '\n'. + Annotations can be used to display an assembler version of code for debugging or to show diagnostic messages inline or to line up different versions of text in a merge tool.

Annotations used for inline diagnostics:

Annotations used for inline diagnostics

@@ -2811,12 +2819,12 @@ struct TextToFind { SCI_ANNOTATIONCLEARALL
A different string may be set for each line with SCI_ANNOTATIONSETTEXT. To clear annotations call SCI_ANNOTATIONSETTEXT with a NULL pointer. - The whole of the text ANNOTATION on a line may be displayed in a particular style with - SCI_ANNOTATIONSETSTYLE or each character may be individually styled with + The whole of the text ANNOTATION on a line may be displayed in a particular style with + SCI_ANNOTATIONSETSTYLE or each character may be individually styled with SCI_ANNOTATIONSETSTYLES which uses an array of bytes with each byte setting the style of the corresponding text byte simlar to SCI_SETSTYLINGEX. The text must be set first as it specifies how long the annotation is so how many bytes of styling to read. - Setting an annotation will cause a + Setting an annotation will cause a SC_MOD_CHANGEANNOTATION notification to be sent.

@@ -2829,7 +2837,7 @@ struct TextToFind { SCI_ANNOTATIONSETVISIBLE(int visible)
SCI_ANNOTATIONGETVISIBLE
Annotations can be made visible in a view and there is a choice of display style when visible. - The two messages set and get the annotation display mode. The visible + The two messages set and get the annotation display mode. The visible argument can be one of:

@@ -2864,9 +2872,9 @@ struct TextToFind {

SCI_ANNOTATIONSETSTYLEOFFSET(int style)
SCI_ANNOTATIONGETSTYLEOFFSET
- Annotation styles may be completely separated from standard text styles by setting a style offset. For example, + Annotation styles may be completely separated from standard text styles by setting a style offset. For example, SCI_ANNOTATIONSETSTYLEOFFSET(512) would allow the annotation styles to be numbered from - 512 upto 767 so they do not overlap styles set by lexers (or margins if margins offset is 256). + 512 upto 767 so they do not overlap styles set by lexers (or margins if margins offset is 256). Each style number set with SCI_ANNOTATIONSETSTYLE or SCI_ANNOTATIONSETSTYLES has the offset added before looking up the style.

@@ -2977,7 +2985,7 @@ struct TextToFind {

On GTK+, code page can be set to 932 (Japanese Shift-JIS), 936 (Simplified Chinese GBK), or 950 (Traditional Chinese Big5). The code page may also be set to SC_CP_DBCS (1) - which uses the current locale to handle multi byte characters which may work for otherwise unsupported + which uses the current locale to handle multi byte characters which may work for otherwise unsupported code pages.

For GTK+ 1.x, the locale should be set to a Unicode locale with a call similar to @@ -3254,8 +3262,8 @@ struct TextToFind { The SC_MARK_EMPTY symbol is invisible, allowing client code to track the movement of lines. You would also use it if you changed the folding style and wanted one or more of the SC_FOLDERNUM_* markers to have no associated symbol.

- -

Applications may use the marker symbol SC_MARK_AVAILABLE to indicate that + +

Applications may use the marker symbol SC_MARK_AVAILABLE to indicate that plugins may allocate that marker number.

@@ -3400,7 +3408,7 @@ struct TextToFind { the XPM format here.

SCI_MARKERSYMBOLDEFINED(int markerNumber)
- Returns the symbol defined for a markerNumber with SCI_MARKERDEFINE + Returns the symbol defined for a markerNumber with SCI_MARKERDEFINE or SC_MARK_PIXMAP if defined with SCI_MARKERDEFINEPIXMAP.

SCI_MARKERSETFORE(int markerNumber, int

- @@ -5739,7 +5747,7 @@ href="#SCI_POSITIONFROMLINE">SCI_POSITIONFROMLINE(lineNumber); - -- cgit v1.2.3
SC_WRAPINDENT_FIXED 0Wrapped sublines aligned to left of window plus amount set by + Wrapped sublines aligned to left of window plus amount set by SCI_SETWRAPSTARTINDENT
0x40000This is set on for actions that the container stored into the undo stack with + This is set on for actions that the container stored into the undo stack with SCI_ADDUNDOACTION.