Main Page   Class Hierarchy   Compound List   File List   Compound Members  

CScintilla Class Reference

#include <scintillaif.h>

Inheritance diagram for CScintilla:

Inheritance graph
[legend]
List of all members.

Public Methods

 CScintilla ()
 Default constructor.

 ~CScintilla ()
 Destructor.

HWND Create (HWND hParent, HINSTANCE hInst)
 Create a Scintilla window inside parent hParent.

bool OpenFile (LPCTSTR filename)
 Load a file from "filename".

bool SaveFile (LPCTSTR filename)
 Save the contents of the control to "filename".

bool IsScintillaNotify (LPARAM lParam)
void HandleNotify (LPARAM lParam)
bool GetModified ()
 Returns whether the text in the control has been modified since the last save.

virtual long SPerform (long Msg, WPARAM wParam=0, LPARAM lParam=0)
void DefineMarker (int marker, int markerType, COLORREF fore, COLORREF back)
void SetFoldingMargins (EFoldStyle style)
 Set the Folding Margins. More...

void FoldChanged (int line, int levelNow, int levelPrev)
 Called when Fold Changed.

void Expand (int &line, bool doExpand, bool force=false, int visLevels=0, int level=-1)
 Called to Expand and Collapse folded sections.

bool MarginClick (int position, int modifiers)
 Called when a margin is clicked on.

void FoldAll ()
 Call FoldAll() to collapse the entire document.

Public Wrapper Functions
The functions below are implemented and coded automagically using the Python wrapper generator code contained in SHFace.py and SHFacer.py.

