From 52af548ba224bf18d36a664bc8eb512ab8556739 Mon Sep 17 00:00:00 2001 From: nyamatongwe Date: Thu, 16 Dec 2010 10:12:06 +1100 Subject: Fixing invalid HTML. --- doc/ScintillaDoc.html | 133 +++++++++++++++++++++++--------------------------- doc/index.html | 2 +- 2 files changed, 63 insertions(+), 72 deletions(-) (limited to 'doc') diff --git a/doc/ScintillaDoc.html b/doc/ScintillaDoc.html index 6f29d71dc..17484539e 100644 --- a/doc/ScintillaDoc.html +++ b/doc/ScintillaDoc.html @@ -79,7 +79,7 @@

Scintilla Documentation

-

Last edited 22/October/2010 NH

+

Last edited 16/December/2010 NH

There is an overview of the internal design of Scintilla.
@@ -937,6 +937,7 @@ struct Sci_TextToFind { SCI_GETSTATUS. To clear the error status call SCI_SETSTATUS(0). The currently defined statuses are: +

@@ -961,8 +962,6 @@ struct Sci_TextToFind {
-

-

Undo and Redo

Scintilla has multiple level undo and redo. It will continue to collect undoable actions @@ -1257,7 +1256,8 @@ struct Sci_TextToFind { the line not including any end of line characters, use SCI_GETLINEENDPOSITION(line) - SCI_POSITIONFROMLINE(line).

- SCI_GETSELTEXT(<unused>, char *text)
+ +

SCI_GETSELTEXT(<unused>, char *text)
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). @@ -1507,9 +1507,9 @@ struct Sci_TextToFind { SCI_SETADDITIONALSELALPHA(int alpha)
SCI_GETADDITIONALSELALPHA
- SCI_SETADDITIONALSELFORE(int colour)
- SCI_SETADDITIONALSELBACK(int colour)
- SCI_SETADDITIONALCARETFORE(int colour)
+ SCI_SETADDITIONALSELFORE(int colour)
+ SCI_SETADDITIONALSELBACK(int colour)
+ SCI_SETADDITIONALCARETFORE(int colour)
SCI_GETADDITIONALCARETFORE
SCI_SETADDITIONALCARETSBLINK(bool additionalCaretsBlink)
SCI_GETADDITIONALCARETSBLINK
@@ -1661,7 +1661,7 @@ struct Sci_TextToFind {

SCI_SETADDITIONALCARETSVISIBLE(bool additionalCaretsVisible)
SCI_GETADDITIONALCARETSVISIBLE
- Determine whether to show additional carets (defaults to true). + Determine whether to show additional carets (defaults to true).

SCI_SWAPMAINANCHORCARET
@@ -2076,11 +2076,11 @@ struct Sci_TextToFind { the lexer's colours with SCI_SETWHITESPACEFORE and SCI_SETWHITESPACEBACK.

- SCI_SETWHITESPACESIZE(int size)
+

SCI_SETWHITESPACESIZE(int size)
SCI_GETWHITESPACESIZE
SCI_SETWHITESPACESIZE sets the size of the dots used for mark space characters. The SCI_GETWHITESPACESIZE message retrieves the current size. -

+

SCI_SETEXTRAASCENT(int extraAscent)
@@ -2093,7 +2093,7 @@ struct Sci_TextToFind { 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. -

+

Cursor

@@ -2531,18 +2531,15 @@ struct Sci_TextToFind { it was not selected. When there is no selection, the current insertion point is marked by the text caret. This is a vertical line that is normally blinking on and off to attract the users attention.

- SCI_SETSELFORE(bool useSelectionForeColour, - int colour)
- SCI_SETSELBACK(bool useSelectionBackColour, - int colour)
+ SCI_SETSELFORE(bool useSelectionForeColour, int colour)
+ SCI_SETSELBACK(bool useSelectionBackColour, int colour)
SCI_SETSELALPHA(int alpha)
SCI_GETSELALPHA
SCI_SETSELEOLFILLED(bool filled)
SCI_GETSELEOLFILLED
SCI_SETCARETFORE(int colour)
SCI_GETCARETFORE
- SCI_SETCARETLINEVISIBLE(bool - show)
+ SCI_SETCARETLINEVISIBLE(bool show)
SCI_GETCARETLINEVISIBLE
SCI_SETCARETLINEBACK(int colour)
SCI_GETCARETLINEBACK
@@ -2554,18 +2551,15 @@ struct Sci_TextToFind { SCI_GETCARETSTYLE
SCI_SETCARETWIDTH(int pixels)
SCI_GETCARETWIDTH
- SCI_SETHOTSPOTACTIVEFORE(bool useSetting, - int colour)
+ SCI_SETHOTSPOTACTIVEFORE(bool useSetting, int colour)
SCI_GETHOTSPOTACTIVEFORE
- SCI_SETHOTSPOTACTIVEBACK(bool useSetting, - int colour)
+ SCI_SETHOTSPOTACTIVEBACK(bool useSetting, int colour)
SCI_GETHOTSPOTACTIVEBACK
SCI_SETHOTSPOTACTIVEUNDERLINE(bool underline)
SCI_GETHOTSPOTACTIVEUNDERLINE
SCI_SETHOTSPOTSINGLELINE(bool singleLine)
SCI_GETHOTSPOTSINGLELINE
- SCI_SETCONTROLCHARSYMBOL(int - symbol)
+ SCI_SETCONTROLCHARSYMBOL(int symbol)
SCI_GETCONTROLCHARSYMBOL
SCI_SETCARETSTICKY(int useCaretStickyBehaviour)
SCI_GETCARETSTICKY
@@ -2928,7 +2922,6 @@ struct Sci_TextToFind { -

SCI_ANNOTATIONSETSTYLEOFFSET(int style)
SCI_ANNOTATIONGETSTYLEOFFSET
@@ -3199,7 +3192,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. + empty lines.

@@ -3227,8 +3220,8 @@ struct Sci_TextToFind { This setting is good for most languages. +
-

SCI_SETHIGHLIGHTGUIDE(int column)
SCI_GETHIGHLIGHTGUIDE
@@ -3631,6 +3624,7 @@ struct Sci_TextToFind { interior more transparent than the border. You can use SCI_INDICSETALPHA to control the alpha transparency value. The default alpha value is 30. + @@ -3640,8 +3634,7 @@ struct Sci_TextToFind { SCI_INDICSETSTYLE(1, INDIC_TT);
SCI_INDICSETSTYLE(2, INDIC_PLAIN);

-

SCI_INDICSETFORE(int indicatorNumber, int colour)
+

SCI_INDICSETFORE(int indicatorNumber, int colour)
SCI_INDICGETFORE(int indicatorNumber)
These two messages set and get the colour used to draw an indicator. The default indicator colours are equivalent to:
@@ -3662,7 +3655,7 @@ struct Sci_TextToFind { Drawing under text works only for modern indicators when two phase drawing is enabled.

-

Modern Indicators

+

Modern Indicators

Modern indicators are stored in a format similar to run length encoding which is efficient in both speed and storage for sparse information.

@@ -3708,7 +3701,7 @@ struct Sci_TextToFind { Can be used to iterate through the document to discover all the indicator positions.

-

Style Byte Indicators (deprecated)

+

Style Byte Indicators (deprecated)

By default, Scintilla organizes the style byte associated with each text byte as 5 bits of style information (for 32 styles) and 3 bits of indicator information for 3 independent indicators so that, for example, syntax errors, deprecated names and bad indentation could all @@ -3806,8 +3799,7 @@ struct Sci_TextToFind { and SCI_AUTOCGETSEPARATOR.

-

The list of words should be in sorted order. If set to ignore case mode with SCI_AUTOCSETIGNORECASE, then +

The list of words should be in sorted order. If set to ignore case mode with SCI_AUTOCSETIGNORECASE, then strings are matched after being converted to upper case. One result of this is that the list should be sorted with the punctuation characters '[', '\', ']', '^', '_', and '`' sorted after letters.

@@ -3858,7 +3850,7 @@ struct Sci_TextToFind { SCN_AUTOCSELECTION notification is used instead.

-

The value is copied to the text buffer, returning the length (not including the +

The value is copied to the text buffer, returning the length (not including the terminating 0). If not found, an empty string is copied to the buffer and 0 is returned.

If the value argument is 0 then the length that should be allocated to store the value is @@ -4932,7 +4924,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ SCI_GETWRAPVISUALFLAGS
You can enable the drawing of visual flags to indicate a line is wrapped. Bits set in wrapVisualFlags determine which visual flags are drawn. - +

@@ -4969,6 +4961,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ SCI_GETWRAPVISUALFLAGSLOCATION
You can set whether the visual flags to indicate a line is wrapped are drawn near the border or near the text. Bits set in wrapVisualFlagsLocation set the location to near the text for the corresponding visual flag. +

@@ -4999,13 +4992,13 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){
-

SCI_SETWRAPINDENTMODE(int indentMode)
SCI_GETWRAPINDENTMODE
Wrapped sublines can be indented to the position of their first subline or one more indent level. The default is SC_WRAPINDENT_FIXED. The modes are: +

@@ -5037,7 +5030,6 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){
-

SCI_SETWRAPSTARTINDENT(int indent)
SCI_GETWRAPSTARTINDENT
@@ -5099,7 +5091,6 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ -

SCI_SETPOSITIONCACHE(int size)
SCI_GETPOSITIONCACHE
@@ -5411,17 +5402,17 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){

ILexer

-class ILexer {
-public:
+class ILexer {
+public:
    virtual int SCI_METHOD Version() const = - 0;
+ 0;
    virtual void SCI_METHOD Release() -= 0;
+= 0;
    virtual const char @@ -5440,7 +5431,7 @@ SCI_METHOD PropertyNames() const char *val) = - 0;
+ 0;
    virtual const char * SCI_METHOD DescribeWordListSets() @@ -5453,7 +5444,7 @@ SCI_METHOD PropertyNames() const char *wl) = - 0;
+ 0;
    virtual void SCI_METHOD Lex(unsigned @@ -5465,7 +5456,7 @@ SCI_METHOD PropertyNames() IDocument *pAccess) = -0;
+0;
    virtual void SCI_METHOD Fold(unsigned @@ -5476,7 +5467,7 @@ SCI_METHOD PropertyNames() IDocument *pAccess) = -0;
+0;
    virtual void * SCI_METHOD @@ -5484,8 +5475,8 @@ SCI_METHOD PropertyNames() operation, void *pointer) -= 0;
-};
+= 0;
+};

@@ -5511,24 +5502,24 @@ invoked with the SCI_PRIVATELEXERCALL API.

class IDocument - {
-public:
+ {
+public:
    virtual int SCI_METHOD Version() const = - 0;
+ 0;
    virtual void SCI_METHOD SetErrorStatus(int status) = -0;
+0;
    virtual int SCI_METHOD Length() const = - 0;
+ 0;
    virtual void SCI_METHOD GetCharRange(char @@ -5538,64 +5529,64 @@ position, int lengthRetrieve) const = -0;
+0;
    virtual char SCI_METHOD StyleAt(int position) const = - 0;
+ 0;
    virtual int SCI_METHOD LineFromPosition(int position) const = - 0;
+ 0;
    virtual int SCI_METHOD LineStart(int line) const = - 0;
+ 0;
    virtual int SCI_METHOD GetLevel(int line) const = -0;
+0;
    virtual int SCI_METHOD SetLevel(int line, int level) = -0;
+0;
    virtual int SCI_METHOD GetLineState(int line) const = 0 -;
+;
    virtual int SCI_METHOD SetLineState(int line, int state) = - 0;
+ 0;
    virtual void SCI_METHOD StartStyling(int position, char mask) = - 0;
+ 0;
    virtual bool SCI_METHOD SetStyleFor(int length, char style) = 0 -;
+;
    virtual bool SCI_METHOD SetStyles(int @@ -5603,13 +5594,13 @@ position, const char *styles) = -0;
+0;
    virtual void SCI_METHOD DecorationSetCurrentIndicator(int indicator) = - 0;
+ 0;
    virtual void SCI_METHOD DecorationFillRange(int @@ -5618,27 +5609,27 @@ position, int fillLength) = -0;
+0;
    virtual void SCI_METHOD ChangeLexerState(int start, int end) = - 0;
+ 0;
    virtual int SCI_METHOD CodePage() const = 0 -;
+;
    virtual bool SCI_METHOD IsDBCSLeadByte(char ch) const = - 0;
-};
+ 0;
+};

Scintilla tries to minimize the consequences of modifying text to @@ -6424,11 +6415,11 @@ for line = lineStart to lineEnd do SCI_ENSUREVISIBLE(line) next void scintilla_release_resources()
 -

GtkWidget *scintilla_new()
+

GtkWidget *scintilla_new()
Create a new Scintilla widget. The returned pointer can be added to a container and displayed in the same way as other widgets.

-

void scintilla_set_id(ScintillaObject *sci, uptr_t id)
+

void scintilla_set_id(ScintillaObject *sci, uptr_t id)
Set the control ID which will be used in the idFrom field of the NotifyHeader structure of all notifications for this instance. When an application creates multiple Scintilla widgets, this allows the source of each notification to be found. The value should be small, preferrably less than 16 bits, diff --git a/doc/index.html b/doc/index.html index 0da0d9a0d..bcb67edf7 100644 --- a/doc/index.html +++ b/doc/index.html @@ -65,7 +65,7 @@ - -- cgit v1.2.3
+