Code::Blocks  SVN r11506
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Friends | List of all members
wxScintilla Class Reference

#include <wxscintilla.h>

Inheritance diagram for wxScintilla:
Collaboration diagram for wxScintilla:

Public Member Functions

 wxScintilla (wxWindow *parent, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxString &name=wxSCINameStr)
 
 wxScintilla ()
 
 ~wxScintilla ()
 
bool Create (wxWindow *parent, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxString &name=wxSCINameStr)
 
void AddText (const wxString &text)
 Generated method declaration section {{{. More...
 
void AddStyledText (const wxMemoryBuffer &data)
 Add array of cells to document. More...
 
void InsertText (int pos, const wxString &text)
 Insert string at a position. More...
 
void ChangeInsertion (int length, const wxString &text)
 Change the text that is being inserted in response to wxSCI_MOD_INSERTCHECK. More...
 
void ClearAll ()
 Delete all text in the document. More...
 
void DeleteRange (int start, int lengthDelete)
 Delete a range of text in the document. More...
 
void ClearDocumentStyle ()
 Set all style bytes to 0, remove all folding information. More...
 
int GetLength () const
 Returns the number of bytes in the document. More...
 
int GetCharAt (int pos) const
 Returns the character byte at the position. More...
 
int GetCurrentPos () const
 Returns the position of the caret. More...
 
int GetAnchor () const
 Returns the position of the opposite end of the selection to the caret. More...
 
int GetStyleAt (int pos) const
 Returns the style byte at the position. More...
 
void Redo ()
 Redoes the next action on the undo history. More...
 
void SetUndoCollection (bool collectUndo)
 Choose between collecting actions into the undo history and discarding them. More...
 
void SetChangeCollection (bool collectChange)
 Choose between collecting actions into the changes history and discarding them. More...
 
int FindChangedLine (const int fromLine, const int toLine) const
 Find a changed line, if fromLine > toLine search is performed backwards. More...
 
void SelectAll ()
 Select all the text in the document. More...
 
void SetSavePoint ()
 Remember the current position in the undo history as the position at which the document was saved. More...
 
wxMemoryBuffer GetStyledText (int startPos, int endPos)
 Retrieve a buffer of cells. More...
 
bool CanRedo () const
 Are there any redoable actions in the undo history? More...
 
int MarkerLineFromHandle (int markerHandle)
 Retrieve the line number at which a particular marker is located. More...
 
void MarkerDeleteHandle (int markerHandle)
 Delete a marker. More...
 
bool GetUndoCollection () const
 Is undo history being collected? More...
 
int GetViewWhiteSpace () const
 Are white space characters currently visible? Returns one of wxSCI_WS_* constants. More...
 
void SetViewWhiteSpace (int viewWS)
 Make white space characters invisible, always visible or visible outside indentation. More...
 
int GetTabDrawMode () const
 Retrieve the current tab draw mode. More...
 
void SetTabDrawMode (int tabDrawMode)
 Set how tabs are drawn when visible. More...
 
int PositionFromPoint (wxPoint pt) const
 Find the position from a point within the window. More...
 
int PositionFromPointClose (int x, int y)
 Find the position from a point within the window but return wxSCI_INVALID_POSITION if not close to text. More...
 
void GotoLine (int line)
 Set caret to start of a line and ensure it is visible. More...
 
void GotoPos (int caret)
 Set caret to a position and ensure it is visible. More...
 
void SetAnchor (int anchor)
 Set the selection anchor to a position. More...
 
wxString GetCurLine (int *linePos=NULL)
 Retrieve the text of the line containing the caret. More...
 
int GetEndStyled () const
 Retrieve the position of the last correctly styled character. More...
 
void ConvertEOLs (int eolMode)
 Convert all line endings in the document to one mode. More...
 
int GetEOLMode () const
 Retrieve the current end of line mode - one of wxSCI_EOL_CRLF, wxSCI_EOL_CR, or wxSCI_EOL_LF. More...
 
void SetEOLMode (int eolMode)
 Set the current end of line mode. More...
 
void StartStyling (int start)
 Set the current styling position to start. More...
 
void 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. More...
 
bool GetBufferedDraw () const
 Is drawing done first into a buffer or direct to the screen? More...
 
void 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. More...
 
void SetTabWidth (int tabWidth)
 Change the visible size of a tab to be a multiple of the width of a space character. More...
 
int GetTabWidth () const
 Retrieve the visible size of a tab. More...
 
void ClearTabStops (int line)
 Clear explicit tabstops on a line. More...
 
void AddTabStop (int line, int x)
 Add an explicit tab stop for a line. More...
 
int GetNextTabStop (int line, int x)
 Find the next explicit tab stop position on a line after a position. More...
 
void SetCodePage (int codePage)
 Set the code page used to interpret the bytes of the document as characters. More...
 
int GetIMEInteraction () const
 Is the IME displayed in a window or inline? More...
 
void SetIMEInteraction (int imeInteraction)
 Choose to display the the IME in a winow or inline. More...
 
void MarkerDefine (int markerNumber, int markerSymbol, const wxColour &foreground=wxNullColour, const wxColour &background=wxNullColour)
 Set the symbol used for a particular marker number, and optionally the fore and background colours. More...
 
void MarkerSetForeground (int markerNumber, const wxColour &fore)
 Set the foreground colour used for a particular marker number. More...
 
void MarkerSetBackground (int markerNumber, const wxColour &back)
 Set the background colour used for a particular marker number. More...
 
void MarkerSetBackgroundSelected (int markerNumber, const wxColour &back)
 Set the background colour used for a particular marker number when its folding block is selected. More...
 
void MarkerEnableHighlight (bool enabled)
 Enable/disable highlight for current folding bloc (smallest one that contains the caret) More...
 
int MarkerAdd (int line, int markerNumber)
 Add a marker to a line, returning an ID which can be used to find or delete the marker. More...
 
void MarkerDelete (int line, int markerNumber)
 Delete a marker from a line. More...
 
void MarkerDeleteAll (int markerNumber)
 Delete all markers with a particular number from all lines. More...
 
int MarkerGet (int line)
 Get a bit mask of all the markers set on a line. More...
 
int MarkerNext (int lineStart, int markerMask)
 Find the next line at or after lineStart that includes a marker in mask. More...
 
int MarkerPrevious (int lineStart, int markerMask)
 Find the previous line before lineStart that includes a marker in mask. More...
 
void MarkerDefineBitmap (int markerNumber, const wxBitmap &bmp)
 Define a marker from a bitmap. More...
 
void MarkerAddSet (int line, int markerSet)
 Add a set of markers to a line. More...
 
void MarkerSetAlpha (int markerNumber, int alpha)
 Set the alpha used for a marker that is drawn in the text area, not the margin. More...
 
void SetMarginType (int margin, int marginType)
 Set a margin to be either numeric or symbolic. More...
 
int GetMarginType (int margin) const
 Retrieve the type of a margin. More...
 
void SetMarginWidth (int margin, int pixelWidth)
 Set the width of a margin to a width expressed in pixels. More...
 
int GetMarginWidth (int margin) const
 Retrieve the width of a margin in pixels. More...
 
void SetMarginMask (int margin, int mask)
 Set a mask that determines which markers are displayed in a margin. More...
 
int GetMarginMask (int margin) const
 Retrieve the marker mask of a margin. More...
 
void SetMarginSensitive (int margin, bool sensitive)
 Make a margin sensitive or insensitive to mouse clicks. More...
 
bool GetMarginSensitive (int margin) const
 Retrieve the mouse click sensitivity of a margin. More...
 
void SetMarginCursor (int margin, int cursor)
 Set the cursor shown when the mouse is inside a margin. More...
 
int GetMarginCursor (int margin) const
 Retrieve the cursor shown in a margin. More...
 
void SetMarginBackground (int margin, const wxColour &back)
 Set the background colour of a margin. Only visible for wxSCI_MARGIN_COLOUR. More...
 
wxColour GetMarginBackground (int margin) const
 Retrieve the background colour of a margin. More...
 
void SetMarginCount (int margins)
 Allocate a non-standard number of margins. More...
 
int GetMarginCount () const
 How many margins are there?. More...
 
void StyleClearAll ()
 Clear all the styles and make equivalent to the global default style. More...
 
void StyleSetForeground (int style, const wxColour &fore)
 Set the foreground colour of a style. More...
 
void StyleSetBackground (int style, const wxColour &back)
 Set the background colour of a style. More...
 
void StyleSetBold (int style, bool bold)
 Set a style to be bold or not. More...
 
void StyleSetItalic (int style, bool italic)
 Set a style to be italic or not. More...
 
void StyleSetSize (int style, int sizePoints)
 Set the size of characters of a style. More...
 
void StyleSetFaceName (int style, const wxString &fontName)
 Set the font of a style. More...
 
void StyleSetEOLFilled (int style, bool eolFilled)
 Set a style to have its end of line filled or not. More...
 
void StyleResetDefault ()
 Reset the default style to its state at startup. More...
 
void StyleSetUnderline (int style, bool underline)
 Set a style to be underlined or not. More...
 
wxColour StyleGetForeground (int style) const
 Get the foreground colour of a style. More...
 
wxColour StyleGetBackground (int style) const
 Get the background colour of a style. More...
 
bool StyleGetBold (int style) const
 Get is a style bold or not. More...
 
bool StyleGetItalic (int style) const
 Get is a style italic or not. More...
 
int StyleGetSize (int style) const
 Get the size of characters of a style. More...
 
wxString StyleGetFaceName (int style)
 Get the font facename of a style. More...
 
bool StyleGetEOLFilled (int style) const
 Get is a style to have its end of line filled or not. More...
 
bool StyleGetUnderline (int style) const
 Get is a style underlined or not. More...
 
int StyleGetCase (int style) const
 Get is a style mixed case, or to force upper or lower case. More...
 
int StyleGetCharacterSet (int style) const
 Get the character get of the font in a style. More...
 
bool StyleGetVisible (int style) const
 Get is a style visible or not. More...
 
bool StyleGetChangeable (int style) const
 Get is a style changeable or not (read only). More...
 
bool StyleGetHotSpot (int style) const
 Get is a style a hotspot or not. More...
 
void StyleSetCase (int style, int caseVisible)
 Set a style to be mixed case, or to force upper or lower case. More...
 
void StyleSetSizeFractional (int style, int sizeHundredthPoints)
 Set the size of characters of a style. Size is in points multiplied by 100. More...
 
int StyleGetSizeFractional (int style) const
 Get the size of characters of a style in points multiplied by 100. More...
 
void StyleSetWeight (int style, int weight)
 Set the weight of characters of a style. More...
 
int StyleGetWeight (int style) const
 Get the weight of characters of a style. More...
 
void StyleSetCharacterSet (int style, int characterSet)
 Set the character set of the font in a style. More...
 
void StyleSetHotSpot (int style, bool hotspot)
 Set a style to be a hotspot or not. More...
 
void SetSelForeground (bool useSetting, const wxColour &fore)
 Set the foreground colour of the main and additional selections and whether to use this setting. More...
 
void SetSelBackground (bool useSetting, const wxColour &back)
 Set the background colour of the main and additional selections and whether to use this setting. More...
 
int GetSelAlpha () const
 Get the alpha of the selection. More...
 
void SetSelAlpha (int alpha)
 Set the alpha of the selection. More...
 
bool GetSelEOLFilled () const
 Is the selection end of line filled? More...
 
void SetSelEOLFilled (bool filled)
 Set the selection to have its end of line filled or not. More...
 
void SetCaretForeground (const wxColour &fore)
 Set the foreground colour of the caret. More...
 
void CmdKeyAssign (int key, int modifiers, int cmd)
 When key+modifier combination keyDefinition is pressed perform sciCommand. More...
 
void CmdKeyClear (int key, int modifiers)
 When key+modifier combination keyDefinition is pressed do nothing. More...
 
void CmdKeyClearAll ()
 Drop all key mappings. More...
 
void SetStyleBytes (int length, char *styleBytes)
 Set the styles for a segment of the document. More...
 
void StyleSetVisible (int style, bool visible)
 Set a style to be visible or not. More...
 
int GetCaretPeriod () const
 Get the time in milliseconds that the caret is on and off. More...
 
void SetCaretPeriod (int periodMilliseconds)
 Get the time in milliseconds that the caret is on and off. 0 = steady on. More...
 
void SetWordChars (const wxString &characters)
 Set the set of characters making up words for when moving or selecting by word. More...
 
wxString GetWordChars () const
 Get the set of characters making up words for when moving or selecting by word. More...
 
void BeginUndoAction ()
 Start a sequence of actions that is undone and redone as a unit. More...
 
void EndUndoAction ()
 End a sequence of actions that is undone and redone as a unit. More...
 
void IndicatorSetStyle (int indicator, int indicatorStyle)
 Set an indicator to plain, squiggle or TT. More...
 
int IndicatorGetStyle (int indicator) const
 Retrieve the style of an indicator. More...
 
void IndicatorSetForeground (int indicator, const wxColour &fore)
 Set the foreground colour of an indicator. More...
 
wxColour IndicatorGetForeground (int indicator) const
 Retrieve the foreground colour of an indicator. More...
 
void IndicatorSetUnder (int indicator, bool under)
 Set an indicator to draw under text or over(default). More...
 
bool IndicatorGetUnder (int indicator) const
 Retrieve whether indicator drawn under or over text. More...
 
void IndicatorSetHoverStyle (int indicator, int indicatorStyle)
 Set a hover indicator to plain, squiggle or TT. More...
 
int IndicatorGetHoverStyle (int indicator) const
 Retrieve the hover style of an indicator. More...
 
void IndicatorSetHoverForeground (int indicator, const wxColour &fore)
 Set the foreground hover colour of an indicator. More...
 
wxColour IndicatorGetHoverForeground (int indicator) const
 Retrieve the foreground hover colour of an indicator. More...
 
void IndicatorSetFlags (int indicator, int flags)
 Set the attributes of an indicator. More...
 
int IndicatorGetFlags (int indicator) const
 Retrieve the attributes of an indicator. More...
 
void SetWhitespaceForeground (bool useSetting, const wxColour &fore)
 Set the foreground colour of all whitespace and whether to use this setting. More...
 
void SetWhitespaceBackground (bool useSetting, const wxColour &back)
 Set the background colour of all whitespace and whether to use this setting. More...
 
void SetWhitespaceSize (int size)
 Set the size of the dots used to mark space characters. More...
 
int GetWhitespaceSize () const
 Get the size of the dots used to mark space characters. More...
 
 wxDEPRECATED_MSG ("This method uses a function deprecated in the Scintilla library.") void SetStyleBits(int bits)
 Divide each styling byte into lexical class bits (default: 5) and indicator bits (default: 3). More...
 
 wxDEPRECATED_MSG ("This method uses a function deprecated in the Scintilla library.") int GetStyleBits() const
 Retrieve number of bits in style bytes used to hold the lexical state. More...
 
void SetLineState (int line, int state)
 Used to hold extra styling information for each line. More...
 
int GetLineState (int line) const
 Retrieve the extra styling information for a line. More...
 
int GetMaxLineState () const
 Retrieve the last line number that has line state. More...
 
bool GetCaretLineVisible () const
 Is the background of the line containing the caret in a different colour? More...
 
void SetCaretLineVisible (bool show)
 Display the background of the line containing the caret in a different colour. More...
 
wxColour GetCaretLineBackground () const
 Get the colour of the background of the line containing the caret. More...
 
void SetCaretLineBackground (const wxColour &back)
 Set the colour of the background of the line containing the caret. More...
 
void StyleSetChangeable (int style, bool changeable)
 Set a style to be changeable or not (read only). More...
 
void AutoCompShow (int lengthEntered, const wxString &itemList)
 Display a auto-completion list. More...
 
void AutoCompCancel ()
 Remove the auto-completion list from the screen. More...
 
bool AutoCompActive ()
 Is there an auto-completion list visible? More...
 
int AutoCompPosStart ()
 Retrieve the position of the caret when the auto-completion list was displayed. More...
 
void AutoCompComplete ()
 User has selected an item so remove the list and insert the selection. More...
 
void AutoCompStops (const wxString &characterSet)
 Define a set of character that when typed cancel the auto-completion list. More...
 
void AutoCompSetSeparator (int separatorCharacter)
 Change the separator character in the string setting up an auto-completion list. More...
 
int AutoCompGetSeparator () const
 Retrieve the auto-completion list separator character. More...
 
void AutoCompSelect (const wxString &select)
 Select the item in the auto-completion list that starts with a string. More...
 
void AutoCompSetCancelAtStart (bool cancel)
 Should the auto-completion list be cancelled if the user backspaces to a position before where the box was created. More...
 
bool AutoCompGetCancelAtStart () const
 Retrieve whether auto-completion cancelled by backspacing before start. More...
 
void AutoCompSetFillUps (const wxString &characterSet)
 Define a set of characters that when typed will cause the autocompletion to choose the selected item. More...
 
void AutoCompSetChooseSingle (bool chooseSingle)
 Should a single item auto-completion list automatically choose the item. More...
 
bool AutoCompGetChooseSingle () const
 Retrieve whether a single item auto-completion list automatically choose the item. More...
 
void AutoCompSetIgnoreCase (bool ignoreCase)
 Set whether case is significant when performing auto-completion searches. More...
 
bool AutoCompGetIgnoreCase () const
 Retrieve state of ignore case flag. More...
 
void UserListShow (int listType, const wxString &itemList)
 Display a list of strings and send notification when user chooses one. More...
 
void AutoCompSetAutoHide (bool autoHide)
 Set whether or not autocompletion is hidden automatically when nothing matches. More...
 
bool AutoCompGetAutoHide () const
 Retrieve whether or not autocompletion is hidden automatically when nothing matches. More...
 
void AutoCompSetDropRestOfWord (bool dropRestOfWord)
 Set whether or not autocompletion deletes any word characters after the inserted text upon completion. More...
 
bool AutoCompGetDropRestOfWord () const
 Retrieve whether or not autocompletion deletes any word characters after the inserted text upon completion. More...
 
void RegisterImage (int type, const wxBitmap &bmp)
 Register an image for use in autocompletion lists. More...
 
void ClearRegisteredImages ()
 Clear all the registered images. More...
 
int AutoCompGetTypeSeparator () const
 Retrieve the auto-completion list type-separator character. More...
 
void AutoCompSetTypeSeparator (int separatorCharacter)
 Change the type-separator character in the string setting up an auto-completion list. More...
 
void AutoCompSetMaxWidth (int characterCount)
 Set the maximum width, in characters, of auto-completion and user lists. More...
 
int AutoCompGetMaxWidth () const
 Get the maximum width, in characters, of auto-completion and user lists. More...
 
void AutoCompSetMaxHeight (int rowCount)
 Set the maximum height, in rows, of auto-completion and user lists. More...
 
int AutoCompGetMaxHeight () const
 Set the maximum height, in rows, of auto-completion and user lists. More...
 
void SetIndent (int indentSize)
 Set the number of spaces used for one level of indentation. More...
 
int GetIndent () const
 Retrieve indentation size. More...
 
void SetUseTabs (bool useTabs)
 Indentation will only use space characters if useTabs is false, otherwise it will use a combination of tabs and spaces. More...
 
bool GetUseTabs () const
 Retrieve whether tabs will be used in indentation. More...
 
void SetLineIndentation (int line, int indentation)
 Change the indentation of a line to a number of columns. More...
 
int GetLineIndentation (int line) const
 Retrieve the number of columns that a line is indented. More...
 
int GetLineIndentPosition (int line) const
 Retrieve the position before the first non indentation character on a line. More...
 
int GetColumn (int pos) const
 Retrieve the column number of a position, taking tab width into account. More...
 
int CountCharacters (int start, int end)
 Count characters between two positions. More...
 
void SetUseHorizontalScrollBar (bool visible)
 Show or hide the horizontal scroll bar. More...
 
bool GetUseHorizontalScrollBar () const
 Is the horizontal scroll bar visible? More...
 
void SetIndentationGuides (int indentView)
 Show or hide indentation guides. More...
 
int GetIndentationGuides () const
 Are the indentation guides visible? More...
 
void SetHighlightGuide (int column)
 Set the highlighted indentation guide column. More...
 
int GetHighlightGuide () const
 Get the highlighted indentation guide column. More...
 
int GetLineEndPosition (int line) const
 Get the position after the last visible characters on a line. More...
 
int GetCodePage () const
 Get the code page used to interpret the bytes of the document as characters. More...
 
wxColour GetCaretForeground () const
 Get the foreground colour of the caret. More...
 
bool GetReadOnly () const
 In read-only mode? More...
 
void SetCurrentPos (int caret)
 Sets the position of the caret. More...
 
void SetSelectionStart (int anchor)
 Sets the position that starts the selection - this becomes the anchor. More...
 
int GetSelectionStart () const
 Returns the position at the start of the selection. More...
 
void SetSelectionEnd (int caret)
 Sets the position that ends the selection - this becomes the caret. More...
 
int GetSelectionEnd () const
 Returns the position at the end of the selection. More...
 
void SetEmptySelection (int caret)
 Set caret to a position, while removing any existing selection. More...
 
void SetPrintMagnification (int magnification)
 Sets the print magnification added to the point size of each style for printing. More...
 
int GetPrintMagnification () const
 Returns the print magnification. More...
 
void SetPrintColourMode (int mode)
 Modify colours when printing for clearer printed text. More...
 
int GetPrintColourMode () const
 Returns the print colour mode. More...
 
int FindText (int minPos, int maxPos, const wxString &text, int flags=0, int *findEnd=NULL)
 Find some text in the document. More...
 
int FormatRange (bool doDraw, int startPos, int endPos, wxDC *draw, wxDC *target, wxRect renderRect, wxRect pageRect)
 On Windows, will draw the document into a display context such as a printer. More...
 
int GetFirstVisibleLine () const
 Retrieve the display line at the top of the display. More...
 
wxString GetLine (int line) const
 Retrieve the contents of a line. More...
 
int GetLineCount () const
 Returns the number of lines in the document. There is always at least one. More...
 
void SetMarginLeft (int pixelWidth)
 Sets the size in pixels of the left margin. More...
 
int GetMarginLeft () const
 Returns the size in pixels of the left margin. More...
 
void SetMarginRight (int pixelWidth)
 Sets the size in pixels of the right margin. More...
 
int GetMarginRight () const
 Returns the size in pixels of the right margin. More...
 
bool GetModify () const
 Is the document different from when it was last saved? More...
 
wxString GetSelectedText ()
 Retrieve the selected text. More...
 
wxString GetTextRange (int startPos, int endPos)
 Retrieve a range of text. More...
 
void HideSelection (bool hide)
 Draw the selection in normal style or with selection highlighted. More...
 
wxPoint PointFromPosition (int pos)
 Retrieve the point in the window where a position is displayed. More...
 
int LineFromPosition (int pos) const
 Retrieve the line containing a position. More...
 
int PositionFromLine (int line) const
 Retrieve the position at the start of a line. More...
 
void LineScroll (int columns, int lines)
 Scroll horizontally and vertically. More...
 
void EnsureCaretVisible ()
 Ensure the caret is visible. More...
 
void ScrollRange (int secondary, int primary)
 Scroll the argument positions and the range between them into view giving priority to the primary position then the secondary position. More...
 
void ReplaceSelection (const wxString &text)
 Replace the selected text with the argument text. More...
 
void SetReadOnly (bool readOnly)
 Set to read only or read write. More...
 
bool CanPaste () const
 Will a paste succeed? More...
 
bool CanUndo () const
 Are there any undoable actions in the undo history? More...
 
void EmptyUndoBuffer (bool collectChangeHistory=false)
 Delete the undo history. More...
 
void Undo ()
 Undo one action in the undo history. More...
 
void Cut ()
 Cut the selection to the clipboard. More...
 
void Copy ()
 Copy the selection to the clipboard. More...
 
void Paste ()
 Paste the contents of the clipboard into the document replacing the selection. More...
 
void Clear ()
 Clear the selection. More...
 
void SetText (const wxString &text)
 Replace the contents of the document with the argument text. More...
 
wxString GetText () const
 Retrieve all the text in the document. More...
 
int GetTextLength () const
 Retrieve the number of characters in the document. More...
 
void * GetDirectFunction () const
 Retrieve a pointer to a function that processes messages for this Scintilla. More...
 
void * GetDirectPointer () const
 Retrieve a pointer value to use as the first argument when calling the function returned by GetDirectFunction. More...
 
void SetOvertype (bool overType)
 Set to overtype (true) or insert mode. More...
 
bool GetOvertype () const
 Returns true if overtype mode is active otherwise false is returned. More...
 
void SetCaretWidth (int pixelWidth)
 Set the width of the insert mode caret. More...
 
int GetCaretWidth () const
 Returns the width of the insert mode caret. More...
 
void SetTargetStart (int start)
 Sets the position that starts the target which is used for updating the document without affecting the scroll position. More...
 
int GetTargetStart () const
 Get the position that starts the target. More...
 
void SetTargetEnd (int end)
 Sets the position that ends the target which is used for updating the document without affecting the scroll position. More...
 
int GetTargetEnd () const
 Get the position that ends the target. More...
 
void SetTargetRange (int start, int end)
 Sets both the start and end of the target in one call. More...
 
wxString GetTargetText () const
 Retrieve the text in the target. More...
 
void TargetFromSelection ()
 Make the target range start and end be the same as the selection range start and end. More...
 
void TargetWholeDocument ()
 Sets the target to the whole document. More...
 
int ReplaceTarget (const wxString &text)
 Replace the target text with the argument text. More...
 
int ReplaceTargetRE (const wxString &text)
 Replace the target text with the argument text after \d processing. More...
 
int SearchInTarget (const wxString &text)
 Search for a counted string in the target and set the target to the found range. More...
 
void SetSearchFlags (int searchFlags)
 Set the search flags used by SearchInTarget. More...
 
int GetSearchFlags () const
 Get the search flags used by SearchInTarget. More...
 
void CallTipShow (int pos, const wxString &definition)
 Show a call tip containing a definition near position pos. More...
 
void CallTipCancel ()
 Remove the call tip from the screen. More...
 
bool CallTipActive ()
 Is there an active call tip? More...
 
int CallTipPosAtStart ()
 Retrieve the position where the caret was before displaying the call tip. More...
 
void CallTipSetPosAtStart (int posStart)
 Set the start position in order to change when backspacing removes the calltip. More...
 
void CallTipSetHighlight (int highlightStart, int highlightEnd)
 Highlight a segment of the definition. More...
 
void CallTipSetBackground (const wxColour &back)
 Set the background colour for the call tip. More...
 
void CallTipSetForeground (const wxColour &fore)
 Set the foreground colour for the call tip. More...
 
void CallTipSetForegroundHighlight (const wxColour &fore)
 Set the foreground colour for the highlighted part of the call tip. More...
 
void CallTipUseStyle (int tabSize)
 Enable use of wxSCI_STYLE_CALLTIP and set call tip tab size in pixels. More...
 
void CallTipSetPosition (bool above)
 Set position of calltip, above or below text. More...
 
int VisibleFromDocLine (int docLine)
 Find the display line of a document line taking hidden lines into account. More...
 
int DocLineFromVisible (int displayLine)
 Find the document line of a display line taking hidden lines into account. More...
 
int WrapCount (int docLine)
 The number of display lines needed to wrap a document line. More...
 
void SetFoldLevel (int line, int level)
 Set the fold level of a line. More...
 
int GetFoldLevel (int line) const
 Retrieve the fold level of a line. More...
 
int GetLastChild (int line, int level) const
 Find the last child line of a header line. More...
 
int GetFoldParent (int line) const
 Find the parent line of a child line. More...
 
void ShowLines (int lineStart, int lineEnd)
 Make a range of lines visible. More...
 
void HideLines (int lineStart, int lineEnd)
 Make a range of lines invisible. More...
 
bool GetLineVisible (int line) const
 Is a line visible? More...
 
bool GetAllLinesVisible () const
 Are all lines visible? More...
 
void SetFoldExpanded (int line, bool expanded)
 Show the children of a header line. More...
 
bool GetFoldExpanded (int line) const
 Is a header line expanded? More...
 
void ToggleFold (int line)
 Switch a header line between expanded and contracted. More...
 
void ToggleFoldShowText (int line, const wxString &text)
 Switch a header line between expanded and contracted and show some text after the line. More...
 
void FoldDisplayTextSetStyle (int style)
 Set the style of fold display text. More...
 
void FoldLine (int line, int action)
 Expand or contract a fold header. More...
 
void FoldChildren (int line, int action)
 Expand or contract a fold header and its children. More...
 
void ExpandChildren (int line, int level)
 Expand a fold header and all children. Use the level argument instead of the line's current level. More...
 
void FoldAll (int action)
 Expand or contract all fold headers. More...
 
void EnsureVisible (int line)
 Ensure a particular line is visible by expanding any header line hiding it. More...
 
void SetAutomaticFold (int automaticFold)
 Set automatic folding behaviours. More...
 
int GetAutomaticFold () const
 Get automatic folding behaviours. More...
 
void SetFoldFlags (int flags)
 Set some style options for folding. More...
 
void EnsureVisibleEnforcePolicy (int line)
 Ensure a particular line is visible by expanding any header line hiding it. More...
 
void SetTabIndents (bool tabIndents)
 Sets whether a tab pressed when caret is within indentation indents. More...
 
bool GetTabIndents () const
 Does a tab pressed when caret is within indentation indent? More...
 
void SetBackSpaceUnIndents (bool bsUnIndents)
 Sets whether a backspace pressed when caret is within indentation unindents. More...
 
bool GetBackSpaceUnIndents () const
 Does a backspace pressed when caret is within indentation unindent? More...
 
void SetMouseDwellTime (int periodMilliseconds)
 Sets the time the mouse must sit still to generate a mouse dwell event. More...
 
int GetMouseDwellTime () const
 Retrieve the time the mouse must sit still to generate a mouse dwell event. More...
 
int WordStartPosition (int pos, bool onlyWordCharacters)
 Get position of start of word. More...
 
int WordEndPosition (int pos, bool onlyWordCharacters)
 Get position of end of word. More...
 
bool IsRangeWord (int start, int end)
 Is the range start..end considered a word? More...
 
void SetIdleStyling (int idleStyling)
 Sets limits to idle styling. More...
 
int GetIdleStyling () const
 Retrieve the limits to idle styling. More...
 
void SetWrapMode (int wrapMode)
 Sets whether text is word wrapped. More...
 
int GetWrapMode () const
 Retrieve whether text is word wrapped. More...
 
void SetWrapVisualFlags (int wrapVisualFlags)
 Set the display mode of visual flags for wrapped lines. More...
 
int GetWrapVisualFlags () const
 Retrive the display mode of visual flags for wrapped lines. More...
 
void SetWrapVisualFlagsLocation (int wrapVisualFlagsLocation)
 Set the location of visual flags for wrapped lines. More...
 
int GetWrapVisualFlagsLocation () const
 Retrive the location of visual flags for wrapped lines. More...
 
void SetWrapStartIndent (int indent)
 Set the start indent for wrapped lines. More...
 
int GetWrapStartIndent () const
 Retrive the start indent for wrapped lines. More...
 
void SetWrapIndentMode (int wrapIndentMode)
 Sets how wrapped sublines are placed. Default is wxSCI_WRAPINDENT_FIXED. More...
 
int GetWrapIndentMode () const
 Retrieve how wrapped sublines are placed. Default is wxSCI_WRAPINDENT_FIXED. More...
 
void SetLayoutCache (int cacheMode)
 Sets the degree of caching of layout information. More...
 
int GetLayoutCache () const
 Retrieve the degree of caching of layout information. More...
 
void SetScrollWidth (int pixelWidth)
 Sets the document width assumed for scrolling. More...
 
int GetScrollWidth () const
 Retrieve the document width assumed for scrolling. More...
 
void SetScrollWidthTracking (bool tracking)
 Sets whether the maximum width line displayed is used to set scroll width. More...
 
bool GetScrollWidthTracking () const
 Retrieve whether the scroll width tracks wide lines. More...
 
int TextWidth (int style, const wxString &text)
 Measure the pixel width of some text in a particular style. More...
 
void SetEndAtLastLine (bool endAtLastLine)
 Sets the scroll range so that maximum scroll position has the last line at the bottom of the view (default). More...
 
bool GetEndAtLastLine () const
 Retrieve whether the maximum scroll position has the last line at the bottom of the view. More...
 
int TextHeight (int line)
 Retrieve the height of a particular line of text in pixels. More...
 
void SetUseVerticalScrollBar (bool visible)
 Show or hide the vertical scroll bar. More...
 
bool GetUseVerticalScrollBar () const
 Is the vertical scroll bar visible? More...
 
void AppendText (const wxString &text)
 Append a string to the end of the document without changing the selection. More...
 
bool GetTwoPhaseDraw () const
 Is drawing done in two phases with backgrounds drawn before foregrounds? More...
 
void SetTwoPhaseDraw (bool twoPhase)
 In twoPhaseDraw mode, drawing is performed in two phases, first the background and then the foreground. More...
 
int GetPhasesDraw () const
 How many phases is drawing done in? More...
 
void SetPhasesDraw (int phases)
 In one phase draw, text is drawn in a series of rectangular blocks with no overlap. More...
 
void SetFontQuality (int fontQuality)
 Choose the quality level for text. More...
 
int GetFontQuality () const
 Retrieve the quality level for text. More...
 
void SetFirstVisibleLine (int displayLine)
 Scroll so that a display line is at the top of the display. More...
 
void SetMultiPaste (int multiPaste)
 Change the effect of pasting when there are multiple selections. More...
 
int GetMultiPaste () const
 Retrieve the effect of pasting when there are multiple selections. More...
 
wxString GetTag (int tagNumber) const
 Retrieve the value of a tag from a regular expression search. More...
 
void LinesJoin ()
 Join the lines in the target. More...
 
void LinesSplit (int pixelWidth)
 Split the lines in the target into lines that are less wide than pixelWidth where possible. More...
 
void SetFoldMarginColour (bool useSetting, const wxColour &back)
 Set one of the colours used as a chequerboard pattern in the fold margin. More...
 
void SetFoldMarginHiColour (bool useSetting, const wxColour &fore)
 Set the other colour used as a chequerboard pattern in the fold margin. More...
 
void LineDown ()
 Move caret down one line. More...
 
void LineDownExtend ()
 Move caret down one line extending selection to new caret position. More...
 
void LineUp ()
 Move caret up one line. More...
 
void LineUpExtend ()
 Move caret up one line extending selection to new caret position. More...
 
void CharLeft ()
 Move caret left one character. More...
 
void CharLeftExtend ()
 Move caret left one character extending selection to new caret position. More...
 
void CharRight ()
 Move caret right one character. More...
 
void CharRightExtend ()
 Move caret right one character extending selection to new caret position. More...
 
void WordLeft ()
 Move caret left one word. More...
 
void WordLeftExtend ()
 Move caret left one word extending selection to new caret position. More...
 
void WordRight ()
 Move caret right one word. More...
 
void WordRightExtend ()
 Move caret right one word extending selection to new caret position. More...
 
void Home ()
 Move caret to first position on line. More...
 
void HomeExtend ()
 Move caret to first position on line extending selection to new caret position. More...
 
void LineEnd ()
 Move caret to last position on line. More...
 
void LineEndExtend ()
 Move caret to last position on line extending selection to new caret position. More...
 
void DocumentStart ()
 Move caret to first position in document. More...
 
void DocumentStartExtend ()
 Move caret to first position in document extending selection to new caret position. More...
 
void DocumentEnd ()
 Move caret to last position in document. More...
 
void DocumentEndExtend ()
 Move caret to last position in document extending selection to new caret position. More...
 
void PageUp ()
 Move caret one page up. More...
 
void PageUpExtend ()
 Move caret one page up extending selection to new caret position. More...
 
void PageDown ()
 Move caret one page down. More...
 
void PageDownExtend ()
 Move caret one page down extending selection to new caret position. More...
 
void EditToggleOvertype ()
 Switch from insert to overtype mode or the reverse. More...
 
void Cancel ()
 Cancel any modes such as call tip or auto-completion list display. More...
 
void DeleteBack ()
 Delete the selection or if no selection, the character before the caret. More...
 
void Tab ()
 If selection is empty or all on one line replace the selection with a tab character. More...
 
void BackTab ()
 Dedent the selected lines. More...
 
void NewLine ()
 Insert a new line, may use a CRLF, CR or LF depending on EOL mode. More...
 
void FormFeed ()
 Insert a Form Feed character. More...
 
void VCHome ()
 Move caret to before first visible character on line. More...
 
void VCHomeExtend ()
 Like VCHome but extending selection to new caret position. More...
 
void ZoomIn ()
 Magnify the displayed text by increasing the sizes by 1 point. More...
 
void ZoomOut ()
 Make the displayed text smaller by decreasing the sizes by 1 point. More...
 
void DelWordLeft ()
 Delete the word to the left of the caret. More...
 
void DelWordRight ()
 Delete the word to the right of the caret. More...
 
void DelWordRightEnd ()
 Delete the word to the right of the caret, but not the trailing non-word characters. More...
 
void LineCut ()
 Cut the line containing the caret. More...
 
void LineDelete ()
 Delete the line containing the caret. More...
 
void LineTranspose ()
 Switch the current line with the previous. More...
 
void LineDuplicate ()
 Duplicate the current line. More...
 
void LowerCase ()
 Transform the selection to lower case. More...
 
void UpperCase ()
 Transform the selection to upper case. More...
 
void LineScrollDown ()
 Scroll the document down, keeping the caret visible. More...
 
void LineScrollUp ()
 Scroll the document up, keeping the caret visible. More...
 
void DeleteBackNotLine ()
 Delete the selection or if no selection, the character before the caret. More...
 
void HomeDisplay ()
 Move caret to first position on display line. More...
 
void HomeDisplayExtend ()
 Move caret to first position on display line extending selection to new caret position. More...
 
void LineEndDisplay ()
 Move caret to last position on display line. More...
 
void LineEndDisplayExtend ()
 Move caret to last position on display line extending selection to new caret position. More...
 
void HomeWrap ()
 Like Home but when word-wrap is enabled goes first to start of display line HomeDisplay, then to start of document line Home. More...
 
void HomeWrapExtend ()
 Like HomeExtend but when word-wrap is enabled extends first to start of display line HomeDisplayExtend, then to start of document line HomeExtend. More...
 
void LineEndWrap ()
 Like LineEnd but when word-wrap is enabled goes first to end of display line LineEndDisplay, then to start of document line LineEnd. More...
 
void LineEndWrapExtend ()
 Like LineEndExtend but when word-wrap is enabled extends first to end of display line LineEndDisplayExtend, then to start of document line LineEndExtend. More...
 
void VCHomeWrap ()
 Like VCHome but when word-wrap is enabled goes first to start of display line VCHomeDisplay, then behaves like VCHome. More...
 
void VCHomeWrapExtend ()
 Like VCHomeExtend but when word-wrap is enabled extends first to start of display line VCHomeDisplayExtend, then behaves like VCHomeExtend. More...
 
void LineCopy ()
 Copy the line containing the caret. More...
 
void MoveCaretInsideView ()
 Move the caret inside current view if it's not there already. More...
 
int LineLength (int line) const
 How many characters are on a line, including end of line characters? More...
 
void BraceHighlight (int posA, int posB)
 Highlight the characters at two positions. More...
 
void BraceHighlightIndicator (bool useSetting, int indicator)
 Use specified indicator to highlight matching braces instead of changing their style. More...
 
void BraceBadLight (int pos)
 Highlight the character at a position indicating there is no matching brace. More...
 
void BraceBadLightIndicator (bool useSetting, int indicator)
 Use specified indicator to highlight non matching brace instead of changing its style. More...
 
int BraceMatch (int pos, int maxReStyle=0)
 Find the position of a matching brace or wxSCI_INVALID_POSITION if no match. More...
 
bool GetViewEOL () const
 Are the end of line characters visible? More...
 
void SetViewEOL (bool visible)
 Make the end of line characters visible or invisible. More...
 
void * GetDocPointer ()
 Retrieve a pointer to the document object. More...
 
void SetDocPointer (void *docPointer)
 Change the document object used. More...
 
void SetModEventMask (int eventMask)
 Set which document modification events are sent to the container. More...
 
int GetEdgeColumn () const
 Retrieve the column number which text should be kept within. More...
 
void SetEdgeColumn (int column)
 Set the column number of the edge. More...
 
int GetEdgeMode () const
 Retrieve the edge highlight mode. More...
 
void SetEdgeMode (int edgeMode)
 The edge may be displayed by a line (wxSCI_EDGE_LINE/wxSCI_EDGE_MULTILINE) or by highlighting text that goes beyond it (wxSCI_EDGE_BACKGROUND) or not displayed at all (wxSCI_EDGE_NONE). More...
 
wxColour GetEdgeColour () const
 Retrieve the colour used in edge indication. More...
 
void SetEdgeColour (const wxColour &edgeColour)
 Change the colour used in edge indication. More...
 
void MultiEdgeAddLine (int column, const wxColour &edgeColour)
 Add a new vertical edge to the view. More...
 
void MultiEdgeClearAll ()
 Clear all vertical edges. More...
 
void SearchAnchor ()
 Sets the current caret position to be the search anchor. More...
 
int SearchNext (int searchFlags, const wxString &text)
 Find some text starting at the search anchor. More...
 
int SearchPrev (int searchFlags, const wxString &text)
 Find some text starting at the search anchor and moving backwards. More...
 
int LinesOnScreen () const
 Retrieves the number of lines completely visible. More...
 
void UsePopUp (int popUpMode)
 Set whether a pop up menu is displayed automatically when the user presses the wrong mouse button on certain areas. More...
 
bool SelectionIsRectangle () const
 Is the selection rectangular? The alternative is the more common stream selection. More...
 
void SetZoom (int zoomInPoints)
 Set the zoom level. More...
 
int GetZoom () const
 Retrieve the zoom level. More...
 
void * CreateDocument ()
 Create a new document object. More...
 
void AddRefDocument (void *docPointer)
 Extend life of document. More...
 
void ReleaseDocument (void *docPointer)
 Release a reference to the document, deleting document if it fades to black. More...
 
int GetModEventMask () const
 Get which document modification events are sent to the container. More...
 
void SetSCIFocus (bool focus)
 Change internal focus flag. More...
 
bool GetSCIFocus () const
 Get internal focus flag. More...
 
void SetStatus (int status)
 Change error status - 0 = OK. More...
 
int GetStatus () const
 Get error status. More...
 
void SetMouseDownCaptures (bool captures)
 Set whether the mouse is captured when its button is pressed. More...
 
bool GetMouseDownCaptures () const
 Get whether mouse gets captured. More...
 
void SetMouseWheelCaptures (bool captures)
 Set whether the mouse wheel can be active outside the window. More...
 
bool GetMouseWheelCaptures () const
 Get whether mouse wheel can be active outside the window. More...
 
void SetSCICursor (int cursorType)
 Sets the cursor to one of the wxSCI_CURSOR* values. More...
 
int GetSCICursor () const
 Get cursor type. More...
 
void SetControlCharSymbol (int symbol)
 Change the way control characters are displayed: If symbol is < 32, keep the drawn way, else, use the given character. More...
 
int GetControlCharSymbol () const
 Get the way control characters are displayed. More...
 
void WordPartLeft ()
 Move to the previous change in capitalisation. More...
 
void WordPartLeftExtend ()
 Move to the previous change in capitalisation extending selection to new caret position. More...
 
void WordPartRight ()
 Move to the change next in capitalisation. More...
 
void WordPartRightExtend ()
 Move to the next change in capitalisation extending selection to new caret position. More...
 
void SetVisiblePolicy (int visiblePolicy, int visibleSlop)
 Set the way the display area is determined when a particular line is to be moved to by Find, FindNext, GotoLine, etc. More...
 
void DelLineLeft ()
 Delete back from the current position to the start of the line. More...
 
void DelLineRight ()
 Delete forwards from the current position to the end of the line. More...
 
void SetXOffset (int xOffset)
 Set the xOffset (ie, horizontal scroll position). More...
 
int GetXOffset () const
 Get the xOffset (ie, horizontal scroll position). More...
 
void ChooseCaretX ()
 Set the last x chosen value to be the caret x position. More...
 
void SetXCaretPolicy (int caretPolicy, int caretSlop)
 Set the way the caret is kept visible when going sideways. More...
 
void SetYCaretPolicy (int caretPolicy, int caretSlop)
 Set the way the line the caret is on is kept visible. More...
 
void SetPrintWrapMode (int wrapMode)
 Set printing to line wrapped (wxSCI_WRAP_WORD) or not line wrapped (wxSCI_WRAP_NONE). More...
 
int GetPrintWrapMode () const
 Is printing line wrapped? More...
 
void SetHotspotActiveForeground (bool useSetting, const wxColour &fore)
 Set a fore colour for active hotspots. More...
 
wxColour GetHotspotActiveForeground () const
 Get the fore colour for active hotspots. More...
 
void SetHotspotActiveBackground (bool useSetting, const wxColour &back)
 Set a back colour for active hotspots. More...
 
wxColour GetHotspotActiveBackground () const
 Get the back colour for active hotspots. More...
 
void SetHotspotActiveUnderline (bool underline)
 Enable / Disable underlining active hotspots. More...
 
bool GetHotspotActiveUnderline () const
 Get whether underlining for active hotspots. More...
 
void SetHotspotSingleLine (bool singleLine)
 Limit hotspots to single line so hotspots on two lines don't merge. More...
 
bool GetHotspotSingleLine () const
 Get the HotspotSingleLine property. More...
 
void ParaDown ()
 Move caret down one paragraph (delimited by empty lines). More...
 
void ParaDownExtend ()
 Extend selection down one paragraph (delimited by empty lines). More...
 
void ParaUp ()
 Move caret up one paragraph (delimited by empty lines). More...
 
void ParaUpExtend ()
 Extend selection up one paragraph (delimited by empty lines). More...
 
int PositionBefore (int pos)
 Given a valid document position, return the previous position taking code page into account. More...
 
int PositionAfter (int pos)
 Given a valid document position, return the next position taking code page into account. More...
 
int PositionRelative (int pos, int relative)
 Given a valid document position, return a position that differs in a number of characters. More...
 
void CopyRange (int start, int end)
 Copy a range of text to the clipboard. Positions are clipped into the document. More...
 
void CopyText (int length, const wxString &text)
 Copy argument text to the clipboard. More...
 
void SetSelectionMode (int selectionMode)
 Set the selection mode to stream (wxSCI_SEL_STREAM) or rectangular (wxSCI_SEL_RECTANGLE/wxSCI_SEL_THIN) or by lines (wxSCI_SEL_LINES). More...
 
int GetSelectionMode () const
 Get the mode of the current selection. More...
 
int GetLineSelStartPosition (int line)
 Retrieve the position of the start of the selection at the given line (wxSCI_INVALID_POSITION if no selection on this line). More...
 
int GetLineSelEndPosition (int line)
 Retrieve the position of the end of the selection at the given line (wxSCI_INVALID_POSITION if no selection on this line). More...
 
void LineDownRectExtend ()
 Move caret down one line, extending rectangular selection to new caret position. More...
 
void LineUpRectExtend ()
 Move caret up one line, extending rectangular selection to new caret position. More...
 
void CharLeftRectExtend ()
 Move caret left one character, extending rectangular selection to new caret position. More...
 
void CharRightRectExtend ()
 Move caret right one character, extending rectangular selection to new caret position. More...
 
void HomeRectExtend ()
 Move caret to first position on line, extending rectangular selection to new caret position. More...
 
void VCHomeRectExtend ()
 Move caret to before first visible character on line. More...
 
void LineEndRectExtend ()
 Move caret to last position on line, extending rectangular selection to new caret position. More...
 
void PageUpRectExtend ()
 Move caret one page up, extending rectangular selection to new caret position. More...
 
void PageDownRectExtend ()
 Move caret one page down, extending rectangular selection to new caret position. More...
 
void StutteredPageUp ()
 Move caret to top of page, or one page up if already at top of page. More...
 
void StutteredPageUpExtend ()
 Move caret to top of page, or one page up if already at top of page, extending selection to new caret position. More...
 
void StutteredPageDown ()
 Move caret to bottom of page, or one page down if already at bottom of page. More...
 
void StutteredPageDownExtend ()
 Move caret to bottom of page, or one page down if already at bottom of page, extending selection to new caret position. More...
 
void WordLeftEnd ()
 Move caret left one word, position cursor at end of word. More...
 
void WordLeftEndExtend ()
 Move caret left one word, position cursor at end of word, extending selection to new caret position. More...
 
void WordRightEnd ()
 Move caret right one word, position cursor at end of word. More...
 
void WordRightEndExtend ()
 Move caret right one word, position cursor at end of word, extending selection to new caret position. More...
 
void SetWhitespaceChars (const wxString &characters)
 Set the set of characters making up whitespace for when moving or selecting by word. More...
 
wxString GetWhitespaceChars () const
 Get the set of characters making up whitespace for when moving or selecting by word. More...
 
void SetPunctuationChars (const wxString &characters)
 Set the set of characters making up punctuation characters Should be called after SetWordChars. More...
 
wxString GetPunctuationChars () const
 Get the set of characters making up punctuation characters. More...
 
void SetCharsDefault ()
 Reset the set of characters for whitespace and word characters to the defaults. More...
 
int AutoCompGetCurrent () const
 Get currently selected item position in the auto-completion list. More...
 
wxString AutoCompGetCurrentText () const
 Get currently selected item text in the auto-completion list. More...
 
void AutoCompSetCaseInsensitiveBehaviour (int behaviour)
 Set auto-completion case insensitive behaviour to either prefer case-sensitive matches or have no preference. More...
 
int AutoCompGetCaseInsensitiveBehaviour () const
 Get auto-completion case insensitive behaviour. More...
 
void AutoCompSetMulti (int multi)
 Change the effect of autocompleting when there are multiple selections. More...
 
int AutoCompGetMulti () const
 Retrieve the effect of autocompleting when there are multiple selections. More...
 
void AutoCompSetOrder (int order)
 Set the way autocompletion lists are ordered. More...
 
int AutoCompGetOrder () const
 Get the way autocompletion lists are ordered. More...
 
void Allocate (int bytes)
 Enlarge the document to a particular size of text bytes. More...
 
int FindColumn (int line, int column)
 Find the position of a column on a line taking into account tabs and multi-byte characters. More...
 
int GetCaretSticky () const
 Can the caret preferred x position only be changed by explicit movement commands? More...
 
void SetCaretSticky (int useCaretStickyBehaviour)
 Stop the caret preferred x position changing when the user types. More...
 
void ToggleCaretSticky ()
 Switch between sticky and non-sticky: meant to be bound to a key. More...
 
void SetPasteConvertEndings (bool convert)
 Enable/Disable convert-on-paste for line endings. More...
 
bool GetPasteConvertEndings () const
 Get convert-on-paste setting. More...
 
void SelectionDuplicate ()
 Duplicate the selection. If selection empty duplicate the line containing the caret. More...
 
void SetCaretLineBackAlpha (int alpha)
 Set background alpha of the caret line. More...
 
int GetCaretLineBackAlpha () const
 Get the background alpha of the caret line. More...
 
void SetCaretStyle (int caretStyle)
 Set the style of the caret to be drawn. More...
 
int GetCaretStyle () const
 Returns the current style of the caret. More...
 
void SetIndicatorCurrent (int indicator)
 Set the indicator used for IndicatorFillRange and IndicatorClearRange. More...
 
int GetIndicatorCurrent () const
 Get the current indicator. More...
 
void SetIndicatorValue (int value)
 Set the value used for IndicatorFillRange. More...
 
int GetIndicatorValue () const
 Get the current indicator value. More...
 
void IndicatorFillRange (int start, int lengthFill)
 Turn a indicator on over a range. More...
 
void IndicatorClearRange (int start, int lengthClear)
 Turn a indicator off over a range. More...
 
int IndicatorAllOnFor (int pos)
 Are any indicators present at pos? More...
 
int IndicatorValueAt (int indicator, int pos)
 What value does a particular indicator have at a position? More...
 
int IndicatorStart (int indicator, int pos)
 Where does a particular indicator start? More...
 
int IndicatorEnd (int indicator, int pos)
 Where does a particular indicator end? More...
 
void SetPositionCacheSize (int size)
 Set number of entries in position cache. More...
 
int GetPositionCacheSize () const
 How many entries are allocated to the position cache? More...
 
void CopyAllowLine ()
 Copy the selection, if selection empty copy the line with the caret. More...
 
const char * GetRangePointer (int position, int rangeLength) const
 Return a read-only pointer to a range of characters in the document. More...
 
int GetGapPosition () const
 Return a position which, to avoid performance costs, should not be within the range of a call to GetRangePointer. More...
 
void IndicatorSetAlpha (int indicator, int alpha)
 Set the alpha fill colour of the given indicator. More...
 
int IndicatorGetAlpha (int indicator) const
 Get the alpha fill colour of the given indicator. More...
 
void IndicatorSetOutlineAlpha (int indicator, int alpha)
 Set the alpha outline colour of the given indicator. More...
 
int IndicatorGetOutlineAlpha (int indicator) const
 Get the alpha outline colour of the given indicator. More...
 
void SetExtraAscent (int extraAscent)
 Set extra ascent for each line. More...
 
int GetExtraAscent () const
 Get extra ascent for each line. More...
 
void SetExtraDescent (int extraDescent)
 Set extra descent for each line. More...
 
int GetExtraDescent () const
 Get extra descent for each line. More...
 
int GetMarkerSymbolDefined (int markerNumber)
 Which symbol was defined for markerNumber with MarkerDefine. More...
 
void MarginSetText (int line, const wxString &text)
 Set the text in the text margin for a line. More...
 
wxString MarginGetText (int line) const
 Get the text in the text margin for a line. More...
 
void MarginSetStyle (int line, int style)
 Set the style number for the text margin for a line. More...
 
int MarginGetStyle (int line) const
 Get the style number for the text margin for a line. More...
 
void MarginSetStyles (int line, const wxString &styles)
 Set the style in the text margin for a line. More...
 
wxString MarginGetStyles (int line) const
 Get the styles in the text margin for a line. More...
 
void MarginTextClearAll ()
 Clear the margin text on all lines. More...
 
void MarginSetStyleOffset (int style)
 Get the start of the range of style numbers used for margin text. More...
 
int MarginGetStyleOffset () const
 Get the start of the range of style numbers used for margin text. More...
 
void SetMarginOptions (int marginOptions)
 Set the margin options. More...
 
int GetMarginOptions () const
 Get the margin options. More...
 
void AnnotationSetText (int line, const wxString &text)
 Set the annotation text for a line. More...
 
wxString AnnotationGetText (int line) const
 Get the annotation text for a line. More...
 
void AnnotationSetStyle (int line, int style)
 Set the style number for the annotations for a line. More...
 
int AnnotationGetStyle (int line) const
 Get the style number for the annotations for a line. More...
 
void AnnotationSetStyles (int line, const wxString &styles)
 Set the annotation styles for a line. More...
 
wxString AnnotationGetStyles (int line) const
 Get the annotation styles for a line. More...
 
int AnnotationGetLines (int line) const
 Get the number of annotation lines for a line. More...
 
void AnnotationClearAll ()
 Clear the annotations from all lines. More...
 
void AnnotationSetVisible (int visible)
 Set the visibility for the annotations for a view. More...
 
int AnnotationGetVisible () const
 Get the visibility for the annotations for a view. More...
 
void AnnotationSetStyleOffset (int style)
 Get the start of the range of style numbers used for annotations. More...
 
int AnnotationGetStyleOffset () const
 Get the start of the range of style numbers used for annotations. More...
 
void ReleaseAllExtendedStyles ()
 Release all extended (>255) style numbers. More...
 
int AllocateExtendedStyles (int numberStyles)
 Allocate some extended (>255) style numbers and return the start of the range. More...
 
void AddUndoAction (int token, int flags)
 Add a container action to the undo stack. More...
 
int CharPositionFromPoint (int x, int y)
 Find the position of a character from a point within the window. More...
 
int CharPositionFromPointClose (int x, int y)
 Find the position of a character from a point within the window. More...
 
void SetMouseSelectionRectangularSwitch (bool mouseSelectionRectangularSwitch)
 Set whether switching to rectangular mode while selecting with the mouse is allowed. More...
 
bool GetMouseSelectionRectangularSwitch () const
 Whether switching to rectangular mode while selecting with the mouse is allowed. More...
 
void SetMultipleSelection (bool multipleSelection)
 Set whether multiple selections can be made. More...
 
bool GetMultipleSelection () const
 Whether multiple selections can be made. More...
 
void SetAdditionalSelectionTyping (bool additionalSelectionTyping)
 Set whether typing can be performed into multiple selections. More...
 
bool GetAdditionalSelectionTyping () const
 Whether typing can be performed into multiple selections. More...
 
void SetAdditionalCaretsVisible (bool additionalCaretsVisible)
 Set whether additional carets are visible. More...
 
bool GetAdditionalCaretsVisible () const
 Whether additional carets are visible. More...
 
int GetSelections () const
 How many selections are there? More...
 
bool GetSelectionEmpty () const
 Is every selected range empty? More...
 
void ClearSelections ()
 Clear selections to a single empty stream selection. More...
 
void SetSelectionVoid (int startPos, int endPos)
 Select a range of text. More...
 
int SetSelectionInt (int caret, int anchor)
 Set a simple selection. More...
 
int AddSelection (int caret, int anchor)
 Add a selection. More...
 
void DropSelectionN (int selection)
 Drop one selection. More...
 
void SetMainSelection (int selection)
 Set the main selection. More...
 
int GetMainSelection () const
 Which selection is the main selection. More...
 
void SetSelectionNCaret (int selection, int caret)
 Set the caret position of the nth selection. More...
 
int GetSelectionNCaret (int selection) const
 Return the caret position of the nth selection. More...
 
void SetSelectionNAnchor (int selection, int anchor)
 Set the anchor position of the nth selection. More...
 
int GetSelectionNAnchor (int selection) const
 Return the anchor position of the nth selection. More...
 
void SetSelectionNCaretVirtualSpace (int selection, int space)
 Set the virtual space of the caret of the nth selection. More...
 
int GetSelectionNCaretVirtualSpace (int selection) const
 Return the virtual space of the caret of the nth selection. More...
 
void SetSelectionNAnchorVirtualSpace (int selection, int space)
 Set the virtual space of the anchor of the nth selection. More...
 
int GetSelectionNAnchorVirtualSpace (int selection) const
 Return the virtual space of the anchor of the nth selection. More...
 
void SetSelectionNStart (int selection, int anchor)
 Sets the position that starts the selection - this becomes the anchor. More...
 
int GetSelectionNStart (int selection) const
 Returns the position at the start of the selection. More...
 
void SetSelectionNEnd (int selection, int caret)
 Sets the position that ends the selection - this becomes the currentPosition. More...
 
int GetSelectionNEnd (int selection) const
 Returns the position at the end of the selection. More...
 
void SetRectangularSelectionCaret (int caret)
 Set the caret position of the rectangular selection. More...
 
int GetRectangularSelectionCaret () const
 Return the caret position of the rectangular selection. More...
 
void SetRectangularSelectionAnchor (int anchor)
 Set the anchor position of the rectangular selection. More...
 
int GetRectangularSelectionAnchor () const
 Return the anchor position of the rectangular selection. More...
 
void SetRectangularSelectionCaretVirtualSpace (int space)
 Set the virtual space of the caret of the rectangular selection. More...
 
int GetRectangularSelectionCaretVirtualSpace () const
 Return the virtual space of the caret of the rectangular selection. More...
 
void SetRectangularSelectionAnchorVirtualSpace (int space)
 Set the virtual space of the anchor of the rectangular selection. More...
 
int GetRectangularSelectionAnchorVirtualSpace () const
 Return the virtual space of the anchor of the rectangular selection. More...
 
void SetVirtualSpaceOptions (int virtualSpaceOptions)
 Set options for virtual space behaviour. More...
 
int GetVirtualSpaceOptions () const
 Return options for virtual space behaviour. More...
 
void SetRectangularSelectionModifier (int modifier)
 On GTK+, allow selecting the modifier key to use for mouse-based rectangular selection. More...
 
int GetRectangularSelectionModifier () const
 Get the modifier key used for rectangular selection. More...
 
void SetAdditionalSelForeground (const wxColour &fore)
 Set the foreground colour of additional selections. More...
 
void SetAdditionalSelBackground (const wxColour &back)
 Set the background colour of additional selections. More...
 
void SetAdditionalSelAlpha (int alpha)
 Set the alpha of the selection. More...
 
int GetAdditionalSelAlpha () const
 Get the alpha of the selection. More...
 
void SetAdditionalCaretForeground (const wxColour &fore)
 Set the foreground colour of additional carets. More...
 
wxColour GetAdditionalCaretForeground () const
 Get the foreground colour of additional carets. More...
 
void RotateSelection ()
 Set the main selection to the next selection. More...
 
void SwapMainAnchorCaret ()
 Swap that caret and anchor of the main selection. More...
 
void MultipleSelectAddNext ()
 Add the next occurrence of the main selection to the set of selections as main. More...
 
void MultipleSelectAddEach ()
 Add each occurrence of the main selection in the target to the set of selections. More...
 
int ChangeLexerState (int start, int end)
 Indicate that the internal state of a lexer has changed over a range and therefore there may be a need to redraw. More...
 
int ContractedFoldNext (int lineStart)
 Find the next line at or after lineStart that is a contracted fold header line. More...
 
void VerticalCentreCaret ()
 Centre current line in window. More...
 
void MoveSelectedLinesUp ()
 Move the selected lines up one line, shifting the line above after the selection. More...
 
void MoveSelectedLinesDown ()
 Move the selected lines down one line, shifting the line below before the selection. More...
 
void SetIdentifier (int identifier)
 Set the identifier reported as idFrom in notification messages. More...
 
int GetIdentifier () const
 Get the identifier. More...
 
void RGBAImageSetWidth (int width)
 Set the width for future RGBA image data. More...
 
void RGBAImageSetHeight (int height)
 Set the height for future RGBA image data. More...
 
void RGBAImageSetScale (int scalePercent)
 Set the scale factor in percent for future RGBA image data. More...
 
void MarkerDefineRGBAImage (int markerNumber, const unsigned char *pixels)
 Define a marker from RGBA data. More...
 
void RegisterRGBAImage (int type, const unsigned char *pixels)
 Register an RGBA image for use in autocompletion lists. More...
 
void ScrollToStart ()
 Scroll to start of document. More...
 
void ScrollToEnd ()
 Scroll to end of document. More...
 
void SetTechnology (int technology)
 Set the technology used. More...
 
int GetTechnology () const
 Get the tech. More...
 
void * CreateLoader (int bytes) const
 Create an ILoader*. More...
 
void VCHomeDisplay ()
 Move caret to before first visible character on display line. More...
 
void VCHomeDisplayExtend ()
 Like VCHomeDisplay but extending selection to new caret position. More...
 
bool GetCaretLineVisibleAlways () const
 Is the caret line always visible? More...
 
void SetCaretLineVisibleAlways (bool alwaysVisible)
 Sets the caret line to always visible. More...
 
void SetLineEndTypesAllowed (int lineEndBitSet)
 Set the line end types that the application wants to use. May not be used if incompatible with lexer or encoding. More...
 
int GetLineEndTypesAllowed () const
 Get the line end types currently allowed. More...
 
int GetLineEndTypesActive () const
 Get the line end types currently recognised. May be a subset of the allowed types due to lexer limitation. More...
 
void SetRepresentation (const wxString &encodedCharacter, const wxString &representation)
 Set the way a character is drawn. More...
 
wxString GetRepresentation (const wxString &encodedCharacter) const
 Set the way a character is drawn. More...
 
void ClearRepresentation (const wxString &encodedCharacter)
 Remove a character representation. More...
 
void StartRecord ()
 Start notifying the container of all key presses and commands. More...
 
void StopRecord ()
 Stop notifying the container of all key presses and commands. More...
 
void SetLexer (int lexer)
 Set the lexing language of the document. More...
 
int GetLexer () const
 Retrieve the lexing language of the document. More...
 
void Colourise (int start, int end)
 Colourise a segment of the document using the current lexing language. More...
 
void SetProperty (const wxString &key, const wxString &value)
 Set up a value that may be used by a lexer for some optional feature. More...
 
void SetKeyWords (int keyWordSet, const wxString &keyWords)
 Set up the key words used by the lexer. More...
 
void SetLexerLanguage (const wxString &language)
 Set the lexing language of the document based on string name. More...
 
void LoadLexerLibrary (const wxString &path)
 Load a lexer library (dll / so). More...
 
wxString GetProperty (const wxString &key)
 Retrieve a "property" value previously set with SetProperty. More...
 
wxString GetPropertyExpanded (const wxString &key)
 Retrieve a "property" value previously set with SetProperty, with "$()" variable replacement on returned buffer. More...
 
int GetPropertyInt (const wxString &key, int defaultValue=0) const
 Retrieve a "property" value previously set with SetProperty, interpreted as an int AFTER any "$()" variable replacement. More...
 
 wxDEPRECATED_MSG ("This method uses a function deprecated in the Scintilla library.") int GetStyleBitsNeeded() const
 Retrieve the number of bits the current lexer needs for styling. More...
 
wxString GetLexerLanguage () const
 Retrieve the lexing language of the document. More...
 
void * PrivateLexerCall (int operation, void *pointer)
 For private communication between an application and a known lexer. More...
 
wxString PropertyNames () const
 Retrieve a '\n' separated list of properties understood by the current lexer. More...
 
int PropertyType (const wxString &name)
 Retrieve the type of a property. More...
 
wxString DescribeProperty (const wxString &name) const
 Describe a property. More...
 
wxString DescribeKeyWordSets () const
 Retrieve a '\n' separated list of descriptions of the keyword sets understood by the current lexer. More...
 
int GetLineEndTypesSupported () const
 Bit set of LineEndType enumertion for which line ends beyond the standard LF, CR, and CRLF are supported by the lexer. More...
 
int AllocateSubStyles (int styleBase, int numberStyles)
 Allocate a set of sub styles for a particular base style, returning start of range. More...
 
int GetSubStylesStart (int styleBase) const
 The starting style number for the sub styles associated with a base style. More...
 
int GetSubStylesLength (int styleBase) const
 The number of sub styles associated with a base style. More...
 
int GetStyleFromSubStyle (int subStyle) const
 For a sub style, return the base style, else return the argument. More...
 
int GetPrimaryStyleFromStyle (int style) const
 For a secondary style, return the primary style, else return the argument. More...
 
void FreeSubStyles ()
 Free allocated sub styles. More...
 
void SetIdentifiers (int style, const wxString &identifiers)
 Set the identifiers that are shown in a particular style. More...
 
int DistanceToSecondaryStyles () const
 Where styles are duplicated by a feature such as active/inactive code return the distance between the two types. More...
 
wxString GetSubStyleBases () const
 Get the set of base styles that can be extended with sub styles. More...
 
int GetCurrentLine ()
 Manually declared methods. More...
 
void StyleSetSpec (int styleNum, const wxString &spec)
 Extract style settings from a spec-string which is composed of one or more of the following comma separated elements: More...
 
wxFont StyleGetFont (int style)
 Get the font of a style. More...
 
void StyleSetFont (int styleNum, const wxFont &font)
 Set style size, face, bold, italic, and underline attributes from a wxFont's attributes. More...
 
void StyleSetFontAttr (int styleNum, int size, const wxString &faceName, bool bold, bool italic, bool underline, wxFontEncoding encoding=wxFONTENCODING_DEFAULT)
 Set all font style attributes at once. More...
 
void StyleSetFontEncoding (int style, wxFontEncoding encoding)
 Set the font encoding to be used by a style. More...
 
void CmdKeyExecute (int cmd)
 Perform one of the operations defined by the wxSCI_CMD_* constants. More...
 
void SetMargins (int left, int right)
 Set the left and right margin in the edit area, measured in pixels. More...
 
void ScrollToLine (int line)
 Scroll enough to make the given line visible. More...
 
void ScrollToColumn (int column)
 Scroll enough to make the given column visible. More...
 
wxIntPtr SendMsg (int msg, wxUIntPtr wp=0, wxIntPtr lp=0) const
 Send a message to Scintilla. More...
 
void SetVScrollBar (wxScrollBar *bar)
 Set the vertical scrollbar to use instead of the one that's built-in. More...
 
void SetHScrollBar (wxScrollBar *bar)
 Set the horizontal scrollbar to use instead of the one that's built-in. More...
 
bool GetLastKeydownProcessed ()
 Can be used to prevent the EVT_CHAR handler from adding the char. More...
 
void SetLastKeydownProcessed (bool val)
 
bool SaveFile (const wxString &filename)
 Write the contents of the editor to filename. More...
 
bool LoadFile (const wxString &filename)
 Load the contents of filename into the editor. More...
 
wxDragResult DoDragEnter (wxCoord x, wxCoord y, wxDragResult def)
 Allow for simulating a DnD DragEnter. More...
 
wxDragResult DoDragOver (wxCoord x, wxCoord y, wxDragResult def)
 Allow for simulating a DnD DragOver. More...
 
void DoDragLeave ()
 Allow for simulating a DnD DragLeave. More...
 
bool DoDropText (long x, long y, const wxString &data)
 Allow for simulating a DnD DropText. More...
 
void SetUseAntiAliasing (bool useAA)
 Specify whether anti-aliased fonts should be used. More...
 
bool GetUseAntiAliasing ()
 Returns the current UseAntiAliasing setting. More...
 
void AnnotationClearLine (int line)
 Clear annotations from the given line. More...
 
void AddTextRaw (const char *text, int length=-1)
 The following methods are nearly equivalent to their similarly named cousins above. More...
 
void InsertTextRaw (int pos, const char *text)
 Insert string at a position. More...
 
wxCharBuffer GetCurLineRaw (int *linePos=NULL)
 Retrieve the text of the line containing the caret. More...
 
wxCharBuffer GetLineRaw (int line)
 Retrieve the contents of a line. More...
 
wxCharBuffer GetSelectedTextRaw ()
 Retrieve the selected text. More...
 
wxCharBuffer GetTargetTextRaw ()
 Retrieve the target text. More...
 
wxCharBuffer GetTextRangeRaw (int startPos, int endPos)
 Retrieve a range of text. More...
 
void SetTextRaw (const char *text)
 Replace the contents of the document with the argument text. More...
 
wxCharBuffer GetTextRaw ()
 Retrieve all the text in the document. More...
 
void AppendTextRaw (const char *text, int length=-1)
 Append a string to the end of the document without changing the selection. More...
 
virtual void WriteText (const wxString &text)
 

implement wxTextEntryBase pure virtual methods

More...
 
virtual void Remove (long from, long to)
 
virtual void Replace (long from, long to, const wxString &text)
 
virtual void SetInsertionPoint (long pos)
 
virtual long GetInsertionPoint () const
 
virtual long GetLastPosition () const
 
virtual void SetSelection (long from, long to)
 
virtual void SelectNone ()
 
virtual void GetSelection (long *from, long *to) const
 
void GetSelection (int *from, int *to)
 kept for compatibility only More...
 
virtual bool IsEditable () const
 
virtual void SetEditable (bool editable)
 
void SetMouseCapture (bool on)
 
bool HaveMouseCapture () const
 

Static Public Member Functions

static wxVersionInfo GetLibraryVersionInfo ()
 

Protected Member Functions

wxString GetValue () const
 
void SetValue (const wxString &text)
 
virtual void DoSetValue (const wxString &value, int flags)
 
virtual wxString DoGetValue () const
 
virtual wxWindowGetEditableWindow ()
 
virtual bool DoLoadFile (const wxString &file, int fileType)
 
virtual bool DoSaveFile (const wxString &file, int fileType)
 
void OnPaint (wxPaintEvent &evt)
 Event handlers. More...
 
void OnScrollWin (wxScrollWinEvent &evt)
 
void OnScroll (wxScrollEvent &evt)
 
void OnSize (wxSizeEvent &evt)
 
void OnMouseLeftDown (wxMouseEvent &evt)
 
void OnMouseRightDown (wxMouseEvent &evt)
 
void OnMouseMove (wxMouseEvent &evt)
 
void OnMouseLeftUp (wxMouseEvent &evt)
 
void OnMouseRightUp (wxMouseEvent &evt)
 
void OnMouseMiddleUp (wxMouseEvent &evt)
 
void OnContextMenu (wxContextMenuEvent &evt)
 
void OnMouseWheel (wxMouseEvent &evt)
 
void OnChar (wxKeyEvent &evt)
 
void OnKeyDown (wxKeyEvent &evt)
 
void OnLoseFocus (wxFocusEvent &evt)
 
void OnGainFocus (wxFocusEvent &evt)
 
void OnSysColourChanged (wxSysColourChangedEvent &evt)
 
void OnEraseBackground (wxEraseEvent &evt)
 
void OnMenu (wxCommandEvent &evt)
 
void OnListBox (wxCommandEvent &evt)
 
void OnIdle (wxIdleEvent &evt)
 
void OnMouseCaptureLost (wxMouseCaptureLostEvent &evt)
 
virtual wxSize DoGetBestSize () const override
 
void NotifyChange ()
 Turn notifications from Scintilla into events. More...
 
void NotifyParent (SCNotification *scn)
 

Protected Attributes

ScintillaWXm_swx
 
wxStopWatch m_stopWatch
 
wxScrollBarm_vScrollBar
 
wxScrollBarm_hScrollBar
 
bool m_lastKeyDownConsumed
 

Private Member Functions

 DECLARE_EVENT_TABLE ()
 
 DECLARE_DYNAMIC_CLASS (wxScintilla)
 

Friends

class ScintillaWX
 
class Platform
 

Detailed Description

Definition at line 2865 of file wxscintilla.h.

Constructor & Destructor Documentation

◆ wxScintilla() [1/2]

wxScintilla::wxScintilla ( wxWindow parent,
wxWindowID  id = wxID_ANY,
const wxPoint pos = wxDefaultPosition,
const wxSize size = wxDefaultSize,
long  style = 0,
const wxString name = wxSCINameStr 
)

◆ wxScintilla() [2/2]

wxScintilla::wxScintilla ( )
inline

◆ ~wxScintilla()

wxScintilla::~wxScintilla ( )

Member Function Documentation

◆ AddRefDocument()

void wxScintilla::AddRefDocument ( void *  docPointer)

Extend life of document.

◆ AddSelection()

int wxScintilla::AddSelection ( int  caret,
int  anchor 
)

◆ AddStyledText()

void wxScintilla::AddStyledText ( const wxMemoryBuffer data)

Add array of cells to document.

◆ AddTabStop()

void wxScintilla::AddTabStop ( int  line,
int  x 
)

Add an explicit tab stop for a line.

◆ AddText()

void wxScintilla::AddText ( const wxString text)

Generated method declaration section {{{.

Add text to the document at current position.

Referenced by cbStyledTextCtrl::DoSelectionBraceCompletion().

◆ AddTextRaw()

void wxScintilla::AddTextRaw ( const char *  text,
int  length = -1 
)

The following methods are nearly equivalent to their similarly named cousins above.

The difference is that these methods bypass wxString and always use a char* even if used in a unicode build of wxWidgets. In that case the character data will be utf-8 encoded since that is what is used internally by Scintilla in unicode builds. Add text to the document at current position.

◆ AddUndoAction()

void wxScintilla::AddUndoAction ( int  token,
int  flags 
)

Add a container action to the undo stack.

◆ Allocate()

void wxScintilla::Allocate ( int  bytes)

Enlarge the document to a particular size of text bytes.

◆ AllocateExtendedStyles()

int wxScintilla::AllocateExtendedStyles ( int  numberStyles)

Allocate some extended (>255) style numbers and return the start of the range.

◆ AllocateSubStyles()

int wxScintilla::AllocateSubStyles ( int  styleBase,
int  numberStyles 
)

Allocate a set of sub styles for a particular base style, returning start of range.

◆ AnnotationClearAll()

void wxScintilla::AnnotationClearAll ( )

Clear the annotations from all lines.

◆ AnnotationClearLine()

void wxScintilla::AnnotationClearLine ( int  line)

Clear annotations from the given line.

◆ AnnotationGetLines()

int wxScintilla::AnnotationGetLines ( int  line) const

Get the number of annotation lines for a line.

◆ AnnotationGetStyle()

int wxScintilla::AnnotationGetStyle ( int  line) const

Get the style number for the annotations for a line.

◆ AnnotationGetStyleOffset()

int wxScintilla::AnnotationGetStyleOffset ( ) const

Get the start of the range of style numbers used for annotations.

◆ AnnotationGetStyles()

wxString wxScintilla::AnnotationGetStyles ( int  line) const

Get the annotation styles for a line.

◆ AnnotationGetText()

wxString wxScintilla::AnnotationGetText ( int  line) const

Get the annotation text for a line.

◆ AnnotationGetVisible()

int wxScintilla::AnnotationGetVisible ( ) const

Get the visibility for the annotations for a view.

◆ AnnotationSetStyle()

void wxScintilla::AnnotationSetStyle ( int  line,
int  style 
)

Set the style number for the annotations for a line.

◆ AnnotationSetStyleOffset()

void wxScintilla::AnnotationSetStyleOffset ( int  style)

Get the start of the range of style numbers used for annotations.

◆ AnnotationSetStyles()

void wxScintilla::AnnotationSetStyles ( int  line,
const wxString styles 
)

Set the annotation styles for a line.

◆ AnnotationSetText()

void wxScintilla::AnnotationSetText ( int  line,
const wxString text 
)

Set the annotation text for a line.

◆ AnnotationSetVisible()

void wxScintilla::AnnotationSetVisible ( int  visible)

Set the visibility for the annotations for a view.

◆ AppendText()

void wxScintilla::AppendText ( const wxString text)

Append a string to the end of the document without changing the selection.

Referenced by DisassemblyDlg::AddAssemblerLine(), and DisassemblyDlg::AddSourceLine().

◆ AppendTextRaw()

void wxScintilla::AppendTextRaw ( const char *  text,
int  length = -1 
)

Append a string to the end of the document without changing the selection.

◆ AutoCompActive()

bool wxScintilla::AutoCompActive ( )

◆ AutoCompCancel()

void wxScintilla::AutoCompCancel ( )

◆ AutoCompComplete()

void wxScintilla::AutoCompComplete ( )

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

◆ AutoCompGetAutoHide()

bool wxScintilla::AutoCompGetAutoHide ( ) const

Retrieve whether or not autocompletion is hidden automatically when nothing matches.

◆ AutoCompGetCancelAtStart()

bool wxScintilla::AutoCompGetCancelAtStart ( ) const

Retrieve whether auto-completion cancelled by backspacing before start.

◆ AutoCompGetCaseInsensitiveBehaviour()

int wxScintilla::AutoCompGetCaseInsensitiveBehaviour ( ) const

Get auto-completion case insensitive behaviour.

◆ AutoCompGetChooseSingle()

bool wxScintilla::AutoCompGetChooseSingle ( ) const

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

◆ AutoCompGetCurrent()

int wxScintilla::AutoCompGetCurrent ( ) const

Get currently selected item position in the auto-completion list.

Referenced by CCManager::OnTimer().

◆ AutoCompGetCurrentText()

wxString wxScintilla::AutoCompGetCurrentText ( ) const

Get currently selected item text in the auto-completion list.

◆ AutoCompGetDropRestOfWord()

bool wxScintilla::AutoCompGetDropRestOfWord ( ) const

Retrieve whether or not autocompletion deletes any word characters after the inserted text upon completion.

◆ AutoCompGetIgnoreCase()

bool wxScintilla::AutoCompGetIgnoreCase ( ) const

Retrieve state of ignore case flag.

◆ AutoCompGetMaxHeight()

int wxScintilla::AutoCompGetMaxHeight ( ) const

Set the maximum height, in rows, of auto-completion and user lists.

Referenced by CCManager::OnAutocompleteSelect().

◆ AutoCompGetMaxWidth()

int wxScintilla::AutoCompGetMaxWidth ( ) const

Get the maximum width, in characters, of auto-completion and user lists.

◆ AutoCompGetMulti()

int wxScintilla::AutoCompGetMulti ( ) const

Retrieve the effect of autocompleting when there are multiple selections.

◆ AutoCompGetOrder()

int wxScintilla::AutoCompGetOrder ( ) const

Get the way autocompletion lists are ordered.

◆ AutoCompGetSeparator()

int wxScintilla::AutoCompGetSeparator ( ) const

Retrieve the auto-completion list separator character.

◆ AutoCompGetTypeSeparator()

int wxScintilla::AutoCompGetTypeSeparator ( ) const

Retrieve the auto-completion list type-separator character.

◆ AutoCompPosStart()

int wxScintilla::AutoCompPosStart ( )

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

◆ AutoCompSelect()

void wxScintilla::AutoCompSelect ( const wxString select)

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

Referenced by CCManager::DoBufferedCC(), and CCManager::OnCompleteCode().

◆ AutoCompSetAutoHide()

void wxScintilla::AutoCompSetAutoHide ( bool  autoHide)

Set whether or not autocompletion is hidden automatically when nothing matches.

◆ AutoCompSetCancelAtStart()

void wxScintilla::AutoCompSetCancelAtStart ( bool  cancel)

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

◆ AutoCompSetCaseInsensitiveBehaviour()

void wxScintilla::AutoCompSetCaseInsensitiveBehaviour ( int  behaviour)

Set auto-completion case insensitive behaviour to either prefer case-sensitive matches or have no preference.

◆ AutoCompSetChooseSingle()

void wxScintilla::AutoCompSetChooseSingle ( bool  chooseSingle)

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

◆ AutoCompSetDropRestOfWord()

void wxScintilla::AutoCompSetDropRestOfWord ( bool  dropRestOfWord)

Set whether or not autocompletion deletes any word characters after the inserted text upon completion.

◆ AutoCompSetFillUps()

void wxScintilla::AutoCompSetFillUps ( const wxString characterSet)

Define a set of characters that when typed will cause the autocompletion to choose the selected item.

◆ AutoCompSetIgnoreCase()

void wxScintilla::AutoCompSetIgnoreCase ( bool  ignoreCase)

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

Referenced by CCManager::OnCompleteCode().

◆ AutoCompSetMaxHeight()

void wxScintilla::AutoCompSetMaxHeight ( int  rowCount)

Set the maximum height, in rows, of auto-completion and user lists.

The default is 5 rows.

Referenced by CCManager::OnCompleteCode().

◆ AutoCompSetMaxWidth()

void wxScintilla::AutoCompSetMaxWidth ( int  characterCount)

Set the maximum width, in characters, of auto-completion and user lists.

Set to 0 to autosize to fit longest item, which is the default.

◆ AutoCompSetMulti()

void wxScintilla::AutoCompSetMulti ( int  multi)

Change the effect of autocompleting when there are multiple selections.

◆ AutoCompSetOrder()

void wxScintilla::AutoCompSetOrder ( int  order)

Set the way autocompletion lists are ordered.

Referenced by CCManager::OnCompleteCode().

◆ AutoCompSetSeparator()

void wxScintilla::AutoCompSetSeparator ( 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.

Referenced by CCManager::OnCompleteCode().

◆ AutoCompSetTypeSeparator()

void wxScintilla::AutoCompSetTypeSeparator ( int  separatorCharacter)

Change the type-separator character in the string setting up an auto-completion list.

Default is '?' but can be changed if items contain '?'.

Referenced by CCManager::OnCompleteCode().

◆ AutoCompShow()

void wxScintilla::AutoCompShow ( int  lengthEntered,
const wxString itemList 
)

Display a auto-completion list.

The lengthEntered parameter indicates how many characters before the caret should be used to provide context.

Referenced by CCManager::DoBufferedCC(), CCManager::InjectAutoCompShow(), and CCManager::OnCompleteCode().

◆ AutoCompStops()

void wxScintilla::AutoCompStops ( const wxString characterSet)

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

◆ BackTab()

void wxScintilla::BackTab ( )

Dedent the selected lines.

◆ BeginUndoAction()

void wxScintilla::BeginUndoAction ( )

◆ BraceBadLight()

void wxScintilla::BraceBadLight ( int  pos)

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

Referenced by cbEditor::HighlightBraces().

◆ BraceBadLightIndicator()

void wxScintilla::BraceBadLightIndicator ( bool  useSetting,
int  indicator 
)

Use specified indicator to highlight non matching brace instead of changing its style.

◆ BraceHighlight()

void wxScintilla::BraceHighlight ( int  posA,
int  posB 
)

Highlight the characters at two positions.

Referenced by cbEditor::HighlightBraces().

◆ BraceHighlightIndicator()

void wxScintilla::BraceHighlightIndicator ( bool  useSetting,
int  indicator 
)

Use specified indicator to highlight matching braces instead of changing their style.

◆ BraceMatch()

int wxScintilla::BraceMatch ( int  pos,
int  maxReStyle = 0 
)

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

The maxReStyle must be 0 for now. It may be defined in a future release.

Referenced by cbStyledTextCtrl::DoBraceCompletion(), cbEditor::GotoMatchingBrace(), cbEditor::HighlightBraces(), and NativeParser::ParseLocalBlock().

◆ CallTipActive()

bool wxScintilla::CallTipActive ( )

◆ CallTipCancel()

void wxScintilla::CallTipCancel ( )

Remove the call tip from the screen.

Referenced by cbStyledTextCtrl::CallTipCancel(), and cbStyledTextCtrl::GetLastSelectedText().

◆ CallTipPosAtStart()

int wxScintilla::CallTipPosAtStart ( )

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

◆ CallTipSetBackground()

void wxScintilla::CallTipSetBackground ( const wxColour back)

Set the background colour for the call tip.

Referenced by setupColours().

◆ CallTipSetForeground()

void wxScintilla::CallTipSetForeground ( const wxColour fore)

Set the foreground colour for the call tip.

Referenced by setupColours().

◆ CallTipSetForegroundHighlight()

void wxScintilla::CallTipSetForegroundHighlight ( const wxColour fore)

Set the foreground colour for the highlighted part of the call tip.

Referenced by setupColours().

◆ CallTipSetHighlight()

void wxScintilla::CallTipSetHighlight ( int  highlightStart,
int  highlightEnd 
)

Highlight a segment of the definition.

Referenced by CCManager::DoShowTips().

◆ CallTipSetPosAtStart()

void wxScintilla::CallTipSetPosAtStart ( int  posStart)

Set the start position in order to change when backspacing removes the calltip.

◆ CallTipSetPosition()

void wxScintilla::CallTipSetPosition ( bool  above)

Set position of calltip, above or below text.

◆ CallTipShow()

void wxScintilla::CallTipShow ( int  pos,
const wxString definition 
)

Show a call tip containing a definition near position pos.

Referenced by CodeCompletion::DoCodeComplete(), and CCManager::DoShowTips().

◆ CallTipUseStyle()

void wxScintilla::CallTipUseStyle ( int  tabSize)

Enable use of wxSCI_STYLE_CALLTIP and set call tip tab size in pixels.

◆ Cancel()

void wxScintilla::Cancel ( )

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

◆ CanPaste()

bool wxScintilla::CanPaste ( ) const

Will a paste succeed?

Referenced by cbEditor::AddToContextMenu(), and cbEditor::CanPaste().

◆ CanRedo()

bool wxScintilla::CanRedo ( ) const

Are there any redoable actions in the undo history?

Referenced by cbEditor::CanRedo(), and cbEditor::CreateContextSubMenu().

◆ CanUndo()

bool wxScintilla::CanUndo ( ) const

Are there any undoable actions in the undo history?

Referenced by cbEditor::CanUndo(), and cbEditor::CreateContextSubMenu().

◆ ChangeInsertion()

void wxScintilla::ChangeInsertion ( int  length,
const wxString text 
)

Change the text that is being inserted in response to wxSCI_MOD_INSERTCHECK.

◆ ChangeLexerState()

int wxScintilla::ChangeLexerState ( int  start,
int  end 
)

Indicate that the internal state of a lexer has changed over a range and therefore there may be a need to redraw.

◆ CharLeft()

void wxScintilla::CharLeft ( )

Move caret left one character.

◆ CharLeftExtend()

void wxScintilla::CharLeftExtend ( )

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

◆ CharLeftRectExtend()

void wxScintilla::CharLeftRectExtend ( )

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

◆ CharPositionFromPoint()

int wxScintilla::CharPositionFromPoint ( int  x,
int  y 
)

Find the position of a character from a point within the window.

◆ CharPositionFromPointClose()

int wxScintilla::CharPositionFromPointClose ( int  x,
int  y 
)

Find the position of a character from a point within the window.

Return wxSCI_INVALID_POSITION if not close to text.

◆ CharRight()

void wxScintilla::CharRight ( )

Move caret right one character.

Referenced by cbStyledTextCtrl::DoBraceCompletion(), and cbStyledTextCtrl::OnKeyDown().

◆ CharRightExtend()

void wxScintilla::CharRightExtend ( )

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

◆ CharRightRectExtend()

void wxScintilla::CharRightRectExtend ( )

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

◆ ChooseCaretX()

void wxScintilla::ChooseCaretX ( )

Set the last x chosen value to be the caret x position.

Referenced by cbEditor::GotoMatchingBrace(), and cbEditor::OnEditorCharAdded().

◆ Clear()

void wxScintilla::Clear ( )

Clear the selection.

◆ ClearAll()

void wxScintilla::ClearAll ( )

◆ ClearDocumentStyle()

void wxScintilla::ClearDocumentStyle ( )

Set all style bytes to 0, remove all folding information.

◆ ClearRegisteredImages()

void wxScintilla::ClearRegisteredImages ( )

◆ ClearRepresentation()

void wxScintilla::ClearRepresentation ( const wxString encodedCharacter)

Remove a character representation.

◆ ClearSelections()

void wxScintilla::ClearSelections ( )

Clear selections to a single empty stream selection.

Referenced by MainFrame::OnEditSelectNextSkip().

◆ ClearTabStops()

void wxScintilla::ClearTabStops ( int  line)

Clear explicit tabstops on a line.

◆ CmdKeyAssign()

void wxScintilla::CmdKeyAssign ( int  key,
int  modifiers,
int  cmd 
)

When key+modifier combination keyDefinition is pressed perform sciCommand.

Referenced by cbEditor::InternalSetEditorStyleBeforeFileOpen().

◆ CmdKeyClear()

void wxScintilla::CmdKeyClear ( int  key,
int  modifiers 
)

When key+modifier combination keyDefinition is pressed do nothing.

◆ CmdKeyClearAll()

void wxScintilla::CmdKeyClearAll ( )

Drop all key mappings.

◆ CmdKeyExecute()

void wxScintilla::CmdKeyExecute ( int  cmd)

Perform one of the operations defined by the wxSCI_CMD_* constants.

◆ Colourise()

void wxScintilla::Colourise ( int  start,
int  end 
)

◆ ContractedFoldNext()

int wxScintilla::ContractedFoldNext ( int  lineStart)

Find the next line at or after lineStart that is a contracted fold header line.

Return -1 when no more lines.

Referenced by cbEditor::UpdateProjectFile().

◆ ConvertEOLs()

void wxScintilla::ConvertEOLs ( int  eolMode)

◆ Copy()

void wxScintilla::Copy ( )

Copy the selection to the clipboard.

Referenced by cbEditor::Copy(), and cbEditor::OnContextMenuEntry().

◆ CopyAllowLine()

void wxScintilla::CopyAllowLine ( )

Copy the selection, if selection empty copy the line with the caret.

◆ CopyRange()

void wxScintilla::CopyRange ( int  start,
int  end 
)

Copy a range of text to the clipboard. Positions are clipped into the document.

◆ CopyText()

void wxScintilla::CopyText ( int  length,
const wxString text 
)

Copy argument text to the clipboard.

◆ CountCharacters()

int wxScintilla::CountCharacters ( int  start,
int  end 
)

Count characters between two positions.

◆ Create()

bool wxScintilla::Create ( wxWindow parent,
wxWindowID  id = wxID_ANY,
const wxPoint pos = wxDefaultPosition,
const wxSize size = wxDefaultSize,
long  style = 0,
const wxString name = wxSCINameStr 
)

◆ CreateDocument()

void* wxScintilla::CreateDocument ( )

Create a new document object.

Starts with reference count of 1 and not selected into editor.

◆ CreateLoader()

void* wxScintilla::CreateLoader ( int  bytes) const

Create an ILoader*.

◆ Cut()

void wxScintilla::Cut ( )

Cut the selection to the clipboard.

Referenced by cbEditor::Cut(), and cbEditor::OnContextMenuEntry().

◆ DECLARE_DYNAMIC_CLASS()

wxScintilla::DECLARE_DYNAMIC_CLASS ( wxScintilla  )
private

◆ DECLARE_EVENT_TABLE()

wxScintilla::DECLARE_EVENT_TABLE ( )
private

◆ DeleteBack()

void wxScintilla::DeleteBack ( )

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

Referenced by cbStyledTextCtrl::DoBraceCompletion(), cbStyledTextCtrl::DoSelectionBraceCompletion(), and cbStyledTextCtrl::OnKeyDown().

◆ DeleteBackNotLine()

void wxScintilla::DeleteBackNotLine ( )

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

Will not delete the character before at the start of a line.

◆ DeleteRange()

void wxScintilla::DeleteRange ( int  start,
int  lengthDelete 
)

Delete a range of text in the document.

Referenced by MainFrame::OnEditLineMove().

◆ DelLineLeft()

void wxScintilla::DelLineLeft ( )

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

◆ DelLineRight()

void wxScintilla::DelLineRight ( )

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

◆ DelWordLeft()

void wxScintilla::DelWordLeft ( )

Delete the word to the left of the caret.

◆ DelWordRight()

void wxScintilla::DelWordRight ( )

Delete the word to the right of the caret.

◆ DelWordRightEnd()

void wxScintilla::DelWordRightEnd ( )

Delete the word to the right of the caret, but not the trailing non-word characters.

◆ DescribeKeyWordSets()

wxString wxScintilla::DescribeKeyWordSets ( ) const

Retrieve a '\n' separated list of descriptions of the keyword sets understood by the current lexer.

Referenced by EditorConfigurationDlg::OnEditKeywords().

◆ DescribeProperty()

wxString wxScintilla::DescribeProperty ( const wxString name) const

Describe a property.

◆ DistanceToSecondaryStyles()

int wxScintilla::DistanceToSecondaryStyles ( ) const

Where styles are duplicated by a feature such as active/inactive code return the distance between the two types.

◆ DocLineFromVisible()

int wxScintilla::DocLineFromVisible ( int  displayLine)

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

◆ DocumentEnd()

void wxScintilla::DocumentEnd ( )

Move caret to last position in document.

◆ DocumentEndExtend()

void wxScintilla::DocumentEndExtend ( )

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

◆ DocumentStart()

void wxScintilla::DocumentStart ( )

Move caret to first position in document.

◆ DocumentStartExtend()

void wxScintilla::DocumentStartExtend ( )

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

◆ DoDragEnter()

wxDragResult wxScintilla::DoDragEnter ( wxCoord  x,
wxCoord  y,
wxDragResult  def 
)

Allow for simulating a DnD DragEnter.

◆ DoDragLeave()

void wxScintilla::DoDragLeave ( )

Allow for simulating a DnD DragLeave.

◆ DoDragOver()

wxDragResult wxScintilla::DoDragOver ( wxCoord  x,
wxCoord  y,
wxDragResult  def 
)

Allow for simulating a DnD DragOver.

◆ DoDropText()

bool wxScintilla::DoDropText ( long  x,
long  y,
const wxString data 
)

Allow for simulating a DnD DropText.

◆ DoGetBestSize()

virtual wxSize wxScintilla::DoGetBestSize ( ) const
overrideprotectedvirtual

◆ DoGetValue()

virtual wxString wxScintilla::DoGetValue ( ) const
inlineprotectedvirtual

Definition at line 5350 of file wxscintilla.h.

◆ DoLoadFile()

virtual bool wxScintilla::DoLoadFile ( const wxString file,
int  fileType 
)
protectedvirtual

◆ DoSaveFile()

virtual bool wxScintilla::DoSaveFile ( const wxString file,
int  fileType 
)
protectedvirtual

◆ DoSetValue()

virtual void wxScintilla::DoSetValue ( const wxString value,
int  flags 
)
protectedvirtual

◆ DropSelectionN()

void wxScintilla::DropSelectionN ( int  selection)

Drop one selection.

◆ EditToggleOvertype()

void wxScintilla::EditToggleOvertype ( )

Switch from insert to overtype mode or the reverse.

◆ EmptyUndoBuffer()

void wxScintilla::EmptyUndoBuffer ( bool  collectChangeHistory = false)

Delete the undo history.

Referenced by cbEditor::ClearHistory(), cbEditor::OnContextMenuEntry(), and cbEditor::Open().

◆ EndUndoAction()

void wxScintilla::EndUndoAction ( )

◆ EnsureCaretVisible()

void wxScintilla::EnsureCaretVisible ( )

Ensure the caret is visible.

◆ EnsureVisible()

void wxScintilla::EnsureVisible ( int  line)

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

Referenced by FindReplace::Find(), cbEditor::GotoLine(), FindReplace::Replace(), and FindReplace::ReplaceInFiles().

◆ EnsureVisibleEnforcePolicy()

void wxScintilla::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.

Referenced by cbEditor::DoFoldBlockFromLine().

◆ ExpandChildren()

void wxScintilla::ExpandChildren ( int  line,
int  level 
)

Expand a fold header and all children. Use the level argument instead of the line's current level.

◆ FindChangedLine()

int wxScintilla::FindChangedLine ( const int  fromLine,
const int  toLine 
) const

Find a changed line, if fromLine > toLine search is performed backwards.

Referenced by cbEditor::GotoNextChanged(), and cbEditor::GotoPreviousChanged().

◆ FindColumn()

int wxScintilla::FindColumn ( int  line,
int  column 
)

Find the position of a column on a line taking into account tabs and multi-byte characters.

If beyond end of line, return line end position.

◆ FindText()

int wxScintilla::FindText ( int  minPos,
int  maxPos,
const wxString text,
int  flags = 0,
int *  findEnd = NULL 
)

◆ FoldAll()

void wxScintilla::FoldAll ( int  action)

Expand or contract all fold headers.

◆ FoldChildren()

void wxScintilla::FoldChildren ( int  line,
int  action 
)

Expand or contract a fold header and its children.

◆ FoldDisplayTextSetStyle()

void wxScintilla::FoldDisplayTextSetStyle ( int  style)

Set the style of fold display text.

◆ FoldLine()

void wxScintilla::FoldLine ( int  line,
int  action 
)

Expand or contract a fold header.

Referenced by cbEditor::DoFoldAll(), and cbEditor::DoFoldBlockFromLine().

◆ FormatRange()

int wxScintilla::FormatRange ( bool  doDraw,
int  startPos,
int  endPos,
wxDC draw,
wxDC target,
wxRect  renderRect,
wxRect  pageRect 
)

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

Referenced by cbEditorPrintout::GetPageInfo(), and cbEditorPrintout::OnPrintPage().

◆ FormFeed()

void wxScintilla::FormFeed ( )

Insert a Form Feed character.

◆ FreeSubStyles()

void wxScintilla::FreeSubStyles ( )

Free allocated sub styles.

◆ GetAdditionalCaretForeground()

wxColour wxScintilla::GetAdditionalCaretForeground ( ) const

Get the foreground colour of additional carets.

◆ GetAdditionalCaretsBlink()

bool wxScintilla::GetAdditionalCaretsBlink ( ) const

Whether additional carets will blink.

◆ GetAdditionalCaretsVisible()

bool wxScintilla::GetAdditionalCaretsVisible ( ) const

Whether additional carets are visible.

◆ GetAdditionalSelAlpha()

int wxScintilla::GetAdditionalSelAlpha ( ) const

Get the alpha of the selection.

◆ GetAdditionalSelectionTyping()

bool wxScintilla::GetAdditionalSelectionTyping ( ) const

Whether typing can be performed into multiple selections.

◆ GetAllLinesVisible()

bool wxScintilla::GetAllLinesVisible ( ) const

Are all lines visible?

◆ GetAnchor()

int wxScintilla::GetAnchor ( ) const

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

Referenced by cbEditor::Save().

◆ GetAutomaticFold()

int wxScintilla::GetAutomaticFold ( ) const

Get automatic folding behaviours.

◆ GetBackSpaceUnIndents()

bool wxScintilla::GetBackSpaceUnIndents ( ) const

Does a backspace pressed when caret is within indentation unindent?

◆ GetBufferedDraw()

bool wxScintilla::GetBufferedDraw ( ) const

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

◆ GetCaretForeground()

wxColour wxScintilla::GetCaretForeground ( ) const

Get the foreground colour of the caret.

Referenced by cbStyledTextCtrl::HighlightRightBrace().

◆ GetCaretLineBackAlpha()

int wxScintilla::GetCaretLineBackAlpha ( ) const

Get the background alpha of the caret line.

◆ GetCaretLineBackground()

wxColour wxScintilla::GetCaretLineBackground ( ) const

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

Referenced by cbEditor::SetLanguageDependentColours().

◆ GetCaretLineVisible()

bool wxScintilla::GetCaretLineVisible ( ) const

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

◆ GetCaretLineVisibleAlways()

bool wxScintilla::GetCaretLineVisibleAlways ( ) const

Is the caret line always visible?

◆ GetCaretPeriod()

int wxScintilla::GetCaretPeriod ( ) const

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

◆ GetCaretSticky()

int wxScintilla::GetCaretSticky ( ) const

Can the caret preferred x position only be changed by explicit movement commands?

◆ GetCaretStyle()

int wxScintilla::GetCaretStyle ( ) const

Returns the current style of the caret.

◆ GetCaretWidth()

int wxScintilla::GetCaretWidth ( ) const

Returns the width of the insert mode caret.

Referenced by cbStyledTextCtrl::HighlightRightBrace().

◆ GetCharAt()

int wxScintilla::GetCharAt ( int  pos) const

◆ GetCodePage()

int wxScintilla::GetCodePage ( ) const

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

◆ GetColumn()

int wxScintilla::GetColumn ( int  pos) const

◆ GetControlCharSymbol()

int wxScintilla::GetControlCharSymbol ( ) const

Get the way control characters are displayed.

◆ GetCurLine()

wxString wxScintilla::GetCurLine ( int *  linePos = NULL)

Retrieve the text of the line containing the caret.

Referenced by CodeCompletion::DoCodeCompleteIncludes(), cbEditor::GotoMatchingBrace(), and cbEditor::OnEditorCharAdded().

◆ GetCurLineRaw()

wxCharBuffer wxScintilla::GetCurLineRaw ( int *  linePos = NULL)

Retrieve the text of the line containing the caret.

Returns the index of the caret on the line.

◆ GetCurrentLine()

int wxScintilla::GetCurrentLine ( )

◆ GetCurrentPos()

int wxScintilla::GetCurrentPos ( ) const

Returns the position of the caret.

Referenced by NativeParser::AI(), cbStyledTextCtrl::AllowTabSmartJump(), ConfirmReplaceDlg::CalcPosition(), FindReplace::CalculateFindReplaceStartEnd(), EditorBase::DisplayContextMenu(), CodeCompletion::DoAllMethodsImpl(), CodeCompletion::DoAutocomplete(), cbStyledTextCtrl::DoBraceCompletion(), CodeCompletion::DoClassMethodDeclImpl(), CodeCompletion::DoCodeComplete(), cbStyledTextCtrl::DoSelectionBraceCompletion(), CCManager::DoUpdateCallTip(), MainFrame::DoUpdateStatusBar(), CodeCompletionHelper::EditorHasNameUnderCursor(), cbStyledTextCtrl::EnableTabSmartJump(), NativeParser::FindCurrentFunctionStart(), FindReplace::FindSelectedText(), NativeParser::GetCallTips(), cbDebuggerPlugin::GetEditorWordAtCaret(), cbSmartIndentPlugin::GetFirstBraceInLine(), cbSmartIndentPlugin::GetLastNonCommentWord(), cbSmartIndentPlugin::GetLastNonWhitespaceChars(), cbEditor::GetLineIndentInSpaces(), cbEditorInternalData::GetLineIndentString(), cbSmartIndentPlugin::GetNextNonWhitespaceCharOfLine(), cbSmartIndentPlugin::GetNextNonWhitespaceCharOnLine(), GetSelectedText(), CodeRefactoring::GetSymbolUnderCursor(), cbEditorInternalData::GetUrl(), cbEditor::GotoMatchingBrace(), cbEditor::GotoNextChanged(), cbEditor::GotoPreviousChanged(), cbEditor::GotoTokenPosition(), cbEditor::HighlightBraces(), cbStyledTextCtrl::HighlightRightBrace(), InsertNewLine(), CCManager::OnCompleteCode(), MainFrame::OnEditLinePaste(), cbEditor::OnEditorCharAdded(), CCManager::OnEditorHook(), MainFrame::OnEditStreamCommentSelected(), CodeCompletion::OnGotoDeclaration(), cbStyledTextCtrl::OnKeyDown(), cbStyledTextCtrl::OnKeyUp(), CCManager::OnMenuSelect(), cbStyledTextCtrl::OnMouseMiddleDown(), CCManager::OnShowCallTip(), CCManager::OnTimer(), CodeRefactoring::Parse(), NativeParser::ParseFunctionArguments(), NativeParser::ParseLocalBlock(), NativeParser::ParseUsingNamespace(), MacrosManager::RecalcVars(), cbEditor::Reload(), cbEditor::Save(), FindReplace::ShowFindDialog(), and cbEditor::UpdateProjectFile().

◆ GetDirectFunction()

void* wxScintilla::GetDirectFunction ( ) const

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

◆ GetDirectPointer()

void* wxScintilla::GetDirectPointer ( ) const

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

◆ GetDocPointer()

void* wxScintilla::GetDocPointer ( )

Retrieve a pointer to the document object.

Referenced by cbEditor::Split().

◆ GetEdgeColour()

wxColour wxScintilla::GetEdgeColour ( ) const

Retrieve the colour used in edge indication.

◆ GetEdgeColumn()

int wxScintilla::GetEdgeColumn ( ) const

Retrieve the column number which text should be kept within.

◆ GetEdgeMode()

int wxScintilla::GetEdgeMode ( ) const

Retrieve the edge highlight mode.

Referenced by cbEditor::Print().

◆ GetEditableWindow()

virtual wxWindow* wxScintilla::GetEditableWindow ( )
inlineprotectedvirtual

Definition at line 5351 of file wxscintilla.h.

◆ GetEndAtLastLine()

bool wxScintilla::GetEndAtLastLine ( ) const

Retrieve whether the maximum scroll position has the last line at the bottom of the view.

◆ GetEndStyled()

int wxScintilla::GetEndStyled ( ) const

Retrieve the position of the last correctly styled character.

◆ GetEOLMode()

int wxScintilla::GetEOLMode ( ) const

◆ GetExtraAscent()

int wxScintilla::GetExtraAscent ( ) const

Get extra ascent for each line.

◆ GetExtraDescent()

int wxScintilla::GetExtraDescent ( ) const

Get extra descent for each line.

◆ GetFirstVisibleLine()

int wxScintilla::GetFirstVisibleLine ( ) const

◆ GetFoldExpanded()

bool wxScintilla::GetFoldExpanded ( int  line) const

◆ GetFoldLevel()

int wxScintilla::GetFoldLevel ( int  line) const

◆ GetFoldParent()

int wxScintilla::GetFoldParent ( int  line) const

Find the parent line of a child line.

Referenced by cbEditor::DoFoldBlockFromLine(), and cbEditor::FixFoldState().

◆ GetFontQuality()

int wxScintilla::GetFontQuality ( ) const

Retrieve the quality level for text.

◆ GetGapPosition()

int wxScintilla::GetGapPosition ( ) const

Return a position which, to avoid performance costs, should not be within the range of a call to GetRangePointer.

◆ GetHighlightGuide()

int wxScintilla::GetHighlightGuide ( ) const

Get the highlighted indentation guide column.

◆ GetHotspotActiveBackground()

wxColour wxScintilla::GetHotspotActiveBackground ( ) const

Get the back colour for active hotspots.

◆ GetHotspotActiveForeground()

wxColour wxScintilla::GetHotspotActiveForeground ( ) const

Get the fore colour for active hotspots.

◆ GetHotspotActiveUnderline()

bool wxScintilla::GetHotspotActiveUnderline ( ) const

Get whether underlining for active hotspots.

◆ GetHotspotSingleLine()

bool wxScintilla::GetHotspotSingleLine ( ) const

Get the HotspotSingleLine property.

◆ GetIdentifier()

int wxScintilla::GetIdentifier ( ) const

Get the identifier.

◆ GetIdleStyling()

int wxScintilla::GetIdleStyling ( ) const

Retrieve the limits to idle styling.

◆ GetIMEInteraction()

int wxScintilla::GetIMEInteraction ( ) const

Is the IME displayed in a window or inline?

◆ GetIndent()

int wxScintilla::GetIndent ( ) const

Retrieve indentation size.

◆ GetIndentationGuides()

int wxScintilla::GetIndentationGuides ( ) const

Are the indentation guides visible?

◆ GetIndicatorCurrent()

int wxScintilla::GetIndicatorCurrent ( ) const

Get the current indicator.

◆ GetIndicatorValue()

int wxScintilla::GetIndicatorValue ( ) const

Get the current indicator value.

◆ GetInsertionPoint()

virtual long wxScintilla::GetInsertionPoint ( ) const
inlinevirtual

Definition at line 5286 of file wxscintilla.h.

◆ GetLastChild()

int wxScintilla::GetLastChild ( int  line,
int  level 
) const

Find the last child line of a header line.

Referenced by cbEditor::DoFoldAll(), and cbEditor::OnEditorModified().

◆ GetLastKeydownProcessed()

bool wxScintilla::GetLastKeydownProcessed ( )
inline

Can be used to prevent the EVT_CHAR handler from adding the char.

Definition at line 5164 of file wxscintilla.h.

◆ GetLastPosition()

virtual long wxScintilla::GetLastPosition ( ) const
inlinevirtual

Definition at line 5287 of file wxscintilla.h.

◆ GetLayoutCache()

int wxScintilla::GetLayoutCache ( ) const

Retrieve the degree of caching of layout information.

◆ GetLength()

int wxScintilla::GetLength ( ) const

◆ GetLexer()

int wxScintilla::GetLexer ( ) const

◆ GetLexerLanguage()

wxString wxScintilla::GetLexerLanguage ( ) const

Retrieve the lexing language of the document.

◆ GetLibraryVersionInfo()

static wxVersionInfo wxScintilla::GetLibraryVersionInfo ( )
static

Referenced by dlgAbout::dlgAbout().

◆ GetLine()

wxString wxScintilla::GetLine ( int  line) const

◆ GetLineCount()

int wxScintilla::GetLineCount ( ) const

◆ GetLineEndPosition()

int wxScintilla::GetLineEndPosition ( int  line) const

◆ GetLineEndTypesActive()

int wxScintilla::GetLineEndTypesActive ( ) const

Get the line end types currently recognised. May be a subset of the allowed types due to lexer limitation.

◆ GetLineEndTypesAllowed()

int wxScintilla::GetLineEndTypesAllowed ( ) const

Get the line end types currently allowed.

◆ GetLineEndTypesSupported()

int wxScintilla::GetLineEndTypesSupported ( ) const

Bit set of LineEndType enumertion for which line ends beyond the standard LF, CR, and CRLF are supported by the lexer.

◆ GetLineIndentation()

int wxScintilla::GetLineIndentation ( int  line) const

Retrieve the number of columns that a line is indented.

◆ GetLineIndentPosition()

int wxScintilla::GetLineIndentPosition ( int  line) const

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

Referenced by CodeCompletion::GetAutocompList(), and cbStyledTextCtrl::HighlightRightBrace().

◆ GetLineRaw()

wxCharBuffer wxScintilla::GetLineRaw ( int  line)

Retrieve the contents of a line.

◆ GetLineSelEndPosition()

int wxScintilla::GetLineSelEndPosition ( int  line)

Retrieve the position of the end of the selection at the given line (wxSCI_INVALID_POSITION if no selection on this line).

◆ GetLineSelStartPosition()

int wxScintilla::GetLineSelStartPosition ( int  line)

Retrieve the position of the start of the selection at the given line (wxSCI_INVALID_POSITION if no selection on this line).

◆ GetLineState()

int wxScintilla::GetLineState ( int  line) const

Retrieve the extra styling information for a line.

◆ GetLineVisible()

bool wxScintilla::GetLineVisible ( int  line) const

Is a line visible?

Referenced by cbEditor::FixFoldState(), and DisassemblyDlg::SetActiveAddress().

◆ GetMainSelection()

int wxScintilla::GetMainSelection ( ) const

Which selection is the main selection.

Referenced by MainFrame::OnEditSelectAll().

◆ GetMarginBackground()

wxColour wxScintilla::GetMarginBackground ( int  margin) const

Retrieve the background colour of a margin.

◆ GetMarginCount()

int wxScintilla::GetMarginCount ( ) const

How many margins are there?.

◆ GetMarginCursor()

int wxScintilla::GetMarginCursor ( int  margin) const

Retrieve the cursor shown in a margin.

◆ GetMarginLeft()

int wxScintilla::GetMarginLeft ( ) const

Returns the size in pixels of the left margin.

◆ GetMarginMask()

int wxScintilla::GetMarginMask ( int  margin) const

◆ GetMarginOptions()

int wxScintilla::GetMarginOptions ( ) const

Get the margin options.

◆ GetMarginRight()

int wxScintilla::GetMarginRight ( ) const

Returns the size in pixels of the right margin.

◆ GetMarginSensitive()

bool wxScintilla::GetMarginSensitive ( int  margin) const

Retrieve the mouse click sensitivity of a margin.

◆ GetMarginType()

int wxScintilla::GetMarginType ( int  margin) const

Retrieve the type of a margin.

Referenced by cbEditor::Print().

◆ GetMarginWidth()

int wxScintilla::GetMarginWidth ( int  margin) const

Retrieve the width of a margin in pixels.

Referenced by CCManager::DoShowTips(), cbEditor::OnBeforeBuildContextMenu(), cbEditor::Print(), and cbEditor::Split().

◆ GetMarkerSymbolDefined()

int wxScintilla::GetMarkerSymbolDefined ( int  markerNumber)

Which symbol was defined for markerNumber with MarkerDefine.

◆ GetMaxLineState()

int wxScintilla::GetMaxLineState ( ) const

Retrieve the last line number that has line state.

◆ GetModEventMask()

int wxScintilla::GetModEventMask ( ) const

Get which document modification events are sent to the container.

◆ GetModify()

bool wxScintilla::GetModify ( ) const

Is the document different from when it was last saved?

Referenced by NativeParser::FindCurrentFunctionStart(), cbEditor::GetModified(), and cbEditor::OnEditorChange().

◆ GetMouseDownCaptures()

bool wxScintilla::GetMouseDownCaptures ( ) const

Get whether mouse gets captured.

◆ GetMouseDwellTime()

int wxScintilla::GetMouseDwellTime ( ) const

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

◆ GetMouseSelectionRectangularSwitch()

bool wxScintilla::GetMouseSelectionRectangularSwitch ( ) const

Whether switching to rectangular mode while selecting with the mouse is allowed.

◆ GetMouseWheelCaptures()

bool wxScintilla::GetMouseWheelCaptures ( ) const

Get whether mouse wheel can be active outside the window.

◆ GetMultiPaste()

int wxScintilla::GetMultiPaste ( ) const

Retrieve the effect of pasting when there are multiple selections.

◆ GetMultipleSelection()

bool wxScintilla::GetMultipleSelection ( ) const

Whether multiple selections can be made.

◆ GetNextTabStop()

int wxScintilla::GetNextTabStop ( int  line,
int  x 
)

Find the next explicit tab stop position on a line after a position.

◆ GetOvertype()

bool wxScintilla::GetOvertype ( ) const

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

Referenced by MainFrame::DoUpdateStatusBar().

◆ GetPasteConvertEndings()

bool wxScintilla::GetPasteConvertEndings ( ) const

Get convert-on-paste setting.

◆ GetPhasesDraw()

int wxScintilla::GetPhasesDraw ( ) const

How many phases is drawing done in?

◆ GetPositionCacheSize()

int wxScintilla::GetPositionCacheSize ( ) const

How many entries are allocated to the position cache?

◆ GetPrimaryStyleFromStyle()

int wxScintilla::GetPrimaryStyleFromStyle ( int  style) const

For a secondary style, return the primary style, else return the argument.

◆ GetPrintColourMode()

int wxScintilla::GetPrintColourMode ( ) const

Returns the print colour mode.

◆ GetPrintMagnification()

int wxScintilla::GetPrintMagnification ( ) const

Returns the print magnification.

◆ GetPrintWrapMode()

int wxScintilla::GetPrintWrapMode ( ) const

Is printing line wrapped?

◆ GetProperty()

wxString wxScintilla::GetProperty ( const wxString key)

Retrieve a "property" value previously set with SetProperty.

◆ GetPropertyExpanded()

wxString wxScintilla::GetPropertyExpanded ( const wxString key)

Retrieve a "property" value previously set with SetProperty, with "$()" variable replacement on returned buffer.

◆ GetPropertyInt()

int wxScintilla::GetPropertyInt ( const wxString key,
int  defaultValue = 0 
) const

Retrieve a "property" value previously set with SetProperty, interpreted as an int AFTER any "$()" variable replacement.

◆ GetPunctuationChars()

wxString wxScintilla::GetPunctuationChars ( ) const

Get the set of characters making up punctuation characters.

◆ GetRangePointer()

const char* wxScintilla::GetRangePointer ( int  position,
int  rangeLength 
) const

Return a read-only pointer to a range of characters in the document.

May move the gap so that the range is contiguous, but will only move up to rangeLength bytes.

◆ GetReadOnly()

bool wxScintilla::GetReadOnly ( ) const

◆ GetRectangularSelectionAnchor()

int wxScintilla::GetRectangularSelectionAnchor ( ) const

Return the anchor position of the rectangular selection.

◆ GetRectangularSelectionAnchorVirtualSpace()

int wxScintilla::GetRectangularSelectionAnchorVirtualSpace ( ) const

Return the virtual space of the anchor of the rectangular selection.

◆ GetRectangularSelectionCaret()

int wxScintilla::GetRectangularSelectionCaret ( ) const

Return the caret position of the rectangular selection.

◆ GetRectangularSelectionCaretVirtualSpace()

int wxScintilla::GetRectangularSelectionCaretVirtualSpace ( ) const

Return the virtual space of the caret of the rectangular selection.

◆ GetRectangularSelectionModifier()

int wxScintilla::GetRectangularSelectionModifier ( ) const

Get the modifier key used for rectangular selection.

◆ GetRepresentation()

wxString wxScintilla::GetRepresentation ( const wxString encodedCharacter) const

Set the way a character is drawn.

◆ GetSCICursor()

int wxScintilla::GetSCICursor ( ) const

Get cursor type.

◆ GetSCIFocus()

bool wxScintilla::GetSCIFocus ( ) const

Get internal focus flag.

◆ GetScrollWidth()

int wxScintilla::GetScrollWidth ( ) const

Retrieve the document width assumed for scrolling.

◆ GetScrollWidthTracking()

bool wxScintilla::GetScrollWidthTracking ( ) const

Retrieve whether the scroll width tracks wide lines.

◆ GetSearchFlags()

int wxScintilla::GetSearchFlags ( ) const

Get the search flags used by SearchInTarget.

◆ GetSelAlpha()

int wxScintilla::GetSelAlpha ( ) const

Get the alpha of the selection.

◆ GetSelectedText()

wxString wxScintilla::GetSelectedText ( )

◆ GetSelectedTextRaw()

wxCharBuffer wxScintilla::GetSelectedTextRaw ( )

Retrieve the selected text.

◆ GetSelection() [1/2]

virtual void wxScintilla::GetSelection ( long *  from,
long *  to 
) const
inlinevirtual

Definition at line 5310 of file wxscintilla.h.

◆ GetSelection() [2/2]

void wxScintilla::GetSelection ( int *  from,
int *  to 
)
inline

kept for compatibility only

Definition at line 5319 of file wxscintilla.h.

◆ GetSelectionEmpty()

bool wxScintilla::GetSelectionEmpty ( ) const

Is every selected range empty?

Referenced by cbEditor::AddToContextMenu(), and cbEditor::CreateContextSubMenu().

◆ GetSelectionEnd()

int wxScintilla::GetSelectionEnd ( ) const

◆ GetSelectionMode()

int wxScintilla::GetSelectionMode ( ) const

Get the mode of the current selection.

◆ GetSelectionNAnchor()

int wxScintilla::GetSelectionNAnchor ( int  selection) const

Return the anchor position of the nth selection.

Referenced by MainFrame::OnEditSelectAll(), and MainFrame::OnEditSelectNextSkip().

◆ GetSelectionNAnchorVirtualSpace()

int wxScintilla::GetSelectionNAnchorVirtualSpace ( int  selection) const

Return the virtual space of the anchor of the nth selection.

◆ GetSelectionNCaret()

int wxScintilla::GetSelectionNCaret ( int  selection) const

Return the caret position of the nth selection.

Referenced by MainFrame::OnEditSelectAll(), and MainFrame::OnEditSelectNextSkip().

◆ GetSelectionNCaretVirtualSpace()

int wxScintilla::GetSelectionNCaretVirtualSpace ( int  selection) const

Return the virtual space of the caret of the nth selection.

◆ GetSelectionNEnd()

int wxScintilla::GetSelectionNEnd ( int  selection) const

Returns the position at the end of the selection.

◆ GetSelectionNStart()

int wxScintilla::GetSelectionNStart ( int  selection) const

Returns the position at the start of the selection.

◆ GetSelections()

int wxScintilla::GetSelections ( ) const

◆ GetSelectionStart()

int wxScintilla::GetSelectionStart ( ) const

◆ GetSelEOLFilled()

bool wxScintilla::GetSelEOLFilled ( ) const

Is the selection end of line filled?

◆ GetStatus()

int wxScintilla::GetStatus ( ) const

Get error status.

◆ GetStyleAt()

int wxScintilla::GetStyleAt ( int  pos) const

◆ GetStyledText()

wxMemoryBuffer wxScintilla::GetStyledText ( int  startPos,
int  endPos 
)

Retrieve a buffer of cells.

◆ GetStyleFromSubStyle()

int wxScintilla::GetStyleFromSubStyle ( int  subStyle) const

For a sub style, return the base style, else return the argument.

◆ GetSubStyleBases()

wxString wxScintilla::GetSubStyleBases ( ) const

Get the set of base styles that can be extended with sub styles.

◆ GetSubStylesLength()

int wxScintilla::GetSubStylesLength ( int  styleBase) const

The number of sub styles associated with a base style.

◆ GetSubStylesStart()

int wxScintilla::GetSubStylesStart ( int  styleBase) const

The starting style number for the sub styles associated with a base style.

◆ GetTabDrawMode()

int wxScintilla::GetTabDrawMode ( ) const

Retrieve the current tab draw mode.

Returns one of wxSCI_TD_* constants.

◆ GetTabIndents()

bool wxScintilla::GetTabIndents ( ) const

Does a tab pressed when caret is within indentation indent?

◆ GetTabWidth()

int wxScintilla::GetTabWidth ( ) const

◆ GetTag()

wxString wxScintilla::GetTag ( int  tagNumber) const

Retrieve the value of a tag from a regular expression search.

◆ GetTargetEnd()

int wxScintilla::GetTargetEnd ( ) const

Get the position that ends the target.

◆ GetTargetStart()

int wxScintilla::GetTargetStart ( ) const

Get the position that starts the target.

◆ GetTargetText()

wxString wxScintilla::GetTargetText ( ) const

Retrieve the text in the target.

◆ GetTargetTextRaw()

wxCharBuffer wxScintilla::GetTargetTextRaw ( )

Retrieve the target text.

◆ GetTechnology()

int wxScintilla::GetTechnology ( ) const

Get the tech.

◆ GetText()

wxString wxScintilla::GetText ( ) const

◆ GetTextLength()

int wxScintilla::GetTextLength ( ) const

Retrieve the number of characters in the document.

◆ GetTextRange()

wxString wxScintilla::GetTextRange ( int  startPos,
int  endPos 
)

◆ GetTextRangeRaw()

wxCharBuffer wxScintilla::GetTextRangeRaw ( int  startPos,
int  endPos 
)

Retrieve a range of text.

◆ GetTextRaw()

wxCharBuffer wxScintilla::GetTextRaw ( )

Retrieve all the text in the document.

◆ GetTwoPhaseDraw()

bool wxScintilla::GetTwoPhaseDraw ( ) const

Is drawing done in two phases with backgrounds drawn before foregrounds?

◆ GetUndoCollection()

bool wxScintilla::GetUndoCollection ( ) const

Is undo history being collected?

◆ GetUseAntiAliasing()

bool wxScintilla::GetUseAntiAliasing ( )

Returns the current UseAntiAliasing setting.

◆ GetUseHorizontalScrollBar()

bool wxScintilla::GetUseHorizontalScrollBar ( ) const

Is the horizontal scroll bar visible?

◆ GetUseTabs()

bool wxScintilla::GetUseTabs ( ) const

◆ GetUseVerticalScrollBar()

bool wxScintilla::GetUseVerticalScrollBar ( ) const

Is the vertical scroll bar visible?

◆ GetValue()

wxString wxScintilla::GetValue ( ) const
inlineprotected

Definition at line 5346 of file wxscintilla.h.

◆ GetViewEOL()

bool wxScintilla::GetViewEOL ( ) const

Are the end of line characters visible?

◆ GetViewWhiteSpace()

int wxScintilla::GetViewWhiteSpace ( ) const

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

◆ GetVirtualSpaceOptions()

int wxScintilla::GetVirtualSpaceOptions ( ) const

Return options for virtual space behaviour.

◆ GetWhitespaceChars()

wxString wxScintilla::GetWhitespaceChars ( ) const

Get the set of characters making up whitespace for when moving or selecting by word.

◆ GetWhitespaceSize()

int wxScintilla::GetWhitespaceSize ( ) const

Get the size of the dots used to mark space characters.

◆ GetWordChars()

wxString wxScintilla::GetWordChars ( ) const

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

◆ GetWrapIndentMode()

int wxScintilla::GetWrapIndentMode ( ) const

Retrieve how wrapped sublines are placed. Default is wxSCI_WRAPINDENT_FIXED.

◆ GetWrapMode()

int wxScintilla::GetWrapMode ( ) const

Retrieve whether text is word wrapped.

◆ GetWrapStartIndent()

int wxScintilla::GetWrapStartIndent ( ) const

Retrive the start indent for wrapped lines.

◆ GetWrapVisualFlags()

int wxScintilla::GetWrapVisualFlags ( ) const

Retrive the display mode of visual flags for wrapped lines.

◆ GetWrapVisualFlagsLocation()

int wxScintilla::GetWrapVisualFlagsLocation ( ) const

Retrive the location of visual flags for wrapped lines.

◆ GetXOffset()

int wxScintilla::GetXOffset ( ) const

Get the xOffset (ie, horizontal scroll position).

◆ GetZoom()

int wxScintilla::GetZoom ( ) const

◆ GotoLine()

void wxScintilla::GotoLine ( int  line)

◆ GotoPos()

void wxScintilla::GotoPos ( int  caret)

◆ HaveMouseCapture()

bool wxScintilla::HaveMouseCapture ( ) const

◆ HideLines()

void wxScintilla::HideLines ( int  lineStart,
int  lineEnd 
)

Make a range of lines invisible.

Referenced by cbEditor::DoFoldAll().

◆ HideSelection()

void wxScintilla::HideSelection ( bool  hide)

Draw the selection in normal style or with selection highlighted.

◆ Home()

void wxScintilla::Home ( )

Move caret to first position on line.

◆ HomeDisplay()

void wxScintilla::HomeDisplay ( )

Move caret to first position on display line.

Referenced by InsertNewLine().

◆ HomeDisplayExtend()

void wxScintilla::HomeDisplayExtend ( )

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

◆ HomeExtend()

void wxScintilla::HomeExtend ( )

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

◆ HomeRectExtend()

void wxScintilla::HomeRectExtend ( )

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

◆ HomeWrap()

void wxScintilla::HomeWrap ( )

Like Home but when word-wrap is enabled goes first to start of display line HomeDisplay, then to start of document line Home.

◆ HomeWrapExtend()

void wxScintilla::HomeWrapExtend ( )

Like HomeExtend but when word-wrap is enabled extends first to start of display line HomeDisplayExtend, then to start of document line HomeExtend.

◆ IndicatorAllOnFor()

int wxScintilla::IndicatorAllOnFor ( int  pos)

Are any indicators present at pos?

◆ IndicatorClearRange()

void wxScintilla::IndicatorClearRange ( int  start,
int  lengthClear 
)

Turn a indicator off over a range.

Referenced by cbStyledTextCtrl::HighlightRightBrace(), and MainFrame::OnEditSelectAll().

◆ IndicatorEnd()

int wxScintilla::IndicatorEnd ( int  indicator,
int  pos 
)

Where does a particular indicator end?

◆ IndicatorFillRange()

void wxScintilla::IndicatorFillRange ( int  start,
int  lengthFill 
)

Turn a indicator on over a range.

Referenced by cbStyledTextCtrl::HighlightRightBrace(), and MainFrame::OnEditSelectNextSkip().

◆ IndicatorGetAlpha()

int wxScintilla::IndicatorGetAlpha ( int  indicator) const

Get the alpha fill colour of the given indicator.

◆ IndicatorGetFlags()

int wxScintilla::IndicatorGetFlags ( int  indicator) const

Retrieve the attributes of an indicator.

◆ IndicatorGetForeground()

wxColour wxScintilla::IndicatorGetForeground ( int  indicator) const

Retrieve the foreground colour of an indicator.

Referenced by cbEditor::Split().

◆ IndicatorGetHoverForeground()

wxColour wxScintilla::IndicatorGetHoverForeground ( int  indicator) const

Retrieve the foreground hover colour of an indicator.

◆ IndicatorGetHoverStyle()

int wxScintilla::IndicatorGetHoverStyle ( int  indicator) const

Retrieve the hover style of an indicator.

◆ IndicatorGetOutlineAlpha()

int wxScintilla::IndicatorGetOutlineAlpha ( int  indicator) const

Get the alpha outline colour of the given indicator.

◆ IndicatorGetStyle()

int wxScintilla::IndicatorGetStyle ( int  indicator) const

Retrieve the style of an indicator.

Referenced by cbEditor::Split().

◆ IndicatorGetUnder()

bool wxScintilla::IndicatorGetUnder ( int  indicator) const

Retrieve whether indicator drawn under or over text.

Referenced by cbEditor::Split().

◆ IndicatorSetAlpha()

void wxScintilla::IndicatorSetAlpha ( int  indicator,
int  alpha 
)

Set the alpha fill colour of the given indicator.

◆ IndicatorSetFlags()

void wxScintilla::IndicatorSetFlags ( int  indicator,
int  flags 
)

Set the attributes of an indicator.

◆ IndicatorSetForeground()

void wxScintilla::IndicatorSetForeground ( int  indicator,
const wxColour fore 
)

Set the foreground colour of an indicator.

Referenced by cbStyledTextCtrl::HighlightRightBrace(), and cbEditor::Split().

◆ IndicatorSetHoverForeground()

void wxScintilla::IndicatorSetHoverForeground ( int  indicator,
const wxColour fore 
)

Set the foreground hover colour of an indicator.

◆ IndicatorSetHoverStyle()

void wxScintilla::IndicatorSetHoverStyle ( int  indicator,
int  indicatorStyle 
)

Set a hover indicator to plain, squiggle or TT.

◆ IndicatorSetOutlineAlpha()

void wxScintilla::IndicatorSetOutlineAlpha ( int  indicator,
int  alpha 
)

Set the alpha outline colour of the given indicator.

◆ IndicatorSetStyle()

void wxScintilla::IndicatorSetStyle ( int  indicator,
int  indicatorStyle 
)

Set an indicator to plain, squiggle or TT.

Referenced by cbStyledTextCtrl::HighlightRightBrace(), and cbEditor::Split().

◆ IndicatorSetUnder()

void wxScintilla::IndicatorSetUnder ( int  indicator,
bool  under 
)

Set an indicator to draw under text or over(default).

Referenced by cbStyledTextCtrl::HighlightRightBrace(), and cbEditor::Split().

◆ IndicatorStart()

int wxScintilla::IndicatorStart ( int  indicator,
int  pos 
)

Where does a particular indicator start?

◆ IndicatorValueAt()

int wxScintilla::IndicatorValueAt ( int  indicator,
int  pos 
)

What value does a particular indicator have at a position?

◆ InsertText()

void wxScintilla::InsertText ( int  pos,
const wxString text 
)

◆ InsertTextRaw()

void wxScintilla::InsertTextRaw ( int  pos,
const char *  text 
)

Insert string at a position.

◆ IsEditable()

virtual bool wxScintilla::IsEditable ( ) const
inlinevirtual

Definition at line 5330 of file wxscintilla.h.

◆ IsRangeWord()

bool wxScintilla::IsRangeWord ( int  start,
int  end 
)

Is the range start..end considered a word?

◆ LineCopy()

void wxScintilla::LineCopy ( )

Copy the line containing the caret.

Referenced by MainFrame::OnEditLineCopy().

◆ LineCut()

void wxScintilla::LineCut ( )

Cut the line containing the caret.

Referenced by MainFrame::OnEditLineCut().

◆ LineDelete()

void wxScintilla::LineDelete ( )

Delete the line containing the caret.

Referenced by MainFrame::OnEditLineDelete().

◆ LineDown()

void wxScintilla::LineDown ( )

Move caret down one line.

Referenced by InsertNewLine().

◆ LineDownExtend()

void wxScintilla::LineDownExtend ( )

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

◆ LineDownRectExtend()

void wxScintilla::LineDownRectExtend ( )

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

◆ LineDuplicate()

void wxScintilla::LineDuplicate ( )

Duplicate the current line.

Referenced by MainFrame::OnEditLineDuplicate().

◆ LineEnd()

void wxScintilla::LineEnd ( )

Move caret to last position on line.

Referenced by MainFrame::OnEditGotoLineEnd().

◆ LineEndDisplay()

void wxScintilla::LineEndDisplay ( )

Move caret to last position on display line.

Referenced by InsertNewLine().

◆ LineEndDisplayExtend()

void wxScintilla::LineEndDisplayExtend ( )

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

◆ LineEndExtend()

void wxScintilla::LineEndExtend ( )

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

◆ LineEndRectExtend()

void wxScintilla::LineEndRectExtend ( )

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

◆ LineEndWrap()

void wxScintilla::LineEndWrap ( )

Like LineEnd but when word-wrap is enabled goes first to end of display line LineEndDisplay, then to start of document line LineEnd.

◆ LineEndWrapExtend()

void wxScintilla::LineEndWrapExtend ( )

Like LineEndExtend but when word-wrap is enabled extends first to end of display line LineEndDisplayExtend, then to start of document line LineEndExtend.

◆ LineFromPosition()

int wxScintilla::LineFromPosition ( int  pos) const

◆ LineLength()

int wxScintilla::LineLength ( int  line) const

◆ LineScroll()

void wxScintilla::LineScroll ( int  columns,
int  lines 
)

Scroll horizontally and vertically.

Referenced by cbStyledTextCtrl::MakeNearbyLinesVisible().

◆ LineScrollDown()

void wxScintilla::LineScrollDown ( )

Scroll the document down, keeping the caret visible.

◆ LineScrollUp()

void wxScintilla::LineScrollUp ( )

Scroll the document up, keeping the caret visible.

◆ LinesJoin()

void wxScintilla::LinesJoin ( )

Join the lines in the target.

◆ LinesOnScreen()

int wxScintilla::LinesOnScreen ( ) const

◆ LinesSplit()

void wxScintilla::LinesSplit ( int  pixelWidth)

Split the lines in the target into lines that are less wide than pixelWidth where possible.

◆ LineTranspose()

void wxScintilla::LineTranspose ( )

Switch the current line with the previous.

Referenced by MainFrame::OnEditLineTranspose().

◆ LineUp()

void wxScintilla::LineUp ( )

Move caret up one line.

◆ LineUpExtend()

void wxScintilla::LineUpExtend ( )

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

◆ LineUpRectExtend()

void wxScintilla::LineUpRectExtend ( )

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

◆ LoadFile()

bool wxScintilla::LoadFile ( const wxString filename)

Load the contents of filename into the editor.

Referenced by EditorConfigurationDlg::CreateColoursSample().

◆ LoadLexerLibrary()

void wxScintilla::LoadLexerLibrary ( const wxString path)

Load a lexer library (dll / so).

◆ LowerCase()

void wxScintilla::LowerCase ( )

Transform the selection to lower case.

Referenced by cbEditor::OnContextMenuEntry(), and MainFrame::OnEditLowerCase().

◆ MarginGetStyle()

int wxScintilla::MarginGetStyle ( int  line) const

Get the style number for the text margin for a line.

◆ MarginGetStyleOffset()

int wxScintilla::MarginGetStyleOffset ( ) const

Get the start of the range of style numbers used for margin text.

◆ MarginGetStyles()

wxString wxScintilla::MarginGetStyles ( int  line) const

Get the styles in the text margin for a line.

◆ MarginGetText()

wxString wxScintilla::MarginGetText ( int  line) const

Get the text in the text margin for a line.

◆ MarginSetStyle()

void wxScintilla::MarginSetStyle ( int  line,
int  style 
)

Set the style number for the text margin for a line.

◆ MarginSetStyleOffset()

void wxScintilla::MarginSetStyleOffset ( int  style)

Get the start of the range of style numbers used for margin text.

◆ MarginSetStyles()

void wxScintilla::MarginSetStyles ( int  line,
const wxString styles 
)

Set the style in the text margin for a line.

◆ MarginSetText()

void wxScintilla::MarginSetText ( int  line,
const wxString text 
)

Set the text in the text margin for a line.

◆ MarginTextClearAll()

void wxScintilla::MarginTextClearAll ( )

Clear the margin text on all lines.

◆ MarkerAdd()

int wxScintilla::MarkerAdd ( int  line,
int  markerNumber 
)

◆ MarkerAddSet()

void wxScintilla::MarkerAddSet ( int  line,
int  markerSet 
)

Add a set of markers to a line.

◆ MarkerDefine()

void wxScintilla::MarkerDefine ( int  markerNumber,
int  markerSymbol,
const wxColour foreground = wxNullColour,
const wxColour background = wxNullColour 
)

Set the symbol used for a particular marker number, and optionally the fore and background colours.

Referenced by cbEditor::CreateEditor(), cbEditor::InternalSetEditorStyleBeforeFileOpen(), and cbEditor::SetMarkerStyle().

◆ MarkerDefineBitmap()

void wxScintilla::MarkerDefineBitmap ( int  markerNumber,
const wxBitmap bmp 
)

Define a marker from a bitmap.

Referenced by cbEditor::InternalSetEditorStyleBeforeFileOpen().

◆ MarkerDefineRGBAImage()

void wxScintilla::MarkerDefineRGBAImage ( int  markerNumber,
const unsigned char *  pixels 
)

Define a marker from RGBA data.

It has the width and height from RGBAImageSetWidth/Height

◆ MarkerDelete()

void wxScintilla::MarkerDelete ( int  line,
int  markerNumber 
)

◆ MarkerDeleteAll()

void wxScintilla::MarkerDeleteAll ( int  markerNumber)

◆ MarkerDeleteHandle()

void wxScintilla::MarkerDeleteHandle ( int  markerHandle)

Delete a marker.

◆ MarkerEnableHighlight()

void wxScintilla::MarkerEnableHighlight ( bool  enabled)

Enable/disable highlight for current folding bloc (smallest one that contains the caret)

◆ MarkerGet()

int wxScintilla::MarkerGet ( int  line)

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

Referenced by cbEditor::BreakpointMarkerToggle(), and cbEditor::LineHasMarker().

◆ MarkerLineFromHandle()

int wxScintilla::MarkerLineFromHandle ( int  markerHandle)

Retrieve the line number at which a particular marker is located.

◆ MarkerNext()

int wxScintilla::MarkerNext ( int  lineStart,
int  markerMask 
)

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

Return -1 when no more lines.

Referenced by cbEditor::MarkerNext(), and cbEditor::RefreshBreakpointMarkers().

◆ MarkerPrevious()

int wxScintilla::MarkerPrevious ( int  lineStart,
int  markerMask 
)

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

Referenced by cbEditor::MarkerPrevious().

◆ MarkerSetAlpha()

void wxScintilla::MarkerSetAlpha ( int  markerNumber,
int  alpha 
)

Set the alpha used for a marker that is drawn in the text area, not the margin.

◆ MarkerSetBackground()

void wxScintilla::MarkerSetBackground ( int  markerNumber,
const wxColour back 
)

Set the background colour used for a particular marker number.

Referenced by cbEditor::InternalSetEditorStyleBeforeFileOpen(), cbEditor::SetLanguageDependentColours(), and cbEditor::SetMarkerStyle().

◆ MarkerSetBackgroundSelected()

void wxScintilla::MarkerSetBackgroundSelected ( int  markerNumber,
const wxColour back 
)

Set the background colour used for a particular marker number when its folding block is selected.

◆ MarkerSetForeground()

void wxScintilla::MarkerSetForeground ( int  markerNumber,
const wxColour fore 
)

Set the foreground colour used for a particular marker number.

Referenced by cbEditor::SetMarkerStyle().

◆ MoveCaretInsideView()

void wxScintilla::MoveCaretInsideView ( )

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

◆ MoveSelectedLinesDown()

void wxScintilla::MoveSelectedLinesDown ( )

Move the selected lines down one line, shifting the line below before the selection.

◆ MoveSelectedLinesUp()

void wxScintilla::MoveSelectedLinesUp ( )

Move the selected lines up one line, shifting the line above after the selection.

◆ MultiEdgeAddLine()

void wxScintilla::MultiEdgeAddLine ( int  column,
const wxColour edgeColour 
)

Add a new vertical edge to the view.

◆ MultiEdgeClearAll()

void wxScintilla::MultiEdgeClearAll ( )

Clear all vertical edges.

◆ MultipleSelectAddEach()

void wxScintilla::MultipleSelectAddEach ( )

Add each occurrence of the main selection in the target to the set of selections.

If the current selection is empty then select word around caret.

◆ MultipleSelectAddNext()

void wxScintilla::MultipleSelectAddNext ( )

Add the next occurrence of the main selection to the set of selections as main.

If the current selection is empty then select word around caret.

◆ NewLine()

void wxScintilla::NewLine ( )

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

Referenced by MainFrame::OnEditInsertNewLine().

◆ NotifyChange()

void wxScintilla::NotifyChange ( )
protected

Turn notifications from Scintilla into events.

◆ NotifyParent()

void wxScintilla::NotifyParent ( SCNotification *  scn)
protected

◆ OnChar()

void wxScintilla::OnChar ( wxKeyEvent evt)
protected

◆ OnContextMenu()

void wxScintilla::OnContextMenu ( wxContextMenuEvent evt)
protected

◆ OnEraseBackground()

void wxScintilla::OnEraseBackground ( wxEraseEvent evt)
protected

◆ OnGainFocus()

void wxScintilla::OnGainFocus ( wxFocusEvent evt)
protected

◆ OnIdle()

void wxScintilla::OnIdle ( wxIdleEvent evt)
protected

◆ OnKeyDown()

void wxScintilla::OnKeyDown ( wxKeyEvent evt)
protected

◆ OnListBox()

void wxScintilla::OnListBox ( wxCommandEvent evt)
protected

◆ OnLoseFocus()

void wxScintilla::OnLoseFocus ( wxFocusEvent evt)
protected

◆ OnMenu()

void wxScintilla::OnMenu ( wxCommandEvent evt)
protected

◆ OnMouseCaptureLost()

void wxScintilla::OnMouseCaptureLost ( wxMouseCaptureLostEvent evt)
protected

◆ OnMouseLeftDown()

void wxScintilla::OnMouseLeftDown ( wxMouseEvent evt)
protected

◆ OnMouseLeftUp()

void wxScintilla::OnMouseLeftUp ( wxMouseEvent evt)
protected

◆ OnMouseMiddleUp()

void wxScintilla::OnMouseMiddleUp ( wxMouseEvent evt)
protected

◆ OnMouseMove()

void wxScintilla::OnMouseMove ( wxMouseEvent evt)
protected

◆ OnMouseRightDown()

void wxScintilla::OnMouseRightDown ( wxMouseEvent evt)
protected

◆ OnMouseRightUp()

void wxScintilla::OnMouseRightUp ( wxMouseEvent evt)
protected

◆ OnMouseWheel()

void wxScintilla::OnMouseWheel ( wxMouseEvent evt)
protected

◆ OnPaint()

void wxScintilla::OnPaint ( wxPaintEvent evt)
protected

Event handlers.

◆ OnScroll()

void wxScintilla::OnScroll ( wxScrollEvent evt)
protected

◆ OnScrollWin()

void wxScintilla::OnScrollWin ( wxScrollWinEvent evt)
protected

◆ OnSize()

void wxScintilla::OnSize ( wxSizeEvent evt)
protected

◆ OnSysColourChanged()

void wxScintilla::OnSysColourChanged ( wxSysColourChangedEvent evt)
protected

◆ PageDown()

void wxScintilla::PageDown ( )

Move caret one page down.

◆ PageDownExtend()

void wxScintilla::PageDownExtend ( )

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

◆ PageDownRectExtend()

void wxScintilla::PageDownRectExtend ( )

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

◆ PageUp()

void wxScintilla::PageUp ( )

Move caret one page up.

◆ PageUpExtend()

void wxScintilla::PageUpExtend ( )

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

◆ PageUpRectExtend()

void wxScintilla::PageUpRectExtend ( )

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

◆ ParaDown()

void wxScintilla::ParaDown ( )

Move caret down one paragraph (delimited by empty lines).

Referenced by MainFrame::OnEditParaDown().

◆ ParaDownExtend()

void wxScintilla::ParaDownExtend ( )

Extend selection down one paragraph (delimited by empty lines).

Referenced by MainFrame::OnEditParaDownExtend().

◆ ParaUp()

void wxScintilla::ParaUp ( )

Move caret up one paragraph (delimited by empty lines).

Referenced by MainFrame::OnEditParaUp().

◆ ParaUpExtend()

void wxScintilla::ParaUpExtend ( )

Extend selection up one paragraph (delimited by empty lines).

Referenced by MainFrame::OnEditParaUpExtend().

◆ Paste()

void wxScintilla::Paste ( )

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

Referenced by cbEditor::OnContextMenuEntry(), MainFrame::OnEditLinePaste(), and cbEditor::Paste().

◆ PointFromPosition()

wxPoint wxScintilla::PointFromPosition ( int  pos)

Retrieve the point in the window where a position is displayed.

Referenced by ConfirmReplaceDlg::CalcPosition(), EditorBase::DisplayContextMenu(), CCManager::DoShowTips(), and CCManager::OnMenuSelect().

◆ PositionAfter()

int wxScintilla::PositionAfter ( int  pos)

Given a valid document position, return the next position taking code page into account.

Maximum value returned is the last position in the document.

◆ PositionBefore()

int wxScintilla::PositionBefore ( int  pos)

Given a valid document position, return the previous position taking code page into account.

Returns 0 if passed 0.

◆ PositionFromLine()

int wxScintilla::PositionFromLine ( int  line) const

◆ PositionFromPoint()

int wxScintilla::PositionFromPoint ( wxPoint  pt) const

◆ PositionFromPointClose()

int wxScintilla::PositionFromPointClose ( int  x,
int  y 
)

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

Referenced by cbDebuggerPlugin::GetEditorWordAtCaret(), and CCManager::OnEditorTooltip().

◆ PositionRelative()

int wxScintilla::PositionRelative ( int  pos,
int  relative 
)

Given a valid document position, return a position that differs in a number of characters.

Returned value is always between 0 and last position in document.

◆ PrivateLexerCall()

void* wxScintilla::PrivateLexerCall ( int  operation,
void *  pointer 
)

For private communication between an application and a known lexer.

◆ PropertyNames()

wxString wxScintilla::PropertyNames ( ) const

Retrieve a '\n' separated list of properties understood by the current lexer.

◆ PropertyType()

int wxScintilla::PropertyType ( const wxString name)

Retrieve the type of a property.

◆ Redo()

void wxScintilla::Redo ( )

Redoes the next action on the undo history.

Referenced by cbEditor::OnContextMenuEntry(), and cbEditor::Redo().

◆ RegisterImage()

void wxScintilla::RegisterImage ( int  type,
const wxBitmap bmp 
)

◆ RegisterRGBAImage()

void wxScintilla::RegisterRGBAImage ( int  type,
const unsigned char *  pixels 
)

Register an RGBA image for use in autocompletion lists.

It has the width and height from RGBAImageSetWidth/Height

◆ ReleaseAllExtendedStyles()

void wxScintilla::ReleaseAllExtendedStyles ( )

Release all extended (>255) style numbers.

◆ ReleaseDocument()

void wxScintilla::ReleaseDocument ( void *  docPointer)

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

◆ Remove()

virtual void wxScintilla::Remove ( long  from,
long  to 
)
inlinevirtual

Definition at line 5256 of file wxscintilla.h.

References wxT.

◆ Replace()

virtual void wxScintilla::Replace ( long  from,
long  to,
const wxString text 
)
inlinevirtual

Definition at line 5260 of file wxscintilla.h.

◆ ReplaceSelection()

void wxScintilla::ReplaceSelection ( const wxString text)

Replace the selected text with the argument text.

Referenced by cbEditor::OnContextMenuEntry(), FindReplace::Replace(), and FindReplace::ReplaceInFiles().

◆ ReplaceTarget()

int wxScintilla::ReplaceTarget ( const wxString text)

◆ ReplaceTargetRE()

int wxScintilla::ReplaceTargetRE ( const wxString text)

Replace the target text with the argument text after \d processing.

Text is counted so it can contain NULs. 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.

Referenced by FindReplace::Replace(), and FindReplace::ReplaceInFiles().

◆ RGBAImageSetHeight()

void wxScintilla::RGBAImageSetHeight ( int  height)

Set the height for future RGBA image data.

◆ RGBAImageSetScale()

void wxScintilla::RGBAImageSetScale ( int  scalePercent)

Set the scale factor in percent for future RGBA image data.

◆ RGBAImageSetWidth()

void wxScintilla::RGBAImageSetWidth ( int  width)

Set the width for future RGBA image data.

◆ RotateSelection()

void wxScintilla::RotateSelection ( )

Set the main selection to the next selection.

◆ SaveFile()

bool wxScintilla::SaveFile ( const wxString filename)

Write the contents of the editor to filename.

◆ ScrollRange()

void wxScintilla::ScrollRange ( int  secondary,
int  primary 
)

Scroll the argument positions and the range between them into view giving priority to the primary position then the secondary position.

This may be used to make a search match visible.

◆ ScrollToColumn()

void wxScintilla::ScrollToColumn ( int  column)

Scroll enough to make the given column visible.

Referenced by cbEditor::SetProjectFile().

◆ ScrollToEnd()

void wxScintilla::ScrollToEnd ( )

Scroll to end of document.

◆ ScrollToLine()

void wxScintilla::ScrollToLine ( int  line)

Scroll enough to make the given line visible.

Referenced by cbEditor::SetProjectFile().

◆ ScrollToStart()

void wxScintilla::ScrollToStart ( )

Scroll to start of document.

◆ SearchAnchor()

void wxScintilla::SearchAnchor ( )

Sets the current caret position to be the search anchor.

◆ SearchInTarget()

int wxScintilla::SearchInTarget ( const wxString text)

Search for a counted string in the target and set the target to the found range.

Text is counted so it can contain NULs. Returns length of range or -1 for failure in which case target is not moved.

◆ SearchNext()

int wxScintilla::SearchNext ( int  searchFlags,
const wxString text 
)

Find some text starting at the search anchor.

Does not ensure the selection is visible.

◆ SearchPrev()

int wxScintilla::SearchPrev ( int  searchFlags,
const wxString text 
)

Find some text starting at the search anchor and moving backwards.

Does not ensure the selection is visible.

◆ SelectAll()

void wxScintilla::SelectAll ( )

Select all the text in the document.

Referenced by cbEditor::OnContextMenuEntry(), and cbEditor::SelectAll().

◆ SelectionDuplicate()

void wxScintilla::SelectionDuplicate ( )

Duplicate the selection. If selection empty duplicate the line containing the caret.

◆ SelectionIsRectangle()

bool wxScintilla::SelectionIsRectangle ( ) const

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

◆ SelectNone()

virtual void wxScintilla::SelectNone ( )
inlinevirtual

Definition at line 5302 of file wxscintilla.h.

◆ SendMsg()

wxIntPtr wxScintilla::SendMsg ( int  msg,
wxUIntPtr  wp = 0,
wxIntPtr  lp = 0 
) const

Send a message to Scintilla.

NB: this method is not really const as it can modify the control but it has to be declared as such as it's called from both const and non-const methods and we can't distinguish between the two

Referenced by cbEditor::DoIndent(), and cbEditor::DoUnIndent().

◆ SetAdditionalCaretForeground()

void wxScintilla::SetAdditionalCaretForeground ( const wxColour fore)

Set the foreground colour of additional carets.

◆ SetAdditionalCaretsBlink()

void wxScintilla::SetAdditionalCaretsBlink ( bool  additionalCaretsBlink)

Set whether additional carets will blink.

◆ SetAdditionalCaretsVisible()

void wxScintilla::SetAdditionalCaretsVisible ( bool  additionalCaretsVisible)

Set whether additional carets are visible.

◆ SetAdditionalSelAlpha()

void wxScintilla::SetAdditionalSelAlpha ( int  alpha)

Set the alpha of the selection.

◆ SetAdditionalSelBackground()

void wxScintilla::SetAdditionalSelBackground ( const wxColour back)

Set the background colour of additional selections.

Must have previously called SetSelBack with non-zero first argument for this to have an effect.

◆ SetAdditionalSelectionTyping()

void wxScintilla::SetAdditionalSelectionTyping ( bool  additionalSelectionTyping)

Set whether typing can be performed into multiple selections.

Referenced by cbEditor::InternalSetEditorStyleBeforeFileOpen(), and MainFrame::OnEditSelectAll().

◆ SetAdditionalSelForeground()

void wxScintilla::SetAdditionalSelForeground ( const wxColour fore)

Set the foreground colour of additional selections.

Must have previously called SetSelFore with non-zero first argument for this to have an effect.

◆ SetAnchor()

void wxScintilla::SetAnchor ( int  anchor)

Set the selection anchor to a position.

The anchor is the opposite end of the selection from the caret.

◆ SetAutomaticFold()

void wxScintilla::SetAutomaticFold ( int  automaticFold)

Set automatic folding behaviours.

◆ SetBackSpaceUnIndents()

void wxScintilla::SetBackSpaceUnIndents ( bool  bsUnIndents)

Sets whether a backspace pressed when caret is within indentation unindents.

Referenced by cbEditor::InternalSetEditorStyleBeforeFileOpen().

◆ SetBufferedDraw()

void wxScintilla::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.

◆ SetCaretForeground()

void wxScintilla::SetCaretForeground ( const wxColour fore)

Set the foreground colour of the caret.

Referenced by cbStyledTextCtrl::HighlightRightBrace(), and cbEditor::InternalSetEditorStyleBeforeFileOpen().

◆ SetCaretLineBackAlpha()

void wxScintilla::SetCaretLineBackAlpha ( int  alpha)

Set background alpha of the caret line.

◆ SetCaretLineBackground()

void wxScintilla::SetCaretLineBackground ( const wxColour back)

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

Referenced by EditorColourSet::Apply().

◆ SetCaretLineVisible()

void wxScintilla::SetCaretLineVisible ( bool  show)

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

Referenced by EditorConfigurationDlg::CreateColoursSample(), and cbEditor::InternalSetEditorStyleBeforeFileOpen().

◆ SetCaretLineVisibleAlways()

void wxScintilla::SetCaretLineVisibleAlways ( bool  alwaysVisible)

Sets the caret line to always visible.

◆ SetCaretPeriod()

void wxScintilla::SetCaretPeriod ( int  periodMilliseconds)

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

Referenced by cbEditor::InternalSetEditorStyleBeforeFileOpen().

◆ SetCaretSticky()

void wxScintilla::SetCaretSticky ( int  useCaretStickyBehaviour)

Stop the caret preferred x position changing when the user types.

◆ SetCaretStyle()

void wxScintilla::SetCaretStyle ( int  caretStyle)

Set the style of the caret to be drawn.

Referenced by cbEditor::InternalSetEditorStyleBeforeFileOpen().

◆ SetCaretWidth()

void wxScintilla::SetCaretWidth ( int  pixelWidth)

Set the width of the insert mode caret.

Referenced by cbStyledTextCtrl::HighlightRightBrace(), and cbEditor::InternalSetEditorStyleBeforeFileOpen().

◆ SetChangeCollection()

void wxScintilla::SetChangeCollection ( bool  collectChange)

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

Referenced by MainFrame::OnFileNewWhat(), FindReplace::Replace(), FindReplace::ReplaceInFiles(), and cbEditor::SetChangeCollection().

◆ SetCharsDefault()

void wxScintilla::SetCharsDefault ( )

Reset the set of characters for whitespace and word characters to the defaults.

◆ SetCodePage()

void wxScintilla::SetCodePage ( int  codePage)

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

◆ SetControlCharSymbol()

void wxScintilla::SetControlCharSymbol ( int  symbol)

Change the way control characters are displayed: If symbol is < 32, keep the drawn way, else, use the given character.

◆ SetCurrentPos()

void wxScintilla::SetCurrentPos ( int  caret)

Sets the position of the caret.

◆ SetDocPointer()

void wxScintilla::SetDocPointer ( void *  docPointer)

Change the document object used.

Referenced by cbEditor::Split().

◆ SetEdgeColour()

void wxScintilla::SetEdgeColour ( const wxColour edgeColour)

Change the colour used in edge indication.

Referenced by cbEditor::InternalSetEditorStyleBeforeFileOpen().

◆ SetEdgeColumn()

void wxScintilla::SetEdgeColumn ( int  column)

Set the column number of the edge.

If text goes past the edge then it is highlighted.

Referenced by cbEditor::InternalSetEditorStyleBeforeFileOpen().

◆ SetEdgeMode()

void wxScintilla::SetEdgeMode ( int  edgeMode)

The edge may be displayed by a line (wxSCI_EDGE_LINE/wxSCI_EDGE_MULTILINE) or by highlighting text that goes beyond it (wxSCI_EDGE_BACKGROUND) or not displayed at all (wxSCI_EDGE_NONE).

Referenced by cbEditor::InternalSetEditorStyleBeforeFileOpen(), and cbEditor::Print().

◆ SetEditable()

virtual void wxScintilla::SetEditable ( bool  editable)
inlinevirtual

Definition at line 5331 of file wxscintilla.h.

◆ SetEmptySelection()

void wxScintilla::SetEmptySelection ( int  caret)

Set caret to a position, while removing any existing selection.

◆ SetEndAtLastLine()

void wxScintilla::SetEndAtLastLine ( bool  endAtLastLine)

Sets the scroll range so that maximum scroll position has the last line at the bottom of the view (default).

Setting this to false allows scrolling one page below the last line.

◆ SetEOLMode()

void wxScintilla::SetEOLMode ( int  eolMode)

Set the current end of line mode.

Referenced by cbEditor::InternalSetEditorStyleAfterFileOpen(), and MainFrame::OnEditEOLMode().

◆ SetExtraAscent()

void wxScintilla::SetExtraAscent ( int  extraAscent)

Set extra ascent for each line.

◆ SetExtraDescent()

void wxScintilla::SetExtraDescent ( int  extraDescent)

Set extra descent for each line.

◆ SetFirstVisibleLine()

void wxScintilla::SetFirstVisibleLine ( int  displayLine)

Scroll so that a display line is at the top of the display.

Referenced by DisassemblyDlg::CenterLine().

◆ SetFoldExpanded()

void wxScintilla::SetFoldExpanded ( int  line,
bool  expanded 
)

Show the children of a header line.

Referenced by cbEditor::DoFoldAll(), cbEditor::FixFoldState(), and cbEditor::OnEditorModified().

◆ SetFoldFlags()

void wxScintilla::SetFoldFlags ( int  flags)

Set some style options for folding.

Referenced by cbEditor::InternalSetEditorStyleAfterFileOpen(), and cbEditor::UnderlineFoldedLines().

◆ SetFoldLevel()

void wxScintilla::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.

Referenced by cbEditor::SaveFoldState().

◆ SetFoldMarginColour()

void wxScintilla::SetFoldMarginColour ( bool  useSetting,
const wxColour back 
)

Set one of the colours used as a chequerboard pattern in the fold margin.

Referenced by cbEditor::InternalSetEditorStyleBeforeFileOpen().

◆ SetFoldMarginHiColour()

void wxScintilla::SetFoldMarginHiColour ( bool  useSetting,
const wxColour fore 
)

Set the other colour used as a chequerboard pattern in the fold margin.

Referenced by cbEditor::InternalSetEditorStyleBeforeFileOpen().

◆ SetFontQuality()

void wxScintilla::SetFontQuality ( int  fontQuality)

Choose the quality level for text.

◆ SetHighlightGuide()

void wxScintilla::SetHighlightGuide ( int  column)

Set the highlighted indentation guide column.

0 = no highlighted guide.

Referenced by cbEditor::HighlightBraces().

◆ SetHotspotActiveBackground()

void wxScintilla::SetHotspotActiveBackground ( bool  useSetting,
const wxColour back 
)

Set a back colour for active hotspots.

◆ SetHotspotActiveForeground()

void wxScintilla::SetHotspotActiveForeground ( bool  useSetting,
const wxColour fore 
)

Set a fore colour for active hotspots.

◆ SetHotspotActiveUnderline()

void wxScintilla::SetHotspotActiveUnderline ( bool  underline)

Enable / Disable underlining active hotspots.

◆ SetHotspotSingleLine()

void wxScintilla::SetHotspotSingleLine ( bool  singleLine)

Limit hotspots to single line so hotspots on two lines don't merge.

◆ SetHScrollBar()

void wxScintilla::SetHScrollBar ( wxScrollBar bar)

Set the horizontal scrollbar to use instead of the one that's built-in.

◆ SetIdentifier()

void wxScintilla::SetIdentifier ( int  identifier)

Set the identifier reported as idFrom in notification messages.

◆ SetIdentifiers()

void wxScintilla::SetIdentifiers ( int  style,
const wxString identifiers 
)

Set the identifiers that are shown in a particular style.

◆ SetIdleStyling()

void wxScintilla::SetIdleStyling ( int  idleStyling)

Sets limits to idle styling.

◆ SetIMEInteraction()

void wxScintilla::SetIMEInteraction ( int  imeInteraction)

Choose to display the the IME in a winow or inline.

◆ SetIndent()

void wxScintilla::SetIndent ( int  indentSize)

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

◆ SetIndentationGuides()

void wxScintilla::SetIndentationGuides ( int  indentView)

◆ SetIndicatorCurrent()

void wxScintilla::SetIndicatorCurrent ( int  indicator)

Set the indicator used for IndicatorFillRange and IndicatorClearRange.

Referenced by cbStyledTextCtrl::HighlightRightBrace().

◆ SetIndicatorValue()

void wxScintilla::SetIndicatorValue ( int  value)

Set the value used for IndicatorFillRange.

◆ SetInsertionPoint()

virtual void wxScintilla::SetInsertionPoint ( long  pos)
inlinevirtual

Definition at line 5282 of file wxscintilla.h.

◆ SetKeyWords()

void wxScintilla::SetKeyWords ( int  keyWordSet,
const wxString keyWords 
)

Set up the key words used by the lexer.

Referenced by EditorColourSet::Apply(), EditorManager::CollectDefines(), and CodeCompletion::UpdateEditorSyntax().

◆ SetLastKeydownProcessed()

void wxScintilla::SetLastKeydownProcessed ( bool  val)
inline

Definition at line 5165 of file wxscintilla.h.

References NULL.

◆ SetLayoutCache()

void wxScintilla::SetLayoutCache ( int  cacheMode)

Sets the degree of caching of layout information.

◆ SetLexer()

void wxScintilla::SetLexer ( int  lexer)

Set the lexing language of the document.

Referenced by EditorColourSet::Apply().

◆ SetLexerLanguage()

void wxScintilla::SetLexerLanguage ( const wxString language)

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

◆ SetLineEndTypesAllowed()

void wxScintilla::SetLineEndTypesAllowed ( int  lineEndBitSet)

Set the line end types that the application wants to use. May not be used if incompatible with lexer or encoding.

◆ SetLineIndentation()

void wxScintilla::SetLineIndentation ( int  line,
int  indentation 
)

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

◆ SetLineState()

void wxScintilla::SetLineState ( int  line,
int  state 
)

Used to hold extra styling information for each line.

◆ SetMainSelection()

void wxScintilla::SetMainSelection ( int  selection)

Set the main selection.

◆ SetMarginBackground()

void wxScintilla::SetMarginBackground ( int  margin,
const wxColour back 
)

Set the background colour of a margin. Only visible for wxSCI_MARGIN_COLOUR.

◆ SetMarginCount()

void wxScintilla::SetMarginCount ( int  margins)

Allocate a non-standard number of margins.

◆ SetMarginCursor()

void wxScintilla::SetMarginCursor ( int  margin,
int  cursor 
)

Set the cursor shown when the mouse is inside a margin.

◆ SetMarginLeft()

void wxScintilla::SetMarginLeft ( int  pixelWidth)

Sets the size in pixels of the left margin.

◆ SetMarginMask()

void wxScintilla::SetMarginMask ( int  margin,
int  mask 
)

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

Referenced by cbEditor::DoInitializations(), cbEditor::InternalSetEditorStyleAfterFileOpen(), and cbEditor::InternalSetEditorStyleBeforeFileOpen().

◆ SetMarginOptions()

void wxScintilla::SetMarginOptions ( int  marginOptions)

Set the margin options.

◆ SetMarginRight()

void wxScintilla::SetMarginRight ( int  pixelWidth)

Sets the size in pixels of the right margin.

◆ SetMargins()

void wxScintilla::SetMargins ( int  left,
int  right 
)

Set the left and right margin in the edit area, measured in pixels.

◆ SetMarginSensitive()

void wxScintilla::SetMarginSensitive ( int  margin,
bool  sensitive 
)

Make a margin sensitive or insensitive to mouse clicks.

Referenced by cbEditor::InternalSetEditorStyleAfterFileOpen(), and cbEditor::InternalSetEditorStyleBeforeFileOpen().

◆ SetMarginType()

void wxScintilla::SetMarginType ( int  margin,
int  marginType 
)

◆ SetMarginWidth()

void wxScintilla::SetMarginWidth ( int  margin,
int  pixelWidth 
)

◆ SetModEventMask()

void wxScintilla::SetModEventMask ( int  eventMask)

Set which document modification events are sent to the container.

Referenced by cbEditor::Open().

◆ SetMouseCapture()

void wxScintilla::SetMouseCapture ( bool  on)

◆ SetMouseDownCaptures()

void wxScintilla::SetMouseDownCaptures ( bool  captures)

Set whether the mouse is captured when its button is pressed.

◆ SetMouseDwellTime()

void wxScintilla::SetMouseDwellTime ( int  periodMilliseconds)

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

Referenced by cbEditor::InternalSetEditorStyleBeforeFileOpen().

◆ SetMouseSelectionRectangularSwitch()

void wxScintilla::SetMouseSelectionRectangularSwitch ( bool  mouseSelectionRectangularSwitch)

Set whether switching to rectangular mode while selecting with the mouse is allowed.

◆ SetMouseWheelCaptures()

void wxScintilla::SetMouseWheelCaptures ( bool  captures)

Set whether the mouse wheel can be active outside the window.

◆ SetMultiPaste()

void wxScintilla::SetMultiPaste ( int  multiPaste)

Change the effect of pasting when there are multiple selections.

Referenced by cbEditor::InternalSetEditorStyleBeforeFileOpen(), and MainFrame::OnEditSelectAll().

◆ SetMultipleSelection()

void wxScintilla::SetMultipleSelection ( bool  multipleSelection)

Set whether multiple selections can be made.

Referenced by cbEditor::InternalSetEditorStyleBeforeFileOpen().

◆ SetOvertype()

void wxScintilla::SetOvertype ( bool  overType)

Set to overtype (true) or insert mode.

◆ SetPasteConvertEndings()

void wxScintilla::SetPasteConvertEndings ( bool  convert)

Enable/Disable convert-on-paste for line endings.

◆ SetPhasesDraw()

void wxScintilla::SetPhasesDraw ( int  phases)

In one phase draw, text is drawn in a series of rectangular blocks with no overlap.

In two phase draw, text is drawn in a series of lines allowing runs to overlap horizontally. In multiple phase draw, each element is drawn over the whole drawing area, allowing text to overlap from one line to the next.

◆ SetPositionCacheSize()

void wxScintilla::SetPositionCacheSize ( int  size)

Set number of entries in position cache.

◆ SetPrintColourMode()

void wxScintilla::SetPrintColourMode ( int  mode)

Modify colours when printing for clearer printed text.

Referenced by cbEditor::Print().

◆ SetPrintMagnification()

void wxScintilla::SetPrintMagnification ( int  magnification)

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

Referenced by cbEditor::Print().

◆ SetPrintWrapMode()

void wxScintilla::SetPrintWrapMode ( int  wrapMode)

Set printing to line wrapped (wxSCI_WRAP_WORD) or not line wrapped (wxSCI_WRAP_NONE).

◆ SetProperty()

void wxScintilla::SetProperty ( const wxString key,
const wxString value 
)

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

Referenced by cbEditor::InternalSetEditorStyleAfterFileOpen().

◆ SetPunctuationChars()

void wxScintilla::SetPunctuationChars ( const wxString characters)

Set the set of characters making up punctuation characters Should be called after SetWordChars.

◆ SetReadOnly()

void wxScintilla::SetReadOnly ( bool  readOnly)

◆ SetRectangularSelectionAnchor()

void wxScintilla::SetRectangularSelectionAnchor ( int  anchor)

Set the anchor position of the rectangular selection.

◆ SetRectangularSelectionAnchorVirtualSpace()

void wxScintilla::SetRectangularSelectionAnchorVirtualSpace ( int  space)

Set the virtual space of the anchor of the rectangular selection.

◆ SetRectangularSelectionCaret()

void wxScintilla::SetRectangularSelectionCaret ( int  caret)

Set the caret position of the rectangular selection.

◆ SetRectangularSelectionCaretVirtualSpace()

void wxScintilla::SetRectangularSelectionCaretVirtualSpace ( int  space)

Set the virtual space of the caret of the rectangular selection.

◆ SetRectangularSelectionModifier()

void wxScintilla::SetRectangularSelectionModifier ( int  modifier)

On GTK+, allow selecting the modifier key to use for mouse-based rectangular selection.

Often the window manager requires Alt+Mouse Drag for moving windows. Valid values are wxSCI_KEYMOD_CTRL (default), wxSCI_KEYMOD_ALT, or wxSCI_KEYMOD_SUPER.

◆ SetRepresentation()

void wxScintilla::SetRepresentation ( const wxString encodedCharacter,
const wxString representation 
)

Set the way a character is drawn.

◆ SetSavePoint()

void wxScintilla::SetSavePoint ( )

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

Referenced by cbEditor::Save(), and cbEditor::SetModified().

◆ SetSCICursor()

void wxScintilla::SetSCICursor ( int  cursorType)

Sets the cursor to one of the wxSCI_CURSOR* values.

◆ SetSCIFocus()

void wxScintilla::SetSCIFocus ( bool  focus)

Change internal focus flag.

Referenced by FindReplace::Find(), FindReplace::FindInFiles(), and FindReplace::Replace().

◆ SetScrollWidth()

void wxScintilla::SetScrollWidth ( int  pixelWidth)

Sets the document width assumed for scrolling.

◆ SetScrollWidthTracking()

void wxScintilla::SetScrollWidthTracking ( bool  tracking)

Sets whether the maximum width line displayed is used to set scroll width.

Referenced by cbEditor::InternalSetEditorStyleBeforeFileOpen().

◆ SetSearchFlags()

void wxScintilla::SetSearchFlags ( int  searchFlags)

Set the search flags used by SearchInTarget.

◆ SetSelAlpha()

void wxScintilla::SetSelAlpha ( int  alpha)

Set the alpha of the selection.

◆ SetSelBackground()

void wxScintilla::SetSelBackground ( bool  useSetting,
const wxColour back 
)

Set the background colour of the main and additional selections and whether to use this setting.

Referenced by EditorColourSet::Apply().

◆ SetSelection()

virtual void wxScintilla::SetSelection ( long  from,
long  to 
)
inlinevirtual

Definition at line 5289 of file wxscintilla.h.

Referenced by MainFrame::OnEditSelectNext().

◆ SetSelectionEnd()

void wxScintilla::SetSelectionEnd ( int  caret)

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

Referenced by FindReplace::FindSelectedText().

◆ SetSelectionInt()

int wxScintilla::SetSelectionInt ( int  caret,
int  anchor 
)

Set a simple selection.

Referenced by cbEditor::GotoTokenPosition().

◆ SetSelectionMode()

void wxScintilla::SetSelectionMode ( int  selectionMode)

Set the selection mode to stream (wxSCI_SEL_STREAM) or rectangular (wxSCI_SEL_RECTANGLE/wxSCI_SEL_THIN) or by lines (wxSCI_SEL_LINES).

◆ SetSelectionNAnchor()

void wxScintilla::SetSelectionNAnchor ( int  selection,
int  anchor 
)

Set the anchor position of the nth selection.

Referenced by MainFrame::OnEditSelectNextSkip().

◆ SetSelectionNAnchorVirtualSpace()

void wxScintilla::SetSelectionNAnchorVirtualSpace ( int  selection,
int  space 
)

Set the virtual space of the anchor of the nth selection.

Referenced by cbEditor::Save().

◆ SetSelectionNCaret()

void wxScintilla::SetSelectionNCaret ( int  selection,
int  caret 
)

Set the caret position of the nth selection.

Referenced by MainFrame::OnEditSelectNextSkip().

◆ SetSelectionNCaretVirtualSpace()

void wxScintilla::SetSelectionNCaretVirtualSpace ( int  selection,
int  space 
)

Set the virtual space of the caret of the nth selection.

Referenced by cbEditor::Save().

◆ SetSelectionNEnd()

void wxScintilla::SetSelectionNEnd ( int  selection,
int  caret 
)

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

◆ SetSelectionNStart()

void wxScintilla::SetSelectionNStart ( int  selection,
int  anchor 
)

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

◆ SetSelectionStart()

void wxScintilla::SetSelectionStart ( int  anchor)

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

Referenced by FindReplace::FindSelectedText().

◆ SetSelectionVoid()

void wxScintilla::SetSelectionVoid ( int  startPos,
int  endPos 
)

◆ SetSelEOLFilled()

void wxScintilla::SetSelEOLFilled ( bool  filled)

Set the selection to have its end of line filled or not.

◆ SetSelForeground()

void wxScintilla::SetSelForeground ( bool  useSetting,
const wxColour fore 
)

Set the foreground colour of the main and additional selections and whether to use this setting.

Referenced by EditorColourSet::Apply().

◆ SetStatus()

void wxScintilla::SetStatus ( int  status)

Change error status - 0 = OK.

◆ SetStyleBytes()

void wxScintilla::SetStyleBytes ( int  length,
char *  styleBytes 
)

Set the styles for a segment of the document.

◆ SetStyling()

void wxScintilla::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.

◆ SetTabDrawMode()

void wxScintilla::SetTabDrawMode ( int  tabDrawMode)

Set how tabs are drawn when visible.

◆ SetTabIndents()

void wxScintilla::SetTabIndents ( bool  tabIndents)

Sets whether a tab pressed when caret is within indentation indents.

Referenced by cbEditor::InternalSetEditorStyleBeforeFileOpen().

◆ SetTabWidth()

void wxScintilla::SetTabWidth ( int  tabWidth)

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

Referenced by EditorConfigurationDlg::CreateColoursSample(), cbEditor::InternalSetEditorStyleAfterFileOpen(), and cbEditor::InternalSetEditorStyleBeforeFileOpen().

◆ SetTargetEnd()

void wxScintilla::SetTargetEnd ( int  end)

◆ SetTargetRange()

void wxScintilla::SetTargetRange ( int  start,
int  end 
)

Sets both the start and end of the target in one call.

◆ SetTargetStart()

void wxScintilla::SetTargetStart ( int  start)

◆ SetTechnology()

void wxScintilla::SetTechnology ( int  technology)

Set the technology used.

◆ SetText()

void wxScintilla::SetText ( const wxString text)

◆ SetTextRaw()

void wxScintilla::SetTextRaw ( const char *  text)

Replace the contents of the document with the argument text.

◆ SetTwoPhaseDraw()

void wxScintilla::SetTwoPhaseDraw ( bool  twoPhase)

In twoPhaseDraw mode, drawing is performed in two phases, first the background and then the foreground.

This avoids chopping off characters that overlap the next run.

◆ SetUndoCollection()

void wxScintilla::SetUndoCollection ( bool  collectUndo)

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

◆ SetUseAntiAliasing()

void wxScintilla::SetUseAntiAliasing ( bool  useAA)

Specify whether anti-aliased fonts should be used.

Will have no effect on some platforms, but on some (wxMac for example) can greatly improve performance.

◆ SetUseHorizontalScrollBar()

void wxScintilla::SetUseHorizontalScrollBar ( bool  visible)

Show or hide the horizontal scroll bar.

◆ SetUseTabs()

void wxScintilla::SetUseTabs ( bool  useTabs)

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

Referenced by cbEditor::InternalSetEditorStyleAfterFileOpen(), cbEditor::InternalSetEditorStyleBeforeFileOpen(), and OverrideUseTabsPerLanguage().

◆ SetUseVerticalScrollBar()

void wxScintilla::SetUseVerticalScrollBar ( bool  visible)

Show or hide the vertical scroll bar.

◆ SetValue()

void wxScintilla::SetValue ( const wxString text)
inlineprotected

Definition at line 5347 of file wxscintilla.h.

◆ SetViewEOL()

void wxScintilla::SetViewEOL ( bool  visible)

Make the end of line characters visible or invisible.

Referenced by cbEditor::InternalSetEditorStyleBeforeFileOpen().

◆ SetViewWhiteSpace()

void wxScintilla::SetViewWhiteSpace ( int  viewWS)

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

Referenced by cbEditor::InternalSetEditorStyleBeforeFileOpen().

◆ SetVirtualSpaceOptions()

void wxScintilla::SetVirtualSpaceOptions ( int  virtualSpaceOptions)

Set options for virtual space behaviour.

Referenced by cbEditor::InternalSetEditorStyleBeforeFileOpen().

◆ SetVisiblePolicy()

void wxScintilla::SetVisiblePolicy ( int  visiblePolicy,
int  visibleSlop 
)

Set the way the display area is determined when a particular line is to be moved to by Find, FindNext, GotoLine, etc.

Referenced by cbEditor::InternalSetEditorStyleBeforeFileOpen().

◆ SetVScrollBar()

void wxScintilla::SetVScrollBar ( wxScrollBar bar)

Set the vertical scrollbar to use instead of the one that's built-in.

◆ SetWhitespaceBackground()

void wxScintilla::SetWhitespaceBackground ( bool  useSetting,
const wxColour back 
)

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

◆ SetWhitespaceChars()

void wxScintilla::SetWhitespaceChars ( const wxString characters)

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

Should be called after SetWordChars.

◆ SetWhitespaceForeground()

void wxScintilla::SetWhitespaceForeground ( bool  useSetting,
const wxColour fore 
)

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

Referenced by cbEditor::InternalSetEditorStyleBeforeFileOpen().

◆ SetWhitespaceSize()

void wxScintilla::SetWhitespaceSize ( int  size)

Set the size of the dots used to mark space characters.

◆ SetWordChars()

void wxScintilla::SetWordChars ( const wxString characters)

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

First sets defaults like SetCharsDefault.

◆ SetWrapIndentMode()

void wxScintilla::SetWrapIndentMode ( int  wrapIndentMode)

Sets how wrapped sublines are placed. Default is wxSCI_WRAPINDENT_FIXED.

◆ SetWrapMode()

void wxScintilla::SetWrapMode ( int  wrapMode)

Sets whether text is word wrapped.

Referenced by cbEditor::InternalSetEditorStyleBeforeFileOpen().

◆ SetWrapStartIndent()

void wxScintilla::SetWrapStartIndent ( int  indent)

Set the start indent for wrapped lines.

◆ SetWrapVisualFlags()

void wxScintilla::SetWrapVisualFlags ( int  wrapVisualFlags)

Set the display mode of visual flags for wrapped lines.

◆ SetWrapVisualFlagsLocation()

void wxScintilla::SetWrapVisualFlagsLocation ( int  wrapVisualFlagsLocation)

Set the location of visual flags for wrapped lines.

◆ SetXCaretPolicy()

void wxScintilla::SetXCaretPolicy ( int  caretPolicy,
int  caretSlop 
)

Set the way the caret is kept visible when going sideways.

The exclusion zone is given in pixels.

◆ SetXOffset()

void wxScintilla::SetXOffset ( int  xOffset)

Set the xOffset (ie, horizontal scroll position).

◆ SetYCaretPolicy()

void wxScintilla::SetYCaretPolicy ( int  caretPolicy,
int  caretSlop 
)

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

The exclusion zone is given in lines.

Referenced by cbEditor::InternalSetEditorStyleBeforeFileOpen().

◆ SetZoom()

void wxScintilla::SetZoom ( int  zoomInPoints)

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.

Referenced by MainFrame::OnEditZoomReset(), cbEditor::SetProjectFile(), cbEditor::SetZoom(), and cbEditor::Split().

◆ ShowLines()

void wxScintilla::ShowLines ( int  lineStart,
int  lineEnd 
)

Make a range of lines visible.

Referenced by cbEditor::DoFoldAll(), cbEditor::FixFoldState(), and cbEditor::OnEditorModified().

◆ StartRecord()

void wxScintilla::StartRecord ( )

Start notifying the container of all key presses and commands.

◆ StartStyling()

void wxScintilla::StartStyling ( int  start)

Set the current styling position to start.

◆ StopRecord()

void wxScintilla::StopRecord ( )

Stop notifying the container of all key presses and commands.

◆ StutteredPageDown()

void wxScintilla::StutteredPageDown ( )

Move caret to bottom of page, or one page down if already at bottom of page.

◆ StutteredPageDownExtend()

void wxScintilla::StutteredPageDownExtend ( )

Move caret to bottom of page, or one page down if already at bottom of page, extending selection to new caret position.

◆ StutteredPageUp()

void wxScintilla::StutteredPageUp ( )

Move caret to top of page, or one page up if already at top of page.

◆ StutteredPageUpExtend()

void wxScintilla::StutteredPageUpExtend ( )

Move caret to top of page, or one page up if already at top of page, extending selection to new caret position.

◆ StyleClearAll()

void wxScintilla::StyleClearAll ( )

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

Referenced by EditorColourSet::Apply(), and cbEditor::InternalSetEditorStyleBeforeFileOpen().

◆ StyleGetBackground()

wxColour wxScintilla::StyleGetBackground ( int  style) const

Get the background colour of a style.

◆ StyleGetBold()

bool wxScintilla::StyleGetBold ( int  style) const

Get is a style bold or not.

◆ StyleGetCase()

int wxScintilla::StyleGetCase ( int  style) const

Get is a style mixed case, or to force upper or lower case.

◆ StyleGetChangeable()

bool wxScintilla::StyleGetChangeable ( int  style) const

Get is a style changeable or not (read only).

Experimental feature, currently buggy.

◆ StyleGetCharacterSet()

int wxScintilla::StyleGetCharacterSet ( int  style) const

Get the character get of the font in a style.

◆ StyleGetEOLFilled()

bool wxScintilla::StyleGetEOLFilled ( int  style) const

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

◆ StyleGetFaceName()

wxString wxScintilla::StyleGetFaceName ( int  style)

Get the font facename of a style.

◆ StyleGetFont()

wxFont wxScintilla::StyleGetFont ( int  style)

Get the font of a style.

Referenced by cbEditorInternalData::SetFoldingColWidth().

◆ StyleGetForeground()

wxColour wxScintilla::StyleGetForeground ( int  style) const

Get the foreground colour of a style.

◆ StyleGetHotSpot()

bool wxScintilla::StyleGetHotSpot ( int  style) const

Get is a style a hotspot or not.

◆ StyleGetItalic()

bool wxScintilla::StyleGetItalic ( int  style) const

Get is a style italic or not.

◆ StyleGetSize()

int wxScintilla::StyleGetSize ( int  style) const

Get the size of characters of a style.