void AddText (int length, const char *text)
void AddStyledText (int length, char *c)
void InsertText (long pos, const char *text)
void ClearAll ()
void ClearDocumentStyle ()
int GetLength ()
int GetCharAt (long pos)
long GetCurrentPos ()
long GetAnchor ()
int GetStyleAt (long pos)
void Redo ()
void SetUndoCollection (bool collectUndo)
void SelectAll ()
void SetSavePoint ()
int GetStyledText (TextRange *tr)
bool CanRedo ()
int MarkerLineFromHandle (int handle)
void MarkerDeleteHandle (int handle)
bool GetUndoCollection ()
int GetViewWS ()
void SetViewWS (int viewWS)
int PositionFromPoint (int x, int y)
int PositionFromPointClose (int x, int y)
void GotoLine (int line)
void GotoPos (long pos)
void SetAnchor (long posAnchor)
int GetCurLine (int length, char *text)
long GetEndStyled ()
void ConvertEOLs (int eolMode)
int GetEOLMode ()
void SetEOLMode (int eolMode)
void StartStyling (long pos, int mask)
void SetStyling (int length, int style)
bool GetBufferedDraw ()
void SetBufferedDraw (bool buffered)
void SetTabWidth (int tabWidth)
int GetTabWidth ()
void SetCodePage (int codePage)
void SetUsePalette (bool usePalette)
void MarkerDefine (int markerNumber, int markerSymbol)
void MarkerSetFore (int markerNumber, COLORREF fore)
void MarkerSetBack (int markerNumber, COLORREF back)
void MarkerAdd (int line, int markerNumber)
void MarkerDelete (int line, int markerNumber)
void MarkerDeleteAll (int markerNumber)
int MarkerGet (int line)
int MarkerNext (int lineStart, int markerMask)
int MarkerPrevious (int lineStart, int markerMask)
void SetMarginTypeN (int margin, int marginType)
int GetMarginTypeN (int margin)
void SetMarginWidthN (int margin, int pixelWidth)
int GetMarginWidthN (int margin)
void SetMarginMaskN (int margin, int mask)
int GetMarginMaskN (int margin)
void SetMarginSensitiveN (int margin, bool sensitive)
bool GetMarginSensitiveN (int margin)
void StyleClearAll ()
void StyleSetFore (int style, COLORREF fore)
void StyleSetBack (int style, COLORREF back)
void StyleSetBold (int style, bool bold)
void StyleSetItalic (int style, bool italic)
void StyleSetSize (int style, int sizePoints)
void StyleSetFont (int style, const char *fontName)
void StyleSetEOLFilled (int style, bool filled)
void StyleResetDefault ()
void StyleSetUnderline (int style, bool underline)
void StyleSetCase (int style, int caseForce)
void StyleSetCharacterSet (int style, int characterSet)
void SetSelFore (bool useSetting, COLORREF fore)
void SetSelBack (bool useSetting, COLORREF back)
void SetCaretFore (COLORREF fore)
void AssignCmdKey (DWORD km, int msg)
void ClearCmdKey (DWORD km)
void ClearAllCmdKeys ()
void SetStylingEx (int length, const char *styles)
void StyleSetVisible (int style, bool visible)
int GetCaretPeriod ()
void SetCaretPeriod (int periodMilliseconds)
void SetWordChars (const char *characters)
void BeginUndoAction ()
void EndUndoAction ()
void IndicSetStyle (int indic, int style)
int IndicGetStyle (int indic)
void IndicSetFore (int indic, COLORREF fore)
COLORREF IndicGetFore (int indic)
void SetStyleBits (int bits)
int GetStyleBits ()
void SetLineState (int line, int state)
int GetLineState (int line)
int GetMaxLineState ()
bool GetCaretLineVisible ()
void SetCaretLineVisible (bool show)
COLORREF GetCaretLineBack ()
void SetCaretLineBack (COLORREF back)
void AutoCShow (int lenEntered, const char *itemList)
void AutoCCancel ()
bool AutoCActive ()
long AutoCPosStart ()
void AutoCComplete ()
void AutoCStops (const char *characterSet)
void AutoCSetSeparator (int separatorCharacter)
int AutoCGetSeparator ()
void AutoCSelect (const char *text)
void AutoCSetCancelAtStart (bool cancel)
bool AutoCGetCancelAtStart ()
void AutoCSetFillUps (const char *characterSet)
void AutoCSetChooseSingle (bool chooseSingle)
bool AutoCGetChooseSingle ()
void AutoCSetIgnoreCase (bool ignoreCase)
bool AutoCGetIgnoreCase ()
void UserListShow (int listType, const char *itemList)
void AutoCSetAutoHide (bool autoHide)
bool AutoCGetAutoHide ()
void SetIndent (int indentSize)
int GetIndent ()
void SetUseTabs (bool useTabs)
bool GetUseTabs ()
void SetLineIndentation (int line, int indentSize)
int GetLineIndentation (int line)
long GetLineIndentPosition (int line)
int GetColumn (long pos)
void SetHScrollBar (bool show)
bool GetHScrollBar ()
void SetIndentationGuides (bool show)
bool GetIndentationGuides ()
void SetHighlightGuide (int column)
int GetHighlightGuide ()
int GetLineEndPosition (int line)
int GetCodePage ()
COLORREF GetCaretFore ()
bool GetUsePalette ()
bool GetReadOnly ()
void SetCurrentPos (long pos)
void SetSelectionStart (long pos)
long GetSelectionStart ()
void SetSelectionEnd (long pos)
long GetSelectionEnd ()
void SetPrintMagnification (int magnification)
int GetPrintMagnification ()
void SetPrintColourMode (int mode)
int GetPrintColourMode ()
long FindText (int flags, TextToFind *ft)
void FormatRange (bool draw, long fr)
int GetFirstVisibleLine ()
int GetLine (int line, char *text)
int GetLineCount ()
void SetMarginLeft (int pixelWidth)
int GetMarginLeft ()
void SetMarginRight (int pixelWidth)
int GetMarginRight ()
bool GetModify ()
void SetSel (long start, long end)
int GetSelText (char *text)
int GetTextRange (TextRange *tr)
void HideSelection (bool normal)
int PointXFromPosition (long pos)
int PointYFromPosition (long pos)
int LineFromPosition (long pos)
int PositionFromLine (int line)
void LineScroll (int columns, int lines)
void ScrollCaret ()
void ReplaceSel (const char *text)
void SetReadOnly (bool readOnly)
void Null ()
bool CanPaste ()
bool CanUndo ()
void EmptyUndoBuffer ()
void Undo ()
void Cut ()
void Copy ()
void Paste ()
void Clear ()
void SetText (const char *text)
int GetText (int length, char *text)
int GetTextLength ()
int GetDirectFunction ()
int GetDirectPointer ()
void SetOvertype (bool overtype)
bool GetOvertype ()
void SetCaretWidth (int pixelWidth)
int GetCaretWidth ()
void SetTargetStart (long pos)
long GetTargetStart ()
void SetTargetEnd (long pos)
long GetTargetEnd ()
int ReplaceTarget (int length, const char *text)
int ReplaceTargetRE (int length, const char *text)
int SearchInTarget (int length, const char *text)
void SetSearchFlags (int flags)
int GetSearchFlags ()
void CallTipShow (long pos, const char *definition)
void CallTipCancel ()
bool CallTipActive ()
long CallTipPosStart ()
void CallTipSetHlt (int start, int end)
void CallTipSetBack (COLORREF back)
int VisibleFromDocLine (int line)
int DocLineFromVisible (int lineDisplay)
void SetFoldLevel (int line, int level)
int GetFoldLevel (int line)
int GetLastChild (int line, int level)
int GetFoldParent (int line)
void ShowLines (int lineStart, int lineEnd)
void HideLines (int lineStart, int lineEnd)
bool GetLineVisible (int line)
void SetFoldExpanded (int line, bool expanded)
bool GetFoldExpanded (int line)
void ToggleFold (int line)
void EnsureVisible (int line)
void SetFoldFlags (int flags)
void EnsureVisibleEnforcePolicy (int line)
void SetTabIndents (bool tabIndents)
bool GetTabIndents ()
void SetBackSpaceUnIndents (bool bsUnIndents)
bool GetBackSpaceUnIndents ()
void SetMouseDwellTime (int periodMilliseconds)
int GetMouseDwellTime ()
void LineDown ()
void LineDownExtend ()
void LineUp ()
void LineUpExtend ()
void CharLeft ()
void CharLeftExtend ()
void CharRight ()
void CharRightExtend ()
void WordLeft ()
void WordLeftExtend ()
void WordRight ()
void WordRightExtend ()
void Home ()
void HomeExtend ()
void LineEnd ()
void LineEndExtend ()
void DocumentStart ()
void DocumentStartExtend ()
void DocumentEnd ()
void DocumentEndExtend ()
void PageUp ()
void PageUpExtend ()
void PageDown ()
void PageDownExtend ()
void EditToggleOvertype ()
void Cancel ()
void DeleteBack ()
void Tab ()
void BackTab ()
void NewLine ()
void FormFeed ()
void VCHome ()
void VCHomeExtend ()
void ZoomIn ()
void ZoomOut ()
void DelWordLeft ()
void DelWordRight ()
void LineCut ()
void LineDelete ()
void LineTranspose ()
void LowerCase ()
void UpperCase ()
void LineScrollDown ()
void LineScrollUp ()
void MoveCaretInsideView ()
int LineLength (int line)
void BraceHighlight (long pos1, long pos2)
void BraceBadLight (long pos)
long BraceMatch (long pos)
bool GetViewEOL ()
void SetViewEOL (bool visible)
int GetDocPointer ()
void SetDocPointer (int pointer)
void SetModEventMask (int mask)
int GetEdgeColumn ()
void SetEdgeColumn (int column)
int GetEdgeMode ()
void SetEdgeMode (int mode)
COLORREF GetEdgeColour ()
void SetEdgeColour (COLORREF edgeColour)
void SearchAnchor ()
int SearchNext (int flags, const char *text)
int SearchPrev (int flags, const char *text)
void SetCaretPolicy (int caretPolicy, int caretSlop)
int LinesOnScreen ()
void UsePopUp (bool allowPopUp)
bool SelectionIsRectangle ()
void SetZoom (int zoom)
int GetZoom ()
int CreateDocument ()
void AddRefDocument (int doc)
void ReleaseDocument (int doc)
int GetModEventMask ()
void SetFocus (bool focus)
bool GetFocus ()
void SetStatus (int statusCode)
int GetStatus ()
void SetMouseDownCaptures (bool captures)
bool GetMouseDownCaptures ()
void SetCursor (int cursorType)
int GetCursor ()
void WordPartLeft ()
void WordPartLeftExtend ()
void WordPartRight ()
void WordPartRightExtend ()
void SetVisiblePolicy (int visiblePolicy, int visibleSlop)
void DelLineLeft ()
void DelLineRight ()
void GrabFocus ()
void StartRecord ()
void StopRecord ()
void SetLexer (int lexer)
int GetLexer ()
void Colourise (long start, long end)
void SetProperty (const char *key, const char *value)
void SetKeyWords (int keywordSet, const char *keyWords)
void SetLexerLanguage (const char *language)

