Version: 3.1.0
wxStyledTextCtrl Class Reference

#include <wx/stc/stc.h>

+ Inheritance diagram for wxStyledTextCtrl:

Detailed Description

A wxWidgets implementation of the Scintilla source code editing component.

As well as features found in standard text editing components, Scintilla includes features especially useful when editing and debugging source code. These include support for syntax styling, error indicators, code completion and call tips.

The selection margin can contain markers like those used in debuggers to indicate breakpoints and the current line. Styling choices are more open than with many editors, allowing the use of proportional fonts, bold and italics, multiple foreground and background colours and multiple fonts.

wxStyledTextCtrl is a 1 to 1 mapping of "raw" scintilla interface, whose documentation can be found in the Scintilla website (http://www.scintilla.org/).

Events emitted by this class

The following event handler macros redirect the events to member function handlers 'func' with prototypes like:

void handlerFuncName(wxStyledTextEvent& event)

Event macros for events emitted by this class:

  • EVT_STC_CHANGE(id, fn):
    TOWRITE
  • EVT_STC_STYLENEEDED(id, fn):
    TOWRITE
  • EVT_STC_CHARADDED(id, fn):
    TOWRITE
  • EVT_STC_SAVEPOINTREACHED(id, fn):
    TOWRITE
  • EVT_STC_SAVEPOINTLEFT(id, fn):
    TOWRITE
  • EVT_STC_ROMODIFYATTEMPT(id, fn):
    TOWRITE
  • EVT_STC_KEY(id, fn):
    TOWRITE
  • EVT_STC_DOUBLECLICK(id, fn):
    TOWRITE
  • EVT_STC_UPDATEUI(id, fn):
    TOWRITE
  • EVT_STC_MODIFIED(id, fn):
    TOWRITE
  • EVT_STC_MACRORECORD(id, fn):
    TOWRITE
  • EVT_STC_MARGINCLICK(id, fn):
    TOWRITE
  • EVT_STC_NEEDSHOWN(id, fn):
    TOWRITE
  • EVT_STC_PAINTED(id, fn):
    TOWRITE
  • EVT_STC_USERLISTSELECTION(id, fn):
    TOWRITE
  • EVT_STC_URIDROPPED(id, fn):
    TOWRITE
  • EVT_STC_DWELLSTART(id, fn):
    TOWRITE
  • EVT_STC_DWELLEND(id, fn):
    TOWRITE
  • EVT_STC_START_DRAG(id, fn):
    Process a wxEVT_STC_START_DRAG event, generated when text is being dragged from the control. Details of the drag may be altered by changing the respective fields of the event; in particular, set an empty string to prohibit the drag entirely. Valid event functions: GetDragFlags, SetDragFlags, GetPosition, GetString, SetString.
  • EVT_STC_DRAG_OVER(id, fn):
    TOWRITE
  • EVT_STC_DO_DROP(id, fn):
    Process a wxEVT_STC_DO_DROP event, generated when text is being dropped into the control. Details of the drag may be altered by changing the respective fields of the event. Valid event functions: GetDragResult, SetDragResult, GetPosition, SetPosition, GetString, SetString, GetX, GetY.
  • EVT_STC_ZOOM(id, fn):
    TOWRITE
  • EVT_STC_HOTSPOT_CLICK(id, fn):
    TOWRITE
  • EVT_STC_HOTSPOT_DCLICK(id, fn):
    TOWRITE
  • EVT_STC_CALLTIP_CLICK(id, fn):
    TOWRITE
  • EVT_STC_AUTOCOMP_SELECTION(id, fn):
    TOWRITE
  • EVT_STC_INDICATOR_CLICK(id, fn):
    TOWRITE
  • EVT_STC_INDICATOR_RELEASE(id, fn):
    TOWRITE
  • EVT_STC_AUTOCOMP_CANCELLED(id, fn):
    TOWRITE
  • EVT_STC_AUTOCOMP_CHAR_DELETED(id, fn):
    TOWRITE
  • EVT_STC_HOTSPOT_RELEASE_CLICK(id, fn):
    TOWRITE
  • EVT_STC_CLIPBOARD_COPY(id, fn):
    Process a wxEVT_STC_CLIPBOARD_COPY event, generated when text is being cut or copied to the clipboard. Use wxStyledTextEvent::SetString() to modify the text that will be placed on the clipboard. Valid event functions: GetString, SetString.
    Since
    3.1.0
  • EVT_STC_CLIPBOARD_PASTE(id, fn):
    Process a wxEVT_STC_CLIPBOARD_PASTE event, generated when text is being pasted from the clipboard. Use wxStyledTextEvent::SetString() to modify the text that will be inserted into the control. Valid event functions: GetPosition, GetString, SetString.
    Since
    3.1.0

Library:  wxSTC
Category:  Scintilla Text Editor
See Also
wxStyledTextEvent

Public Member Functions

 wxStyledTextCtrl (wxWindow *parent, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxString &name=wxSTCNameStr)
 Ctor.
 
 wxStyledTextCtrl ()
 Default ctor.
 
 ~wxStyledTextCtrl ()
 Destructor.
 
bool Create (wxWindow *parent, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxString &name=wxSTCNameStr)
 Create the UI elements for a STC that was created with the default ctor.
 
void AddText (const wxString &text)
 Add text to the document at current position.
 
void AddStyledText (const wxMemoryBuffer &data)
 Add array of cells to document.
 
void InsertText (int pos, const wxString &text)
 Insert string at a position.
 
void ClearAll ()
 Delete all text in the document.
 
void DeleteRange (int pos, int deleteLength)
 Delete a range of text in the document.
 
void ClearDocumentStyle ()
 Set all style bytes to 0, remove all folding information.
 
int GetLength () const
 Returns the number of bytes in the document.
 
int GetCharAt (int pos) const
 Returns the character byte at the position.
 
int GetCurrentPos () const
 Returns the position of the caret.
 
int GetAnchor () const
 Returns the position of the opposite end of the selection to the caret.
 
int GetStyleAt (int pos) const
 Returns the style byte at the position.
 
void Redo ()
 Redoes the next action on the undo history.
 
void SetUndoCollection (bool collectUndo)
 Choose between collecting actions into the undo history and discarding them.
 
void SelectAll ()
 Select all the text in the document.
 
void SetSavePoint ()
 Remember the current position in the undo history as the position at which the document was saved.
 
wxMemoryBuffer GetStyledText (int startPos, int endPos)
 Retrieve a buffer of cells.
 
bool CanRedo () const
 Are there any redoable actions in the undo history?
 
int MarkerLineFromHandle (int handle)
 Retrieve the line number at which a particular marker is located.
 
void MarkerDeleteHandle (int handle)
 Delete a marker.
 
bool GetUndoCollection () const
 Is undo history being collected?
 
int GetViewWhiteSpace () const
 Are white space characters currently visible? Returns one of SCWS_* constants.
 
void SetViewWhiteSpace (int viewWS)
 Make white space characters invisible, always visible or visible outside indentation.
 
int PositionFromPoint (wxPoint pt) const
 Find the position from a point within the window.
 
int PositionFromPointClose (int x, int y)
 Find the position from a point within the window but return INVALID_POSITION if not close to text.
 
void GotoLine (int line)
 Set caret to start of a line and ensure it is visible.
 
void GotoPos (int pos)
 Set caret to a position and ensure it is visible.
 
void SetAnchor (int posAnchor)
 Set the selection anchor to a position.
 
wxString GetCurLine (int *linePos=NULL)
 Retrieve the text of the line containing the caret.
 
int GetEndStyled () const
 Retrieve the position of the last correctly styled character.
 
void ConvertEOLs (int eolMode)
 Convert all line endings in the document to one mode.
 
int GetEOLMode () const
 Retrieve the current end of line mode - one of CRLF, CR, or LF.
 
void SetEOLMode (int eolMode)
 Set the current end of line mode.
 
void StartStyling (int pos, int mask)
 Set the current styling position to pos and the styling mask to mask.
 
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.
 
bool GetBufferedDraw () const
 Is drawing done first into a buffer or direct to the screen?
 
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.
 
void SetTabWidth (int tabWidth)
 Change the visible size of a tab to be a multiple of the width of a space character.
 
int GetTabWidth () const
 Retrieve the visible size of a tab.
 
void SetCodePage (int codePage)
 Set the code page used to interpret the bytes of the document as characters.
 
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.
 
void MarkerSetForeground (int markerNumber, const wxColour &fore)
 Set the foreground colour used for a particular marker number.
 
void MarkerSetBackground (int markerNumber, const wxColour &back)
 Set the background colour used for a particular marker number.
 
void MarkerSetBackgroundSelected (int markerNumber, const wxColour &back)
 Set the background colour used for a particular marker number when its folding block is selected.
 
void MarkerEnableHighlight (bool enabled)
 Enable/disable highlight for current folding bloc (smallest one that contains the caret)
 
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.
 
void MarkerDelete (int line, int markerNumber)
 Delete a marker from a line.
 
void MarkerDeleteAll (int markerNumber)
 Delete all markers with a particular number from all lines.
 
int MarkerGet (int line)
 Get a bit mask of all the markers set on a line.
 
int MarkerNext (int lineStart, int markerMask)
 Find the next line at or after lineStart that includes a marker in mask.
 
int MarkerPrevious (int lineStart, int markerMask)
 Find the previous line before lineStart that includes a marker in mask.
 
void MarkerDefineBitmap (int markerNumber, const wxBitmap &bmp)
 Define a marker from a bitmap.
 
void MarkerAddSet (int line, int set)
 Add a set of markers to a line.
 
void MarkerSetAlpha (int markerNumber, int alpha)
 Set the alpha used for a marker that is drawn in the text area, not the margin.
 
void SetMarginType (int margin, int marginType)
 Set a margin to be either numeric or symbolic.
 
int GetMarginType (int margin) const
 Retrieve the type of a margin.
 
void SetMarginWidth (int margin, int pixelWidth)
 Set the width of a margin to a width expressed in pixels.
 
int GetMarginWidth (int margin) const
 Retrieve the width of a margin in pixels.
 
void SetMarginMask (int margin, int mask)
 Set a mask that determines which markers are displayed in a margin.
 
int GetMarginMask (int margin) const
 Retrieve the marker mask of a margin.
 
void SetMarginSensitive (int margin, bool sensitive)
 Make a margin sensitive or insensitive to mouse clicks.
 
bool GetMarginSensitive (int margin) const
 Retrieve the mouse click sensitivity of a margin.
 
void SetMarginCursor (int margin, int cursor)
 Set the cursor shown when the mouse is inside a margin.
 
int GetMarginCursor (int margin) const
 Retrieve the cursor shown in a margin.
 
void StyleClearAll ()
 Clear all the styles and make equivalent to the global default style.
 
void StyleSetForeground (int style, const wxColour &fore)
 Set the foreground colour of a style.
 
void StyleSetBackground (int style, const wxColour &back)
 Set the background colour of a style.
 
void StyleSetBold (int style, bool bold)
 Set a style to be bold or not.
 
void StyleSetItalic (int style, bool italic)
 Set a style to be italic or not.
 
void StyleSetSize (int style, int sizePoints)
 Set the size of characters of a style.
 
void StyleSetFaceName (int style, const wxString &fontName)
 Set the font of a style.
 
void StyleSetEOLFilled (int style, bool filled)
 Set a style to have its end of line filled or not.
 
void StyleResetDefault ()
 Reset the default style to its state at startup.
 
void StyleSetUnderline (int style, bool underline)
 Set a style to be underlined or not.
 
wxColour StyleGetForeground (int style) const
 Get the foreground colour of a style.
 
wxColour StyleGetBackground (int style) const
 Get the background colour of a style.
 
bool StyleGetBold (int style) const
 Get is a style bold or not.
 
bool StyleGetItalic (int style) const
 Get is a style italic or not.
 
int StyleGetSize (int style) const
 Get the size of characters of a style.
 
wxString StyleGetFaceName (int style)
 Get the font facename of a style.
 
bool StyleGetEOLFilled (int style) const
 Get is a style to have its end of line filled or not.
 
bool StyleGetUnderline (int style) const
 Get is a style underlined or not.
 
int StyleGetCase (int style) const
 Get is a style mixed case, or to force upper or lower case.
 
int StyleGetCharacterSet (int style) const
 Get the character set of the font in a style.
 
bool StyleGetVisible (int style) const
 Get is a style visible or not.
 
bool StyleGetChangeable (int style) const
 Get is a style changeable or not (read only).
 
bool StyleGetHotSpot (int style) const
 Get is a style a hotspot or not.
 
void StyleSetCase (int style, int caseForce)
 Set a style to be mixed case, or to force upper or lower case.
 
void StyleSetSizeFractional (int style, int caseForce)
 Set the size of characters of a style.
 
int StyleGetSizeFractional (int style) const
 Get the size of characters of a style in points multiplied by 100.
 
void StyleSetWeight (int style, int weight)
 Set the weight of characters of a style.
 
int StyleGetWeight (int style) const
 Get the weight of characters of a style.
 
void StyleSetHotSpot (int style, bool hotspot)
 Set a style to be a hotspot or not.
 
void SetSelForeground (bool useSetting, const wxColour &fore)
 Set the foreground colour of the main and additional selections and whether to use this setting.
 
void SetSelBackground (bool useSetting, const wxColour &back)
 Set the background colour of the main and additional selections and whether to use this setting.
 
int GetSelAlpha () const
 Get the alpha of the selection.
 
void SetSelAlpha (int alpha)
 Set the alpha of the selection.
 
bool GetSelEOLFilled () const
 Is the selection end of line filled?
 
void SetSelEOLFilled (bool filled)
 Set the selection to have its end of line filled or not.
 
void SetCaretForeground (const wxColour &fore)
 Set the foreground colour of the caret.
 
void CmdKeyAssign (int key, int modifiers, int cmd)
 When key+modifier combination km is pressed perform msg.
 
void CmdKeyClear (int key, int modifiers)
 When key+modifier combination km is pressed do nothing.
 
void CmdKeyClearAll ()
 Drop all key mappings.
 
void SetStyleBytes (int length, char *styleBytes)
 Set the styles for a segment of the document.
 
void StyleSetVisible (int style, bool visible)
 Set a style to be visible or not.
 
int GetCaretPeriod () const
 Get the time in milliseconds that the caret is on and off.
 
void SetCaretPeriod (int periodMilliseconds)
 Get the time in milliseconds that the caret is on and off.
 
void SetWordChars (const wxString &characters)
 Set the set of characters making up words for when moving or selecting by word.
 
wxString GetWordChars () const
 Get the set of characters making up words for when moving or selecting by word.
 
void BeginUndoAction ()
 Start a sequence of actions that is undone and redone as a unit.
 
void EndUndoAction ()
 End a sequence of actions that is undone and redone as a unit.
 
void IndicatorSetStyle (int indic, int style)
 Set an indicator to plain, squiggle or TT.
 
int IndicatorGetStyle (int indic) const
 Retrieve the style of an indicator.
 
void IndicatorSetForeground (int indic, const wxColour &fore)
 Set the foreground colour of an indicator.
 
wxColour IndicatorGetForeground (int indic) const
 Retrieve the foreground colour of an indicator.
 
void IndicatorSetUnder (int indic, bool under)
 Set an indicator to draw under text or over(default).
 
bool IndicatorGetUnder (int indic) const
 Retrieve whether indicator drawn under or over text.
 
void SetWhitespaceForeground (bool useSetting, const wxColour &fore)
 Set the foreground colour of all whitespace and whether to use this setting.
 
void SetWhitespaceBackground (bool useSetting, const wxColour &back)
 Set the background colour of all whitespace and whether to use this setting.
 
void SetWhitespaceSize (int size)
 Set the size of the dots used to mark space characters.
 
int GetWhitespaceSize () const
 Get the size of the dots used to mark space characters.
 
void SetStyleBits (int bits)
 Divide each styling byte into lexical class bits (default: 5) and indicator bits (default: 3).
 
int GetStyleBits () const
 Retrieve number of bits in style bytes used to hold the lexical state.
 
void SetLineState (int line, int state)
 Used to hold extra styling information for each line.
 
int GetLineState (int line) const
 Retrieve the extra styling information for a line.
 
int GetMaxLineState () const
 Retrieve the last line number that has line state.
 
bool GetCaretLineVisible () const
 Is the background of the line containing the caret in a different colour?
 
void SetCaretLineVisible (bool show)
 Display the background of the line containing the caret in a different colour.
 
wxColour GetCaretLineBackground () const
 Get the colour of the background of the line containing the caret.
 
void SetCaretLineBackground (const wxColour &back)
 Set the colour of the background of the line containing the caret.
 
void StyleSetChangeable (int style, bool changeable)
 Set a style to be changeable or not (read only).
 
void AutoCompShow (int lenEntered, const wxString &itemList)
 Display a auto-completion list.
 
void AutoCompCancel ()
 Remove the auto-completion list from the screen.
 
bool AutoCompActive ()
 Is there an auto-completion list visible?
 
int AutoCompPosStart ()
 Retrieve the position of the caret when the auto-completion list was displayed.
 
void AutoCompComplete ()
 User has selected an item so remove the list and insert the selection.
 
void AutoCompStops (const wxString &characterSet)
 Define a set of character that when typed cancel the auto-completion list.
 
void AutoCompSetSeparator (int separatorCharacter)
 Change the separator character in the string setting up an auto-completion list.
 
int AutoCompGetSeparator () const
 Retrieve the auto-completion list separator character.
 
void AutoCompSelect (const wxString &text)
 Select the item in the auto-completion list that starts with a string.
 
void AutoCompSetCancelAtStart (bool cancel)
 Should the auto-completion list be cancelled if the user backspaces to a position before where the box was created.
 
bool AutoCompGetCancelAtStart () const
 Retrieve whether auto-completion cancelled by backspacing before start.
 
void AutoCompSetFillUps (const wxString &characterSet)
 Define a set of characters that when typed will cause the autocompletion to choose the selected item.
 
void AutoCompSetChooseSingle (bool chooseSingle)
 Should a single item auto-completion list automatically choose the item.
 
bool AutoCompGetChooseSingle () const
 Retrieve whether a single item auto-completion list automatically choose the item.
 
void AutoCompSetIgnoreCase (bool ignoreCase)
 Set whether case is significant when performing auto-completion searches.
 
bool AutoCompGetIgnoreCase () const
 Retrieve state of ignore case flag.
 
void UserListShow (int listType, const wxString &itemList)
 Display a list of strings and send notification when user chooses one.
 
void AutoCompSetAutoHide (bool autoHide)
 Set whether or not autocompletion is hidden automatically when nothing matches.
 
bool AutoCompGetAutoHide () const
 Retrieve whether or not autocompletion is hidden automatically when nothing matches.
 
void AutoCompSetDropRestOfWord (bool dropRestOfWord)
 Set whether or not autocompletion deletes any word characters after the inserted text upon completion.
 
bool AutoCompGetDropRestOfWord () const
 Retrieve whether or not autocompletion deletes any word characters after the inserted text upon completion.
 
void RegisterImage (int type, const wxBitmap &bmp)
 Register an image for use in autocompletion lists.
 
void ClearRegisteredImages ()
 Clear all the registered images.
 
int AutoCompGetTypeSeparator () const
 Retrieve the auto-completion list type-separator character.
 
void AutoCompSetTypeSeparator (int separatorCharacter)
 Change the type-separator character in the string setting up an auto-completion list.
 
void AutoCompSetMaxWidth (int characterCount)
 Set the maximum width, in characters, of auto-completion and user lists.
 
int AutoCompGetMaxWidth () const
 Get the maximum width, in characters, of auto-completion and user lists.
 
void AutoCompSetMaxHeight (int rowCount)
 Set the maximum height, in rows, of auto-completion and user lists.
 
int AutoCompGetMaxHeight () const
 Set the maximum height, in rows, of auto-completion and user lists.
 
void SetIndent (int indentSize)
 Set the number of spaces used for one level of indentation.
 
int GetIndent () const
 Retrieve indentation size.
 
void SetUseTabs (bool useTabs)
 Indentation will only use space characters if useTabs is false, otherwise it will use a combination of tabs and spaces.
 
bool GetUseTabs () const
 Retrieve whether tabs will be used in indentation.
 
void SetLineIndentation (int line, int indentSize)
 Change the indentation of a line to a number of columns.
 
int GetLineIndentation (int line) const
 Retrieve the number of columns that a line is indented.
 
int GetLineIndentPosition (int line) const
 Retrieve the position before the first non indentation character on a line.
 
int GetColumn (int pos) const
 Retrieve the column number of a position, taking tab width into account.
 
int CountCharacters (int startPos, int endPos)
 Count characters between two positions.
 
void SetUseHorizontalScrollBar (bool show)
 Show or hide the horizontal scroll bar.
 
bool GetUseHorizontalScrollBar () const
 Is the horizontal scroll bar visible?
 
void SetIndentationGuides (int indentView)
 Show or hide indentation guides.
 
int GetIndentationGuides () const
 Are the indentation guides visible?
 
void SetHighlightGuide (int column)
 Set the highlighted indentation guide column.
 
int GetHighlightGuide () const
 Get the highlighted indentation guide column.
 
int GetLineEndPosition (int line) const
 Get the position after the last visible characters on a line.
 
int GetCodePage () const
 Get the code page used to interpret the bytes of the document as characters.
 
wxColour GetCaretForeground () const
 Get the foreground colour of the caret.
 
bool GetReadOnly () const
 In read-only mode?
 
void SetCurrentPos (int pos)
 Sets the position of the caret.
 
void SetSelectionStart (int pos)
 Sets the position that starts the selection - this becomes the anchor.
 
int GetSelectionStart () const
 Returns the position at the start of the selection.
 
void SetSelectionEnd (int pos)
 Sets the position that ends the selection - this becomes the currentPosition.
 
int GetSelectionEnd () const
 Returns the position at the end of the selection.
 
void SetEmptySelection (int pos)
 Set caret to a position, while removing any existing selection.
 
void SetPrintMagnification (int magnification)
 Sets the print magnification added to the point size of each style for printing.
 
int GetPrintMagnification () const
 Returns the print magnification.
 
void SetPrintColourMode (int mode)
 Modify colours when printing for clearer printed text.
 
int GetPrintColourMode () const
 Returns the print colour mode.
 
int FindText (int minPos, int maxPos, const wxString &text, int flags=0)
 Find some text in the document.
 
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.
 
int GetFirstVisibleLine () const
 Retrieve the display line at the top of the display.
 
wxString GetLine (int line) const
 Retrieve the contents of a line.
 
int GetLineCount () const
 Returns the number of lines in the document.
 
void SetMarginLeft (int pixelWidth)
 Sets the size in pixels of the left margin.
 
int GetMarginLeft () const
 Returns the size in pixels of the left margin.
 
void SetMarginRight (int pixelWidth)
 Sets the size in pixels of the right margin.
 
int GetMarginRight () const
 Returns the size in pixels of the right margin.
 
bool GetModify () const
 Is the document different from when it was last saved?
 
wxString GetSelectedText ()
 Retrieve the selected text.
 
wxString GetTextRange (int startPos, int endPos)
 Retrieve a range of text.
 
void HideSelection (bool normal)
 Draw the selection in normal style or with selection highlighted.
 
int LineFromPosition (int pos) const
 Retrieve the line containing a position.
 
int PositionFromLine (int line) const
 Retrieve the position at the start of a line.
 
void LineScroll (int columns, int lines)
 Scroll horizontally and vertically.
 
void EnsureCaretVisible ()
 Ensure the caret is visible.
 
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.
 
void ReplaceSelection (const wxString &text)
 Replace the selected text with the argument text.
 
void SetReadOnly (bool readOnly)
 Set to read only or read write.
 
bool CanPaste () const
 Will a paste succeed?
 
bool CanUndo () const
 Are there any undoable actions in the undo history?
 
void EmptyUndoBuffer ()
 Delete the undo history.
 
void Undo ()
 Undo one action in the undo history.
 
void Cut ()
 Cut the selection to the clipboard.
 
void Copy ()
 Copy the selection to the clipboard.
 
void Paste ()
 Paste the contents of the clipboard into the document replacing the selection.
 
void Clear ()
 Clear the selection.
 
void SetText (const wxString &text)
 Replace the contents of the document with the argument text.
 
wxString GetText () const
 Retrieve all the text in the document.
 
int GetTextLength () const
 Retrieve the number of characters in the document.
 
void SetOvertype (bool overtype)
 Set to overtype (true) or insert mode.
 
bool GetOvertype () const
 Returns true if overtype mode is active otherwise false is returned.
 
void SetCaretWidth (int pixelWidth)
 Set the width of the insert mode caret.
 
int GetCaretWidth () const
 Returns the width of the insert mode caret.
 
void SetTargetStart (int pos)
 Sets the position that starts the target which is used for updating the document without affecting the scroll position.
 
int GetTargetStart () const
 Get the position that starts the target.
 
void SetTargetEnd (int pos)
 Sets the position that ends the target which is used for updating the document without affecting the scroll position.
 
int GetTargetEnd () const
 Get the position that ends the target.
 
int ReplaceTarget (const wxString &text)
 Replace the target text with the argument text.
 
int ReplaceTargetRE (const wxString &text)
 Replace the target text with the argument text after \d processing.
 
int SearchInTarget (const wxString &text)
 Search for a counted string in the target and set the target to the found range.
 
void SetSearchFlags (int flags)
 Set the search flags used by SearchInTarget.
 
int GetSearchFlags () const
 Get the search flags used by SearchInTarget.
 
void CallTipShow (int pos, const wxString &definition)
 Show a call tip containing a definition near position pos.
 
void CallTipCancel ()
 Remove the call tip from the screen.
 
bool CallTipActive ()
 Is there an active call tip?
 
int CallTipPosAtStart ()
 Retrieve the position where the caret was before displaying the call tip.
 
void CallTipSetPosAtStart (int posStart)
 Set the start position in order to change when backspacing removes the calltip.
 
void CallTipSetHighlight (int start, int end)
 Highlight a segment of the definition.
 
void CallTipSetBackground (const wxColour &back)
 Set the background colour for the call tip.
 
void CallTipSetForeground (const wxColour &fore)
 Set the foreground colour for the call tip.
 
void CallTipSetForegroundHighlight (const wxColour &fore)
 Set the foreground colour for the highlighted part of the call tip.
 
void CallTipUseStyle (int tabSize)
 Enable use of STYLE_CALLTIP and set call tip tab size in pixels.
 
void CallTipSetPosition (bool above)
 Set position of calltip, above or below text.
 
int VisibleFromDocLine (int line)
 Find the display line of a document line taking hidden lines into account.
 
int DocLineFromVisible (int lineDisplay)
 Find the document line of a display line taking hidden lines into account.
 
int WrapCount (int line)
 The number of display lines needed to wrap a document line.
 
void SetFoldLevel (int line, int level)
 Set the fold level of a line.
 
int GetFoldLevel (int line) const
 Retrieve the fold level of a line.
 
int GetLastChild (int line, int level) const
 Find the last child line of a header line.
 
int GetFoldParent (int line) const
 Find the parent line of a child line.
 
void ShowLines (int lineStart, int lineEnd)
 Make a range of lines visible.
 
void HideLines (int lineStart, int lineEnd)
 Make a range of lines invisible.
 
bool GetLineVisible (int line) const
 Is a line visible?
 
bool GetAllLinesVisible () const
 Are all lines visible?
 
void SetFoldExpanded (int line, bool expanded)
 Show the children of a header line.
 
bool GetFoldExpanded (int line) const
 Is a header line expanded?
 
void ToggleFold (int line)
 Switch a header line between expanded and contracted.
 
void FoldLine (int line, int action)
 Expand or contract a fold header.
 
void FoldChildren (int line, int action)
 Expand or contract a fold header and its children.
 
void ExpandChildren (int line, int level)
 Expand a fold header and all children.
 
void FoldAll (int action)
 Expand or contract all fold headers.
 
void EnsureVisible (int line)
 Ensure a particular line is visible by expanding any header line hiding it.
 
void SetAutomaticFold (int automaticFold)
 Set automatic folding behaviours.
 
int GetAutomaticFold () const
 Get automatic folding behaviours.
 
void SetFoldFlags (int flags)
 Set some style options for folding.
 
void EnsureVisibleEnforcePolicy (int line)
 Ensure a particular line is visible by expanding any header line hiding it.
 
void SetTabIndents (bool tabIndents)
 Sets whether a tab pressed when caret is within indentation indents.
 
bool GetTabIndents () const
 Does a tab pressed when caret is within indentation indent?
 
void SetBackSpaceUnIndents (bool bsUnIndents)
 Sets whether a backspace pressed when caret is within indentation unindents.
 
bool GetBackSpaceUnIndents () const
 Does a backspace pressed when caret is within indentation unindent?
 
void SetMouseDwellTime (int periodMilliseconds)
 Sets the time the mouse must sit still to generate a mouse dwell event.
 
int GetMouseDwellTime () const
 Retrieve the time the mouse must sit still to generate a mouse dwell event.
 
int WordStartPosition (int pos, bool onlyWordCharacters)
 Get position of start of word.
 
int WordEndPosition (int pos, bool onlyWordCharacters)
 Get position of end of word.
 
void SetWrapMode (int mode)
 Sets whether text is word wrapped.
 
int GetWrapMode () const
 Retrieve whether text is word wrapped.
 
void SetWrapVisualFlags (int wrapVisualFlags)
 Set the display mode of visual flags for wrapped lines.
 
int GetWrapVisualFlags () const
 Retrive the display mode of visual flags for wrapped lines.
 
void SetWrapVisualFlagsLocation (int wrapVisualFlagsLocation)
 Set the location of visual flags for wrapped lines.
 
int GetWrapVisualFlagsLocation () const
 Retrive the location of visual flags for wrapped lines.
 
void SetWrapStartIndent (int indent)
 Set the start indent for wrapped lines.
 
int GetWrapStartIndent () const
 Retrive the start indent for wrapped lines.
 
void SetWrapIndentMode (int mode)
 Sets how wrapped sublines are placed.
 
int GetWrapIndentMode () const
 Retrieve how wrapped sublines are placed.
 
void SetLayoutCache (int mode)
 Sets the degree of caching of layout information.
 
int GetLayoutCache () const
 Retrieve the degree of caching of layout information.
 
void SetScrollWidth (int pixelWidth)
 Sets the document width assumed for scrolling.
 
int GetScrollWidth () const
 Retrieve the document width assumed for scrolling.
 
void SetScrollWidthTracking (bool tracking)
 Sets whether the maximum width line displayed is used to set scroll width.
 
bool GetScrollWidthTracking () const
 Retrieve whether the scroll width tracks wide lines.
 
int TextWidth (int style, const wxString &text)
 Measure the pixel width of some text in a particular style.
 
void SetEndAtLastLine (bool endAtLastLine)
 Sets the scroll range so that maximum scroll position has the last line at the bottom of the view (default).
 
bool GetEndAtLastLine () const
 Retrieve whether the maximum scroll position has the last line at the bottom of the view.
 
int TextHeight (int line)
 Retrieve the height of a particular line of text in pixels.
 
void SetUseVerticalScrollBar (bool show)
 Show or hide the vertical scroll bar.
 
bool GetUseVerticalScrollBar () const
 Is the vertical scroll bar visible?
 
void AppendText (const wxString &text)
 Append a string to the end of the document without changing the selection.
 
bool GetTwoPhaseDraw () const
 Is drawing done in two phases with backgrounds drawn before foregrounds?
 
void SetTwoPhaseDraw (bool twoPhase)
 In twoPhaseDraw mode, drawing is performed in two phases, first the background and then the foreground.
 
void SetFirstVisibleLine (int lineDisplay)
 Scroll so that a display line is at the top of the display.
 
void SetMultiPaste (int multiPaste)
 Change the effect of pasting when there are multiple selections.
 
int GetMultiPaste () const
 Retrieve the effect of pasting when there are multiple selections.
 
wxString GetTag (int tagNumber) const
 Retrieve the value of a tag from a regular expression search.
 
void TargetFromSelection ()
 Make the target range start and end be the same as the selection range start and end.
 
void LinesJoin ()
 Join the lines in the target.
 
void LinesSplit (int pixelWidth)
 Split the lines in the target into lines that are less wide than pixelWidth where possible.
 
void SetFoldMarginColour (bool useSetting, const wxColour &back)
 Set the colours used as a chequerboard pattern in the fold margin.
 
void SetFoldMarginHiColour (bool useSetting, const wxColour &fore)
 
void LineDown ()
 Move caret down one line.
 
void LineDownExtend ()
 Move caret down one line extending selection to new caret position.
 
void LineUp ()
 Move caret up one line.
 
void LineUpExtend ()
 Move caret up one line extending selection to new caret position.
 
void CharLeft ()
 Move caret left one character.
 
void CharLeftExtend ()
 Move caret left one character extending selection to new caret position.
 
void CharRight ()
 Move caret right one character.
 
void CharRightExtend ()
 Move caret right one character extending selection to new caret position.
 
void WordLeft ()
 Move caret left one word.
 
void WordLeftExtend ()
 Move caret left one word extending selection to new caret position.
 
void WordRight ()
 Move caret right one word.
 
void WordRightExtend ()
 Move caret right one word extending selection to new caret position.
 
void Home ()
 Move caret to first position on line.
 
void HomeExtend ()
 Move caret to first position on line extending selection to new caret position.
 
void LineEnd ()
 Move caret to last position on line.
 
void LineEndExtend ()
 Move caret to last position on line extending selection to new caret position.
 
void DocumentStart ()
 Move caret to first position in document.
 
void DocumentStartExtend ()
 Move caret to first position in document extending selection to new caret position.
 
void DocumentEnd ()
 Move caret to last position in document.
 
void DocumentEndExtend ()
 Move caret to last position in document extending selection to new caret position.
 
void PageUp ()
 Move caret one page up.
 
void PageUpExtend ()
 Move caret one page up extending selection to new caret position.
 
void PageDown ()
 Move caret one page down.
 
void PageDownExtend ()
 Move caret one page down extending selection to new caret position.
 
void EditToggleOvertype ()
 Switch from insert to overtype mode or the reverse.
 
void Cancel ()
 Cancel any modes such as call tip or auto-completion list display.
 
void DeleteBack ()
 Delete the selection or if no selection, the character before the caret.
 
void Tab ()
 If selection is empty or all on one line replace the selection with a tab character.
 
void BackTab ()
 Dedent the selected lines.
 
void NewLine ()
 Insert a new line, may use a CRLF, CR or LF depending on EOL mode.
 
void FormFeed ()
 Insert a Form Feed character.
 
void VCHome ()
 Move caret to before first visible character on line.
 
void VCHomeExtend ()
 Like VCHome but extending selection to new caret position.
 
void ZoomIn ()
 Magnify the displayed text by increasing the sizes by 1 point.
 
void ZoomOut ()
 Make the displayed text smaller by decreasing the sizes by 1 point.
 
void DelWordLeft ()
 Delete the word to the left of the caret.
 
void DelWordRight ()
 Delete the word to the right of the caret.
 
void DelWordRightEnd ()
 Delete the word to the right of the caret, but not the trailing non-word characters.
 
void LineCut ()
 Cut the line containing the caret.
 
void LineDelete ()
 Delete the line containing the caret.
 
void LineTranspose ()
 Switch the current line with the previous.
 
void LineDuplicate ()
 Duplicate the current line.
 
void LowerCase ()
 Transform the selection to lower case.
 
void UpperCase ()
 Transform the selection to upper case.
 
void LineScrollDown ()
 Scroll the document down, keeping the caret visible.
 
void LineScrollUp ()
 Scroll the document up, keeping the caret visible.
 
void DeleteBackNotLine ()
 Delete the selection or if no selection, the character before the caret.
 
void HomeDisplay ()
 Move caret to first position on display line.
 
void HomeDisplayExtend ()
 Move caret to first position on display line extending selection to new caret position.
 
void LineEndDisplay ()
 Move caret to last position on display line.
 
void LineEndDisplayExtend ()
 Move caret to last position on display line extending selection to new caret position.
 
void HomeWrap ()
 These are like their namesakes Home(Extend)?, LineEnd(Extend)?, VCHome(Extend)? except they behave differently when word-wrap is enabled: They go first to the start / end of the display line, like (Home|LineEnd)Display The difference is that, the cursor is already at the point, it goes on to the start or end of the document line, as appropriate for (Home|LineEnd|VCHome)(Extend)?.
 
void HomeWrapExtend ()
 
void LineEndWrap ()
 
void LineEndWrapExtend ()
 
void VCHomeWrap ()
 
void VCHomeWrapExtend ()
 
void LineCopy ()
 Copy the line containing the caret.
 
void MoveCaretInsideView ()
 Move the caret inside current view if it's not there already.
 
int LineLength (int line) const
 How many characters are on a line, including end of line characters?
 
void BraceHighlight (int pos1, int pos2)
 Highlight the characters at two positions.
 
void BraceHighlightIndicator (bool useBraceHighlightIndicator, int indicator)
 Use specified indicator to highlight matching braces instead of changing their style.
 
void BraceBadLight (int pos)
 Highlight the character at a position indicating there is no matching brace.
 
void BraceBadLightIndicator (bool useBraceBadLightIndicator, int indicator)
 Use specified indicator to highlight non matching brace instead of changing its style.
 
int BraceMatch (int pos)
 Find the position of a matching brace or INVALID_POSITION if no match.
 
bool GetViewEOL () const
 Are the end of line characters visible?
 
void SetViewEOL (bool visible)
 Make the end of line characters visible or invisible.
 
void * GetDocPointer ()
 Retrieve a pointer to the document object.
 
void SetDocPointer (void *docPointer)
 Change the document object used.
 
void SetModEventMask (int mask)
 Set which document modification events are sent to the container.
 
int GetEdgeColumn () const
 Retrieve the column number which text should be kept within.
 
void SetEdgeColumn (int column)
 Set the column number of the edge.
 
int GetEdgeMode () const
 Retrieve the edge highlight mode.
 
void SetEdgeMode (int mode)
 The edge may be displayed by a line (EDGE_LINE) or by highlighting text that goes beyond it (EDGE_BACKGROUND) or not displayed at all (EDGE_NONE).
 
wxColour GetEdgeColour () const
 Retrieve the colour used in edge indication.
 
void SetEdgeColour (const wxColour &edgeColour)
 Change the colour used in edge indication.
 
void SearchAnchor ()
 Sets the current caret position to be the search anchor.
 
int SearchNext (int flags, const wxString &text)
 Find some text starting at the search anchor.
 
int SearchPrev (int flags, const wxString &text)
 Find some text starting at the search anchor and moving backwards.
 
int LinesOnScreen () const
 Retrieves the number of lines completely visible.
 
void UsePopUp (bool allowPopUp)
 Set whether a pop up menu is displayed automatically when the user presses the wrong mouse button.
 
bool SelectionIsRectangle () const
 Is the selection rectangular? The alternative is the more common stream selection.
 
void SetZoom (int zoom)
 Set the zoom level.
 
int GetZoom () const
 Retrieve the zoom level.
 
void * CreateDocument ()
 Create a new document object.
 
void AddRefDocument (void *docPointer)
 Extend life of document.
 
void ReleaseDocument (void *docPointer)
 Release a reference to the document, deleting document if it fades to black.
 
int GetModEventMask () const
 Get which document modification events are sent to the container.
 
void SetSTCFocus (bool focus)
 Change internal focus flag.
 
bool GetSTCFocus () const
 Get internal focus flag.
 
void SetStatus (int statusCode)
 Change error status - 0 = OK.
 
int GetStatus () const
 Get error status.
 
void SetMouseDownCaptures (bool captures)
 Set whether the mouse is captured when its button is pressed.
 
bool GetMouseDownCaptures () const
 Get whether mouse gets captured.
 
void SetSTCCursor (int cursorType)
 Sets the cursor to one of the SC_CURSOR* values.
 
int GetSTCCursor () const
 Get cursor type.
 
void SetControlCharSymbol (int symbol)
 Change the way control characters are displayed: If symbol is < 32, keep the drawn way, else, use the given character.
 
int GetControlCharSymbol () const
 Get the way control characters are displayed.
 
void WordPartLeft ()
 Move to the previous change in capitalisation.
 
void WordPartLeftExtend ()
 Move to the previous change in capitalisation extending selection to new caret position.
 
void WordPartRight ()
 Move to the change next in capitalisation.
 
void WordPartRightExtend ()
 Move to the next change in capitalisation extending selection to new caret position.
 
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.
 
void DelLineLeft ()
 Delete back from the current position to the start of the line.
 
void DelLineRight ()
 Delete forwards from the current position to the end of the line.
 
void SetXOffset (int newOffset)
 Get and Set the xOffset (ie, horizontal scroll position).
 
int GetXOffset () const
 
void ChooseCaretX ()
 Set the last x chosen value to be the caret x position.
 
void SetXCaretPolicy (int caretPolicy, int caretSlop)
 Set the way the caret is kept visible when going sideways.
 
void SetYCaretPolicy (int caretPolicy, int caretSlop)
 Set the way the line the caret is on is kept visible.
 
void SetPrintWrapMode (int mode)
 Set printing to line wrapped (SC_WRAP_WORD) or not line wrapped (SC_WRAP_NONE).
 
int GetPrintWrapMode () const
 Is printing line wrapped?
 
void SetHotspotActiveForeground (bool useSetting, const wxColour &fore)
 Set a fore colour for active hotspots.
 
wxColour GetHotspotActiveForeground () const
 Get the fore colour for active hotspots.
 
void SetHotspotActiveBackground (bool useSetting, const wxColour &back)
 Set a back colour for active hotspots.
 
wxColour GetHotspotActiveBackground () const
 Get the back colour for active hotspots.
 
void SetHotspotActiveUnderline (bool underline)
 Enable / Disable underlining active hotspots.
 
bool GetHotspotActiveUnderline () const
 Get whether underlining for active hotspots.
 
void SetHotspotSingleLine (bool singleLine)
 Limit hotspots to single line so hotspots on two lines don't merge.
 
bool GetHotspotSingleLine () const
 Get the HotspotSingleLine property.
 
void ParaDown ()
 Move caret between paragraphs (delimited by empty lines).
 
void ParaDownExtend ()
 
void ParaUp ()
 
void ParaUpExtend ()
 
int PositionBefore (int pos)
 Given a valid document position, return the previous position taking code page into account.
 
int PositionAfter (int pos)
 Given a valid document position, return the next position taking code page into account.
 
int PositionRelative (int pos, int relative)
 Given a valid document position, return a position that differs in a number of characters.
 
void CopyRange (int start, int end)
 Copy a range of text to the clipboard.
 
void CopyText (int length, const wxString &text)
 Copy argument text to the clipboard.
 
void SetSelectionMode (int mode)
 Set the selection mode to stream (SC_SEL_STREAM) or rectangular (SC_SEL_RECTANGLE/SC_SEL_THIN) or by lines (SC_SEL_LINES).
 
int GetSelectionMode () const
 Get the mode of the current selection.
 
int GetLineSelStartPosition (int line)
 Retrieve the position of the start of the selection at the given line (INVALID_POSITION if no selection on this line).
 
int GetLineSelEndPosition (int line)
 Retrieve the position of the end of the selection at the given line (INVALID_POSITION if no selection on this line).
 
void LineDownRectExtend ()
 Move caret down one line, extending rectangular selection to new caret position.
 
void LineUpRectExtend ()
 Move caret up one line, extending rectangular selection to new caret position.
 
void CharLeftRectExtend ()
 Move caret left one character, extending rectangular selection to new caret position.
 
void CharRightRectExtend ()
 Move caret right one character, extending rectangular selection to new caret position.
 
void HomeRectExtend ()
 Move caret to first position on line, extending rectangular selection to new caret position.
 
void VCHomeRectExtend ()
 Move caret to before first visible character on line.
 
void LineEndRectExtend ()
 Move caret to last position on line, extending rectangular selection to new caret position.
 
void PageUpRectExtend ()
 Move caret one page up, extending rectangular selection to new caret position.
 
void PageDownRectExtend ()
 Move caret one page down, extending rectangular selection to new caret position.
 
void StutteredPageUp ()
 Move caret to top of page, or one page up if already at top of page.
 
void StutteredPageUpExtend ()
 Move caret to top of page, or one page up if already at top of page, extending selection to new caret position.
 
void StutteredPageDown ()
 Move caret to bottom of page, or one page down if already at bottom of page.
 
void StutteredPageDownExtend ()
 Move caret to bottom of page, or one page down if already at bottom of page, extending selection to new caret position.
 
void WordLeftEnd ()
 Move caret left one word, position cursor at end of word.
 
void WordLeftEndExtend ()
 Move caret left one word, position cursor at end of word, extending selection to new caret position.
 
void WordRightEnd ()
 Move caret right one word, position cursor at end of word.
 
void WordRightEndExtend ()
 Move caret right one word, position cursor at end of word, extending selection to new caret position.
 
void SetWhitespaceChars (const wxString &characters)
 Set the set of characters making up whitespace for when moving or selecting by word.
 
wxString GetWhitespaceChars () const
 Get the set of characters making up whitespace for when moving or selecting by word.
 
void SetPunctuationChars (const wxString &characters)
 Set the set of characters making up punctuation characters Should be called after SetWordChars.
 
wxString GetPunctuationChars () const
 Get the set of characters making up punctuation characters.
 
void SetCharsDefault ()
 Reset the set of characters for whitespace and word characters to the defaults.
 
int AutoCompGetCurrent () const
 Get currently selected item position in the auto-completion list.
 
void AutoCompSetCaseInsensitiveBehaviour (int behaviour)
 Set auto-completion case insensitive behaviour to either prefer case-sensitive matches or have no preference.
 
int AutoCompGetCaseInsensitiveBehaviour () const
 Get auto-completion case insensitive behaviour.
 
void AutoCompSetOrder (int order)
 Set the way autocompletion lists are ordered.
 
int AutoCompGetOrder () const
 Get the way autocompletion lists are ordered.
 
void Allocate (int bytes)
 Enlarge the document to a particular size of text bytes.
 
int FindColumn (int line, int column)
 Find the position of a column on a line taking into account tabs and multi-byte characters.
 
int GetCaretSticky () const
 Can the caret preferred x position only be changed by explicit movement commands?
 
void SetCaretSticky (int useCaretStickyBehaviour)
 Stop the caret preferred x position changing when the user types.
 
void ToggleCaretSticky ()
 Switch between sticky and non-sticky: meant to be bound to a key.
 
void SetPasteConvertEndings (bool convert)
 Enable/Disable convert-on-paste for line endings.
 
bool GetPasteConvertEndings () const
 Get convert-on-paste setting.
 
void SelectionDuplicate ()
 Duplicate the selection.
 
void SetCaretLineBackAlpha (int alpha)
 Set background alpha of the caret line.
 
int GetCaretLineBackAlpha () const
 Get the background alpha of the caret line.
 
void SetCaretStyle (int caretStyle)
 Set the style of the caret to be drawn.
 
int GetCaretStyle () const
 Returns the current style of the caret.
 
void SetIndicatorCurrent (int indicator)
 Set the indicator used for IndicatorFillRange and IndicatorClearRange.
 
int GetIndicatorCurrent () const
 Get the current indicator.
 
void SetIndicatorValue (int value)
 Set the value used for IndicatorFillRange.
 
int GetIndicatorValue () const
 Get the current indicator value.
 
void IndicatorFillRange (int position, int fillLength)
 Turn a indicator on over a range.
 
void IndicatorClearRange (int position, int clearLength)
 Turn a indicator off over a range.
 
int IndicatorAllOnFor (int position)
 Are any indicators present at position?
 
int IndicatorValueAt (int indicator, int position)
 What value does a particular indicator have at at a position?
 
int IndicatorStart (int indicator, int position)
 Where does a particular indicator start?
 
int IndicatorEnd (int indicator, int position)
 Where does a particular indicator end?
 
void SetPositionCacheSize (int size)
 Set number of entries in position cache.
 
int GetPositionCacheSize () const
 How many entries are allocated to the position cache?
 
void CopyAllowLine ()
 Copy the selection, if selection empty copy the line with the caret.
 
const char * GetCharacterPointer () const
 Compact the document buffer and return a read-only pointer to the characters in the document.
 
const char * GetRangePointer (int position, int rangeLength) const
 Return a read-only pointer to a range of characters in the document.
 
int GetGapPosition () const
 Return a position which, to avoid performance costs, should not be within the range of a call to GetRangePointer.
 
void SetKeysUnicode (bool keysUnicode)
 Always interpret keyboard input as Unicode.
 
bool GetKeysUnicode () const
 Are keys always interpreted as Unicode?
 
void IndicatorSetAlpha (int indicator, int alpha)
 Set the alpha fill colour of the given indicator.
 
int IndicatorGetAlpha (int indicator) const
 Get the alpha fill colour of the given indicator.
 
void IndicatorSetOutlineAlpha (int indicator, int alpha)
 Set the alpha outline colour of the given indicator.
 
int IndicatorGetOutlineAlpha (int indicator) const
 Get the alpha outline colour of the given indicator.
 
void SetExtraAscent (int extraAscent)
 Set extra ascent for each line.
 
int GetExtraAscent () const
 Get extra ascent for each line.
 
void SetExtraDescent (int extraDescent)
 Set extra descent for each line.
 
int GetExtraDescent () const
 Get extra descent for each line.
 
int GetMarkerSymbolDefined (int markerNumber)
 Which symbol was defined for markerNumber with MarkerDefine.
 
void MarginSetText (int line, const wxString &text)
 Set the text in the text margin for a line.
 
wxString MarginGetText (int line) const
 Get the text in the text margin for a line.
 
void MarginSetStyle (int line, int style)
 Set the style number for the text margin for a line.
 
int MarginGetStyle (int line) const
 Get the style number for the text margin for a line.
 
void MarginSetStyles (int line, const wxString &styles)
 Set the style in the text margin for a line.
 
wxString MarginGetStyles (int line) const
 Get the styles in the text margin for a line.
 
void MarginTextClearAll ()
 Clear the margin text on all lines.
 
void MarginSetStyleOffset (int style)
 Get the start of the range of style numbers used for margin text.
 
int MarginGetStyleOffset () const
 Get the start of the range of style numbers used for margin text.
 
void SetMarginOptions (int marginOptions)
 Set the margin options.
 
int GetMarginOptions () const
 Get the margin options.
 
void AnnotationSetText (int line, const wxString &text)
 Set the annotation text for a line.
 
wxString AnnotationGetText (int line) const
 Get the annotation text for a line.
 
void AnnotationSetStyle (int line, int style)
 Set the style number for the annotations for a line.
 
int AnnotationGetStyle (int line) const
 Get the style number for the annotations for a line.
 
void AnnotationSetStyles (int line, const wxString &styles)
 Set the annotation styles for a line.
 
wxString AnnotationGetStyles (int line) const
 Get the annotation styles for a line.
 
int AnnotationGetLines (int line) const
 Get the number of annotation lines for a line.
 
void AnnotationClearAll ()
 Clear the annotations from all lines.
 
void AnnotationSetVisible (int visible)
 Set the visibility for the annotations for a view.
 
int AnnotationGetVisible () const
 Get the visibility for the annotations for a view.
 
void AnnotationSetStyleOffset (int style)
 Get the start of the range of style numbers used for annotations.
 
int AnnotationGetStyleOffset () const
 Get the start of the range of style numbers used for annotations.
 
void ReleaseAllExtendedStyles ()
 Release all extended (>255) style numbers.
 
int AllocateExtendedStyles (int numberStyles)
 Allocate some extended (>255) style numbers and return the start of the range.
 
void AddUndoAction (int token, int flags)
 Add a container action to the undo stack.
 
int CharPositionFromPoint (int x, int y)
 Find the position of a character from a point within the window.
 
int CharPositionFromPointClose (int x, int y)
 Find the position of a character from a point within the window.
 
void SetMouseSelectionRectangularSwitch (bool mouseSelectionRectangularSwitch)
 Set whether switching to rectangular mode while selecting with the mouse is allowed.
 
bool GetMouseSelectionRectangularSwitch () const
 Whether switching to rectangular mode while selecting with the mouse is allowed.
 
void SetMultipleSelection (bool multipleSelection)
 Set whether multiple selections can be made.
 
bool GetMultipleSelection () const
 Whether multiple selections can be made.
 
void SetAdditionalSelectionTyping (bool additionalSelectionTyping)
 Set whether typing can be performed into multiple selections.
 
bool GetAdditionalSelectionTyping () const
 Whether typing can be performed into multiple selections.
 
void SetAdditionalCaretsBlink (bool additionalCaretsBlink)
 Set whether additional carets will blink.
 
bool GetAdditionalCaretsBlink () const
 Whether additional carets will blink.
 
void SetAdditionalCaretsVisible (bool additionalCaretsBlink)
 Set whether additional carets are visible.
 
bool GetAdditionalCaretsVisible () const
 Whether additional carets are visible.
 
int GetSelections () const
 How many selections are there?
 
bool GetSelectionEmpty () const
 Is every selected range empty?
 
void ClearSelections ()
 Clear selections to a single empty stream selection.
 
int AddSelection (int caret, int anchor)
 Add a selection.
 
void DropSelectionN (int selection)
 Drop one selection.
 
void SetMainSelection (int selection)
 Set the main selection.
 
int GetMainSelection () const
 Which selection is the main selection.
 
void SetSelectionNCaret (int selection, int pos)
 
int GetSelectionNCaret (int selection) const
 
void SetSelectionNAnchor (int selection, int posAnchor)
 
int GetSelectionNAnchor (int selection) const
 
void SetSelectionNCaretVirtualSpace (int selection, int space)
 
int GetSelectionNCaretVirtualSpace (int selection) const
 
void SetSelectionNAnchorVirtualSpace (int selection, int space)
 
int GetSelectionNAnchorVirtualSpace (int selection) const
 
void SetSelectionNStart (int selection, int pos)
 Sets the position that starts the selection - this becomes the anchor.
 
int GetSelectionNStart (int selection) const
 Returns the position at the start of the selection.
 
void SetSelectionNEnd (int selection, int pos)
 Sets the position that ends the selection - this becomes the currentPosition.
 
int GetSelectionNEnd (int selection) const
 Returns the position at the end of the selection.
 
void SetRectangularSelectionCaret (int pos)
 
int GetRectangularSelectionCaret () const
 
void SetRectangularSelectionAnchor (int posAnchor)
 
int GetRectangularSelectionAnchor () const
 
void SetRectangularSelectionCaretVirtualSpace (int space)
 
int GetRectangularSelectionCaretVirtualSpace () const
 
void SetRectangularSelectionAnchorVirtualSpace (int space)
 
int GetRectangularSelectionAnchorVirtualSpace () const
 
void SetVirtualSpaceOptions (int virtualSpaceOptions)
 
int GetVirtualSpaceOptions () const
 
void SetRectangularSelectionModifier (int modifier)
 On GTK+, allow selecting the modifier key to use for mouse-based rectangular selection.
 
int GetRectangularSelectionModifier () const
 Get the modifier key used for rectangular selection.
 
void SetAdditionalSelForeground (const wxColour &fore)
 Set the foreground colour of additional selections.
 
void SetAdditionalSelBackground (const wxColour &back)
 Set the background colour of additional selections.
 
void SetAdditionalSelAlpha (int alpha)
 Set the alpha of the selection.
 
int GetAdditionalSelAlpha () const
 Get the alpha of the selection.
 
void SetAdditionalCaretForeground (const wxColour &fore)
 Set the foreground colour of additional carets.
 
wxColour GetAdditionalCaretForeground () const
 Get the foreground colour of additional carets.
 
void RotateSelection ()
 Set the main selection to the next selection.
 
void SwapMainAnchorCaret ()
 Swap that caret and anchor of the main selection.
 
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.
 
int ContractedFoldNext (int lineStart)
 Find the next line at or after lineStart that is a contracted fold header line.
 
void VerticalCentreCaret ()
 Centre current line in window.
 
void MoveSelectedLinesUp ()
 Move the selected lines up one line, shifting the line above after the selection.
 
void MoveSelectedLinesDown ()
 Move the selected lines down one line, shifting the line below before the selection.
 
void SetIdentifier (int identifier)
 Set the identifier reported as idFrom in notification messages.
 
int GetIdentifier () const
 Get the identifier.
 
void RGBAImageSetWidth (int width)
 Set the width for future RGBA image data.
 
void RGBAImageSetHeight (int height)
 Set the height for future RGBA image data.
 
void RGBAImageSetScale (int scalePercent)
 Set the scale factor in percent for future RGBA image data.
 
void MarkerDefineRGBAImage (int markerNumber, const unsigned char *pixels)
 Define a marker from RGBA data.
 
void RegisterRGBAImage (int type, const unsigned char *pixels)
 Register an RGBA image for use in autocompletion lists.
 
void ScrollToStart ()
 Scroll to start of document.
 
void ScrollToEnd ()
 Scroll to end of document.
 
void SetTechnology (int technology)
 Set the technology used.
 
int GetTechnology () const
 Get the tech.
 
void * CreateLoader (int bytes) const
 Create an ILoader*.
 
void VCHomeDisplay ()
 Move caret to before first visible character on display line.
 
void VCHomeDisplayExtend ()
 Like VCHomeDisplay but extending selection to new caret position.
 
bool GetCaretLineVisibleAlways () const
 Is the caret line always visible?
 
void SetCaretLineVisibleAlways (bool alwaysVisible)
 Sets the caret line to always visible.
 
void SetRepresentation (const wxString &encodedCharacter, const wxString &representation)
 Set the way a character is drawn.
 
wxString GetRepresentation (const wxString &encodedCharacter) const
 Get the way a character is drawn.
 
void ClearRepresentation (const wxString &encodedCharacter)
 Remove a character representation.
 
void StartRecord ()
 Start notifying the container of all key presses and commands.
 
void StopRecord ()
 Stop notifying the container of all key presses and commands.
 
void SetLexer (int lexer)
 Set the lexing language of the document.
 
int GetLexer () const
 Retrieve the lexing language of the document.
 
void Colourise (int start, int end)
 Colourise a segment of the document using the current lexing language.
 
void SetProperty (const wxString &key, const wxString &value)
 Set up a value that may be used by a lexer for some optional feature.
 
void SetKeyWords (int keywordSet, const wxString &keyWords)
 Set up the key words used by the lexer.
 
void SetLexerLanguage (const wxString &language)
 Set the lexing language of the document based on string name.
 
wxString GetProperty (const wxString &key)
 Retrieve a 'property' value previously set with SetProperty.
 
wxString GetPropertyExpanded (const wxString &key)
 Retrieve a 'property' value previously set with SetProperty, with '$()' variable replacement on returned buffer.
 
int GetPropertyInt (const wxString &key) const
 Retrieve a 'property' value previously set with SetProperty, interpreted as an int AFTER any '$()' variable replacement.
 
int GetStyleBitsNeeded () const
 Retrieve the number of bits the current lexer needs for styling.
 
void * PrivateLexerCall (int operation, void *pointer)
 For private communication between an application and a known lexer.
 
wxString PropertyNames () const
 Retrieve a '
' separated list of properties understood by the current lexer.
 
int PropertyType (const wxString &name)
 Retrieve the type of a property.
 
wxString DescribeProperty (const wxString &name) const
 Describe a property.
 
wxString DescribeKeyWordSets () const
 Retrieve a '
' separated list of descriptions of the keyword sets understood by the current lexer.
 
void SetLineEndTypesAllowed (int lineEndBitSet)
 Set the line end types that the application wants to use.
 
int GetLineEndTypesAllowed () const
 Get the line end types currently allowed.
 
int GetLineEndTypesActive () const
 Get the line end types currently recognised.
 
int GetLineEndTypesSupported () const
 Bit set of LineEndType enumertion for which line ends beyond the standard LF, CR, and CRLF are supported by the lexer.
 
int AllocateSubStyles (int styleBase, int numberStyles)
 Allocate a set of sub styles for a particular base style, returning start of range.
 
int GetSubStylesStart (int styleBase) const
 The starting style number for the sub styles associated with a base style.
 
int GetSubStylesLength (int styleBase) const
 The number of sub styles associated with a base style.
 
int GetStyleFromSubStyle (int subStyle) const
 For a sub style, return the base style, else return the argument.
 
int GetPrimaryStyleFromStyle (int style) const
 For a secondary style, return the primary style, else return the argument.
 
void FreeSubStyles ()
 Free allocated sub styles.
 
void SetIdentifiers (int style, const wxString &identifiers)
 Set the identifiers that are shown in a particular style.
 
int DistanceToSecondaryStyles () const
 Where styles are duplicated by a feature such as active/inactive code return the distance between the two types.
 
wxString GetSubStyleBases () const
 Get the set of base styles that can be extended with sub styles.
 
int GetCurrentLine ()
 Returns the line number of the line with the caret.
 
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:
 
wxFont StyleGetFont (int style)
 Get the font of a style.
 
void StyleSetFont (int styleNum, wxFont &font)
 Set style size, face, bold, italic, and underline attributes from a wxFont's attributes.
 
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.
 
void StyleSetCharacterSet (int style, int characterSet)
 Set the character set of the font in a style.
 
void StyleSetFontEncoding (int style, wxFontEncoding encoding)
 Set the font encoding to be used by a style.
 
void CmdKeyExecute (int cmd)
 Perform one of the operations defined by the wxSTC_CMD_* constants.
 
void SetMargins (int left, int right)
 Set the left and right margin in the edit area, measured in pixels.
 
wxPoint PointFromPosition (int pos)
 Retrieve the point in the window where a position is displayed.
 
void ScrollToLine (int line)
 Scroll enough to make the given line visible.
 
void ScrollToColumn (int column)
 Scroll enough to make the given column visible.
 
wxIntPtr SendMsg (int msg, wxUIntPtr wp=0, wxIntPtr lp=0) const
 Send a message to Scintilla.
 
void SetVScrollBar (wxScrollBar *bar)
 Set the vertical scrollbar to use instead of the ont that's built-in.
 
void SetHScrollBar (wxScrollBar *bar)
 Set the horizontal scrollbar to use instead of the ont that's built-in.
 
bool GetLastKeydownProcessed ()
 Can be used to prevent the EVT_CHAR handler from adding the char.
 
void SetLastKeydownProcessed (bool val)
 
bool SaveFile (const wxString &filename)
 Write the contents of the editor to filename.
 
bool LoadFile (const wxString &filename)
 Load the contents of filename into the editor.
 
wxDragResult DoDragEnter (wxCoord x, wxCoord y, wxDragResult defaultRes)
 Allow for simulating a DnD DragEnter.
 
wxDragResult DoDragOver (wxCoord x, wxCoord y, wxDragResult defaultRes)
 Allow for simulating a DnD DragOver.
 
void DoDragLeave ()
 Allow for simulating a DnD DragLeave.
 
bool DoDropText (long x, long y, const wxString &data)
 Allow for simulating a DnD DropText.
 
void AnnotationClearLine (int line)
 Clear annotations from the given line.
 
void AddTextRaw (const char *text, int length=-1)
 Add text to the document at current position.
 
void InsertTextRaw (int pos, const char *text)
 Insert string at a position.
 
wxCharBuffer GetCurLineRaw (int *linePos=NULL)
 Retrieve the text of the line containing the caret.
 
wxCharBuffer GetLineRaw (int line)
 Retrieve the contents of a line.
 
wxCharBuffer GetSelectedTextRaw ()
 Retrieve the selected text.
 
wxCharBuffer GetTextRangeRaw (int startPos, int endPos)
 Retrieve a range of text.
 
void SetTextRaw (const char *text)
 Replace the contents of the document with the argument text.
 
wxCharBuffer GetTextRaw ()
 Retrieve all the text in the document.
 
void AppendTextRaw (const char *text, int length=-1)
 Append a string to the end of the document without changing the selection.
 
virtual void WriteText (const wxString &text)
 Writes the text into the text control at the current insertion position.
 
virtual void Remove (long from, long to)
 Removes the text starting at the first given position up to (but not including) the character at the last position.
 
virtual void Replace (long from, long to, const wxString &text)
 Replaces the text starting at the first position up to (but not including) the character at the last position with the given text.
 
virtual void SetInsertionPoint (long pos)
 Sets the insertion point at the given position.
 
virtual long GetInsertionPoint () const
 Returns the insertion point, or cursor, position.
 
virtual long GetLastPosition () const
 Returns the zero based index of the last position in the text control, which is equal to the number of characters in the control.
 
virtual void SetSelection (long from, long to)
 Selects the text starting at the first position up to (but not including) the character at the last position.
 
virtual void SelectNone ()
 Deselects selected text in the control.
 
virtual void GetSelection (long *from, long *to) const
 Gets the current selection span.
 
virtual bool IsEditable () const
 Returns true if the controls contents may be edited by user (note that it always can be changed by the program).
 
virtual void SetEditable (bool editable)
 Makes the text item editable or read-only, overriding the wxTE_READONLY flag.
 
virtual int GetLineLength (long n) const
 
virtual wxString GetLineText (long n) const
 
virtual int GetNumberOfLines () const
 
virtual bool IsModified () const
 
virtual void MarkDirty ()
 
virtual void DiscardEdits ()
 
virtual bool SetStyle (long start, long end, const wxTextAttr &style)
 
virtual bool GetStyle (long position, wxTextAttr &style)
 
virtual bool SetDefaultStyle (const wxTextAttr &style)
 
virtual long XYToPosition (long x, long y) const
 
virtual bool PositionToXY (long pos, long *x, long *y) const
 
virtual void ShowPosition (long pos)
 
virtual wxTextCtrlHitTestResult HitTest (const wxPoint &pt, long *pos) const
 
virtual wxTextCtrlHitTestResult HitTest (const wxPoint &pt, wxTextCoord *col, wxTextCoord *row) const
 
- Public Member Functions inherited from wxControl
 wxControl (wxWindow *parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxValidator &validator=wxDefaultValidator, const wxString &name=wxControlNameStr)
 Constructs a control.
 
 wxControl ()
 Default constructor to allow 2-phase creation.
 
bool Create (wxWindow *parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxValidator &validator=wxDefaultValidator, const wxString &name=wxControlNameStr)
 
virtual void Command (wxCommandEvent &event)
 Simulates the effect of the user issuing a command to the item.
 
wxString GetLabel () const
 Returns the control's label, as it was passed to SetLabel().
 
wxString GetLabelText () const
 Returns the control's label without mnemonics.
 
wxSize GetSizeFromTextSize (int xlen, int ylen=-1) const
 Determine the size needed by the control to leave the given area for its text.
 
wxSize GetSizeFromTextSize (const wxSize &tsize) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
void SetLabel (const wxString &label)
 Sets the control's label.
 
void SetLabelText (const wxString &text)
 Sets the control's label to exactly the given string.
 
bool SetLabelMarkup (const wxString &markup)
 Sets the controls label to a string using markup.
 
- Public Member Functions inherited from wxWindow
 wxWindow ()
 Default constructor.
 
 wxWindow (wxWindow *parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxString &name=wxPanelNameStr)
 Constructs a window, which can be a child of a frame, dialog or any other non-control window.
 
virtual ~wxWindow ()
 Destructor.
 
bool Create (wxWindow *parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxString &name=wxPanelNameStr)
 
virtual bool AcceptsFocus () const
 This method may be overridden in the derived classes to return false to indicate that this control doesn't accept input at all (i.e. behaves like e.g. wxStaticText) and so doesn't need focus.
 
virtual bool AcceptsFocusFromKeyboard () const
 This method may be overridden in the derived classes to return false to indicate that while this control can, in principle, have focus if the user clicks it with the mouse, it shouldn't be included in the TAB traversal chain when using the keyboard.
 
virtual bool AcceptsFocusRecursively () const
 Overridden to indicate whether this window or one of its children accepts focus.
 
bool IsFocusable () const
 Can this window itself have focus?
 
bool CanAcceptFocus () const
 Can this window have focus right now?
 
bool CanAcceptFocusFromKeyboard () const
 Can this window be assigned focus from keyboard right now?
 
virtual bool HasFocus () const
 Returns true if the window (or in case of composite controls, its main child window) has focus.
 
virtual void SetCanFocus (bool canFocus)
 This method is only implemented by ports which have support for native TAB traversal (such as GTK+ 2.0).
 
virtual void SetFocus ()
 This sets the window to receive keyboard input.
 
virtual void SetFocusFromKbd ()
 This function is called by wxWidgets keyboard navigation code when the user gives the focus to this window from keyboard (e.g.
 
virtual void AddChild (wxWindow *child)
 Adds a child window.
 
bool DestroyChildren ()
 Destroys all children of a window.
 
wxWindowFindWindow (long id) const
 Find a child of this window, by id.
 
wxWindowFindWindow (const wxString &name) const
 Find a child of this window, by name.
 
wxWindowList & GetChildren ()
 Returns a reference to the list of the window's children.
 
const wxWindowList & GetChildren () const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
virtual void RemoveChild (wxWindow *child)
 Removes a child window.
 
wxWindowGetGrandParent () const
 Returns the grandparent of a window, or NULL if there isn't one.
 
wxWindowGetNextSibling () const
 Returns the next window after this one among the parent's children or NULL if this window is the last child.
 
wxWindowGetParent () const
 Returns the parent of the window, or NULL if there is no parent.
 
wxWindowGetPrevSibling () const
 Returns the previous window before this one among the parent's children or NULL if this window is the first child.
 
bool IsDescendant (wxWindowBase *win) const
 Check if the specified window is a descendant of this one.
 
virtual bool Reparent (wxWindow *newParent)
 Reparents the window, i.e. the window will be removed from its current parent window (e.g.
 
virtual void AlwaysShowScrollbars (bool hflag=true, bool vflag=true)
 Call this function to force one or both scrollbars to be always shown, even if the window is big enough to show its entire contents without scrolling.
 
virtual int GetScrollPos (int orientation) const
 Returns the built-in scrollbar position.
 
virtual int GetScrollRange (int orientation) const
 Returns the built-in scrollbar range.
 
virtual int GetScrollThumb (int orientation) const
 Returns the built-in scrollbar thumb size.
 
bool CanScroll (int orient) const
 Returns true if this window can have a scroll bar in this orientation.
 
bool HasScrollbar (int orient) const
 Returns true if this window currently has a scroll bar for this orientation.
 
virtual bool IsScrollbarAlwaysShown (int orient) const
 Return whether a scrollbar is always shown.
 
virtual bool ScrollLines (int lines)
 Scrolls the window by the given number of lines down (if lines is positive) or up.
 
virtual bool ScrollPages (int pages)
 Scrolls the window by the given number of pages down (if pages is positive) or up.
 
virtual void ScrollWindow (int dx, int dy, const wxRect *rect=NULL)
 Physically scrolls the pixels in the window and move child windows accordingly.
 
bool LineUp ()
 Same as ScrollLines (-1).
 
bool LineDown ()
 Same as ScrollLines (1).
 
bool PageUp ()
 Same as ScrollPages (-1).
 
bool PageDown ()
 Same as ScrollPages (1).
 
virtual void SetScrollPos (int orientation, int pos, bool refresh=true)
 Sets the position of one of the built-in scrollbars.
 
virtual void SetScrollbar (int orientation, int position, int thumbSize, int range, bool refresh=true)
 Sets the scrollbar properties of a built-in scrollbar.
 
bool BeginRepositioningChildren ()
 Prepare for changing positions of multiple child windows.
 
void EndRepositioningChildren ()
 Fix child window positions after setting all of them at once.
 
void CacheBestSize (const wxSize &size) const
 Sets the cached best size value.
 
virtual wxSize ClientToWindowSize (const wxSize &size) const
 Converts client area size size to corresponding window size.
 
virtual wxSize WindowToClientSize (const wxSize &size) const
 Converts window size size to corresponding client area size In other words, the returned value is what would GetClientSize() return if this window had given window size.
 
virtual void Fit ()
 Sizes the window so that it fits around its subwindows.
 
virtual void FitInside ()
 Similar to Fit(), but sizes the interior (virtual) size of a window.
 
wxSize GetBestSize () const
 This functions returns the best acceptable minimal size for the window.
 
int GetBestHeight (int width) const
 Returns the best height needed by this window if it had the given width.
 
int GetBestWidth (int height) const
 Returns the best width needed by this window if it had the given height.
 
void GetClientSize (int *width, int *height) const
 Returns the size of the window 'client area' in pixels.
 
wxSize GetClientSize () const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
virtual wxSize GetEffectiveMinSize () const
 Merges the window's best size into the min size and returns the result.
 
virtual wxSize GetMaxClientSize () const
 Returns the maximum size of window's client area.
 
virtual wxSize GetMaxSize () const
 Returns the maximum size of the window.
 
virtual wxSize GetMinClientSize () const
 Returns the minimum size of window's client area, an indication to the sizer layout mechanism that this is the minimum required size of its client area.
 
virtual wxSize GetMinSize () const
 Returns the minimum size of the window, an indication to the sizer layout mechanism that this is the minimum required size.
 
int GetMinWidth () const
 Returns the horizontal component of window minimal size.
 
int GetMinHeight () const
 Returns the vertical component of window minimal size.
 
int GetMaxWidth () const
 Returns the horizontal component of window maximal size.
 
int GetMaxHeight () const
 Returns the vertical component of window maximal size.
 
void GetSize (int *width, int *height) const
 Returns the size of the entire window in pixels, including title bar, border, scrollbars, etc.
 
wxSize GetSize () const
 See the GetSize(int*,int*) overload for more info.
 
wxSize GetVirtualSize () const
 This gets the virtual size of the window in pixels.
 
void GetVirtualSize (int *width, int *height) const
 Like the other GetVirtualSize() overload but uses pointers instead.
 
virtual wxSize GetBestVirtualSize () const
 Return the largest of ClientSize and BestSize (as determined by a sizer, interior children, or other means)
 
virtual double GetContentScaleFactor () const
 Returns the magnification of the backing store of this window, eg 2.0 for a window on a retina screen.
 
virtual wxSize GetWindowBorderSize () const
 Returns the size of the left/right and top/bottom borders of this window in x and y components of the result respectively.
 
virtual bool InformFirstDirection (int direction, int size, int availableOtherDir)
 wxSizer and friends use this to give a chance to a component to recalc its min size once one of the final size components is known.
 
void InvalidateBestSize ()
 Resets the cached best size value so it will be recalculated the next time it is needed.
 
void PostSizeEvent ()
 Posts a size event to the window.
 
void PostSizeEventToParent ()
 Posts a size event to the parent of this window.
 
virtual void SendSizeEvent (int flags=0)
 This function sends a dummy size event to the window allowing it to re-layout its children positions.
 
void SendSizeEventToParent (int flags=0)
 Safe wrapper for GetParent()->SendSizeEvent().
 
void SetClientSize (int width, int height)
 This sets the size of the window client area in pixels.
 
void SetClientSize (const wxSize &size)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
void SetClientSize (const wxRect &rect)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
void SetContainingSizer (wxSizer *sizer)
 This normally does not need to be called by user code.
 
void SetInitialSize (const wxSize &size=wxDefaultSize)
 A smart SetSize that will fill in default size components with the window's best size values.
 
virtual void SetMaxClientSize (const wxSize &size)
 Sets the maximum client size of the window, to indicate to the sizer layout mechanism that this is the maximum possible size of its client area.
 
virtual void SetMaxSize (const wxSize &size)
 Sets the maximum size of the window, to indicate to the sizer layout mechanism that this is the maximum possible size.
 
virtual void SetMinClientSize (const wxSize &size)
 Sets the minimum client size of the window, to indicate to the sizer layout mechanism that this is the minimum required size of window's client area.
 
virtual void SetMinSize (const wxSize &size)
 Sets the minimum size of the window, to indicate to the sizer layout mechanism that this is the minimum required size.
 
void SetSize (int x, int y, int width, int height, int sizeFlags=wxSIZE_AUTO)
 Sets the size of the window in pixels.
 
void SetSize (const wxRect &rect)
 Sets the size of the window in pixels.
 
void SetSize (const wxSize &size)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
void SetSize (int width, int height)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
virtual void SetSizeHints (const wxSize &minSize, const wxSize &maxSize=wxDefaultSize, const wxSize &incSize=wxDefaultSize)
 Use of this function for windows which are not toplevel windows (such as wxDialog or wxFrame) is discouraged.
 
virtual void SetSizeHints (int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1, int incH=-1)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
void SetVirtualSize (int width, int height)
 Sets the virtual size of the window in pixels.
 
void SetVirtualSize (const wxSize &size)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
void Center (int dir=wxBOTH)
 A synonym for Centre().
 
void CenterOnParent (int dir=wxBOTH)
 A synonym for CentreOnParent().
 
void Centre (int direction=wxBOTH)
 Centres the window.
 
void CentreOnParent (int direction=wxBOTH)
 Centres the window on its parent.
 
void GetPosition (int *x, int *y) const
 This gets the position of the window in pixels, relative to the parent window for the child windows or relative to the display origin for the top level windows.
 
wxPoint GetPosition () const
 This gets the position of the window in pixels, relative to the parent window for the child windows or relative to the display origin for the top level windows.
 
wxRect GetRect () const
 Returns the position and size of the window as a wxRect object.
 
void GetScreenPosition (int *x, int *y) const
 Returns the window position in screen coordinates, whether the window is a child window or a top level one.
 
wxPoint GetScreenPosition () const
 Returns the window position in screen coordinates, whether the window is a child window or a top level one.
 
wxRect GetScreenRect () const
 Returns the position and size of the window on the screen as a wxRect object.
 
virtual wxPoint GetClientAreaOrigin () const
 Get the origin of the client area of the window relative to the window top left corner (the client area may be shifted because of the borders, scrollbars, other decorations...)
 
wxRect GetClientRect () const
 Get the client rectangle in window (i.e. client) coordinates.
 
void Move (int x, int y, int flags=wxSIZE_USE_EXISTING)
 Moves the window to the given position.
 
void Move (const wxPoint &pt, int flags=wxSIZE_USE_EXISTING)
 Moves the window to the given position.
 
void SetPosition (const wxPoint &pt)
 A synonym for Centre().
 
void ClientToScreen (int *x, int *y) const
 Converts to screen coordinates from coordinates relative to this window.
 
wxPoint ClientToScreen (const wxPoint &pt) const
 Converts to screen coordinates from coordinates relative to this window.
 
wxPoint ConvertDialogToPixels (const wxPoint &pt) const
 Converts a point or size from dialog units to pixels.
 
wxSize ConvertDialogToPixels (const wxSize &sz) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
wxPoint ConvertPixelsToDialog (const wxPoint &pt) const
 Converts a point or size from pixels to dialog units.
 
wxSize ConvertPixelsToDialog (const wxSize &sz) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
void ScreenToClient (int *x, int *y) const
 Converts from screen to client window coordinates.
 
wxPoint ScreenToClient (const wxPoint &pt) const
 Converts from screen to client window coordinates.
 
virtual void ClearBackground ()
 Clears the window by filling it with the current background colour.
 
void Freeze ()
 Freezes the window or, in other words, prevents any updates from taking place on screen, the window is not redrawn at all.
 
void Thaw ()
 Re-enables window updating after a previous call to Freeze().
 
bool IsFrozen () const
 Returns true if the window is currently frozen by a call to Freeze().
 
wxColour GetBackgroundColour () const
 Returns the background colour of the window.
 
virtual wxBackgroundStyle GetBackgroundStyle () const
 Returns the background style of the window.
 
virtual int GetCharHeight () const
 Returns the character height for this window.
 
virtual int GetCharWidth () const
 Returns the average character width for this window.
 
virtual wxVisualAttributes GetDefaultAttributes () const
 Currently this is the same as calling wxWindow::GetClassDefaultAttributes(wxWindow::GetWindowVariant()).
 
wxFont GetFont () const
 Returns the font for this window.
 
wxColour GetForegroundColour () const
 Returns the foreground colour of the window.
 
void GetTextExtent (const wxString &string, int *w, int *h, int *descent=NULL, int *externalLeading=NULL, const wxFont *font=NULL) const
 Gets the dimensions of the string as it would be drawn on the window with the currently selected font.
 
wxSize GetTextExtent (const wxString &string) const
 Gets the dimensions of the string as it would be drawn on the window with the currently selected font.
 
const wxRegionGetUpdateRegion () const
 Returns the region specifying which parts of the window have been damaged.
 
wxRect GetUpdateClientRect () const
 Get the update rectangle bounding box in client coords.
 
virtual bool HasTransparentBackground ()
 Returns true if this window background is transparent (as, for example, for wxStaticText) and should show the parent window background.
 
virtual void Refresh (bool eraseBackground=true, const wxRect *rect=NULL)
 Causes this window, and all of its children recursively (except under wxGTK1 where this is not implemented), to be repainted.
 
void RefreshRect (const wxRect &rect, bool eraseBackground=true)
 Redraws the contents of the given rectangle: only the area inside it will be repainted.
 
virtual void Update ()
 Calling this method immediately repaints the invalidated area of the window and all of its children recursively (this normally only happens when the flow of control returns to the event loop).
 
virtual bool SetBackgroundColour (const wxColour &colour)
 Sets the background colour of the window.
 
virtual bool SetBackgroundStyle (wxBackgroundStyle style)
 Sets the background style of the window.
 
virtual bool IsTransparentBackgroundSupported (wxString *reason=NULL) const
 Checks whether using transparent background might work.
 
virtual bool SetFont (const wxFont &font)
 Sets the font for this window.
 
virtual bool SetForegroundColour (const wxColour &colour)
 Sets the foreground colour of the window.
 
void SetOwnBackgroundColour (const wxColour &colour)
 Sets the background colour of the window but prevents it from being inherited by the children of this window.
 
bool InheritsBackgroundColour () const
 Return true if this window inherits the background colour from its parent.
 
bool UseBgCol () const
 Return true if a background colour has been set for this window.
 
void SetOwnFont (const wxFont &font)
 Sets the font of the window but prevents it from being inherited by the children of this window.
 
void SetOwnForegroundColour (const wxColour &colour)
 Sets the foreground colour of the window but prevents it from being inherited by the children of this window.
 
void SetPalette (const wxPalette &pal)
 
virtual bool ShouldInheritColours () const
 Return true from here to allow the colours of this window to be changed by InheritAttributes().
 
virtual void SetThemeEnabled (bool enable)
 This function tells a window if it should use the system's "theme" code to draw the windows' background instead of its own background drawing code.
 
virtual bool GetThemeEnabled () const
 Clears the window by filling it with the current background colour.
 
virtual bool CanSetTransparent ()
 Returns true if the system supports transparent windows and calling SetTransparent() may succeed.
 
virtual bool SetTransparent (wxByte alpha)
 Set the transparency of the window.
 
wxEvtHandlerGetEventHandler () const
 Returns the event handler for this window.
 
bool HandleAsNavigationKey (const wxKeyEvent &event)
 This function will generate the appropriate call to Navigate() if the key event is one normally used for keyboard navigation and return true in this case.
 
bool HandleWindowEvent (wxEvent &event) const
 Shorthand for:
 
bool ProcessWindowEvent (wxEvent &event)
 Convenient wrapper for ProcessEvent().
 
bool ProcessWindowEventLocally (wxEvent &event)
 Wrapper for wxEvtHandler::ProcessEventLocally().
 
wxEvtHandlerPopEventHandler (bool deleteHandler=false)
 Removes and returns the top-most event handler on the event handler stack.
 
void PushEventHandler (wxEvtHandler *handler)
 Pushes this event handler onto the event stack for the window.
 
bool RemoveEventHandler (wxEvtHandler *handler)
 Find the given handler in the windows event handler stack and removes (but does not delete) it from the stack.
 
void SetEventHandler (wxEvtHandler *handler)
 Sets the event handler for this window.
 
virtual void SetNextHandler (wxEvtHandler *handler)
 wxWindows cannot be used to form event handler chains; this function thus will assert when called.
 
virtual void SetPreviousHandler (wxEvtHandler *handler)
 wxWindows cannot be used to form event handler chains; this function thus will assert when called.
 
long GetExtraStyle () const
 Returns the extra style bits for the window.
 
virtual long GetWindowStyleFlag () const
 Gets the window style that was passed to the constructor or Create() method.
 
long GetWindowStyle () const
 See GetWindowStyleFlag() for more info.
 
bool HasExtraStyle (int exFlag) const
 Returns true if the window has the given exFlag bit set in its extra styles.
 
bool HasFlag (int flag) const
 Returns true if the window has the given flag bit set.
 
virtual void SetExtraStyle (long exStyle)
 Sets the extra style bits for the window.
 
virtual void SetWindowStyleFlag (long style)
 Sets the style of the window.
 
void SetWindowStyle (long style)
 See SetWindowStyleFlag() for more info.
 
bool ToggleWindowStyle (int flag)
 Turns the given flag on if it's currently turned off and vice versa.
 
void MoveAfterInTabOrder (wxWindow *win)
 Moves this window in the tab navigation order after the specified win.
 
void MoveBeforeInTabOrder (wxWindow *win)
 Same as MoveAfterInTabOrder() except that it inserts this window just before win instead of putting it right after it.
 
bool Navigate (int flags=wxNavigationKeyEvent::IsForward)
 Performs a keyboard navigation action starting from this window.
 
bool NavigateIn (int flags=wxNavigationKeyEvent::IsForward)
 Performs a keyboard navigation action inside this window.
 
virtual void Lower ()
 Lowers the window to the bottom of the window hierarchy (Z-order).
 
virtual void Raise ()
 Raises the window to the top of the window hierarchy (Z-order).
 
bool Hide ()
 Equivalent to calling wxWindow::Show(false).
 
virtual bool HideWithEffect (wxShowEffect effect, unsigned int timeout=0)
 This function hides a window, like Hide(), but using a special visual effect if possible.
 
bool IsEnabled () const
 Returns true if the window is enabled, i.e. if it accepts user input, false otherwise.
 
bool IsExposed (int x, int y) const
 Returns true if the given point or rectangle area has been exposed since the last repaint.
 
bool IsExposed (wxPoint &pt) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool IsExposed (int x, int y, int w, int h) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool IsExposed (wxRect &rect) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
virtual bool IsShown () const
 Returns true if the window is shown, false if it has been hidden.
 
virtual bool IsShownOnScreen () const
 Returns true if the window is physically visible on the screen, i.e. it is shown and all its parents up to the toplevel window are shown as well.
 
bool Disable ()
 Disables the window.
 
virtual bool Enable (bool enable=true)
 Enable or disable the window for user input.
 
virtual bool Show (bool show=true)
 Shows or hides the window.
 
virtual bool ShowWithEffect (wxShowEffect effect, unsigned int timeout=0)
 This function shows a window, like Show(), but using a special visual effect if possible.
 
wxString GetHelpText () const
 Gets the help text to be used as context-sensitive help for this window.
 
void SetHelpText (const wxString &helpText)
 Sets the help text to be used as context-sensitive help for this window.
 
virtual wxString GetHelpTextAtPoint (const wxPoint &point, wxHelpEvent::Origin origin) const
 Gets the help text to be used as context-sensitive help for this window.
 
wxToolTipGetToolTip () const
 Get the associated tooltip or NULL if none.
 
wxString GetToolTipText () const
 Get the text of the associated tooltip or empty string if none.
 
void SetToolTip (const wxString &tipString)
 Attach a tooltip to the window.
 
void SetToolTip (wxToolTip *tip)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
void UnsetToolTip ()
 Unset any existing tooltip.
 
int GetPopupMenuSelectionFromUser (wxMenu &menu, const wxPoint &pos=wxDefaultPosition)
 This function shows a popup menu at the given position in this window and returns the selected id.
 
int GetPopupMenuSelectionFromUser (wxMenu &menu, int x, int y)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool PopupMenu (wxMenu *menu, const wxPoint &pos=wxDefaultPosition)
 Pops up the given menu at the specified coordinates, relative to this window, and returns control when the user has dismissed the menu.
 
bool PopupMenu (wxMenu *menu, int x, int y)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
virtual wxValidatorGetValidator ()
 Validator functions.
 
virtual void SetValidator (const wxValidator &validator)
 Deletes the current validator (if any) and sets the window validator, having called wxValidator::Clone to create a new validator of this type.
 
virtual bool TransferDataFromWindow ()
 Transfers values from child controls to data areas specified by their validators.
 
virtual bool TransferDataToWindow ()
 Transfers values to child controls from data areas specified by their validators.
 
virtual bool Validate ()
 Validates the current values of the child controls using their validators.
 
wxWindowID GetId () const
 Returns the identifier of the window.
 
virtual wxLayoutDirection GetLayoutDirection () const
 Returns the layout direction for this window, Note that wxLayout_Default is returned if layout direction is not supported.
 
virtual wxCoord AdjustForLayoutDirection (wxCoord x, wxCoord width, wxCoord widthTotal) const
 Mirror coordinates for RTL layout if this window uses it and if the mirroring is not done automatically like Win32.
 
virtual wxString GetName () const
 Returns the window's name.
 
wxWindowVariant GetWindowVariant () const
 Returns the value previously passed to SetWindowVariant().
 
void SetId (wxWindowID winid)
 Sets the identifier of the window.
 
virtual void SetLayoutDirection (wxLayoutDirection dir)
 Sets the layout direction for this window.
 
virtual void SetName (const wxString &name)
 Sets the window's name.
 
void SetWindowVariant (wxWindowVariant variant)
 Chooses a different variant of the window display to use.
 
wxAcceleratorTableGetAcceleratorTable ()
 Gets the accelerator table for this window.
 
wxAccessibleGetAccessible ()
 Returns the accessible object for this window, if any.
 
virtual void SetAcceleratorTable (const wxAcceleratorTable &accel)
 Sets the accelerator table for this window.
 
void SetAccessible (wxAccessible *accessible)
 Sets the accessible for this window.
 
bool Close (bool force=false)
 This function simply generates a wxCloseEvent whose handler usually tries to close the window.
 
virtual bool Destroy ()
 Destroys the window safely.
 
bool IsBeingDeleted () const
 Returns true if this window is in process of being destroyed.
 
virtual wxDropTargetGetDropTarget () const
 Returns the associated drop target, which may be NULL.
 
virtual void SetDropTarget (wxDropTarget *target)
 Associates a drop target with this window.
 
virtual void DragAcceptFiles (bool accept)
 Enables or disables eligibility for drop file events (OnDropFiles).
 
wxSizerGetContainingSizer () const
 Returns the sizer of which this window is a member, if any, otherwise NULL.
 
wxSizerGetSizer () const
 Returns the sizer associated with the window by a previous call to SetSizer(), or NULL.
 
void SetSizer (wxSizer *sizer, bool deleteOld=true)
 Sets the window to have the given layout sizer.
 
void SetSizerAndFit (wxSizer *sizer, bool deleteOld=true)
 This method calls SetSizer() and then wxSizer::SetSizeHints which sets the initial window size to the size needed to accommodate all sizer elements and sets the size hints which, if this window is a top level one, prevent the user from resizing it to be less than this minimal size.
 
wxLayoutConstraintsGetConstraints () const
 Returns a pointer to the window's layout constraints, or NULL if there are none.
 
void SetConstraints (wxLayoutConstraints *constraints)
 Sets the window to have the given layout constraints.
 
virtual bool Layout ()
 Invokes the constraint-based layout algorithm or the sizer-based algorithm for this window.
 
void SetAutoLayout (bool autoLayout)
 Determines whether the Layout() function will be called automatically when the window is resized.
 
bool GetAutoLayout () const
 Returns the sizer of which this window is a member, if any, otherwise NULL.
 
void CaptureMouse ()
 Directs all mouse input to this window.
 
wxCaretGetCaret () const
 Returns the caret() associated with the window.
 
const wxCursorGetCursor () const
 Return the cursor associated with this window.
 
virtual bool HasCapture () const
 Returns true if this window has the current mouse capture.
 
void ReleaseMouse ()
 Releases mouse input captured with CaptureMouse().
 
void SetCaret (wxCaret *caret)
 Sets the caret() associated with the window.
 
virtual bool SetCursor (const wxCursor &cursor)
 Sets the window's cursor.
 
virtual void WarpPointer (int x, int y)
 Moves the pointer to the given position on the window.
 
wxHitTest HitTest (wxCoord x, wxCoord y) const
 Return where the given point lies, exactly.
 
wxHitTest HitTest (const wxPoint &pt) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
wxBorder GetBorder (long flags) const
 Get the window border style from the given flags: this is different from simply doing flags & wxBORDER_MASK because it uses GetDefaultBorder() to translate wxBORDER_DEFAULT to something reasonable.
 
wxBorder GetBorder () const
 Get border for the flags of this window.
 
virtual void DoUpdateWindowUI (wxUpdateUIEvent &event)
 Does the window-specific updating after processing the update event.
 
virtual WXWidget GetHandle () const
 Returns the platform-specific handle of the physical window.
 
virtual bool HasMultiplePages () const
 This method should be overridden to return true if this window has multiple pages.
 
virtual void InheritAttributes ()
 This function is (or should be, in case of custom controls) called during window creation to intelligently set up the window visual attributes, that is the font and the foreground and background colours.
 
virtual void InitDialog ()
 Sends an wxEVT_INIT_DIALOG event, whose handler usually transfers data to the dialog via validators.
 
virtual bool IsDoubleBuffered () const
 Returns true if the window contents is double-buffered by the system, i.e. if any drawing done on the window is really done on a temporary backing surface and transferred to the screen all at once later.
 
void SetDoubleBuffered (bool on)
 Turn on or off double buffering of the window if the system supports it.
 
virtual bool IsRetained () const
 Returns true if the window is retained, false otherwise.
 
bool IsThisEnabled () const
 Returns true if this window is intrinsically enabled, false otherwise, i.e. if Enable() Enable(false) had been called.
 
virtual bool IsTopLevel () const
 Returns true if the given window is a top-level one.
 
virtual void OnInternalIdle ()
 This virtual function is normally only used internally, but sometimes an application may need it to implement functionality that should not be disabled by an application defining an OnIdle handler in a derived class.
 
virtual bool SendIdleEvents (wxIdleEvent &event)
 Send idle event to window and all subwindows.
 
virtual bool RegisterHotKey (int hotkeyId, int modifiers, int virtualKeyCode)
 Registers a system wide hotkey.
 
virtual bool UnregisterHotKey (int hotkeyId)
 Unregisters a system wide hotkey.
 
virtual void UpdateWindowUI (long flags=wxUPDATE_UI_NONE)
 This function sends one or more wxUpdateUIEvent to the window.
 
- Public Member Functions inherited from wxEvtHandler
 wxEvtHandler ()
 Constructor.
 
virtual ~wxEvtHandler ()
 Destructor.
 
template<typename T , typename T1 , ... >
void CallAfter (void(T::*method)(T1,...), T1 x1,...)
 Asynchronously call the given method.
 
template<typename T >
void CallAfter (const T &functor)
 Asynchronously call the given functor.
 
bool ProcessEventLocally (wxEvent &event)
 Try to process the event in this handler and all those chained to it.
 
bool SafelyProcessEvent (wxEvent &event)
 Processes an event by calling ProcessEvent() and handles any exceptions that occur in the process.
 
void ProcessPendingEvents ()
 Processes the pending events previously queued using QueueEvent() or AddPendingEvent(); you must call this function only if you are sure there are pending events for this handler, otherwise a wxCHECK will fail.
 
void DeletePendingEvents ()
 Deletes all events queued on this event handler using QueueEvent() or AddPendingEvent().
 
virtual bool SearchEventTable (wxEventTable &table, wxEvent &event)
 Searches the event table, executing an event handler function if an appropriate one is found.
 
void Connect (int id, int lastId, wxEventType eventType, wxObjectEventFunction function, wxObject *userData=NULL, wxEvtHandler *eventSink=NULL)
 Connects the given function dynamically with the event handler, id and event type.
 
void Connect (int id, wxEventType eventType, wxObjectEventFunction function, wxObject *userData=NULL, wxEvtHandler *eventSink=NULL)
 See the Connect(int, int, wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*) overload for more info.
 
void Connect (wxEventType eventType, wxObjectEventFunction function, wxObject *userData=NULL, wxEvtHandler *eventSink=NULL)
 See the Connect(int, int, wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*) overload for more info.
 
bool Disconnect (wxEventType eventType, wxObjectEventFunction function, wxObject *userData=NULL, wxEvtHandler *eventSink=NULL)
 Disconnects the given function dynamically from the event handler, using the specified parameters as search criteria and returning true if a matching function has been found and removed.
 
bool Disconnect (int id=wxID_ANY, wxEventType eventType=wxEVT_NULL, wxObjectEventFunction function=NULL, wxObject *userData=NULL, wxEvtHandler *eventSink=NULL)
 See the Disconnect(wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*) overload for more info.
 
bool Disconnect (int id, int lastId, wxEventType eventType, wxObjectEventFunction function=NULL, wxObject *userData=NULL, wxEvtHandler *eventSink=NULL)
 See the Disconnect(wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*) overload for more info.
 
template<typename EventTag , typename Functor >
void Bind (const EventTag &eventType, Functor functor, int id=wxID_ANY, int lastId=wxID_ANY, wxObject *userData=NULL)
 Binds the given function, functor or method dynamically with the event.
 
template<typename EventTag , typename Class , typename EventArg , typename EventHandler >
void Bind (const EventTag &eventType, void(Class::*method)(EventArg &), EventHandler *handler, int id=wxID_ANY, int lastId=wxID_ANY, wxObject *userData=NULL)
 See the Bind<>(const EventTag&, Functor, int, int, wxObject*) overload for more info.
 
template<typename EventTag , typename Functor >
bool Unbind (const EventTag &eventType, Functor functor, int id=wxID_ANY, int lastId=wxID_ANY, wxObject *userData=NULL)
 Unbinds the given function, functor or method dynamically from the event handler, using the specified parameters as search criteria and returning true if a matching function has been found and removed.
 
template<typename EventTag , typename Class , typename EventArg , typename EventHandler >
bool Unbind (const EventTag &eventType, void(Class::*method)(EventArg &), EventHandler *handler, int id=wxID_ANY, int lastId=wxID_ANY, wxObject *userData=NULL)
 See the Unbind<>(const EventTag&, Functor, int, int, wxObject*) overload for more info.
 
void * GetClientData () const
 Returns user-supplied client data.
 
wxClientDataGetClientObject () const
 Returns a pointer to the user-supplied client data object.
 
void SetClientData (void *data)
 Sets user-supplied client data.
 
void SetClientObject (wxClientData *data)
 Set the client data object.
 
bool GetEvtHandlerEnabled () const
 Returns true if the event handler is enabled, false otherwise.
 
wxEvtHandlerGetNextHandler () const
 Returns the pointer to the next handler in the chain.
 
wxEvtHandlerGetPreviousHandler () const
 Returns the pointer to the previous handler in the chain.
 
void SetEvtHandlerEnabled (bool enabled)
 Enables or disables the event handler.
 
void Unlink ()
 Unlinks this event handler from the chain it's part of (if any); then links the "previous" event handler to the "next" one (so that the chain won't be interrupted).
 
bool IsUnlinked () const
 Returns true if the next and the previous handler pointers of this event handler instance are NULL.
 
- Public Member Functions inherited from wxObject
 wxObject ()
 Default ctor; initializes to NULL the internal reference data.
 
 wxObject (const wxObject &other)
 Copy ctor.
 
virtual ~wxObject ()
 Destructor.
 
virtual wxClassInfoGetClassInfo () const
 This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar).
 
wxObjectRefDataGetRefData () const
 Returns the wxObject::m_refData pointer, i.e. the data referenced by this object.
 
bool IsKindOf (const wxClassInfo *info) const
 Determines whether this class is a subclass of (or the same class as) the given class.
 
bool IsSameAs (const wxObject &obj) const
 Returns true if this object has the same data pointer as obj.
 
void Ref (const wxObject &clone)
 Makes this object refer to the data in clone.
 
void SetRefData (wxObjectRefData *data)
 Sets the wxObject::m_refData pointer.
 
void UnRef ()
 Decrements the reference count in the associated data, and if it is zero, deletes the data.
 
void UnShare ()
 This is the same of AllocExclusive() but this method is public.
 
void operator delete (void *buf)
 The delete operator is defined for debugging versions of the library only, when the identifier WXDEBUG is defined.
 
void * operator new (size_t size, const wxString &filename=NULL, int lineNum=0)
 The new operator is defined for debugging versions of the library only, when the identifier WXDEBUG is defined.
 
- Public Member Functions inherited from wxTextEntry
bool AutoComplete (const wxArrayString &choices)
 Call this function to enable auto-completion of the text typed in a single-line text control using the given choices.
 
bool AutoComplete (wxTextCompleter *completer)
 Enable auto-completion using the provided completer object.
 
bool AutoCompleteFileNames ()
 Call this function to enable auto-completion of the text typed in a single-line text control using all valid file system paths.
 
bool AutoCompleteDirectories ()
 Call this function to enable auto-completion of the text using the file system directories.
 
virtual bool CanCopy () const
 Returns true if the selection can be copied to the clipboard.
 
virtual bool CanCut () const
 Returns true if the selection can be cut to the clipboard.
 
virtual void ChangeValue (const wxString &value)
 Sets the new text control value.
 
virtual wxString GetRange (long from, long to) const
 Returns the string containing the text starting in the positions from and up to to in the control.
 
virtual wxString GetStringSelection () const
 Gets the text currently selected in the control.
 
virtual wxString GetValue () const
 Gets the contents of the control.
 
virtual bool IsEmpty () const
 Returns true if the control is currently empty.
 
virtual void SetInsertionPointEnd ()
 Sets the insertion point at the end of the text control.
 
virtual void SetMaxLength (unsigned long len)
 This function sets the maximum number of characters the user can enter into the control.
 
virtual bool SetHint (const wxString &hint)
 Sets a hint shown in an empty unfocused text control.
 
virtual wxString GetHint () const
 Returns the current hint string.
 
wxPoint GetMargins () const
 Returns the margins used by the control.
 
virtual void SetValue (const wxString &value)
 Sets the new text control value.
 
bool SetMargins (const wxPoint &pt)
 Attempts to set the control margins.
 
bool SetMargins (wxCoord left, wxCoord top=-1)
 Attempts to set the control margins.
 

Static Public Member Functions

static wxVersionInfo GetLibraryVersionInfo ()
 
- Static Public Member Functions inherited from wxControl
static wxString GetLabelText (const wxString &label)
 Returns the given label string without mnemonics ("&" characters).
 
static wxString RemoveMnemonics (const wxString &str)
 Returns the given str string without mnemonics ("&" characters).
 
static wxString EscapeMnemonics (const wxString &text)
 Escapes the special mnemonics characters ("&") in the given string.
 
static wxString Ellipsize (const wxString &label, const wxDC &dc, wxEllipsizeMode mode, int maxWidth, int flags=wxELLIPSIZE_FLAGS_DEFAULT)
 Replaces parts of the label string with ellipsis, if needed, so that it fits into maxWidth pixels if possible.
 
- Static Public Member Functions inherited from wxWindow
static wxVisualAttributes GetClassDefaultAttributes (wxWindowVariant variant=wxWINDOW_VARIANT_NORMAL)
 Returns the default font and colours which are used by the control.
 
static wxWindowFindFocus ()
 Finds the window or control which currently has the keyboard focus.
 
static wxWindowFindWindowById (long id, const wxWindow *parent=0)
 Find the first window with the given id.
 
static wxWindowFindWindowByLabel (const wxString &label, const wxWindow *parent=0)
 Find a window by its label.
 
static wxWindowFindWindowByName (const wxString &name, const wxWindow *parent=0)
 Find a window by its name (as given in a window constructor or Create() function call).
 
static wxWindowGetCapture ()
 Returns the currently captured window.
 
static wxWindowID NewControlId (int count=1)
 Create a new ID or range of IDs that are not currently in use.
 
static void UnreserveControlId (wxWindowID id, int count=1)
 Unreserve an ID or range of IDs that was reserved by NewControlId().
 
- Static Public Member Functions inherited from wxEvtHandler
static void AddFilter (wxEventFilter *filter)
 Add an event filter whose FilterEvent() method will be called for each and every event processed by wxWidgets.
 
static void RemoveFilter (wxEventFilter *filter)
 Remove a filter previously installed with AddFilter().
 

Additional Inherited Members

- Protected Member Functions inherited from wxWindow
virtual void DoCentre (int direction)
 Centres the window.
 
virtual wxSize DoGetBestSize () const
 Implementation of GetBestSize() that can be overridden.
 
virtual wxSize DoGetBestClientSize () const
 Override this method to return the best size for a custom control.
 
virtual int DoGetBestClientHeight (int width) const
 Override this method to implement height-for-width best size calculation.
 
virtual int DoGetBestClientWidth (int height) const
 Override this method to implement width-for-height best size calculation.
 
virtual void SetInitialBestSize (const wxSize &size)
 Sets the initial window size if none is given (i.e. at least one of the components of the size passed to ctor/Create() is wxDefaultCoord).
 
void SendDestroyEvent ()
 Generate wxWindowDestroyEvent for this window.
 
virtual bool ProcessEvent (wxEvent &event)
 This function is public in wxEvtHandler but protected in wxWindow because for wxWindows you should always call ProcessEvent() on the pointer returned by GetEventHandler() and not on the wxWindow object itself.
 
bool SafelyProcessEvent (wxEvent &event)
 See ProcessEvent() for more info about why you shouldn't use this function and the reason for making this function protected in wxWindow.
 
virtual void QueueEvent (wxEvent *event)
 See ProcessEvent() for more info about why you shouldn't use this function and the reason for making this function protected in wxWindow.
 
virtual void AddPendingEvent (const wxEvent &event)
 See ProcessEvent() for more info about why you shouldn't use this function and the reason for making this function protected in wxWindow.
 
void ProcessPendingEvents ()
 See ProcessEvent() for more info about why you shouldn't use this function and the reason for making this function protected in wxWindow.
 
bool ProcessThreadEvent (const wxEvent &event)
 See ProcessEvent() for more info about why you shouldn't use this function and the reason for making this function protected in wxWindow.
 
- Protected Attributes inherited from wxObject
wxObjectRefDatam_refData
 Pointer to an object which is the object's reference-counted data.
 

Constructor & Destructor Documentation

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

Ctor.

wxStyledTextCtrl::wxStyledTextCtrl ( )

Default ctor.

wxStyledTextCtrl::~wxStyledTextCtrl ( )

Destructor.

Member Function Documentation

void wxStyledTextCtrl::AddRefDocument ( void *  docPointer)

Extend life of document.

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

Add a selection.

void wxStyledTextCtrl::AddStyledText ( const wxMemoryBuffer data)

Add array of cells to document.

void wxStyledTextCtrl::AddText ( const wxString text)

Add text to the document at current position.

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

Add text to the document at current position.

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

Add a container action to the undo stack.

void wxStyledTextCtrl::Allocate ( int  bytes)

Enlarge the document to a particular size of text bytes.

int wxStyledTextCtrl::AllocateExtendedStyles ( int  numberStyles)

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

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

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

void wxStyledTextCtrl::AnnotationClearAll ( )

Clear the annotations from all lines.

void wxStyledTextCtrl::AnnotationClearLine ( int  line)

Clear annotations from the given line.

int wxStyledTextCtrl::AnnotationGetLines ( int  line) const

Get the number of annotation lines for a line.

int wxStyledTextCtrl::AnnotationGetStyle ( int  line) const

Get the style number for the annotations for a line.

int wxStyledTextCtrl::AnnotationGetStyleOffset ( ) const

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

wxString wxStyledTextCtrl::AnnotationGetStyles ( int  line) const

Get the annotation styles for a line.

wxString wxStyledTextCtrl::AnnotationGetText ( int  line) const

Get the annotation text for a line.

int wxStyledTextCtrl::AnnotationGetVisible ( ) const

Get the visibility for the annotations for a view.

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

Set the style number for the annotations for a line.

void wxStyledTextCtrl::AnnotationSetStyleOffset ( int  style)

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

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

Set the annotation styles for a line.

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

Set the annotation text for a line.

void wxStyledTextCtrl::AnnotationSetVisible ( int  visible)

Set the visibility for the annotations for a view.

void wxStyledTextCtrl::AppendText ( const wxString text)
virtual

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

Reimplemented from wxTextEntry.

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

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

bool wxStyledTextCtrl::AutoCompActive ( )

Is there an auto-completion list visible?

void wxStyledTextCtrl::AutoCompCancel ( )

Remove the auto-completion list from the screen.

void wxStyledTextCtrl::AutoCompComplete ( )

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

bool wxStyledTextCtrl::AutoCompGetAutoHide ( ) const

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

bool wxStyledTextCtrl::AutoCompGetCancelAtStart ( ) const

Retrieve whether auto-completion cancelled by backspacing before start.

int wxStyledTextCtrl::AutoCompGetCaseInsensitiveBehaviour ( ) const

Get auto-completion case insensitive behaviour.

bool wxStyledTextCtrl::AutoCompGetChooseSingle ( ) const

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

int wxStyledTextCtrl::AutoCompGetCurrent ( ) const

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

bool wxStyledTextCtrl::AutoCompGetDropRestOfWord ( ) const

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

bool wxStyledTextCtrl::AutoCompGetIgnoreCase ( ) const

Retrieve state of ignore case flag.

int wxStyledTextCtrl::AutoCompGetMaxHeight ( ) const

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

int wxStyledTextCtrl::AutoCompGetMaxWidth ( ) const

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

int wxStyledTextCtrl::AutoCompGetOrder ( ) const

Get the way autocompletion lists are ordered.

int wxStyledTextCtrl::AutoCompGetSeparator ( ) const

Retrieve the auto-completion list separator character.

int wxStyledTextCtrl::AutoCompGetTypeSeparator ( ) const

Retrieve the auto-completion list type-separator character.

int wxStyledTextCtrl::AutoCompPosStart ( )

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

void wxStyledTextCtrl::AutoCompSelect ( const wxString text)

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

void wxStyledTextCtrl::AutoCompSetAutoHide ( bool  autoHide)

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

void wxStyledTextCtrl::AutoCompSetCancelAtStart ( bool  cancel)

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

void wxStyledTextCtrl::AutoCompSetCaseInsensitiveBehaviour ( int  behaviour)

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

void wxStyledTextCtrl::AutoCompSetChooseSingle ( bool  chooseSingle)

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

void wxStyledTextCtrl::AutoCompSetDropRestOfWord ( bool  dropRestOfWord)

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

void wxStyledTextCtrl::AutoCompSetFillUps ( const wxString characterSet)

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

void wxStyledTextCtrl::AutoCompSetIgnoreCase ( bool  ignoreCase)

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

void wxStyledTextCtrl::AutoCompSetMaxHeight ( int  rowCount)

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

The default is 5 rows.

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

void wxStyledTextCtrl::AutoCompSetOrder ( int  order)

Set the way autocompletion lists are ordered.

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

void wxStyledTextCtrl::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 '?'.

void wxStyledTextCtrl::AutoCompShow ( int  lenEntered,
const wxString itemList 
)

Display a auto-completion list.

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

void wxStyledTextCtrl::AutoCompStops ( const wxString characterSet)

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

void wxStyledTextCtrl::BackTab ( )

Dedent the selected lines.

void wxStyledTextCtrl::BeginUndoAction ( )

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

May be nested.

void wxStyledTextCtrl::BraceBadLight ( int  pos)

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

void wxStyledTextCtrl::BraceBadLightIndicator ( bool  useBraceBadLightIndicator,
int  indicator 
)

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

void wxStyledTextCtrl::BraceHighlight ( int  pos1,
int  pos2 
)

Highlight the characters at two positions.

void wxStyledTextCtrl::BraceHighlightIndicator ( bool  useBraceHighlightIndicator,
int  indicator 
)

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

int wxStyledTextCtrl::BraceMatch ( int  pos)

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

bool wxStyledTextCtrl::CallTipActive ( )

Is there an active call tip?

void wxStyledTextCtrl::CallTipCancel ( )

Remove the call tip from the screen.

int wxStyledTextCtrl::CallTipPosAtStart ( )

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

void wxStyledTextCtrl::CallTipSetBackground ( const wxColour back)

Set the background colour for the call tip.

void wxStyledTextCtrl::CallTipSetForeground ( const wxColour fore)

Set the foreground colour for the call tip.

void wxStyledTextCtrl::CallTipSetForegroundHighlight ( const wxColour fore)

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

void wxStyledTextCtrl::CallTipSetHighlight ( int  start,
int  end 
)

Highlight a segment of the definition.

void wxStyledTextCtrl::CallTipSetPosAtStart ( int  posStart)

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

void wxStyledTextCtrl::CallTipSetPosition ( bool  above)

Set position of calltip, above or below text.

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

Show a call tip containing a definition near position pos.

void wxStyledTextCtrl::CallTipUseStyle ( int  tabSize)

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

void wxStyledTextCtrl::Cancel ( )

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

bool wxStyledTextCtrl::CanPaste ( ) const
virtual

Will a paste succeed?

Reimplemented from wxTextEntry.

bool wxStyledTextCtrl::CanRedo ( ) const
virtual

Are there any redoable actions in the undo history?

Reimplemented from wxTextEntry.

bool wxStyledTextCtrl::CanUndo ( ) const
virtual

Are there any undoable actions in the undo history?

Reimplemented from wxTextEntry.

int wxStyledTextCtrl::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.

void wxStyledTextCtrl::CharLeft ( )

Move caret left one character.

void wxStyledTextCtrl::CharLeftExtend ( )

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

void wxStyledTextCtrl::CharLeftRectExtend ( )

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

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

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

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

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

Return INVALID_POSITION if not close to text.

void wxStyledTextCtrl::CharRight ( )

Move caret right one character.

void wxStyledTextCtrl::CharRightExtend ( )

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

void wxStyledTextCtrl::CharRightRectExtend ( )

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

void wxStyledTextCtrl::ChooseCaretX ( )

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

void wxStyledTextCtrl::Clear ( )
virtual

Clear the selection.

Reimplemented from wxTextEntry.

void wxStyledTextCtrl::ClearAll ( )

Delete all text in the document.

void wxStyledTextCtrl::ClearDocumentStyle ( )

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

void wxStyledTextCtrl::ClearRegisteredImages ( )

Clear all the registered images.

void wxStyledTextCtrl::ClearRepresentation ( const wxString encodedCharacter)

Remove a character representation.

void wxStyledTextCtrl::ClearSelections ( )

Clear selections to a single empty stream selection.

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

When key+modifier combination km is pressed perform msg.

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

When key+modifier combination km is pressed do nothing.

void wxStyledTextCtrl::CmdKeyClearAll ( )

Drop all key mappings.

void wxStyledTextCtrl::CmdKeyExecute ( int  cmd)

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

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

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

int wxStyledTextCtrl::ContractedFoldNext ( int  lineStart)

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

Return -1 when no more lines.

void wxStyledTextCtrl::ConvertEOLs ( int  eolMode)

Convert all line endings in the document to one mode.

void wxStyledTextCtrl::Copy ( )
virtual

Copy the selection to the clipboard.

Reimplemented from wxTextEntry.

void wxStyledTextCtrl::CopyAllowLine ( )

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

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

Copy a range of text to the clipboard.

Positions are clipped into the document.

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

Copy argument text to the clipboard.

int wxStyledTextCtrl::CountCharacters ( int  startPos,
int  endPos 
)

Count characters between two positions.

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

Create the UI elements for a STC that was created with the default ctor.

(For 2-phase create.)

void* wxStyledTextCtrl::CreateDocument ( )

Create a new document object.

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

void* wxStyledTextCtrl::CreateLoader ( int  bytes) const

Create an ILoader*.

void wxStyledTextCtrl::Cut ( )
virtual

Cut the selection to the clipboard.

Reimplemented from wxTextEntry.

void wxStyledTextCtrl::DeleteBack ( )

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

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

void wxStyledTextCtrl::DeleteRange ( int  pos,
int  deleteLength 
)

Delete a range of text in the document.

void wxStyledTextCtrl::DelLineLeft ( )

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

void wxStyledTextCtrl::DelLineRight ( )

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

void wxStyledTextCtrl::DelWordLeft ( )

Delete the word to the left of the caret.

void wxStyledTextCtrl::DelWordRight ( )

Delete the word to the right of the caret.

void wxStyledTextCtrl::DelWordRightEnd ( )

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

wxString wxStyledTextCtrl::DescribeKeyWordSets ( ) const

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

wxString wxStyledTextCtrl::DescribeProperty ( const wxString name) const

Describe a property.

virtual void wxStyledTextCtrl::DiscardEdits ( )
virtual
int wxStyledTextCtrl::DistanceToSecondaryStyles ( ) const

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

int wxStyledTextCtrl::DocLineFromVisible ( int  lineDisplay)

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

void wxStyledTextCtrl::DocumentEnd ( )

Move caret to last position in document.

void wxStyledTextCtrl::DocumentEndExtend ( )

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

void wxStyledTextCtrl::DocumentStart ( )

Move caret to first position in document.

void wxStyledTextCtrl::DocumentStartExtend ( )

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

wxDragResult wxStyledTextCtrl::DoDragEnter ( wxCoord  x,
wxCoord  y,
wxDragResult  defaultRes 
)

Allow for simulating a DnD DragEnter.

Since
3.1.0
void wxStyledTextCtrl::DoDragLeave ( )

Allow for simulating a DnD DragLeave.

Since
3.1.0
wxDragResult wxStyledTextCtrl::DoDragOver ( wxCoord  x,
wxCoord  y,
wxDragResult  defaultRes 
)

Allow for simulating a DnD DragOver.

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

Allow for simulating a DnD DropText.

void wxStyledTextCtrl::DropSelectionN ( int  selection)

Drop one selection.

void wxStyledTextCtrl::EditToggleOvertype ( )

Switch from insert to overtype mode or the reverse.

void wxStyledTextCtrl::EmptyUndoBuffer ( )

Delete the undo history.

void wxStyledTextCtrl::EndUndoAction ( )

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

void wxStyledTextCtrl::EnsureCaretVisible ( )

Ensure the caret is visible.

void wxStyledTextCtrl::EnsureVisible ( int  line)

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

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

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

Expand a fold header and all children.

Use the level argument instead of the line's current level.

int wxStyledTextCtrl::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.

int wxStyledTextCtrl::FindText ( int  minPos,
int  maxPos,
const wxString text,
int  flags = 0 
)

Find some text in the document.

void wxStyledTextCtrl::FoldAll ( int  action)

Expand or contract all fold headers.

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

Expand or contract a fold header and its children.

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

Expand or contract a fold header.

int wxStyledTextCtrl::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.

void wxStyledTextCtrl::FormFeed ( )

Insert a Form Feed character.

void wxStyledTextCtrl::FreeSubStyles ( )

Free allocated sub styles.

wxColour wxStyledTextCtrl::GetAdditionalCaretForeground ( ) const

Get the foreground colour of additional carets.

bool wxStyledTextCtrl::GetAdditionalCaretsBlink ( ) const

Whether additional carets will blink.

bool wxStyledTextCtrl::GetAdditionalCaretsVisible ( ) const

Whether additional carets are visible.

int wxStyledTextCtrl::GetAdditionalSelAlpha ( ) const

Get the alpha of the selection.

bool wxStyledTextCtrl::GetAdditionalSelectionTyping ( ) const

Whether typing can be performed into multiple selections.

bool wxStyledTextCtrl::GetAllLinesVisible ( ) const

Are all lines visible?

int wxStyledTextCtrl::GetAnchor ( ) const

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

int wxStyledTextCtrl::GetAutomaticFold ( ) const

Get automatic folding behaviours.

bool wxStyledTextCtrl::GetBackSpaceUnIndents ( ) const

Does a backspace pressed when caret is within indentation unindent?

bool wxStyledTextCtrl::GetBufferedDraw ( ) const

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

wxColour wxStyledTextCtrl::GetCaretForeground ( ) const

Get the foreground colour of the caret.

int wxStyledTextCtrl::GetCaretLineBackAlpha ( ) const

Get the background alpha of the caret line.

wxColour wxStyledTextCtrl::GetCaretLineBackground ( ) const

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

bool wxStyledTextCtrl::GetCaretLineVisible ( ) const

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

bool wxStyledTextCtrl::GetCaretLineVisibleAlways ( ) const

Is the caret line always visible?

int wxStyledTextCtrl::GetCaretPeriod ( ) const

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

int wxStyledTextCtrl::GetCaretSticky ( ) const

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

int wxStyledTextCtrl::GetCaretStyle ( ) const

Returns the current style of the caret.

int wxStyledTextCtrl::GetCaretWidth ( ) const

Returns the width of the insert mode caret.

const char* wxStyledTextCtrl::GetCharacterPointer ( ) const

Compact the document buffer and return a read-only pointer to the characters in the document.

int wxStyledTextCtrl::GetCharAt ( int  pos) const

Returns the character byte at the position.

int wxStyledTextCtrl::GetCodePage ( ) const

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

int wxStyledTextCtrl::GetColumn ( int  pos) const

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

int wxStyledTextCtrl::GetControlCharSymbol ( ) const

Get the way control characters are displayed.

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

Retrieve the text of the line containing the caret.

Returns the index of the caret on the line.

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

Retrieve the text of the line containing the caret.

Returns the index of the caret on the line.

int wxStyledTextCtrl::GetCurrentLine ( )

Returns the line number of the line with the caret.

int wxStyledTextCtrl::GetCurrentPos ( ) const

Returns the position of the caret.

void* wxStyledTextCtrl::GetDocPointer ( )

Retrieve a pointer to the document object.

wxColour wxStyledTextCtrl::GetEdgeColour ( ) const

Retrieve the colour used in edge indication.

int wxStyledTextCtrl::GetEdgeColumn ( ) const

Retrieve the column number which text should be kept within.

int wxStyledTextCtrl::GetEdgeMode ( ) const

Retrieve the edge highlight mode.

bool wxStyledTextCtrl::GetEndAtLastLine ( ) const

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

int wxStyledTextCtrl::GetEndStyled ( ) const

Retrieve the position of the last correctly styled character.

int wxStyledTextCtrl::GetEOLMode ( ) const

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

int wxStyledTextCtrl::GetExtraAscent ( ) const

Get extra ascent for each line.

int wxStyledTextCtrl::GetExtraDescent ( ) const

Get extra descent for each line.

int wxStyledTextCtrl::GetFirstVisibleLine ( ) const

Retrieve the display line at the top of the display.

bool wxStyledTextCtrl::GetFoldExpanded ( int  line) const

Is a header line expanded?

int wxStyledTextCtrl::GetFoldLevel ( int  line) const

Retrieve the fold level of a line.

int wxStyledTextCtrl::GetFoldParent ( int  line) const

Find the parent line of a child line.

int wxStyledTextCtrl::GetGapPosition ( ) const

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

int wxStyledTextCtrl::GetHighlightGuide ( ) const

Get the highlighted indentation guide column.

wxColour wxStyledTextCtrl::GetHotspotActiveBackground ( ) const

Get the back colour for active hotspots.

wxColour wxStyledTextCtrl::GetHotspotActiveForeground ( ) const

Get the fore colour for active hotspots.

bool wxStyledTextCtrl::GetHotspotActiveUnderline ( ) const

Get whether underlining for active hotspots.

bool wxStyledTextCtrl::GetHotspotSingleLine ( ) const

Get the HotspotSingleLine property.

int wxStyledTextCtrl::GetIdentifier ( ) const

Get the identifier.

int wxStyledTextCtrl::GetIndent ( ) const

Retrieve indentation size.

int wxStyledTextCtrl::GetIndentationGuides ( ) const

Are the indentation guides visible?

int wxStyledTextCtrl::GetIndicatorCurrent ( ) const

Get the current indicator.

int wxStyledTextCtrl::GetIndicatorValue ( ) const

Get the current indicator value.

virtual long wxStyledTextCtrl::GetInsertionPoint ( ) const
virtual

Returns the insertion point, or cursor, position.

This is defined as the zero based index of the character position to the right of the insertion point. For example, if the insertion point is at the end of the single-line text control, it is equal to GetLastPosition().

Notice that insertion position is, in general, different from the index of the character the cursor position at in the string returned by GetValue(). While this is always the case for the single line controls, multi-line controls can use two characters "\\r\\n" as line separator (this is notably the case under MSW) meaning that indices in the control and its string value are offset by 1 for every line.

Hence to correctly get the character at the current cursor position, taking into account that there can be none if the cursor is at the end of the string, you could do the following:

wxString GetCurrentChar(wxTextCtrl *tc)
{
long pos = tc->GetInsertionPoint();
if ( pos == tc->GetLastPosition() )
return wxString();
return tc->GetRange(pos, pos + 1);
}

Reimplemented from wxTextEntry.

bool wxStyledTextCtrl::GetKeysUnicode ( ) const

Are keys always interpreted as Unicode?

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

Find the last child line of a header line.

bool wxStyledTextCtrl::GetLastKeydownProcessed ( )

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

virtual long wxStyledTextCtrl::GetLastPosition ( ) const
virtual

Returns the zero based index of the last position in the text control, which is equal to the number of characters in the control.

Reimplemented from wxTextEntry.

int wxStyledTextCtrl::GetLayoutCache ( ) const

Retrieve the degree of caching of layout information.

int wxStyledTextCtrl::GetLength ( ) const

Returns the number of bytes in the document.

int wxStyledTextCtrl::GetLexer ( ) const

Retrieve the lexing language of the document.

static wxVersionInfo wxStyledTextCtrl::GetLibraryVersionInfo ( )
static
wxString wxStyledTextCtrl::GetLine ( int  line) const

Retrieve the contents of a line.

int wxStyledTextCtrl::GetLineCount ( ) const

Returns the number of lines in the document.

There is always at least one.

int wxStyledTextCtrl::GetLineEndPosition ( int  line) const

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

int wxStyledTextCtrl::GetLineEndTypesActive ( ) const

Get the line end types currently recognised.

May be a subset of the allowed types due to lexer limitation.

int wxStyledTextCtrl::GetLineEndTypesAllowed ( ) const

Get the line end types currently allowed.

int wxStyledTextCtrl::GetLineEndTypesSupported ( ) const

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

int wxStyledTextCtrl::GetLineIndentation ( int  line) const

Retrieve the number of columns that a line is indented.

int wxStyledTextCtrl::GetLineIndentPosition ( int  line) const

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

virtual int wxStyledTextCtrl::GetLineLength ( long  n) const
virtual
wxCharBuffer wxStyledTextCtrl::GetLineRaw ( int  line)

Retrieve the contents of a line.

int wxStyledTextCtrl::GetLineSelEndPosition ( int  line)

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

int wxStyledTextCtrl::GetLineSelStartPosition ( int  line)

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

int wxStyledTextCtrl::GetLineState ( int  line) const

Retrieve the extra styling information for a line.

virtual wxString wxStyledTextCtrl::GetLineText ( long  n) const
virtual
bool wxStyledTextCtrl::GetLineVisible ( int  line) const

Is a line visible?

int wxStyledTextCtrl::GetMainSelection ( ) const

Which selection is the main selection.

int wxStyledTextCtrl::GetMarginCursor ( int  margin) const

Retrieve the cursor shown in a margin.

int wxStyledTextCtrl::GetMarginLeft ( ) const

Returns the size in pixels of the left margin.

int wxStyledTextCtrl::GetMarginMask ( int  margin) const

Retrieve the marker mask of a margin.

int wxStyledTextCtrl::GetMarginOptions ( ) const

Get the margin options.

int wxStyledTextCtrl::GetMarginRight ( ) const

Returns the size in pixels of the right margin.

bool wxStyledTextCtrl::GetMarginSensitive ( int  margin) const

Retrieve the mouse click sensitivity of a margin.

int wxStyledTextCtrl::GetMarginType ( int  margin) const

Retrieve the type of a margin.

int wxStyledTextCtrl::GetMarginWidth ( int  margin) const

Retrieve the width of a margin in pixels.

int wxStyledTextCtrl::GetMarkerSymbolDefined ( int  markerNumber)

Which symbol was defined for markerNumber with MarkerDefine.

int wxStyledTextCtrl::GetMaxLineState ( ) const

Retrieve the last line number that has line state.

int wxStyledTextCtrl::GetModEventMask ( ) const

Get which document modification events are sent to the container.

bool wxStyledTextCtrl::GetModify ( ) const

Is the document different from when it was last saved?

bool wxStyledTextCtrl::GetMouseDownCaptures ( ) const

Get whether mouse gets captured.

int wxStyledTextCtrl::GetMouseDwellTime ( ) const

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

bool wxStyledTextCtrl::GetMouseSelectionRectangularSwitch ( ) const

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

int wxStyledTextCtrl::GetMultiPaste ( ) const

Retrieve the effect of pasting when there are multiple selections.

bool wxStyledTextCtrl::GetMultipleSelection ( ) const

Whether multiple selections can be made.

virtual int wxStyledTextCtrl::GetNumberOfLines ( ) const
virtual
bool wxStyledTextCtrl::GetOvertype ( ) const

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

bool wxStyledTextCtrl::GetPasteConvertEndings ( ) const

Get convert-on-paste setting.

int wxStyledTextCtrl::GetPositionCacheSize ( ) const

How many entries are allocated to the position cache?

int wxStyledTextCtrl::GetPrimaryStyleFromStyle ( int  style) const

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

int wxStyledTextCtrl::GetPrintColourMode ( ) const

Returns the print colour mode.

int wxStyledTextCtrl::GetPrintMagnification ( ) const

Returns the print magnification.

int wxStyledTextCtrl::GetPrintWrapMode ( ) const

Is printing line wrapped?

wxString wxStyledTextCtrl::GetProperty ( const wxString key)

Retrieve a 'property' value previously set with SetProperty.

wxString wxStyledTextCtrl::GetPropertyExpanded ( const wxString key)

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

int wxStyledTextCtrl::GetPropertyInt ( const wxString key) const

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

wxString wxStyledTextCtrl::GetPunctuationChars ( ) const

Get the set of characters making up punctuation characters.

const char* wxStyledTextCtrl::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.

bool wxStyledTextCtrl::GetReadOnly ( ) const

In read-only mode?

int wxStyledTextCtrl::GetRectangularSelectionAnchor ( ) const
int wxStyledTextCtrl::GetRectangularSelectionAnchorVirtualSpace ( ) const
int wxStyledTextCtrl::GetRectangularSelectionCaret ( ) const
int wxStyledTextCtrl::GetRectangularSelectionCaretVirtualSpace ( ) const
int wxStyledTextCtrl::GetRectangularSelectionModifier ( ) const

Get the modifier key used for rectangular selection.

wxString wxStyledTextCtrl::GetRepresentation ( const wxString encodedCharacter) const

Get the way a character is drawn.

int wxStyledTextCtrl::GetScrollWidth ( ) const

Retrieve the document width assumed for scrolling.

bool wxStyledTextCtrl::GetScrollWidthTracking ( ) const

Retrieve whether the scroll width tracks wide lines.

int wxStyledTextCtrl::GetSearchFlags ( ) const

Get the search flags used by SearchInTarget.

int wxStyledTextCtrl::GetSelAlpha ( ) const

Get the alpha of the selection.

wxString wxStyledTextCtrl::GetSelectedText ( )

Retrieve the selected text.

wxCharBuffer wxStyledTextCtrl::GetSelectedTextRaw ( )

Retrieve the selected text.

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

Gets the current selection span.

If the returned values are equal, there was no selection. Please note that the indices returned may be used with the other wxTextCtrl methods but don't necessarily represent the correct indices into the string returned by GetValue() for multiline controls under Windows (at least,) you should use GetStringSelection() to get the selected text.

Parameters
fromThe returned first position.
toThe returned last position.

wxPerl Note: In wxPerl this method takes no parameters and returns a 2-element list (from, to).

Reimplemented from wxTextEntry.

bool wxStyledTextCtrl::GetSelectionEmpty ( ) const

Is every selected range empty?

int wxStyledTextCtrl::GetSelectionEnd ( ) const

Returns the position at the end of the selection.

int wxStyledTextCtrl::GetSelectionMode ( ) const

Get the mode of the current selection.

int wxStyledTextCtrl::GetSelectionNAnchor ( int  selection) const
int wxStyledTextCtrl::GetSelectionNAnchorVirtualSpace ( int  selection) const
int wxStyledTextCtrl::GetSelectionNCaret ( int  selection) const
int wxStyledTextCtrl::GetSelectionNCaretVirtualSpace ( int  selection) const
int wxStyledTextCtrl::GetSelectionNEnd ( int  selection) const

Returns the position at the end of the selection.

int wxStyledTextCtrl::GetSelectionNStart ( int  selection) const

Returns the position at the start of the selection.

int wxStyledTextCtrl::GetSelections ( ) const

How many selections are there?

int wxStyledTextCtrl::GetSelectionStart ( ) const

Returns the position at the start of the selection.

bool wxStyledTextCtrl::GetSelEOLFilled ( ) const

Is the selection end of line filled?

int wxStyledTextCtrl::GetStatus ( ) const

Get error status.

int wxStyledTextCtrl::GetSTCCursor ( ) const

Get cursor type.

bool wxStyledTextCtrl::GetSTCFocus ( ) const

Get internal focus flag.

virtual bool wxStyledTextCtrl::GetStyle ( long  position,
wxTextAttr style 
)
virtual
int wxStyledTextCtrl::GetStyleAt ( int  pos) const

Returns the style byte at the position.

int wxStyledTextCtrl::GetStyleBits ( ) const

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

int wxStyledTextCtrl::GetStyleBitsNeeded ( ) const

Retrieve the number of bits the current lexer needs for styling.

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

Retrieve a buffer of cells.

int wxStyledTextCtrl::GetStyleFromSubStyle ( int  subStyle) const

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

wxString wxStyledTextCtrl::GetSubStyleBases ( ) const

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

int wxStyledTextCtrl::GetSubStylesLength ( int  styleBase) const

The number of sub styles associated with a base style.

int wxStyledTextCtrl::GetSubStylesStart ( int  styleBase) const

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

bool wxStyledTextCtrl::GetTabIndents ( ) const

Does a tab pressed when caret is within indentation indent?

int wxStyledTextCtrl::GetTabWidth ( ) const

Retrieve the visible size of a tab.

wxString wxStyledTextCtrl::GetTag ( int  tagNumber) const

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

int wxStyledTextCtrl::GetTargetEnd ( ) const

Get the position that ends the target.

int wxStyledTextCtrl::GetTargetStart ( ) const

Get the position that starts the target.

int wxStyledTextCtrl::GetTechnology ( ) const

Get the tech.

wxString wxStyledTextCtrl::GetText ( ) const

Retrieve all the text in the document.

int wxStyledTextCtrl::GetTextLength ( ) const

Retrieve the number of characters in the document.

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

Retrieve a range of text.

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

Retrieve a range of text.

wxCharBuffer wxStyledTextCtrl::GetTextRaw ( )

Retrieve all the text in the document.

bool wxStyledTextCtrl::GetTwoPhaseDraw ( ) const

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

bool wxStyledTextCtrl::GetUndoCollection ( ) const

Is undo history being collected?

bool wxStyledTextCtrl::GetUseHorizontalScrollBar ( ) const

Is the horizontal scroll bar visible?

bool wxStyledTextCtrl::GetUseTabs ( ) const

Retrieve whether tabs will be used in indentation.

bool wxStyledTextCtrl::GetUseVerticalScrollBar ( ) const

Is the vertical scroll bar visible?

bool wxStyledTextCtrl::GetViewEOL ( ) const

Are the end of line characters visible?

int wxStyledTextCtrl::GetViewWhiteSpace ( ) const

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

int wxStyledTextCtrl::GetVirtualSpaceOptions ( ) const
wxString wxStyledTextCtrl::GetWhitespaceChars ( ) const

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

int wxStyledTextCtrl::GetWhitespaceSize ( ) const

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

wxString wxStyledTextCtrl::GetWordChars ( ) const

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

int wxStyledTextCtrl::GetWrapIndentMode ( ) const

Retrieve how wrapped sublines are placed.

Default is fixed.

int wxStyledTextCtrl::GetWrapMode ( ) const

Retrieve whether text is word wrapped.

int wxStyledTextCtrl::GetWrapStartIndent ( ) const

Retrive the start indent for wrapped lines.

int wxStyledTextCtrl::GetWrapVisualFlags ( ) const

Retrive the display mode of visual flags for wrapped lines.

int wxStyledTextCtrl::GetWrapVisualFlagsLocation ( ) const

Retrive the location of visual flags for wrapped lines.

int wxStyledTextCtrl::GetXOffset ( ) const
int wxStyledTextCtrl::GetZoom ( ) const

Retrieve the zoom level.

void wxStyledTextCtrl::GotoLine ( int  line)

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

void wxStyledTextCtrl::GotoPos ( int  pos)

Set caret to a position and ensure it is visible.

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

Make a range of lines invisible.

void wxStyledTextCtrl::HideSelection ( bool  normal)

Draw the selection in normal style or with selection highlighted.

virtual wxTextCtrlHitTestResult wxStyledTextCtrl::HitTest ( const wxPoint pt,
long *  pos 
) const
virtual
virtual wxTextCtrlHitTestResult wxStyledTextCtrl::HitTest ( const wxPoint pt,
wxTextCoord col,
wxTextCoord row 
) const
virtual
void wxStyledTextCtrl::Home ( )

Move caret to first position on line.

void wxStyledTextCtrl::HomeDisplay ( )

Move caret to first position on display line.

void wxStyledTextCtrl::HomeDisplayExtend ( )

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

void wxStyledTextCtrl::HomeExtend ( )

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

void wxStyledTextCtrl::HomeRectExtend ( )

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

void wxStyledTextCtrl::HomeWrap ( )

These are like their namesakes Home(Extend)?, LineEnd(Extend)?, VCHome(Extend)? except they behave differently when word-wrap is enabled: They go first to the start / end of the display line, like (Home|LineEnd)Display The difference is that, the cursor is already at the point, it goes on to the start or end of the document line, as appropriate for (Home|LineEnd|VCHome)(Extend)?.

void wxStyledTextCtrl::HomeWrapExtend ( )
int wxStyledTextCtrl::IndicatorAllOnFor ( int  position)

Are any indicators present at position?

void wxStyledTextCtrl::IndicatorClearRange ( int  position,
int  clearLength 
)

Turn a indicator off over a range.

int wxStyledTextCtrl::IndicatorEnd ( int  indicator,
int  position 
)

Where does a particular indicator end?

void wxStyledTextCtrl::IndicatorFillRange ( int  position,
int  fillLength 
)

Turn a indicator on over a range.

int wxStyledTextCtrl::IndicatorGetAlpha ( int  indicator) const

Get the alpha fill colour of the given indicator.

wxColour wxStyledTextCtrl::IndicatorGetForeground ( int  indic) const

Retrieve the foreground colour of an indicator.

int wxStyledTextCtrl::IndicatorGetOutlineAlpha ( int  indicator) const

Get the alpha outline colour of the given indicator.

int wxStyledTextCtrl::IndicatorGetStyle ( int  indic) const

Retrieve the style of an indicator.

bool wxStyledTextCtrl::IndicatorGetUnder ( int  indic) const

Retrieve whether indicator drawn under or over text.

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

Set the alpha fill colour of the given indicator.

void wxStyledTextCtrl::IndicatorSetForeground ( int  indic,
const wxColour fore 
)

Set the foreground colour of an indicator.

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

Set the alpha outline colour of the given indicator.

void wxStyledTextCtrl::IndicatorSetStyle ( int  indic,
int  style 
)

Set an indicator to plain, squiggle or TT.

void wxStyledTextCtrl::IndicatorSetUnder ( int  indic,
bool  under 
)

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

int wxStyledTextCtrl::IndicatorStart ( int  indicator,
int  position 
)

Where does a particular indicator start?

int wxStyledTextCtrl::IndicatorValueAt ( int  indicator,
int  position 
)

What value does a particular indicator have at at a position?

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

Insert string at a position.

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

Insert string at a position.

virtual bool wxStyledTextCtrl::IsEditable ( ) const
virtual

Returns true if the controls contents may be edited by user (note that it always can be changed by the program).

In other words, this functions returns true if the control hasn't been put in read-only mode by a previous call to SetEditable().

Reimplemented from wxTextEntry.

virtual bool wxStyledTextCtrl::IsModified ( ) const
virtual
void wxStyledTextCtrl::LineCopy ( )

Copy the line containing the caret.

void wxStyledTextCtrl::LineCut ( )

Cut the line containing the caret.

void wxStyledTextCtrl::LineDelete ( )

Delete the line containing the caret.

void wxStyledTextCtrl::LineDown ( )

Move caret down one line.

void wxStyledTextCtrl::LineDownExtend ( )

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

void wxStyledTextCtrl::LineDownRectExtend ( )

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

void wxStyledTextCtrl::LineDuplicate ( )

Duplicate the current line.

void wxStyledTextCtrl::LineEnd ( )

Move caret to last position on line.

void wxStyledTextCtrl::LineEndDisplay ( )

Move caret to last position on display line.

void wxStyledTextCtrl::LineEndDisplayExtend ( )

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

void wxStyledTextCtrl::LineEndExtend ( )

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

void wxStyledTextCtrl::LineEndRectExtend ( )

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

void wxStyledTextCtrl::LineEndWrap ( )
void wxStyledTextCtrl::LineEndWrapExtend ( )
int wxStyledTextCtrl::LineFromPosition ( int  pos) const

Retrieve the line containing a position.

int wxStyledTextCtrl::LineLength ( int  line) const

How many characters are on a line, including end of line characters?

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

Scroll horizontally and vertically.

void wxStyledTextCtrl::LineScrollDown ( )

Scroll the document down, keeping the caret visible.

void wxStyledTextCtrl::LineScrollUp ( )

Scroll the document up, keeping the caret visible.

void wxStyledTextCtrl::LinesJoin ( )

Join the lines in the target.

int wxStyledTextCtrl::LinesOnScreen ( ) const

Retrieves the number of lines completely visible.

void wxStyledTextCtrl::LinesSplit ( int  pixelWidth)

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

void wxStyledTextCtrl::LineTranspose ( )

Switch the current line with the previous.

void wxStyledTextCtrl::LineUp ( )

Move caret up one line.

void wxStyledTextCtrl::LineUpExtend ( )

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

void wxStyledTextCtrl::LineUpRectExtend ( )

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

bool wxStyledTextCtrl::LoadFile ( const wxString filename)

Load the contents of filename into the editor.

void wxStyledTextCtrl::LowerCase ( )

Transform the selection to lower case.

int wxStyledTextCtrl::MarginGetStyle ( int  line) const

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

int wxStyledTextCtrl::MarginGetStyleOffset ( ) const

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

wxString wxStyledTextCtrl::MarginGetStyles ( int  line) const

Get the styles in the text margin for a line.

wxString wxStyledTextCtrl::MarginGetText ( int  line) const

Get the text in the text margin for a line.

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

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

void wxStyledTextCtrl::MarginSetStyleOffset ( int  style)

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

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

Set the style in the text margin for a line.

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

Set the text in the text margin for a line.

void wxStyledTextCtrl::MarginTextClearAll ( )

Clear the margin text on all lines.

virtual void wxStyledTextCtrl::MarkDirty ( )
virtual
int wxStyledTextCtrl::MarkerAdd ( int  line,
int  markerNumber 
)

Add a marker to a line, returning an ID which can be used to find or delete the marker.

void wxStyledTextCtrl::MarkerAddSet ( int  line,
int  set 
)

Add a set of markers to a line.

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

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

Define a marker from a bitmap.

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

Define a marker from RGBA data.

It has the width and height from RGBAImageSetWidth/Height

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

Delete a marker from a line.

void wxStyledTextCtrl::MarkerDeleteAll ( int  markerNumber)

Delete all markers with a particular number from all lines.

void wxStyledTextCtrl::MarkerDeleteHandle ( int  handle)

Delete a marker.

void wxStyledTextCtrl::MarkerEnableHighlight ( bool  enabled)

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

int wxStyledTextCtrl::MarkerGet ( int  line)

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

int wxStyledTextCtrl::MarkerLineFromHandle ( int  handle)

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

int wxStyledTextCtrl::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.

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

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

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

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

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

Set the background colour used for a particular marker number.

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

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

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

Set the foreground colour used for a particular marker number.

void wxStyledTextCtrl::MoveCaretInsideView ( )

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

void wxStyledTextCtrl::MoveSelectedLinesDown ( )

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

void wxStyledTextCtrl::MoveSelectedLinesUp ( )

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

void wxStyledTextCtrl::NewLine ( )

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

void wxStyledTextCtrl::PageDown ( )

Move caret one page down.

void wxStyledTextCtrl::PageDownExtend ( )

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

void wxStyledTextCtrl::PageDownRectExtend ( )

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

void wxStyledTextCtrl::PageUp ( )

Move caret one page up.

void wxStyledTextCtrl::PageUpExtend ( )

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

void wxStyledTextCtrl::PageUpRectExtend ( )

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

void wxStyledTextCtrl::ParaDown ( )

Move caret between paragraphs (delimited by empty lines).

void wxStyledTextCtrl::ParaDownExtend ( )
void wxStyledTextCtrl::ParaUp ( )
void wxStyledTextCtrl::ParaUpExtend ( )
void wxStyledTextCtrl::Paste ( )
virtual

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

Reimplemented from wxTextEntry.

wxPoint wxStyledTextCtrl::PointFromPosition ( int  pos)

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

int wxStyledTextCtrl::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.

int wxStyledTextCtrl::PositionBefore ( int  pos)

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

Returns 0 if passed 0.

int wxStyledTextCtrl::PositionFromLine ( int  line) const

Retrieve the position at the start of a line.

int wxStyledTextCtrl::PositionFromPoint ( wxPoint  pt) const

Find the position from a point within the window.

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

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

int wxStyledTextCtrl::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.

virtual bool wxStyledTextCtrl::PositionToXY ( long  pos,
long *  x,
long *  y 
) const
virtual
void* wxStyledTextCtrl::PrivateLexerCall ( int  operation,
void *  pointer 
)

For private communication between an application and a known lexer.

wxString wxStyledTextCtrl::PropertyNames ( ) const

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

int wxStyledTextCtrl::PropertyType ( const wxString name)

Retrieve the type of a property.

void wxStyledTextCtrl::Redo ( )
virtual

Redoes the next action on the undo history.

Reimplemented from wxTextEntry.

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

Register an image for use in autocompletion lists.

void wxStyledTextCtrl::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

void wxStyledTextCtrl::ReleaseAllExtendedStyles ( )

Release all extended (>255) style numbers.

void wxStyledTextCtrl::ReleaseDocument ( void *  docPointer)

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

virtual void wxStyledTextCtrl::Remove ( long  from,
long  to 
)
virtual

Removes the text starting at the first given position up to (but not including) the character at the last position.

This function puts the current insertion point position at to as a side effect.

Parameters
fromThe first position.
toThe last position.

Reimplemented from wxTextEntry.

virtual void wxStyledTextCtrl::Replace ( long  from,
long  to,
const wxString value 
)
virtual

Replaces the text starting at the first position up to (but not including) the character at the last position with the given text.

This function puts the current insertion point position at to as a side effect.

Parameters
fromThe first position.
toThe last position.
valueThe value to replace the existing text with.

Reimplemented from wxTextEntry.

void wxStyledTextCtrl::ReplaceSelection ( const wxString text)

Replace the selected text with the argument text.

int wxStyledTextCtrl::ReplaceTarget ( const wxString text)

Replace the target text with the argument text.

Text is counted so it can contain NULs. Returns the length of the replacement text.

int wxStyledTextCtrl::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.

void wxStyledTextCtrl::RGBAImageSetHeight ( int  height)

Set the height for future RGBA image data.

void wxStyledTextCtrl::RGBAImageSetScale ( int  scalePercent)

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

void wxStyledTextCtrl::RGBAImageSetWidth ( int  width)

Set the width for future RGBA image data.

void wxStyledTextCtrl::RotateSelection ( )

Set the main selection to the next selection.

bool wxStyledTextCtrl::SaveFile ( const wxString filename)

Write the contents of the editor to filename.

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

void wxStyledTextCtrl::ScrollToColumn ( int  column)

Scroll enough to make the given column visible.

void wxStyledTextCtrl::ScrollToEnd ( )

Scroll to end of document.

void wxStyledTextCtrl::ScrollToLine ( int  line)

Scroll enough to make the given line visible.

void wxStyledTextCtrl::ScrollToStart ( )

Scroll to start of document.

void wxStyledTextCtrl::SearchAnchor ( )

Sets the current caret position to be the search anchor.

int wxStyledTextCtrl::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.

int wxStyledTextCtrl::SearchNext ( int  flags,
const wxString text 
)

Find some text starting at the search anchor.

Does not ensure the selection is visible.

int wxStyledTextCtrl::SearchPrev ( int  flags,
const wxString text 
)

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

Does not ensure the selection is visible.

void wxStyledTextCtrl::SelectAll ( )
virtual

Select all the text in the document.

Reimplemented from wxTextEntry.

void wxStyledTextCtrl::SelectionDuplicate ( )

Duplicate the selection.

If selection empty duplicate the line containing the caret.

bool wxStyledTextCtrl::SelectionIsRectangle ( ) const

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

virtual void wxStyledTextCtrl::SelectNone ( )
virtual

Deselects selected text in the control.

Since
2.9.5

Reimplemented from wxTextEntry.

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

Send a message to Scintilla.

void wxStyledTextCtrl::SetAdditionalCaretForeground ( const wxColour fore)

Set the foreground colour of additional carets.

void wxStyledTextCtrl::SetAdditionalCaretsBlink ( bool  additionalCaretsBlink)

Set whether additional carets will blink.

void wxStyledTextCtrl::SetAdditionalCaretsVisible ( bool  additionalCaretsBlink)

Set whether additional carets are visible.

void wxStyledTextCtrl::SetAdditionalSelAlpha ( int  alpha)

Set the alpha of the selection.

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

void wxStyledTextCtrl::SetAdditionalSelectionTyping ( bool  additionalSelectionTyping)

Set whether typing can be performed into multiple selections.

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

void wxStyledTextCtrl::SetAnchor ( int  posAnchor)

Set the selection anchor to a position.

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

void wxStyledTextCtrl::SetAutomaticFold ( int  automaticFold)

Set automatic folding behaviours.

void wxStyledTextCtrl::SetBackSpaceUnIndents ( bool  bsUnIndents)

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

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