Protected Methods

void GetRange (int start, int end, char *text)
 Locally used method to get a range of text.


Protected Attributes

HWND hWnd
 Handle of the relevant scintilla window.

void * m_Pointer
 Used for Scintilla's GetDirectPointer.

scmsgfn Perform
 Function pointer to Scintilla window message pump.

bool m_Modified
 Is text modified?


Static Protected Attributes

HMODULE scidll = NULL
 Handle of the loaded scilexer.dll.

int refs = 0
 Reference counter.


Detailed Description

CScintilla is a non-MFC Scintilla wrapper for C++, it still requires assistance from a window loop in the containing window. The code for many methods is derived from / taken from code found in Scite.


Member Function Documentation

void CScintilla::AddRefDocument int   doc
 

Extend life of document.

void CScintilla::AddStyledText int   length,
char *   c
 

Add array of cells to document

void CScintilla::AddText int   length,
const char *   text
 

Add text to the document

void CScintilla::AssignCmdKey DWORD   km,
int   msg
 

When key+modifier combination km is pressed perform msg.

bool CScintilla::AutoCActive  
 

Is there an auto-completion list visible?

void CScintilla::AutoCCancel  
 

Remove the auto-completion list from the screen.

void CScintilla::AutoCComplete  
 

User has selected an item so remove the list and insert the selection.

bool CScintilla::AutoCGetAutoHide  
 

Retrieve whether or not autocompletion is hidden automatically when nothing matches

bool CScintilla::AutoCGetCancelAtStart  
 

Retrieve whether auto-completion cancelled by backspacing before start.

bool CScintilla::AutoCGetChooseSingle  
 

Retrieve whether a single item auto-completion list automatically choose the item.

bool CScintilla::AutoCGetIgnoreCase  
 

Retrieve state of ignore case flag.

int CScintilla::AutoCGetSeparator  
 

Retrieve the auto-completion list separator character.

long CScintilla::AutoCPosStart  
 

Retrieve the position of the caret when the auto-completion list was displayed.

void CScintilla::AutoCSelect const char *   text
 

Select the item in the auto-completion list that starts with a string.

void CScintilla::AutoCSetAutoHide bool   autoHide
 

Set whether or not autocompletion is hidden automatically when nothing matches

void CScintilla::AutoCSetCancelAtStart bool   cancel
 

Should the auto-completion list be cancelled if the user backspaces to a position before where the box was created.

void CScintilla::AutoCSetChooseSingle bool   chooseSingle
 

Should a single item auto-completion list automatically choose the item.

void CScintilla::AutoCSetFillUps const char *   characterSet
 

Define a set of character that when typed fills up the selected word.

void CScintilla::AutoCSetIgnoreCase bool   ignoreCase
 

Set whether case is significant when performing auto-completion searches.

void CScintilla::AutoCSetSeparator int   separatorCharacter
 

Change the separator character in the string setting up an auto-completion list. Default is space but can be changed if items contain space.

void CScintilla::AutoCShow int   lenEntered,
const char *   itemList
 

Display a auto-completion list. The lenEntered parameter indicates how many characters before the caret should be used to provide context.

void CScintilla::AutoCStops const char *   characterSet
 

Define a set of character that when typed cancel the auto-completion list.

void CScintilla::BackTab  
 

Dedent the selected lines.

void CScintilla::BeginUndoAction  
 

Start a sequence of actions that is undone and redone as a unit. May be nested.

void CScintilla::BraceBadLight long   pos
 

Highlight the character at a position indicating there is no matching brace.

void CScintilla::BraceHighlight long   pos1,
long   pos2
 

Highlight the characters at two positions.

long CScintilla::BraceMatch long   pos
 

Find the position of a matching brace or INVALID_POSITION if no match.

bool CScintilla::CallTipActive  
 

Is there an active call tip?

void CScintilla::CallTipCancel  
 

Remove the call tip from the screen.

long CScintilla::CallTipPosStart  
 

Retrieve the position where the caret was before displaying the call tip.

void CScintilla::CallTipSetBack COLORREF   back
 

Set the background colour for the call tip.

void CScintilla::CallTipSetHlt int   start,
int   end
 

Highlight a segment of the definition.

void CScintilla::CallTipShow long   pos,
const char *   definition
 

Show a call tip containing a definition near position pos.

bool CScintilla::CanPaste  
 

Will a paste succeed?

bool CScintilla::CanRedo  
 

Are there any redoable actions in the undo history.

bool CScintilla::CanUndo  
 

Are there any undoable actions in the undo history.

void CScintilla::Cancel  
 

Cancel any modes such as call tip or auto-completion list display.

void CScintilla::CharLeft  
 

Move caret left one character.

void CScintilla::CharLeftExtend  
 

Move caret left one character extending selection to new caret position.

void CScintilla::CharRight  
 

Move caret right one character.

void CScintilla::CharRightExtend  
 

Move caret right one character extending selection to new caret position.

void CScintilla::Clear  
 

Clear the selection.

void CScintilla::ClearAll  
 

Delete all text in the document

void CScintilla::ClearAllCmdKeys  
 

Drop all key mappings.

void CScintilla::ClearCmdKey DWORD   km
 

When key+modifier combination km do nothing.

void CScintilla::ClearDocumentStyle  
 

Set all style bytes to 0, remove all folding information

void CScintilla::Colourise long   start,
long   end
 

Colourise a segment of the document using the current lexing language.

void CScintilla::ConvertEOLs int   eolMode
 

Convert all line endings in the document to one mode.

void CScintilla::Copy  
 

Copy the selection to the clipboard.

int CScintilla::CreateDocument  
 

Create a new document object. Starts with reference count of 1 and not selected into editor.

void CScintilla::Cut  
 

Cut the selection to the clipboard.

void CScintilla::DefineMarker int   marker,
int   markerType,
COLORREF   fore,
COLORREF   back
 

Function taken from Scite to combine three marker define operations

void CScintilla::DelLineLeft  
 

Delete back from the current position to the start of the line

void CScintilla::DelLineRight  
 

Delete forwards from the current position to the end of the line

void CScintilla::DelWordLeft  
 

Delete the word to the left of the caret.

void CScintilla::DelWordRight  
 

Delete the word to the right of the caret.

void CScintilla::DeleteBack  
 

Delete the selection or if no selection, the character before the caret.

int CScintilla::DocLineFromVisible int   lineDisplay
 

Find the document line of a display line taking hidden lines into account.

void CScintilla::DocumentEnd  
 

Move caret to last position in document.

void CScintilla::DocumentEndExtend  
 

Move caret to last position in document extending selection to new caret position.

void CScintilla::DocumentStart  
 

Move caret to first position in document.

void CScintilla::DocumentStartExtend  
 

Move caret to first position in document extending selection to new caret position.

void CScintilla::EditToggleOvertype  
 

Switch from insert to overtype mode or the reverse.

void CScintilla::EmptyUndoBuffer  
 

Delete the undo history.

void CScintilla::EndUndoAction  
 

End a sequence of actions that is undone and redone as a unit.

void CScintilla::EnsureVisible int   line
 

Ensure a particular line is visible by expanding any header line hiding it.

void CScintilla::EnsureVisibleEnforcePolicy int   line
 

Ensure a particular line is visible by expanding any header line hiding it. Use the currently set visibility policy to determine which range to display.

long CScintilla::FindText int   flags,
TextToFind *   ft
 

Find some text in the document.

void CScintilla::FormFeed  
 

Insert a Form Feed character.

void CScintilla::FormatRange bool   draw,
long   fr
 

On Windows will draw the document into a display context such as a printer.

long CScintilla::GetAnchor  
 

Returns the position of the opposite end of the selection to the caret

bool CScintilla::GetBackSpaceUnIndents  
 

Does a backspace pressed when caret is within indentation unindent?

bool CScintilla::GetBufferedDraw  
 

Is drawing done first into a buffer or direct to the screen.

COLORREF CScintilla::GetCaretFore  
 

Get the foreground colour of the caret.

COLORREF CScintilla::GetCaretLineBack  
 

Get the colour of the background of the line containing the caret.

bool CScintilla::GetCaretLineVisible  
 

Is the background of the line containing the caret in a different colour?

int CScintilla::GetCaretPeriod  
 

Get the time in milliseconds that the caret is on and off.

int CScintilla::GetCaretWidth  
 

Returns the width of the insert mode caret

int CScintilla::GetCharAt long   pos
 

Returns the character byte at the position

int CScintilla::GetCodePage  
 

Get the code page used to interpret the bytes of the document as characters.

int CScintilla::GetColumn long   pos
 

Retrieve the column number of a position, taking tab width into account.

int CScintilla::GetCurLine int   length,
char *   text
 

Retrieve the text of the line containing the caret. Returns the index of the caret on the line.

long CScintilla::GetCurrentPos  
 

Returns the position of the caret

int CScintilla::GetCursor  
 

Get cursor type

int CScintilla::GetDirectFunction  
 

Retrieve a pointer to a function that processes messages for this Scintilla.

int CScintilla::GetDirectPointer  
 

Retrieve a pointer value to use as the first argument when calling the function returned by GetDirectFunction.

int CScintilla::GetDocPointer  
 

Retrieve a pointer to the document object.

int CScintilla::GetEOLMode  
 

Retrieve the current end of line mode - one of CRLF, CR, or LF.

COLORREF CScintilla::GetEdgeColour  
 

Retrieve the colour used in edge indication.

int CScintilla::GetEdgeColumn  
 

Retrieve the column number which text should be kept within.

int CScintilla::GetEdgeMode  
 

Retrieve the edge highlight mode.

long CScintilla::GetEndStyled  
 

Retrieve the position of the last correctly styled character.

int CScintilla::GetFirstVisibleLine  
 

Retrieve the line at the top of the display.

bool CScintilla::GetFocus  
 

Get internal focus flag

bool CScintilla::GetFoldExpanded int   line
 

Is a header line expanded?

int CScintilla::GetFoldLevel int   line
 

Retrieve the fold level of a line.

int CScintilla::GetFoldParent int   line
 

Find the parent line of a child line.

bool CScintilla::GetHScrollBar  
 

Is the horizontal scroll bar visible?

int CScintilla::GetHighlightGuide  
 

Get the highlighted indentation guide column.

int CScintilla::GetIndent  
 

Retrieve indentation size.

bool CScintilla::GetIndentationGuides  
 

Are the indentation guides visible?

int CScintilla::GetLastChild int   line,
int   level
 

Find the last child line of a header line.

int CScintilla::GetLength  
 

The number of characters in the document

int CScintilla::GetLexer  
 

Retrieve the lexing language of the document.

int CScintilla::GetLine int   line,
char *   text
 

Retrieve the contents of a line. Returns the length of the line.

int CScintilla::GetLineCount  
 

Returns the number of lines in the document. There is always at least one.

int CScintilla::GetLineEndPosition int   line
 

Get the position after the last visible characters on a line.

long CScintilla::GetLineIndentPosition int   line
 

Retrieve the position before the first non indentation character on a line.

int CScintilla::GetLineIndentation int   line
 

Retrieve the number of columns that a line is indented.

int CScintilla::GetLineState int   line
 

Retrieve the extra styling information for a line.

bool CScintilla::GetLineVisible int   line
 

Is a line visible?

int CScintilla::GetMarginLeft  
 

Returns the size in pixels of the left margin.

int CScintilla::GetMarginMaskN int   margin
 

Retrieve the marker mask of a margin.

int CScintilla::GetMarginRight  
 

Returns the size in pixels of the right margin.

bool CScintilla::GetMarginSensitiveN int   margin
 

Retrieve the mouse click sensitivity of a margin.

int CScintilla::GetMarginTypeN int   margin
 

Retrieve the type of a margin.

int CScintilla::GetMarginWidthN int   margin
 

Retrieve the width of a margin in pixels.

int CScintilla::GetMaxLineState  
 

Retrieve the last line number that has line state.

int CScintilla::GetModEventMask  
 

Get which document modification events are sent to the container.

bool CScintilla::GetModify  
 

Is the document different from when it was last saved?

bool CScintilla::GetMouseDownCaptures  
 

Get whether mouse gets captured

int CScintilla::GetMouseDwellTime  
 

Retrieve the time the mouse must sit still to generate a mouse dwell event

bool CScintilla::GetOvertype  
 

Returns true if overtype mode is active otherwise false is returned.

int CScintilla::GetPrintColourMode  
 

Returns the print colour mode.

int CScintilla::GetPrintMagnification  
 

Returns the print magnification.

bool CScintilla::GetReadOnly  
 

In read-only mode?

int CScintilla::GetSearchFlags  
 

Get the search flags used by SearchInTarget

int CScintilla::GetSelText char *   text
 

Retrieve the selected text. Return the length of the text.

long CScintilla::GetSelectionEnd  
 

Returns the position at the end of the selection.

long CScintilla::GetSelectionStart  
 

Returns the position at the start of the selection.

int CScintilla::GetStatus  
 

Get error status

int CScintilla::GetStyleAt long   pos
 

Returns the style byte at the position

int CScintilla::GetStyleBits  
 

Retrieve number of bits in style bytes used to hold the lexical state.

int CScintilla::GetStyledText TextRange *   tr
 

Retrieve a buffer of cells. Returns the number of bytes in the buffer not including terminating nulls.

bool CScintilla::GetTabIndents  
 

Does a tab pressed when caret is within indentation indent?

int CScintilla::GetTabWidth  
 

Retrieve the visible size of a tab.

long CScintilla::GetTargetEnd  
 

Get the position that ends the target.

long CScintilla::GetTargetStart  
 

Get the position that starts the target.

int CScintilla::GetText int   length,
char *   text
 

Retrieve all the text in the document. Returns number of characters retrieved.

int CScintilla::GetTextLength  
 

Retrieve the number of characters in the document.

int CScintilla::GetTextRange TextRange *   tr
 

Retrieve a range of text. Return the length of the text.

bool CScintilla::GetUndoCollection  
 

Is undo history being collected?

bool CScintilla::GetUsePalette  
 

In palette mode?

bool CScintilla::GetUseTabs  
 

Retrieve whether tabs will be used in indentation.

bool CScintilla::GetViewEOL  
 

Are the end of line characters visible.

int CScintilla::GetViewWS  
 

Are white space characters currently visible? Returns one of SCWS_* constants.

int CScintilla::GetZoom  
 

Retrieve the zoom level.

void CScintilla::GotoLine int   line
 

Set caret to start of a line and ensure it is visible.

void CScintilla::GotoPos long   pos
 

Set caret to a position and ensure it is visible.

void CScintilla::GrabFocus  
 

Set the focus to this Scintilla widget. GTK+ Specific

void CScintilla::HandleNotify LPARAM   lParam
 

HandleNotify currently only updates the Modified flag of CScintilla.

void CScintilla::HideLines int   lineStart,
int   lineEnd
 

Make a range of lines invisible.

void CScintilla::HideSelection bool   normal
 

Draw the selection in normal style or with selection highlighted.

void CScintilla::Home  
 

Move caret to first position on line.

void CScintilla::HomeExtend  
 

Move caret to first position on line extending selection to new caret position.

COLORREF CScintilla::IndicGetFore int   indic
 

Retrieve the foreground colour of an indicator.

int CScintilla::IndicGetStyle int   indic
 

Retrieve the style of an indicator.

void CScintilla::IndicSetFore int   indic,
COLORREF   fore
 

Set the foreground colour of an indicator.

void CScintilla::IndicSetStyle int   indic,
int   style
 

Set an indicator to plain, squiggle or TT.

void CScintilla::InsertText long   pos,
const char *   text
 

Insert string at a position

bool CScintilla::IsScintillaNotify LPARAM   lParam
 

Is the control modified - gained from HandleNotify function. A using class should call IsScintillaNotify on a Notify message (WM_NOTIFY) and should then call HandleNotify if the result is true.

void CScintilla::LineCut  
 

Cut the line containing the caret.

void CScintilla::LineDelete  
 

Delete the line containing the caret.

void CScintilla::LineDown  
 

Move caret down one line.

void CScintilla::LineDownExtend  
 

Move caret down one line extending selection to new caret position.

void CScintilla::LineEnd  
 

Move caret to last position on line.

void CScintilla::LineEndExtend  
 

Move caret to last position on line extending selection to new caret position.

int CScintilla::LineFromPosition long   pos
 

Retrieve the line containing a position.

int CScintilla::LineLength int   line
 

How many characters are on a line, not including end of line characters.

void CScintilla::LineScroll int   columns,
int   lines
 

Scroll horizontally and vertically.

void CScintilla::LineScrollDown  
 

Scroll the document down, keeping the caret visible.

void CScintilla::LineScrollUp  
 

Scroll the document up, keeping the caret visible.

void CScintilla::LineTranspose  
 

Switch the current line with the previous.

void CScintilla::LineUp  
 

Move caret up one line.

void CScintilla::LineUpExtend  
 

Move caret up one line extending selection to new caret position.

int CScintilla::LinesOnScreen  
 

Retrieves the number of lines completely visible.

void CScintilla::LowerCase  
 

Transform the selection to lower case.

void CScintilla::MarkerAdd int   line,
int   markerNumber
 

Add a marker to a line.

void CScintilla::MarkerDefine int   markerNumber,
int   markerSymbol
 

Set the symbol used for a particular marker number.

void CScintilla::MarkerDelete int   line,
int   markerNumber
 

Delete a marker from a line

void CScintilla::MarkerDeleteAll int   markerNumber
 

Delete all markers with a particular number from all lines

void CScintilla::MarkerDeleteHandle int   handle
 

Delete a marker.

int CScintilla::MarkerGet int   line
 

Get a bit mask of all the markers set on a line.

int CScintilla::MarkerLineFromHandle int   handle
 

Retrieve the line number at which a particular marker is located

int CScintilla::MarkerNext int   lineStart,
int   markerMask
 

Find the next line after lineStart that includes a marker in mask.

int CScintilla::MarkerPrevious int   lineStart,
int   markerMask
 

Find the previous line before lineStart that includes a marker in mask.

void CScintilla::MarkerSetBack int   markerNumber,
COLORREF   back
 

Set the background colour used for a particular marker number.

void CScintilla::MarkerSetFore int   markerNumber,
COLORREF   fore
 

Set the foreground colour used for a particular marker number.

void CScintilla::MoveCaretInsideView  
 

Move the caret inside current view if it's not there already

void CScintilla::NewLine  
 

Insert a new line, may use a CRLF, CR or LF depending on EOL mode.

void CScintilla::Null  
 

Null operation.

void CScintilla::PageDown  
 

Move caret one page down.

void CScintilla::PageDownExtend  
 

Move caret one page down extending selection to new caret position.

void CScintilla::PageUp  
 

Move caret one page up.

void CScintilla::PageUpExtend  
 

Move caret one page up extending selection to new caret position.

void CScintilla::Paste  
 

Paste the contents of the clipboard into the document replacing the selection.

int CScintilla::PointXFromPosition long   pos
 

Retrieve the x value of the point in the window where a position is displayed.

int CScintilla::PointYFromPosition long   pos
 

Retrieve the y value of the point in the window where a position is displayed.

int CScintilla::PositionFromLine int   line
 

Retrieve the position at the start of a line.

int CScintilla::PositionFromPoint int   x,
int   y
 

Find the position from a point within the window.

int CScintilla::PositionFromPointClose int   x,
int   y
 

Find the position from a point within the window but return INVALID_POSITION if not close to text.

void CScintilla::Redo  
 

Redoes the next action on the undo history

void CScintilla::ReleaseDocument int   doc
 

Release a reference to the document, deleting document if it fades to black.

void CScintilla::ReplaceSel const char *   text
 

Replace the selected text with the argument text.

int CScintilla::ReplaceTarget int   length,
const char *   text
 

Replace the target text with the argument text. Text is counted so it can contain nulls. Returns the length of the replacement text.

int CScintilla::ReplaceTargetRE int   length,
const char *   text
 

Replace the target text with the argument text after \d processing. Text is counted so it can contain nulls. Looks for \d where d is between 1 and 9 and replaces these with the strings matched in the last search operation which were surrounded by \( and \). Returns the length of the replacement text including any change caused by processing the \d patterns.

virtual long CScintilla::SPerform long   Msg,
WPARAM   wParam = 0,
LPARAM   lParam = 0
[inline, virtual]
 

SPerform uses either SendMessage or the function pointer (Perform) to run scintilla commands on the relevant scintilla control.

Reimplemented in CRecordingScintilla.

void CScintilla::ScrollCaret  
 

Ensure the caret is visible.

void CScintilla::SearchAnchor  
 

Sets the current caret position to be the search anchor.

int CScintilla::SearchInTarget int   length,
const char *   text
 

Search for a counted string in the target and set the target to the found range. Text is counted so it can contain nulls. Returns length of range or -1 for failure in which case target is not moved.

int CScintilla::SearchNext int   flags,
const char *   text
 

Find some text starting at the search anchor. Does not ensure the selection is visible.

int CScintilla::SearchPrev int   flags,
const char *   text
 

Find some text starting at the search anchor and moving backwards. Does not ensure the selection is visible.

void CScintilla::SelectAll  
 

Select all the text in the document.

bool CScintilla::SelectionIsRectangle  
 

Is the selection a rectangular. The alternative is the more common stream selection.

void CScintilla::SetAnchor long   posAnchor
 

Set the selection anchor to a position. The anchor is the opposite end of the selection from the caret.

void CScintilla::SetBackSpaceUnIndents bool   bsUnIndents
 

Sets whether a backspace pressed when caret is within indentation unindents

void CScintilla::SetBufferedDraw bool   buffered
 

If drawing is buffered then each line of text is drawn into a bitmap buffer before drawing it to the screen to avoid flicker.

void CScintilla::SetCaretFore COLORREF   fore
 

Set the foreground colour of the caret.

void CScintilla::SetCaretLineBack COLORREF   back
 

Set the colour of the background of the line containing the caret.

void CScintilla::SetCaretLineVisible bool   show
 

Dsplay the background of the line containing the caret in a different colour.

void CScintilla::SetCaretPeriod int   periodMilliseconds
 

Get the time in milliseconds that the caret is on and off. 0 = steady on.

void CScintilla::SetCaretPolicy int   caretPolicy,
int   caretSlop
 

Set the way the line the caret is on is kept visible.

void CScintilla::SetCaretWidth int   pixelWidth
 

Set the width of the insert mode caret

void CScintilla::SetCodePage int   codePage
 

Set the code page used to interpret the bytes of the document as characters. The SC_CP_UTF8 value can be used to enter Unicode mode.

void CScintilla::SetCurrentPos long   pos
 

Sets the position of the caret.

void CScintilla::SetCursor int   cursorType
 

Sets the cursor to one of the SC_CURSOR* values

void CScintilla::SetDocPointer int   pointer
 

Change the document object used.

void CScintilla::SetEOLMode int   eolMode
 

Set the current end of line mode.

void CScintilla::SetEdgeColour COLORREF   edgeColour
 

Change the colour used in edge indication.

void CScintilla::SetEdgeColumn int   column
 

Set the column number of the edge. If text goes past the edge then it is highlighted.

void CScintilla::SetEdgeMode int   mode
 

The edge may be displayed by a line (EDGE_LINE) or by highlighting text that goes beyond it (EDGE_BACKGROUND) or not displayed at all (EDGE_NONE).

void CScintilla::SetFocus bool   focus
 

Change internal focus flag

void CScintilla::SetFoldExpanded int   line,
bool   expanded
 

Show the children of a header line.

void CScintilla::SetFoldFlags int   flags
 

Set some debugging options for folding

void CScintilla::SetFoldLevel int   line,
int   level
 

Set the fold level of a line. This encodes an integer level along with flags indicating whether the line is a header and whether it is effectively white space.

void CScintilla::SetFoldingMargins EFoldStyle   style
 

Set the Folding Margins.

Call SetFoldingMargins to have CScintilla automatically set up the folding margin indicators in one of several given styles. The function also enables folding by setting the fold and fold.compact properties in Scintilla. Finally, it sets the fold flags to 16.

By default, CScintilla handles all notification messages related to folding and implements Scite-Style folding control.

Parameters:
style   Style is one value from the EFoldStyle enumeration

void CScintilla::SetHScrollBar bool   show
 

Show or hide the horizontal scroll bar.

void CScintilla::SetHighlightGuide int   column
 

Set the highlighted indentation guide column. 0 = no highlighted guide.

void CScintilla::SetIndent int   indentSize
 

Set the number of spaces used for one level of indentation.

void CScintilla::SetIndentationGuides bool   show
 

Show or hide indentation guides.

void CScintilla::SetKeyWords int   keywordSet,
const char *   keyWords
 

Set up the key words used by the lexer.

void CScintilla::SetLexer int   lexer
 

Set the lexing language of the document.

void CScintilla::SetLexerLanguage const char *   language
 

Set the lexing language of the document based on string name.

void CScintilla::SetLineIndentation int   line,
int   indentSize
 

Change the indentation of a line to a number of columns.

void CScintilla::SetLineState int   line,
int   state
 

Used to hold extra styling information for each line.

void CScintilla::SetMarginLeft int   pixelWidth
 

Sets the size in pixels of the left margin.

void CScintilla::SetMarginMaskN int   margin,
int   mask
 

Set a mask that determines which markers are displayed in a margin.

void CScintilla::SetMarginRight int   pixelWidth
 

Sets the size in pixels of the right margin.

void CScintilla::SetMarginSensitiveN int   margin,
bool   sensitive
 

Make a margin sensitive or insensitive to mouse clicks.

void CScintilla::SetMarginTypeN int   margin,
int   marginType
 

Set a margin to be either numeric or symbolic.

void CScintilla::SetMarginWidthN int   margin,
int   pixelWidth
 

Set the width of a margin to a width expressed in pixels.

void CScintilla::SetModEventMask int   mask
 

Set which document modification events are sent to the container.

void CScintilla::SetMouseDownCaptures bool   captures
 

Set whether the mouse is captured when its button is pressed

void CScintilla::SetMouseDwellTime int   periodMilliseconds
 

Sets the time the mouse must sit still to generate a mouse dwell event

void CScintilla::SetOvertype bool   overtype
 

Set to overtype (true) or insert mode

void CScintilla::SetPrintColourMode int   mode
 

Modify colours when printing for clearer printed text.

void CScintilla::SetPrintMagnification int   magnification
 

Sets the print magnification added to the point size of each style for printing.

void CScintilla::SetProperty const char *   key,
const char *   value
 

Set up a value that may be used by a lexer for some optional feature.

void CScintilla::SetReadOnly bool   readOnly
 

Set to read only or read write.

void CScintilla::SetSavePoint  
 

Remember the current position in the undo history as the position at which the document was saved.

void CScintilla::SetSearchFlags int   flags
 

Set the search flags used by SearchInTarget

void CScintilla::SetSel long   start,
long   end
 

Select a range of text.

void CScintilla::SetSelBack bool   useSetting,
COLORREF   back
 

Set the background colour of the selection and whether to use this setting.

void CScintilla::SetSelFore bool   useSetting,
COLORREF   fore
 

Set the foreground colour of the selection and whether to use this setting.

void CScintilla::SetSelectionEnd long   pos
 

Sets the position that ends the selection - this becomes the currentPosition.

void CScintilla::SetSelectionStart long   pos
 

Sets the position that starts the selection - this becomes the anchor.

void CScintilla::SetStatus int   statusCode
 

Change error status - 0 = OK

void CScintilla::SetStyleBits int   bits
 

Divide each styling byte into lexical class bits (default:5) and indicator bits (default:3). If a lexer requires more than 32 lexical states, then this is used to expand the possible states.

void CScintilla::SetStyling int   length,
int   style
 

Change style from current styling position for length characters to a style and move the current styling position to after this newly styled segment.

void CScintilla::SetStylingEx int   length,
const char *   styles
 

Set the styles for a segment of the document.

void CScintilla::SetTabIndents bool   tabIndents
 

Sets whether a tab pressed when caret is within indentation indents

void CScintilla::SetTabWidth int   tabWidth
 

Change the visible size of a tab to be a multiple of the width of a space character.

void CScintilla::SetTargetEnd long   pos
 

Sets the position that ends the target which is used for updating the document without affecting the scroll position.

void CScintilla::SetTargetStart long   pos
 

Sets the position that starts the target which is used for updating the document without affecting the scroll position.

void CScintilla::SetText const char *   text
 

Replace the contents of the document with the argument text.

void CScintilla::SetUndoCollection bool   collectUndo
 

Choose between collecting actions into the undo history and discarding them.

void CScintilla::SetUsePalette bool   usePalette
 

In palette mode, Scintilla uses the environments palette calls to display more colours. This may lead to ugly displays.

void CScintilla::SetUseTabs bool   useTabs
 

Indentation will only use space characters if useTabs is false, otherwise it will use a combination of tabs and spaces.

void CScintilla::SetViewEOL bool   visible
 

Make the end of line characters visible or invisible

void CScintilla::SetViewWS int   viewWS
 

Make white space characters invisible, always visible or visible outside indentation.

void CScintilla::SetVisiblePolicy int   visiblePolicy,
int   visibleSlop
 

Set the way the display area is determined when a particular line is to be moved to.

void CScintilla::SetWordChars const char *   characters
 

Set the set of characters making up words for when moving or selecting by word.

void CScintilla::SetZoom int   zoom
 

Set the zoom level. This number of points is added to the size of all fonts. It may be positive to magnify or negative to reduce.

void CScintilla::ShowLines int   lineStart,
int   lineEnd
 

Make a range of lines visible.

void CScintilla::StartRecord  
 

Start notifying the container of all key presses and commands.

void CScintilla::StartStyling long   pos,
int   mask
 

Set the current styling position to pos and the styling mask to mask. The styling mask can be used to protect some bits in each styling byte from modification.

void CScintilla::StopRecord  
 

Stop notifying the container of all key presses and commands.

void CScintilla::StyleClearAll  
 

Clear all the styles and make equivalent to the global default style.

void CScintilla::StyleResetDefault  
 

Reset the default style to its state at startup

void CScintilla::StyleSetBack int   style,
COLORREF   back
 

Set the background colour of a style.

void CScintilla::StyleSetBold int   style,
bool   bold
 

Set a style to be bold or not.

void CScintilla::StyleSetCase int   style,
int   caseForce
 

Set a style to be mixed case, or to force upper or lower case.

void CScintilla::StyleSetCharacterSet int   style,
int   characterSet
 

Set the character set of the font in a style.

void CScintilla::StyleSetEOLFilled int   style,
bool   filled
 

Set a style to have its end of line filled or not.

void CScintilla::StyleSetFont int   style,
const char *   fontName
 

Set the font of a style.

void CScintilla::StyleSetFore int   style,
COLORREF   fore
 

Set the foreground colour of a style.

void CScintilla::StyleSetItalic int   style,
bool   italic
 

Set a style to be italic or not.

void CScintilla::StyleSetSize int   style,
int   sizePoints
 

Set the size of characters of a style.

void CScintilla::StyleSetUnderline int   style,
bool   underline
 

Set a style to be underlined or not.

void CScintilla::StyleSetVisible int   style,
bool   visible
 

Set a style to be visible or not.

void CScintilla::Tab  
 

If selection is empty or all on one line replace the selection with a tab character. If more than one line selected, indent the lines.

void CScintilla::ToggleFold int   line
 

Switch a header line between expanded and contracted.

void CScintilla::Undo  
 

Undo one action in the undo history.

void CScintilla::UpperCase  
 

Transform the selection to upper case.

void CScintilla::UsePopUp bool   allowPopUp
 

Set whether a pop up menu is displayed automatically when the user presses the wrong mouse button.

void CScintilla::UserListShow int   listType,
const char *   itemList
 

Display a list of strings and send notification when user chooses one.

void CScintilla::VCHome  
 

Move caret to before first visible character on line. If already there move to first character on line.

void CScintilla::VCHomeExtend  
 

Like VCHome but extending selection to new caret position.

int CScintilla::VisibleFromDocLine int   line
 

Find the display line of a document line taking hidden lines into account.

void CScintilla::WordLeft  
 

Move caret left one word.

void CScintilla::WordLeftExtend  
 

Move caret left one word extending selection to new caret position.

void CScintilla::WordPartLeft  
 

Move to the previous change in capitalistion

void CScintilla::WordPartLeftExtend  
 

Move to the previous change in capitalistion extending selection to new caret position.

void CScintilla::WordPartRight  
 

Move to the change next in capitalistion

void CScintilla::WordPartRightExtend  
 

Move to the next change in capitalistion extending selection to new caret position.

void CScintilla::WordRight  
 

Move caret right one word.

void CScintilla::WordRightExtend  
 

Move caret right one word extending selection to new caret position.

void CScintilla::ZoomIn  
 

Magnify the displayed text by increasing the sizes by 1 point.

void CScintilla::ZoomOut  
 

Make the displayed text smaller by decreasing the sizes by 1 point.


The documentation for this class was generated from the following files:
Generated at Thu Aug 30 15:52:45 2001 for sciwrapper by doxygen1.2.10 written by Dimitri van Heesch, © 1997-2001