no changes, just come cleanup and more comments

[wxWidgets.git] / docs / latex / wx / styledtextctrl.tex

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Name:        styledtextctrl.tex
%% Purpose:     wxStyledTextCtrl documentation
%% Author:      Francesco Montorsi
%% Created:     2007-08-07
%% RCS-ID:      $Id$
%% Copyright:   (c) 2006 Francesco Montorsi
%% License:     wxWindows license
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\section{\class{wxStyledTextCtrl}}\label{wxstyledtextctrl}

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 \urlref{Scintilla website}{http://www.scintilla.org/}.

\wxheading{Derived from}

\helpref{wxControl}{wxcontrol}

\wxheading{Include files}

<wx/stc/stc.h>

\wxheading{See also}

\helpref{wxStyledTextEvent}{wxstyledtextevent}

\wxheading{Event handling}

To process input from a wxStyledTextCtrl, use these event handler macros to direct input to member
functions that take a \helpref{wxStyledTextEvent}{wxstyledtextevent} argument.

\twocolwidtha{7cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf EVT\_STC\_CHANGE(id, fn)}}{TOWRITE}
\twocolitem{{\bf EVT\_STC\_STYLENEEDED(id, fn)}}{TOWRITE}
\twocolitem{{\bf EVT\_STC\_CHARADDED(id, fn)}}{TOWRITE}
\twocolitem{{\bf EVT\_STC\_SAVEPOINTREACHED(id, fn)}}{TOWRITE}
\twocolitem{{\bf EVT\_STC\_SAVEPOINTLEFT(id, fn)}}{TOWRITE}
\twocolitem{{\bf EVT\_STC\_ROMODIFYATTEMPT(id, fn)}}{TOWRITE}
\twocolitem{{\bf EVT\_STC\_KEY(id, fn)}}{TOWRITE}
\twocolitem{{\bf EVT\_STC\_DOUBLECLICK(id, fn)}}{TOWRITE}
\twocolitem{{\bf EVT\_STC\_UPDATEUI(id, fn)}}{TOWRITE}
\twocolitem{{\bf EVT\_STC\_MODIFIED(id, fn)}}{TOWRITE}
\twocolitem{{\bf EVT\_STC\_MACRORECORD(id, fn)}}{TOWRITE}
\twocolitem{{\bf EVT\_STC\_MARGINCLICK(id, fn)}}{TOWRITE}
\twocolitem{{\bf EVT\_STC\_NEEDSHOWN(id, fn)}}{TOWRITE}
\twocolitem{{\bf EVT\_STC\_PAINTED(id, fn)}}{TOWRITE}
\twocolitem{{\bf EVT\_STC\_USERLISTSELECTION(id, fn)}}{TOWRITE}
\twocolitem{{\bf EVT\_STC\_URIDROPPED(id, fn)}}{TOWRITE}
\twocolitem{{\bf EVT\_STC\_DWELLSTART(id, fn)}}{TOWRITE}
\twocolitem{{\bf EVT\_STC\_DWELLEND(id, fn)}}{TOWRITE}
\twocolitem{{\bf EVT\_STC\_START\_DRAG(id, fn)}}{TOWRITE}
\twocolitem{{\bf EVT\_STC\_DRAG\_OVER(id, fn)}}{TOWRITE}
\twocolitem{{\bf EVT\_STC\_DO\_DROP(id, fn)}}{TOWRITE}
\twocolitem{{\bf EVT\_STC\_ZOOM(id, fn)}}{TOWRITE}
\twocolitem{{\bf EVT\_STC\_HOTSPOT\_CLICK(id, fn)}}{TOWRITE}
\twocolitem{{\bf EVT\_STC\_HOTSPOT\_DCLICK(id, fn)}}{TOWRITE}
\twocolitem{{\bf EVT\_STC\_CALLTIP\_CLICK(id, fn)}}{TOWRITE}
\twocolitem{{\bf EVT\_STC\_AUTOCOMP\_SELECTION(id, fn)}}{TOWRITE}
\end{twocollist}


\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxStyledTextCtrl::wxStyledTextCtrl}\label{wxstyledtextctrlwxstyledtextctrl}

\func{}{wxStyledTextCtrl::wxStyledTextCtrl}{\param{wxWindow *}{parent}, \param{wxWindowID}{id = wxID\_ANY}, \param{const wxPoint&}{pos = wxDefaultPosition}, \param{const wxSize&}{size = wxDefaultSize}, \param{long}{style = 0}, \param{const wxString&}{name = "stcwindow"}}

Ctor.

\membersection{wxStyledTextCtrl::AddRefDocument}\label{wxstyledtextctrladdrefdocument}

\func{void}{AddRefDocument}{\param{void* }{docPointer}}

Extend life of document.


\membersection{wxStyledTextCtrl::AddStyledText}\label{wxstyledtextctrladdstyledtext}

\func{void}{AddStyledText}{\param{const wxMemoryBuffer\& }{data}}

Add array of cells to document.


\membersection{wxStyledTextCtrl::AddText}\label{wxstyledtextctrladdtext}

\func{void}{AddText}{\param{const wxString\& }{text}}


BEGIN generated section.  The following code is automatically generated
by gen\_iface.py.  Do not edit this file.  Edit stc.h.in instead
and regenerate
Add text to the document at current position.


\membersection{wxStyledTextCtrl::AddTextRaw}\label{wxstyledtextctrladdtextraw}

\func{void}{AddTextRaw}{\param{const char* }{text}}

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


\membersection{wxStyledTextCtrl::Allocate}\label{wxstyledtextctrlallocate}

\func{void}{Allocate}{\param{int }{bytes}}

Enlarge the document to a particular size of text bytes.


\membersection{wxStyledTextCtrl::AppendText}\label{wxstyledtextctrlappendtext}

\func{void}{AppendText}{\param{const wxString\& }{text}}

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


\membersection{wxStyledTextCtrl::AppendTextRaw}\label{wxstyledtextctrlappendtextraw}

\func{void}{AppendTextRaw}{\param{const char* }{text}}

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


\membersection{wxStyledTextCtrl::AutoCompActive}\label{wxstyledtextctrlautocompactive}

\func{bool}{AutoCompActive}{\void}

Is there an auto-completion list visible?


\membersection{wxStyledTextCtrl::AutoCompCancel}\label{wxstyledtextctrlautocompcancel}

\func{void}{AutoCompCancel}{\void}

Remove the auto-completion list from the screen.


\membersection{wxStyledTextCtrl::AutoCompComplete}\label{wxstyledtextctrlautocompcomplete}

\func{void}{AutoCompComplete}{\void}

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


\membersection{wxStyledTextCtrl::AutoCompGetAutoHide}\label{wxstyledtextctrlautocompgetautohide}

\func{bool}{AutoCompGetAutoHide}{\void}

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


\membersection{wxStyledTextCtrl::AutoCompGetCancelAtStart}\label{wxstyledtextctrlautocompgetcancelatstart}

\func{bool}{AutoCompGetCancelAtStart}{\void}

Retrieve whether auto-completion cancelled by backspacing before start.


\membersection{wxStyledTextCtrl::AutoCompGetChooseSingle}\label{wxstyledtextctrlautocompgetchoosesingle}

\func{bool}{AutoCompGetChooseSingle}{\void}

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


\membersection{wxStyledTextCtrl::AutoCompGetCurrent}\label{wxstyledtextctrlautocompgetcurrent}

\func{int}{AutoCompGetCurrent}{\void}

Get currently selected item position in the auto-completion list


\membersection{wxStyledTextCtrl::AutoCompGetDropRestOfWord}\label{wxstyledtextctrlautocompgetdroprestofword}

\func{bool}{AutoCompGetDropRestOfWord}{\void}

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


\membersection{wxStyledTextCtrl::AutoCompGetIgnoreCase}\label{wxstyledtextctrlautocompgetignorecase}

\func{bool}{AutoCompGetIgnoreCase}{\void}

Retrieve state of ignore case flag.


\membersection{wxStyledTextCtrl::AutoCompGetMaxHeight}\label{wxstyledtextctrlautocompgetmaxheight}

\func{int}{AutoCompGetMaxHeight}{\void}

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


\membersection{wxStyledTextCtrl::AutoCompGetMaxWidth}\label{wxstyledtextctrlautocompgetmaxwidth}

\func{int}{AutoCompGetMaxWidth}{\void}

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


\membersection{wxStyledTextCtrl::AutoCompGetSeparator}\label{wxstyledtextctrlautocompgetseparator}

\func{int}{AutoCompGetSeparator}{\void}

Retrieve the auto-completion list separator character.


\membersection{wxStyledTextCtrl::AutoCompGetTypeSeparator}\label{wxstyledtextctrlautocompgettypeseparator}

\func{int}{AutoCompGetTypeSeparator}{\void}

Retrieve the auto-completion list type-separator character.


\membersection{wxStyledTextCtrl::AutoCompPosStart}\label{wxstyledtextctrlautocompposstart}

\func{int}{AutoCompPosStart}{\void}

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


\membersection{wxStyledTextCtrl::AutoCompSelect}\label{wxstyledtextctrlautocompselect}

\func{void}{AutoCompSelect}{\param{const wxString\& }{text}}

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


\membersection{wxStyledTextCtrl::AutoCompSetAutoHide}\label{wxstyledtextctrlautocompsetautohide}

\func{void}{AutoCompSetAutoHide}{\param{bool }{autoHide}}

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


\membersection{wxStyledTextCtrl::AutoCompSetCancelAtStart}\label{wxstyledtextctrlautocompsetcancelatstart}

\func{void}{AutoCompSetCancelAtStart}{\param{bool }{cancel}}

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


\membersection{wxStyledTextCtrl::AutoCompSetChooseSingle}\label{wxstyledtextctrlautocompsetchoosesingle}

\func{void}{AutoCompSetChooseSingle}{\param{bool }{chooseSingle}}

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


\membersection{wxStyledTextCtrl::AutoCompSetDropRestOfWord}\label{wxstyledtextctrlautocompsetdroprestofword}

\func{void}{AutoCompSetDropRestOfWord}{\param{bool }{dropRestOfWord}}

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


\membersection{wxStyledTextCtrl::AutoCompSetFillUps}\label{wxstyledtextctrlautocompsetfillups}

\func{void}{AutoCompSetFillUps}{\param{const wxString\& }{characterSet}}

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


\membersection{wxStyledTextCtrl::AutoCompSetIgnoreCase}\label{wxstyledtextctrlautocompsetignorecase}

\func{void}{AutoCompSetIgnoreCase}{\param{bool }{ignoreCase}}

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


\membersection{wxStyledTextCtrl::AutoCompSetMaxHeight}\label{wxstyledtextctrlautocompsetmaxheight}

\func{void}{AutoCompSetMaxHeight}{\param{int }{rowCount}}

Set the maximum height, in rows, of auto-completion and user lists.
The default is 5 rows.


\membersection{wxStyledTextCtrl::AutoCompSetMaxWidth}\label{wxstyledtextctrlautocompsetmaxwidth}

\func{void}{AutoCompSetMaxWidth}{\param{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.


\membersection{wxStyledTextCtrl::AutoCompSetSeparator}\label{wxstyledtextctrlautocompsetseparator}

\func{void}{AutoCompSetSeparator}{\param{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.


\membersection{wxStyledTextCtrl::AutoCompSetTypeSeparator}\label{wxstyledtextctrlautocompsettypeseparator}

\func{void}{AutoCompSetTypeSeparator}{\param{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 '?'.


\membersection{wxStyledTextCtrl::AutoCompShow}\label{wxstyledtextctrlautocompshow}

\func{void}{AutoCompShow}{\param{int }{lenEntered}, \param{const wxString\& }{itemList}}

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


\membersection{wxStyledTextCtrl::AutoCompStops}\label{wxstyledtextctrlautocompstops}

\func{void}{AutoCompStops}{\param{const wxString\& }{characterSet}}

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


\membersection{wxStyledTextCtrl::BackTab}\label{wxstyledtextctrlbacktab}

\func{void}{BackTab}{\void}

Dedent the selected lines.


\membersection{wxStyledTextCtrl::BeginUndoAction}\label{wxstyledtextctrlbeginundoaction}

\func{void}{BeginUndoAction}{\void}

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


\membersection{wxStyledTextCtrl::BraceBadLight}\label{wxstyledtextctrlbracebadlight}

\func{void}{BraceBadLight}{\param{int }{pos}}

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


\membersection{wxStyledTextCtrl::BraceHighlight}\label{wxstyledtextctrlbracehighlight}

\func{void}{BraceHighlight}{\param{int }{pos1}, \param{int }{pos2}}

Highlight the characters at two positions.


\membersection{wxStyledTextCtrl::BraceMatch}\label{wxstyledtextctrlbracematch}

\func{int}{BraceMatch}{\param{int }{pos}}

Find the position of a matching brace or INVALID\_POSITION if no match.


\membersection{wxStyledTextCtrl::CallTipActive}\label{wxstyledtextctrlcalltipactive}

\func{bool}{CallTipActive}{\void}

Is there an active call tip?


\membersection{wxStyledTextCtrl::CallTipCancel}\label{wxstyledtextctrlcalltipcancel}

\func{void}{CallTipCancel}{\void}

Remove the call tip from the screen.


\membersection{wxStyledTextCtrl::CallTipPosAtStart}\label{wxstyledtextctrlcalltipposatstart}

\func{int}{CallTipPosAtStart}{\void}

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


\membersection{wxStyledTextCtrl::CallTipSetBackground}\label{wxstyledtextctrlcalltipsetbackground}

\func{void}{CallTipSetBackground}{\param{const wxColour\& }{back}}

Set the background colour for the call tip.


\membersection{wxStyledTextCtrl::CallTipSetForeground}\label{wxstyledtextctrlcalltipsetforeground}

\func{void}{CallTipSetForeground}{\param{const wxColour\& }{fore}}

Set the foreground colour for the call tip.


\membersection{wxStyledTextCtrl::CallTipSetForegroundHighlight}\label{wxstyledtextctrlcalltipsetforegroundhighlight}

\func{void}{CallTipSetForegroundHighlight}{\param{const wxColour\& }{fore}}

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


\membersection{wxStyledTextCtrl::CallTipSetHighlight}\label{wxstyledtextctrlcalltipsethighlight}

\func{void}{CallTipSetHighlight}{\param{int }{start}, \param{int }{end}}

Highlight a segment of the definition.


\membersection{wxStyledTextCtrl::CallTipShow}\label{wxstyledtextctrlcalltipshow}

\func{void}{CallTipShow}{\param{int }{pos}, \param{const wxString\& }{definition}}

Show a call tip containing a definition near position pos.


\membersection{wxStyledTextCtrl::CallTipUseStyle}\label{wxstyledtextctrlcalltipusestyle}

\func{void}{CallTipUseStyle}{\param{int }{tabSize}}

Enable use of STYLE\_CALLTIP and set call tip tab size in pixels.


\membersection{wxStyledTextCtrl::CanPaste}\label{wxstyledtextctrlcanpaste}

\func{bool}{CanPaste}{\void}

Will a paste succeed?


\membersection{wxStyledTextCtrl::CanRedo}\label{wxstyledtextctrlcanredo}

\func{bool}{CanRedo}{\void}

Are there any redoable actions in the undo history?


\membersection{wxStyledTextCtrl::CanUndo}\label{wxstyledtextctrlcanundo}

\func{bool}{CanUndo}{\void}

Are there any undoable actions in the undo history?


\membersection{wxStyledTextCtrl::Cancel}\label{wxstyledtextctrlcancel}

\func{void}{Cancel}{\void}

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


\membersection{wxStyledTextCtrl::CharLeft}\label{wxstyledtextctrlcharleft}

\func{void}{CharLeft}{\void}

Move caret left one character.


\membersection{wxStyledTextCtrl::CharLeftExtend}\label{wxstyledtextctrlcharleftextend}

\func{void}{CharLeftExtend}{\void}

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


\membersection{wxStyledTextCtrl::CharLeftRectExtend}\label{wxstyledtextctrlcharleftrectextend}

\func{void}{CharLeftRectExtend}{\void}

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


\membersection{wxStyledTextCtrl::CharRight}\label{wxstyledtextctrlcharright}

\func{void}{CharRight}{\void}

Move caret right one character.


\membersection{wxStyledTextCtrl::CharRightExtend}\label{wxstyledtextctrlcharrightextend}

\func{void}{CharRightExtend}{\void}

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


\membersection{wxStyledTextCtrl::CharRightRectExtend}\label{wxstyledtextctrlcharrightrectextend}

\func{void}{CharRightRectExtend}{\void}

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


\membersection{wxStyledTextCtrl::ChooseCaretX}\label{wxstyledtextctrlchoosecaretx}

\func{void}{ChooseCaretX}{\void}

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


\membersection{wxStyledTextCtrl::Clear}\label{wxstyledtextctrlclear}

\func{void}{Clear}{\void}

Clear the selection.


\membersection{wxStyledTextCtrl::ClearAll}\label{wxstyledtextctrlclearall}

\func{void}{ClearAll}{\void}

Delete all text in the document.


\membersection{wxStyledTextCtrl::ClearDocumentStyle}\label{wxstyledtextctrlcleardocumentstyle}

\func{void}{ClearDocumentStyle}{\void}

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


\membersection{wxStyledTextCtrl::ClearRegisteredImages}\label{wxstyledtextctrlclearregisteredimages}

\func{void}{ClearRegisteredImages}{\void}

Clear all the registered images.


\membersection{wxStyledTextCtrl::CmdKeyAssign}\label{wxstyledtextctrlcmdkeyassign}

\func{void}{CmdKeyAssign}{\param{int }{key}, \param{int }{modifiers}, \param{int }{cmd}}

When key+modifier combination km is pressed perform msg.


\membersection{wxStyledTextCtrl::CmdKeyClear}\label{wxstyledtextctrlcmdkeyclear}

\func{void}{CmdKeyClear}{\param{int }{key}, \param{int }{modifiers}}

When key+modifier combination km is pressed do nothing.


\membersection{wxStyledTextCtrl::CmdKeyClearAll}\label{wxstyledtextctrlcmdkeyclearall}

\func{void}{CmdKeyClearAll}{\void}

Drop all key mappings.


\membersection{wxStyledTextCtrl::CmdKeyExecute}\label{wxstyledtextctrlcmdkeyexecute}

\func{void}{CmdKeyExecute}{\param{int }{cmd}}

Perform one of the operations defined by the wxSTC\_CMD\_* constants.


\membersection{wxStyledTextCtrl::Colourise}\label{wxstyledtextctrlcolourise}

\func{void}{Colourise}{\param{int }{start}, \param{int }{end}}

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


\membersection{wxStyledTextCtrl::ConvertEOLs}\label{wxstyledtextctrlconverteols}

\func{void}{ConvertEOLs}{\param{int }{eolMode}}

Convert all line endings in the document to one mode.


\membersection{wxStyledTextCtrl::Copy}\label{wxstyledtextctrlcopy}

\func{void}{Copy}{\void}

Copy the selection to the clipboard.


\membersection{wxStyledTextCtrl::CopyRange}\label{wxstyledtextctrlcopyrange}

\func{void}{CopyRange}{\param{int }{start}, \param{int }{end}}

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


\membersection{wxStyledTextCtrl::CopyText}\label{wxstyledtextctrlcopytext}

\func{void}{CopyText}{\param{int }{length}, \param{const wxString\& }{text}}

Copy argument text to the clipboard.


\membersection{wxStyledTextCtrl::Create}\label{wxstyledtextctrlcreate}

\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id = wxID\_ANY}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = 0}, \param{const wxString\& }{name = wxSTCNameStr}}


\membersection{wxStyledTextCtrl::CreateDocument}\label{wxstyledtextctrlcreatedocument}

\func{void*}{CreateDocument}{\void}

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


\membersection{wxStyledTextCtrl::Cut}\label{wxstyledtextctrlcut}

\func{void}{Cut}{\void}

Cut the selection to the clipboard.


\membersection{wxStyledTextCtrl::DelLineLeft}\label{wxstyledtextctrldellineleft}

\func{void}{DelLineLeft}{\void}

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


\membersection{wxStyledTextCtrl::DelLineRight}\label{wxstyledtextctrldellineright}

\func{void}{DelLineRight}{\void}

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


\membersection{wxStyledTextCtrl::DelWordLeft}\label{wxstyledtextctrldelwordleft}

\func{void}{DelWordLeft}{\void}

Delete the word to the left of the caret.


\membersection{wxStyledTextCtrl::DelWordRight}\label{wxstyledtextctrldelwordright}

\func{void}{DelWordRight}{\void}

Delete the word to the right of the caret.


\membersection{wxStyledTextCtrl::DeleteBack}\label{wxstyledtextctrldeleteback}

\func{void}{DeleteBack}{\void}

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


\membersection{wxStyledTextCtrl::DeleteBackNotLine}\label{wxstyledtextctrldeletebacknotline}

\func{void}{DeleteBackNotLine}{\void}

Delete the selection or if no selection, the character before the caret.
Will not delete the character before at the start of a line.


\membersection{wxStyledTextCtrl::DoDragOver}\label{wxstyledtextctrldodragover}

\func{wxDragResult}{DoDragOver}{\param{wxCoord }{x}, \param{wxCoord }{y}, \param{wxDragResult }{def}}

Allow for simulating a DnD DragOver


\membersection{wxStyledTextCtrl::DoDropText}\label{wxstyledtextctrldodroptext}

\func{bool}{DoDropText}{\param{long }{x}, \param{long }{y}, \param{const wxString\& }{data}}

Allow for simulating a DnD DropText


\membersection{wxStyledTextCtrl::DocLineFromVisible}\label{wxstyledtextctrldoclinefromvisible}

\func{int}{DocLineFromVisible}{\param{int }{lineDisplay}}

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


\membersection{wxStyledTextCtrl::DocumentEnd}\label{wxstyledtextctrldocumentend}

\func{void}{DocumentEnd}{\void}

Move caret to last position in document.


\membersection{wxStyledTextCtrl::DocumentEndExtend}\label{wxstyledtextctrldocumentendextend}

\func{void}{DocumentEndExtend}{\void}

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


\membersection{wxStyledTextCtrl::DocumentStart}\label{wxstyledtextctrldocumentstart}

\func{void}{DocumentStart}{\void}

Move caret to first position in document.


\membersection{wxStyledTextCtrl::DocumentStartExtend}\label{wxstyledtextctrldocumentstartextend}

\func{void}{DocumentStartExtend}{\void}

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


\membersection{wxStyledTextCtrl::EditToggleOvertype}\label{wxstyledtextctrledittoggleovertype}

\func{void}{EditToggleOvertype}{\void}

Switch from insert to overtype mode or the reverse.


\membersection{wxStyledTextCtrl::EmptyUndoBuffer}\label{wxstyledtextctrlemptyundobuffer}

\func{void}{EmptyUndoBuffer}{\void}

Delete the undo history.


\membersection{wxStyledTextCtrl::EndUndoAction}\label{wxstyledtextctrlendundoaction}

\func{void}{EndUndoAction}{\void}

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


\membersection{wxStyledTextCtrl::EnsureCaretVisible}\label{wxstyledtextctrlensurecaretvisible}

\func{void}{EnsureCaretVisible}{\void}

Ensure the caret is visible.


\membersection{wxStyledTextCtrl::EnsureVisible}\label{wxstyledtextctrlensurevisible}

\func{void}{EnsureVisible}{\param{int }{line}}

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


\membersection{wxStyledTextCtrl::EnsureVisibleEnforcePolicy}\label{wxstyledtextctrlensurevisibleenforcepolicy}

\func{void}{EnsureVisibleEnforcePolicy}{\param{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.


\membersection{wxStyledTextCtrl::FindColumn}\label{wxstyledtextctrlfindcolumn}

\func{int}{FindColumn}{\param{int }{line}, \param{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.


\membersection{wxStyledTextCtrl::FindText}\label{wxstyledtextctrlfindtext}

\func{int}{FindText}{\param{int }{minPos}, \param{int }{maxPos}, \param{const wxString\& }{text}, \param{int }{flags = 0}}

Find some text in the document.


\membersection{wxStyledTextCtrl::FormFeed}\label{wxstyledtextctrlformfeed}

\func{void}{FormFeed}{\void}

Insert a Form Feed character.


\membersection{wxStyledTextCtrl::FormatRange}\label{wxstyledtextctrlformatrange}

\func{int}{FormatRange}{\param{bool }{doDraw}, \param{int }{startPos}, \param{int }{endPos}, \param{wxDC* }{draw}, \param{wxDC* }{target}, \param{wxRect }{renderRect}, \param{wxRect }{pageRect}}

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


\membersection{wxStyledTextCtrl::GetAnchor}\label{wxstyledtextctrlgetanchor}

\func{int}{GetAnchor}{\void}

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


\membersection{wxStyledTextCtrl::GetBackSpaceUnIndents}\label{wxstyledtextctrlgetbackspaceunindents}

\func{bool}{GetBackSpaceUnIndents}{\void}

Does a backspace pressed when caret is within indentation unindent?


\membersection{wxStyledTextCtrl::GetBufferedDraw}\label{wxstyledtextctrlgetbuffereddraw}

\func{bool}{GetBufferedDraw}{\void}

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


\membersection{wxStyledTextCtrl::GetCaretForeground}\label{wxstyledtextctrlgetcaretforeground}

\func{wxColour}{GetCaretForeground}{\void}

Get the foreground colour of the caret.


\membersection{wxStyledTextCtrl::GetCaretLineBackAlpha}\label{wxstyledtextctrlgetcaretlinebackalpha}

\func{int}{GetCaretLineBackAlpha}{\void}

Get the background alpha of the caret line.


\membersection{wxStyledTextCtrl::GetCaretLineBackground}\label{wxstyledtextctrlgetcaretlinebackground}

\func{wxColour}{GetCaretLineBackground}{\void}

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


\membersection{wxStyledTextCtrl::GetCaretLineVisible}\label{wxstyledtextctrlgetcaretlinevisible}

\func{bool}{GetCaretLineVisible}{\void}

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


\membersection{wxStyledTextCtrl::GetCaretPeriod}\label{wxstyledtextctrlgetcaretperiod}

\func{int}{GetCaretPeriod}{\void}

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


\membersection{wxStyledTextCtrl::GetCaretSticky}\label{wxstyledtextctrlgetcaretsticky}

\func{bool}{GetCaretSticky}{\void}

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


\membersection{wxStyledTextCtrl::GetCaretWidth}\label{wxstyledtextctrlgetcaretwidth}

\func{int}{GetCaretWidth}{\void}

Returns the width of the insert mode caret.


\membersection{wxStyledTextCtrl::GetCharAt}\label{wxstyledtextctrlgetcharat}

\func{int}{GetCharAt}{\param{int }{pos}}

Returns the character byte at the position.


\membersection{wxStyledTextCtrl::GetCodePage}\label{wxstyledtextctrlgetcodepage}

\func{int}{GetCodePage}{\void}

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


\membersection{wxStyledTextCtrl::GetColumn}\label{wxstyledtextctrlgetcolumn}

\func{int}{GetColumn}{\param{int }{pos}}

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


\membersection{wxStyledTextCtrl::GetControlCharSymbol}\label{wxstyledtextctrlgetcontrolcharsymbol}

\func{int}{GetControlCharSymbol}{\void}

Get the way control characters are displayed.


\membersection{wxStyledTextCtrl::GetCurLine}\label{wxstyledtextctrlgetcurline}

\func{wxString}{GetCurLine}{\param{int* }{OUTPUT}}


\membersection{wxStyledTextCtrl::GetCurLineRaw}\label{wxstyledtextctrlgetcurlineraw}

\func{wxCharBuffer}{GetCurLineRaw}{\param{int* }{OUTPUT}}


\membersection{wxStyledTextCtrl::GetCurrentLine}\label{wxstyledtextctrlgetcurrentline}

\func{int}{GetCurrentLine}{\void}

END of generated section

Others...
Returns the line number of the line with the caret.


\membersection{wxStyledTextCtrl::GetCurrentPos}\label{wxstyledtextctrlgetcurrentpos}

\func{int}{GetCurrentPos}{\void}

Returns the position of the caret.


\membersection{wxStyledTextCtrl::GetDocPointer}\label{wxstyledtextctrlgetdocpointer}

\func{void*}{GetDocPointer}{\void}

Retrieve a pointer to the document object.


\membersection{wxStyledTextCtrl::GetEOLMode}\label{wxstyledtextctrlgeteolmode}

\func{int}{GetEOLMode}{\void}

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


\membersection{wxStyledTextCtrl::GetEdgeColour}\label{wxstyledtextctrlgetedgecolour}

\func{wxColour}{GetEdgeColour}{\void}

Retrieve the colour used in edge indication.


\membersection{wxStyledTextCtrl::GetEdgeColumn}\label{wxstyledtextctrlgetedgecolumn}

\func{int}{GetEdgeColumn}{\void}

Retrieve the column number which text should be kept within.


\membersection{wxStyledTextCtrl::GetEdgeMode}\label{wxstyledtextctrlgetedgemode}

\func{int}{GetEdgeMode}{\void}

Retrieve the edge highlight mode.


\membersection{wxStyledTextCtrl::GetEndAtLastLine}\label{wxstyledtextctrlgetendatlastline}

\func{bool}{GetEndAtLastLine}{\void}

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


\membersection{wxStyledTextCtrl::GetEndStyled}\label{wxstyledtextctrlgetendstyled}

\func{int}{GetEndStyled}{\void}

Retrieve the position of the last correctly styled character.


\membersection{wxStyledTextCtrl::GetFirstVisibleLine}\label{wxstyledtextctrlgetfirstvisibleline}

\func{int}{GetFirstVisibleLine}{\void}

Retrieve the display line at the top of the display.


\membersection{wxStyledTextCtrl::GetFoldExpanded}\label{wxstyledtextctrlgetfoldexpanded}

\func{bool}{GetFoldExpanded}{\param{int }{line}}

Is a header line expanded?


\membersection{wxStyledTextCtrl::GetFoldLevel}\label{wxstyledtextctrlgetfoldlevel}

\func{int}{GetFoldLevel}{\param{int }{line}}

Retrieve the fold level of a line.


\membersection{wxStyledTextCtrl::GetFoldParent}\label{wxstyledtextctrlgetfoldparent}

\func{int}{GetFoldParent}{\param{int }{line}}

Find the parent line of a child line.


\membersection{wxStyledTextCtrl::GetHighlightGuide}\label{wxstyledtextctrlgethighlightguide}

\func{int}{GetHighlightGuide}{\void}

Get the highlighted indentation guide column.


\membersection{wxStyledTextCtrl::GetIndent}\label{wxstyledtextctrlgetindent}

\func{int}{GetIndent}{\void}

Retrieve indentation size.


\membersection{wxStyledTextCtrl::GetIndentationGuides}\label{wxstyledtextctrlgetindentationguides}

\func{bool}{GetIndentationGuides}{\void}

Are the indentation guides visible?


\membersection{wxStyledTextCtrl::GetLastChild}\label{wxstyledtextctrlgetlastchild}

\func{int}{GetLastChild}{\param{int }{line}, \param{int }{level}}

Find the last child line of a header line.


\membersection{wxStyledTextCtrl::GetLastKeydownProcessed}\label{wxstyledtextctrlgetlastkeydownprocessed}

\func{bool}{GetLastKeydownProcessed}{\void}

Can be used to prevent the EVT\_CHAR handler from adding the char


\membersection{wxStyledTextCtrl::GetLayoutCache}\label{wxstyledtextctrlgetlayoutcache}

\func{int}{GetLayoutCache}{\void}

Retrieve the degree of caching of layout information.


\membersection{wxStyledTextCtrl::GetLength}\label{wxstyledtextctrlgetlength}

\func{int}{GetLength}{\void}

Returns the number of characters in the document.


\membersection{wxStyledTextCtrl::GetLexer}\label{wxstyledtextctrlgetlexer}

\func{int}{GetLexer}{\void}

Retrieve the lexing language of the document.


\membersection{wxStyledTextCtrl::GetLine}\label{wxstyledtextctrlgetline}

\func{wxString}{GetLine}{\param{int }{line}}

Retrieve the contents of a line.


\membersection{wxStyledTextCtrl::GetLineCount}\label{wxstyledtextctrlgetlinecount}

\func{int}{GetLineCount}{\void}

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


\membersection{wxStyledTextCtrl::GetLineEndPosition}\label{wxstyledtextctrlgetlineendposition}

\func{int}{GetLineEndPosition}{\param{int }{line}}

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


\membersection{wxStyledTextCtrl::GetLineIndentPosition}\label{wxstyledtextctrlgetlineindentposition}

\func{int}{GetLineIndentPosition}{\param{int }{line}}

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


\membersection{wxStyledTextCtrl::GetLineIndentation}\label{wxstyledtextctrlgetlineindentation}

\func{int}{GetLineIndentation}{\param{int }{line}}

Retrieve the number of columns that a line is indented.


\membersection{wxStyledTextCtrl::GetLineRaw}\label{wxstyledtextctrlgetlineraw}

\func{wxCharBuffer}{GetLineRaw}{\param{int }{line}}

Retrieve the contents of a line.


\membersection{wxStyledTextCtrl::GetLineSelEndPosition}\label{wxstyledtextctrlgetlineselendposition}

\func{int}{GetLineSelEndPosition}{\param{int }{line}}

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


\membersection{wxStyledTextCtrl::GetLineSelStartPosition}\label{wxstyledtextctrlgetlineselstartposition}

\func{int}{GetLineSelStartPosition}{\param{int }{line}}

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


\membersection{wxStyledTextCtrl::GetLineState}\label{wxstyledtextctrlgetlinestate}

\func{int}{GetLineState}{\param{int }{line}}

Retrieve the extra styling information for a line.


\membersection{wxStyledTextCtrl::GetLineVisible}\label{wxstyledtextctrlgetlinevisible}

\func{bool}{GetLineVisible}{\param{int }{line}}

Is a line visible?


\membersection{wxStyledTextCtrl::GetMarginLeft}\label{wxstyledtextctrlgetmarginleft}

\func{int}{GetMarginLeft}{\void}

Returns the size in pixels of the left margin.


\membersection{wxStyledTextCtrl::GetMarginMask}\label{wxstyledtextctrlgetmarginmask}

\func{int}{GetMarginMask}{\param{int }{margin}}

Retrieve the marker mask of a margin.


\membersection{wxStyledTextCtrl::GetMarginRight}\label{wxstyledtextctrlgetmarginright}

\func{int}{GetMarginRight}{\void}

Returns the size in pixels of the right margin.


\membersection{wxStyledTextCtrl::GetMarginSensitive}\label{wxstyledtextctrlgetmarginsensitive}

\func{bool}{GetMarginSensitive}{\param{int }{margin}}

Retrieve the mouse click sensitivity of a margin.


\membersection{wxStyledTextCtrl::GetMarginType}\label{wxstyledtextctrlgetmargintype}

\func{int}{GetMarginType}{\param{int }{margin}}

Retrieve the type of a margin.


\membersection{wxStyledTextCtrl::GetMarginWidth}\label{wxstyledtextctrlgetmarginwidth}

\func{int}{GetMarginWidth}{\param{int }{margin}}

Retrieve the width of a margin in pixels.


\membersection{wxStyledTextCtrl::GetMaxLineState}\label{wxstyledtextctrlgetmaxlinestate}

\func{int}{GetMaxLineState}{\void}

Retrieve the last line number that has line state.


\membersection{wxStyledTextCtrl::GetModEventMask}\label{wxstyledtextctrlgetmodeventmask}

\func{int}{GetModEventMask}{\void}

Get which document modification events are sent to the container.


\membersection{wxStyledTextCtrl::GetModify}\label{wxstyledtextctrlgetmodify}

\func{bool}{GetModify}{\void}

Is the document different from when it was last saved?


\membersection{wxStyledTextCtrl::GetMouseDownCaptures}\label{wxstyledtextctrlgetmousedowncaptures}

\func{bool}{GetMouseDownCaptures}{\void}

Get whether mouse gets captured.


\membersection{wxStyledTextCtrl::GetMouseDwellTime}\label{wxstyledtextctrlgetmousedwelltime}

\func{int}{GetMouseDwellTime}{\void}

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


\membersection{wxStyledTextCtrl::GetOvertype}\label{wxstyledtextctrlgetovertype}

\func{bool}{GetOvertype}{\void}

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


\membersection{wxStyledTextCtrl::GetPasteConvertEndings}\label{wxstyledtextctrlgetpasteconvertendings}

\func{bool}{GetPasteConvertEndings}{\void}

Get convert-on-paste setting


\membersection{wxStyledTextCtrl::GetPrintColourMode}\label{wxstyledtextctrlgetprintcolourmode}

\func{int}{GetPrintColourMode}{\void}

Returns the print colour mode.


\membersection{wxStyledTextCtrl::GetPrintMagnification}\label{wxstyledtextctrlgetprintmagnification}

\func{int}{GetPrintMagnification}{\void}

Returns the print magnification.


\membersection{wxStyledTextCtrl::GetPrintWrapMode}\label{wxstyledtextctrlgetprintwrapmode}

\func{int}{GetPrintWrapMode}{\void}

Is printing line wrapped?


\membersection{wxStyledTextCtrl::GetProperty}\label{wxstyledtextctrlgetproperty}

\func{wxString}{GetProperty}{\param{const wxString\& }{key}}

Retrieve a 'property' value previously set with SetProperty.


\membersection{wxStyledTextCtrl::GetPropertyExpanded}\label{wxstyledtextctrlgetpropertyexpanded}

\func{wxString}{GetPropertyExpanded}{\param{const wxString\& }{key}}

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


\membersection{wxStyledTextCtrl::GetPropertyInt}\label{wxstyledtextctrlgetpropertyint}

\func{int}{GetPropertyInt}{\param{const wxString\& }{key}}

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


\membersection{wxStyledTextCtrl::GetReadOnly}\label{wxstyledtextctrlgetreadonly}

\func{bool}{GetReadOnly}{\void}

In read-only mode?


\membersection{wxStyledTextCtrl::GetSTCCursor}\label{wxstyledtextctrlgetstccursor}

\func{int}{GetSTCCursor}{\void}

Get cursor type.


\membersection{wxStyledTextCtrl::GetSTCFocus}\label{wxstyledtextctrlgetstcfocus}

\func{bool}{GetSTCFocus}{\void}

Get internal focus flag.


\membersection{wxStyledTextCtrl::GetScrollWidth}\label{wxstyledtextctrlgetscrollwidth}

\func{int}{GetScrollWidth}{\void}

Retrieve the document width assumed for scrolling.


\membersection{wxStyledTextCtrl::GetSearchFlags}\label{wxstyledtextctrlgetsearchflags}

\func{int}{GetSearchFlags}{\void}

Get the search flags used by SearchInTarget.


\membersection{wxStyledTextCtrl::GetSelAlpha}\label{wxstyledtextctrlgetselalpha}

\func{int}{GetSelAlpha}{\void}

Get the alpha of the selection.


\membersection{wxStyledTextCtrl::GetSelectedText}\label{wxstyledtextctrlgetselectedtext}

\func{wxString}{GetSelectedText}{\void}

Retrieve the selected text.


\membersection{wxStyledTextCtrl::GetSelectedTextRaw}\label{wxstyledtextctrlgetselectedtextraw}

\func{wxCharBuffer}{GetSelectedTextRaw}{\void}

Retrieve the selected text.


\membersection{wxStyledTextCtrl::GetSelection}\label{wxstyledtextctrlgetselection}

\func{void}{GetSelection}{\param{int* }{OUTPUT}, \param{int* }{OUTPUT}}


\membersection{wxStyledTextCtrl::GetSelectionEnd}\label{wxstyledtextctrlgetselectionend}

\func{int}{GetSelectionEnd}{\void}

Returns the position at the end of the selection.


\membersection{wxStyledTextCtrl::GetSelectionMode}\label{wxstyledtextctrlgetselectionmode}

\func{int}{GetSelectionMode}{\void}

Get the mode of the current selection.


\membersection{wxStyledTextCtrl::GetSelectionStart}\label{wxstyledtextctrlgetselectionstart}

\func{int}{GetSelectionStart}{\void}

Returns the position at the start of the selection.


\membersection{wxStyledTextCtrl::GetStatus}\label{wxstyledtextctrlgetstatus}

\func{int}{GetStatus}{\void}

Get error status.


\membersection{wxStyledTextCtrl::GetStyleAt}\label{wxstyledtextctrlgetstyleat}

\func{int}{GetStyleAt}{\param{int }{pos}}

Returns the style byte at the position.


\membersection{wxStyledTextCtrl::GetStyleBits}\label{wxstyledtextctrlgetstylebits}

\func{int}{GetStyleBits}{\void}

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


\membersection{wxStyledTextCtrl::GetStyleBitsNeeded}\label{wxstyledtextctrlgetstylebitsneeded}

\func{int}{GetStyleBitsNeeded}{\void}

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


\membersection{wxStyledTextCtrl::GetStyledText}\label{wxstyledtextctrlgetstyledtext}

\func{wxMemoryBuffer}{GetStyledText}{\param{int }{startPos}, \param{int }{endPos}}

Retrieve a buffer of cells.


\membersection{wxStyledTextCtrl::GetTabIndents}\label{wxstyledtextctrlgettabindents}

\func{bool}{GetTabIndents}{\void}

Does a tab pressed when caret is within indentation indent?


\membersection{wxStyledTextCtrl::GetTabWidth}\label{wxstyledtextctrlgettabwidth}

\func{int}{GetTabWidth}{\void}

Retrieve the visible size of a tab.


\membersection{wxStyledTextCtrl::GetTargetEnd}\label{wxstyledtextctrlgettargetend}

\func{int}{GetTargetEnd}{\void}

Get the position that ends the target.


\membersection{wxStyledTextCtrl::GetTargetStart}\label{wxstyledtextctrlgettargetstart}

\func{int}{GetTargetStart}{\void}

Get the position that starts the target.


\membersection{wxStyledTextCtrl::GetText}\label{wxstyledtextctrlgettext}

\func{wxString}{GetText}{\void}

Retrieve all the text in the document.


\membersection{wxStyledTextCtrl::GetTextLength}\label{wxstyledtextctrlgettextlength}

\func{int}{GetTextLength}{\void}

Retrieve the number of characters in the document.


\membersection{wxStyledTextCtrl::GetTextRange}\label{wxstyledtextctrlgettextrange}

\func{wxString}{GetTextRange}{\param{int }{startPos}, \param{int }{endPos}}

Retrieve a range of text.


\membersection{wxStyledTextCtrl::GetTextRangeRaw}\label{wxstyledtextctrlgettextrangeraw}

\func{wxCharBuffer}{GetTextRangeRaw}{\param{int }{startPos}, \param{int }{endPos}}

Retrieve a range of text.


\membersection{wxStyledTextCtrl::GetTextRaw}\label{wxstyledtextctrlgettextraw}

\func{wxCharBuffer}{GetTextRaw}{\void}

Retrieve all the text in the document.


\membersection{wxStyledTextCtrl::GetTwoPhaseDraw}\label{wxstyledtextctrlgettwophasedraw}

\func{bool}{GetTwoPhaseDraw}{\void}

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


\membersection{wxStyledTextCtrl::GetUndoCollection}\label{wxstyledtextctrlgetundocollection}

\func{bool}{GetUndoCollection}{\void}

Is undo history being collected?


\membersection{wxStyledTextCtrl::GetUseAntiAliasing}\label{wxstyledtextctrlgetuseantialiasing}

\func{bool}{GetUseAntiAliasing}{\void}

Returns the current UseAntiAliasing setting.


\membersection{wxStyledTextCtrl::GetUseHorizontalScrollBar}\label{wxstyledtextctrlgetusehorizontalscrollbar}

\func{bool}{GetUseHorizontalScrollBar}{\void}

Is the horizontal scroll bar visible?


\membersection{wxStyledTextCtrl::GetUseTabs}\label{wxstyledtextctrlgetusetabs}

\func{bool}{GetUseTabs}{\void}

Retrieve whether tabs will be used in indentation.


\membersection{wxStyledTextCtrl::GetUseVerticalScrollBar}\label{wxstyledtextctrlgetuseverticalscrollbar}

\func{bool}{GetUseVerticalScrollBar}{\void}

Is the vertical scroll bar visible?


\membersection{wxStyledTextCtrl::GetViewEOL}\label{wxstyledtextctrlgetvieweol}

\func{bool}{GetViewEOL}{\void}

Are the end of line characters visible?


\membersection{wxStyledTextCtrl::GetViewWhiteSpace}\label{wxstyledtextctrlgetviewwhitespace}

\func{int}{GetViewWhiteSpace}{\void}

Are white space characters currently visible?
Returns one of SCWS\_* constants.


\membersection{wxStyledTextCtrl::GetWrapMode}\label{wxstyledtextctrlgetwrapmode}

\func{int}{GetWrapMode}{\void}

Retrieve whether text is word wrapped.


\membersection{wxStyledTextCtrl::GetWrapStartIndent}\label{wxstyledtextctrlgetwrapstartindent}

\func{int}{GetWrapStartIndent}{\void}

Retrive the start indent for wrapped lines.


\membersection{wxStyledTextCtrl::GetWrapVisualFlags}\label{wxstyledtextctrlgetwrapvisualflags}

\func{int}{GetWrapVisualFlags}{\void}

Retrive the display mode of visual flags for wrapped lines.


\membersection{wxStyledTextCtrl::GetWrapVisualFlagsLocation}\label{wxstyledtextctrlgetwrapvisualflagslocation}

\func{int}{GetWrapVisualFlagsLocation}{\void}

Retrive the location of visual flags for wrapped lines.


\membersection{wxStyledTextCtrl::GetXOffset}\label{wxstyledtextctrlgetxoffset}

\func{int}{GetXOffset}{\void}


\membersection{wxStyledTextCtrl::GetZoom}\label{wxstyledtextctrlgetzoom}

\func{int}{GetZoom}{\void}

Retrieve the zoom level.


\membersection{wxStyledTextCtrl::GotoLine}\label{wxstyledtextctrlgotoline}

\func{void}{GotoLine}{\param{int }{line}}

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


\membersection{wxStyledTextCtrl::GotoPos}\label{wxstyledtextctrlgotopos}

\func{void}{GotoPos}{\param{int }{pos}}

Set caret to a position and ensure it is visible.


\membersection{wxStyledTextCtrl::HideLines}\label{wxstyledtextctrlhidelines}

\func{void}{HideLines}{\param{int }{lineStart}, \param{int }{lineEnd}}

Make a range of lines invisible.


\membersection{wxStyledTextCtrl::HideSelection}\label{wxstyledtextctrlhideselection}

\func{void}{HideSelection}{\param{bool }{normal}}

Draw the selection in normal style or with selection highlighted.


\membersection{wxStyledTextCtrl::Home}\label{wxstyledtextctrlhome}

\func{void}{Home}{\void}

Move caret to first position on line.


\membersection{wxStyledTextCtrl::HomeDisplay}\label{wxstyledtextctrlhomedisplay}

\func{void}{HomeDisplay}{\void}

Move caret to first position on display line.


\membersection{wxStyledTextCtrl::HomeDisplayExtend}\label{wxstyledtextctrlhomedisplayextend}

\func{void}{HomeDisplayExtend}{\void}

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


\membersection{wxStyledTextCtrl::HomeExtend}\label{wxstyledtextctrlhomeextend}

\func{void}{HomeExtend}{\void}

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


\membersection{wxStyledTextCtrl::HomeRectExtend}\label{wxstyledtextctrlhomerectextend}

\func{void}{HomeRectExtend}{\void}

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


\membersection{wxStyledTextCtrl::HomeWrap}\label{wxstyledtextctrlhomewrap}

\func{void}{HomeWrap}{\void}

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)?.


\membersection{wxStyledTextCtrl::HomeWrapExtend}\label{wxstyledtextctrlhomewrapextend}

\func{void}{HomeWrapExtend}{\void}


\membersection{wxStyledTextCtrl::IndicatorGetForeground}\label{wxstyledtextctrlindicatorgetforeground}

\func{wxColour}{IndicatorGetForeground}{\param{int }{indic}}

Retrieve the foreground colour of an indicator.


\membersection{wxStyledTextCtrl::IndicatorGetStyle}\label{wxstyledtextctrlindicatorgetstyle}

\func{int}{IndicatorGetStyle}{\param{int }{indic}}

Retrieve the style of an indicator.


\membersection{wxStyledTextCtrl::IndicatorSetForeground}\label{wxstyledtextctrlindicatorsetforeground}

\func{void}{IndicatorSetForeground}{\param{int }{indic}, \param{const wxColour\& }{fore}}

Set the foreground colour of an indicator.


\membersection{wxStyledTextCtrl::IndicatorSetStyle}\label{wxstyledtextctrlindicatorsetstyle}

\func{void}{IndicatorSetStyle}{\param{int }{indic}, \param{int }{style}}

Set an indicator to plain, squiggle or TT.


\membersection{wxStyledTextCtrl::InsertText}\label{wxstyledtextctrlinserttext}

\func{void}{InsertText}{\param{int }{pos}, \param{const wxString\& }{text}}

Insert string at a position.


\membersection{wxStyledTextCtrl::InsertTextRaw}\label{wxstyledtextctrlinserttextraw}

\func{void}{InsertTextRaw}{\param{int }{pos}, \param{const char* }{text}}

Insert string at a position.


\membersection{wxStyledTextCtrl::LineCopy}\label{wxstyledtextctrllinecopy}

\func{void}{LineCopy}{\void}

Copy the line containing the caret.


\membersection{wxStyledTextCtrl::LineCut}\label{wxstyledtextctrllinecut}

\func{void}{LineCut}{\void}

Cut the line containing the caret.


\membersection{wxStyledTextCtrl::LineDelete}\label{wxstyledtextctrllinedelete}

\func{void}{LineDelete}{\void}

Delete the line containing the caret.


\membersection{wxStyledTextCtrl::LineDown}\label{wxstyledtextctrllinedown}

\func{void}{LineDown}{\void}

Move caret down one line.


\membersection{wxStyledTextCtrl::LineDownExtend}\label{wxstyledtextctrllinedownextend}

\func{void}{LineDownExtend}{\void}

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


\membersection{wxStyledTextCtrl::LineDownRectExtend}\label{wxstyledtextctrllinedownrectextend}

\func{void}{LineDownRectExtend}{\void}

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


\membersection{wxStyledTextCtrl::LineDuplicate}\label{wxstyledtextctrllineduplicate}

\func{void}{LineDuplicate}{\void}

Duplicate the current line.


\membersection{wxStyledTextCtrl::LineEnd}\label{wxstyledtextctrllineend}

\func{void}{LineEnd}{\void}

Move caret to last position on line.


\membersection{wxStyledTextCtrl::LineEndDisplay}\label{wxstyledtextctrllineenddisplay}

\func{void}{LineEndDisplay}{\void}

Move caret to last position on display line.


\membersection{wxStyledTextCtrl::LineEndDisplayExtend}\label{wxstyledtextctrllineenddisplayextend}

\func{void}{LineEndDisplayExtend}{\void}

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


\membersection{wxStyledTextCtrl::LineEndExtend}\label{wxstyledtextctrllineendextend}

\func{void}{LineEndExtend}{\void}

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


\membersection{wxStyledTextCtrl::LineEndRectExtend}\label{wxstyledtextctrllineendrectextend}

\func{void}{LineEndRectExtend}{\void}

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


\membersection{wxStyledTextCtrl::LineEndWrap}\label{wxstyledtextctrllineendwrap}

\func{void}{LineEndWrap}{\void}


\membersection{wxStyledTextCtrl::LineEndWrapExtend}\label{wxstyledtextctrllineendwrapextend}

\func{void}{LineEndWrapExtend}{\void}


\membersection{wxStyledTextCtrl::LineFromPosition}\label{wxstyledtextctrllinefromposition}

\func{int}{LineFromPosition}{\param{int }{pos}}

Retrieve the line containing a position.


\membersection{wxStyledTextCtrl::LineLength}\label{wxstyledtextctrllinelength}

\func{int}{LineLength}{\param{int }{line}}

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


\membersection{wxStyledTextCtrl::LineScroll}\label{wxstyledtextctrllinescroll}

\func{void}{LineScroll}{\param{int }{columns}, \param{int }{lines}}

Scroll horizontally and vertically.


\membersection{wxStyledTextCtrl::LineScrollDown}\label{wxstyledtextctrllinescrolldown}

\func{void}{LineScrollDown}{\void}

Scroll the document down, keeping the caret visible.


\membersection{wxStyledTextCtrl::LineScrollUp}\label{wxstyledtextctrllinescrollup}

\func{void}{LineScrollUp}{\void}

Scroll the document up, keeping the caret visible.


\membersection{wxStyledTextCtrl::LineTranspose}\label{wxstyledtextctrllinetranspose}

\func{void}{LineTranspose}{\void}

Switch the current line with the previous.


\membersection{wxStyledTextCtrl::LineUp}\label{wxstyledtextctrllineup}

\func{void}{LineUp}{\void}

Move caret up one line.


\membersection{wxStyledTextCtrl::LineUpExtend}\label{wxstyledtextctrllineupextend}

\func{void}{LineUpExtend}{\void}

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


\membersection{wxStyledTextCtrl::LineUpRectExtend}\label{wxstyledtextctrllineuprectextend}

\func{void}{LineUpRectExtend}{\void}

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


\membersection{wxStyledTextCtrl::LinesJoin}\label{wxstyledtextctrllinesjoin}

\func{void}{LinesJoin}{\void}

Join the lines in the target.


\membersection{wxStyledTextCtrl::LinesOnScreen}\label{wxstyledtextctrllinesonscreen}

\func{int}{LinesOnScreen}{\void}

Retrieves the number of lines completely visible.


\membersection{wxStyledTextCtrl::LinesSplit}\label{wxstyledtextctrllinessplit}

\func{void}{LinesSplit}{\param{int }{pixelWidth}}

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


\membersection{wxStyledTextCtrl::LoadFile}\label{wxstyledtextctrlloadfile}

\func{bool}{LoadFile}{\param{const wxString\& }{filename}}

Load the contents of filename into the editor


\membersection{wxStyledTextCtrl::LowerCase}\label{wxstyledtextctrllowercase}

\func{void}{LowerCase}{\void}

Transform the selection to lower case.


\membersection{wxStyledTextCtrl::MarkerAdd}\label{wxstyledtextctrlmarkeradd}

\func{int}{MarkerAdd}{\param{int }{line}, \param{int }{markerNumber}}

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


\membersection{wxStyledTextCtrl::MarkerAddSet}\label{wxstyledtextctrlmarkeraddset}

\func{void}{MarkerAddSet}{\param{int }{line}, \param{int }{set}}

Add a set of markers to a line.


\membersection{wxStyledTextCtrl::MarkerDefine}\label{wxstyledtextctrlmarkerdefine}

\func{void}{MarkerDefine}{\param{int }{markerNumber}, \param{int }{markerSymbol}, \param{const wxColour\& }{foreground = wxNullColour}, \param{const wxColour\& }{background = wxNullColour}}

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


\membersection{wxStyledTextCtrl::MarkerDefineBitmap}\label{wxstyledtextctrlmarkerdefinebitmap}

\func{void}{MarkerDefineBitmap}{\param{int }{markerNumber}, \param{const wxBitmap\& }{bmp}}

Define a marker from a bitmap


\membersection{wxStyledTextCtrl::MarkerDelete}\label{wxstyledtextctrlmarkerdelete}

\func{void}{MarkerDelete}{\param{int }{line}, \param{int }{markerNumber}}

Delete a marker from a line.


\membersection{wxStyledTextCtrl::MarkerDeleteAll}\label{wxstyledtextctrlmarkerdeleteall}

\func{void}{MarkerDeleteAll}{\param{int }{markerNumber}}

Delete all markers with a particular number from all lines.


\membersection{wxStyledTextCtrl::MarkerDeleteHandle}\label{wxstyledtextctrlmarkerdeletehandle}

\func{void}{MarkerDeleteHandle}{\param{int }{handle}}

Delete a marker.


\membersection{wxStyledTextCtrl::MarkerGet}\label{wxstyledtextctrlmarkerget}

\func{int}{MarkerGet}{\param{int }{line}}

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


\membersection{wxStyledTextCtrl::MarkerLineFromHandle}\label{wxstyledtextctrlmarkerlinefromhandle}

\func{int}{MarkerLineFromHandle}{\param{int }{handle}}

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


\membersection{wxStyledTextCtrl::MarkerNext}\label{wxstyledtextctrlmarkernext}

\func{int}{MarkerNext}{\param{int }{lineStart}, \param{int }{markerMask}}

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


\membersection{wxStyledTextCtrl::MarkerPrevious}\label{wxstyledtextctrlmarkerprevious}

\func{int}{MarkerPrevious}{\param{int }{lineStart}, \param{int }{markerMask}}

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


\membersection{wxStyledTextCtrl::MarkerSetAlpha}\label{wxstyledtextctrlmarkersetalpha}

\func{void}{MarkerSetAlpha}{\param{int }{markerNumber}, \param{int }{alpha}}

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


\membersection{wxStyledTextCtrl::MarkerSetBackground}\label{wxstyledtextctrlmarkersetbackground}

\func{void}{MarkerSetBackground}{\param{int }{markerNumber}, \param{const wxColour\& }{back}}

Set the background colour used for a particular marker number.


\membersection{wxStyledTextCtrl::MarkerSetForeground}\label{wxstyledtextctrlmarkersetforeground}

\func{void}{MarkerSetForeground}{\param{int }{markerNumber}, \param{const wxColour\& }{fore}}

Set the foreground colour used for a particular marker number.


\membersection{wxStyledTextCtrl::MoveCaretInsideView}\label{wxstyledtextctrlmovecaretinsideview}

\func{void}{MoveCaretInsideView}{\void}

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


\membersection{wxStyledTextCtrl::NewLine}\label{wxstyledtextctrlnewline}

\func{void}{NewLine}{\void}

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


\membersection{wxStyledTextCtrl::PageDown}\label{wxstyledtextctrlpagedown}

\func{void}{PageDown}{\void}

Move caret one page down.


\membersection{wxStyledTextCtrl::PageDownExtend}\label{wxstyledtextctrlpagedownextend}

\func{void}{PageDownExtend}{\void}

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


\membersection{wxStyledTextCtrl::PageDownRectExtend}\label{wxstyledtextctrlpagedownrectextend}

\func{void}{PageDownRectExtend}{\void}

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


\membersection{wxStyledTextCtrl::PageUp}\label{wxstyledtextctrlpageup}

\func{void}{PageUp}{\void}

Move caret one page up.


\membersection{wxStyledTextCtrl::PageUpExtend}\label{wxstyledtextctrlpageupextend}

\func{void}{PageUpExtend}{\void}

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


\membersection{wxStyledTextCtrl::PageUpRectExtend}\label{wxstyledtextctrlpageuprectextend}

\func{void}{PageUpRectExtend}{\void}

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


\membersection{wxStyledTextCtrl::ParaDown}\label{wxstyledtextctrlparadown}

\func{void}{ParaDown}{\void}

Move caret between paragraphs (delimited by empty lines).


\membersection{wxStyledTextCtrl::ParaDownExtend}\label{wxstyledtextctrlparadownextend}

\func{void}{ParaDownExtend}{\void}


\membersection{wxStyledTextCtrl::ParaUp}\label{wxstyledtextctrlparaup}

\func{void}{ParaUp}{\void}


\membersection{wxStyledTextCtrl::ParaUpExtend}\label{wxstyledtextctrlparaupextend}

\func{void}{ParaUpExtend}{\void}


\membersection{wxStyledTextCtrl::Paste}\label{wxstyledtextctrlpaste}

\func{void}{Paste}{\void}

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


\membersection{wxStyledTextCtrl::PointFromPosition}\label{wxstyledtextctrlpointfromposition}

\func{wxPoint}{PointFromPosition}{\param{int }{pos}}

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


\membersection{wxStyledTextCtrl::PositionAfter}\label{wxstyledtextctrlpositionafter}

\func{int}{PositionAfter}{\param{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.


\membersection{wxStyledTextCtrl::PositionBefore}\label{wxstyledtextctrlpositionbefore}

\func{int}{PositionBefore}{\param{int }{pos}}

Given a valid document position, return the previous position taking code
page into account. Returns 0 if passed 0.


\membersection{wxStyledTextCtrl::PositionFromLine}\label{wxstyledtextctrlpositionfromline}

\func{int}{PositionFromLine}{\param{int }{line}}

Retrieve the position at the start of a line.


\membersection{wxStyledTextCtrl::PositionFromPoint}\label{wxstyledtextctrlpositionfrompoint}

\func{int}{PositionFromPoint}{\param{wxPoint }{pt}}

Find the position from a point within the window.


\membersection{wxStyledTextCtrl::PositionFromPointClose}\label{wxstyledtextctrlpositionfrompointclose}

\func{int}{PositionFromPointClose}{\param{int }{x}, \param{int }{y}}

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


\membersection{wxStyledTextCtrl::Redo}\label{wxstyledtextctrlredo}

\func{void}{Redo}{\void}

Redoes the next action on the undo history.


\membersection{wxStyledTextCtrl::RegisterImage}\label{wxstyledtextctrlregisterimage}

\func{void}{RegisterImage}{\param{int }{type}, \param{const wxBitmap\& }{bmp}}

Register an image for use in autocompletion lists.


\membersection{wxStyledTextCtrl::ReleaseDocument}\label{wxstyledtextctrlreleasedocument}

\func{void}{ReleaseDocument}{\param{void* }{docPointer}}

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


\membersection{wxStyledTextCtrl::ReplaceSelection}\label{wxstyledtextctrlreplaceselection}

\func{void}{ReplaceSelection}{\param{const wxString\& }{text}}

Replace the selected text with the argument text.


\membersection{wxStyledTextCtrl::ReplaceTarget}\label{wxstyledtextctrlreplacetarget}

\func{int}{ReplaceTarget}{\param{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.


\membersection{wxStyledTextCtrl::ReplaceTargetRE}\label{wxstyledtextctrlreplacetargetre}

\func{int}{ReplaceTargetRE}{\param{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.


\membersection{wxStyledTextCtrl::SaveFile}\label{wxstyledtextctrlsavefile}

\func{bool}{SaveFile}{\param{const wxString\& }{filename}}

Write the contents of the editor to filename


\membersection{wxStyledTextCtrl::ScrollToColumn}\label{wxstyledtextctrlscrolltocolumn}

\func{void}{ScrollToColumn}{\param{int }{column}}

Scroll enough to make the given column visible


\membersection{wxStyledTextCtrl::ScrollToLine}\label{wxstyledtextctrlscrolltoline}

\func{void}{ScrollToLine}{\param{int }{line}}

Scroll enough to make the given line visible


\membersection{wxStyledTextCtrl::SearchAnchor}\label{wxstyledtextctrlsearchanchor}

\func{void}{SearchAnchor}{\void}

Sets the current caret position to be the search anchor.


\membersection{wxStyledTextCtrl::SearchInTarget}\label{wxstyledtextctrlsearchintarget}

\func{int}{SearchInTarget}{\param{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.


\membersection{wxStyledTextCtrl::SearchNext}\label{wxstyledtextctrlsearchnext}

\func{int}{SearchNext}{\param{int }{flags}, \param{const wxString\& }{text}}

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


\membersection{wxStyledTextCtrl::SearchPrev}\label{wxstyledtextctrlsearchprev}

\func{int}{SearchPrev}{\param{int }{flags}, \param{const wxString\& }{text}}

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


\membersection{wxStyledTextCtrl::SelectAll}\label{wxstyledtextctrlselectall}

\func{void}{SelectAll}{\void}

Select all the text in the document.


\membersection{wxStyledTextCtrl::SelectionDuplicate}\label{wxstyledtextctrlselectionduplicate}

\func{void}{SelectionDuplicate}{\void}

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


\membersection{wxStyledTextCtrl::SelectionIsRectangle}\label{wxstyledtextctrlselectionisrectangle}

\func{bool}{SelectionIsRectangle}{\void}

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


\membersection{wxStyledTextCtrl::SendMsg}\label{wxstyledtextctrlsendmsg}

\func{long}{SendMsg}{\param{int }{msg}, \param{long }{wp = 0}, \param{long }{lp = 0}}

Send a message to Scintilla


\membersection{wxStyledTextCtrl::SetAnchor}\label{wxstyledtextctrlsetanchor}

\func{void}{SetAnchor}{\param{int }{posAnchor}}

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


\membersection{wxStyledTextCtrl::SetBackSpaceUnIndents}\label{wxstyledtextctrlsetbackspaceunindents}

\func{void}{SetBackSpaceUnIndents}{\param{bool }{bsUnIndents}}

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


\membersection{wxStyledTextCtrl::SetBufferedDraw}\label{wxstyledtextctrlsetbuffereddraw}

\func{void}{SetBufferedDraw}{\param{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.


\membersection{wxStyledTextCtrl::SetCaretForeground}\label{wxstyledtextctrlsetcaretforeground}

\func{void}{SetCaretForeground}{\param{const wxColour\& }{fore}}

Set the foreground colour of the caret.


\membersection{wxStyledTextCtrl::SetCaretLineBackAlpha}\label{wxstyledtextctrlsetcaretlinebackalpha}

\func{void}{SetCaretLineBackAlpha}{\param{int }{alpha}}

Set background alpha of the caret line.


\membersection{wxStyledTextCtrl::SetCaretLineBackground}\label{wxstyledtextctrlsetcaretlinebackground}

\func{void}{SetCaretLineBackground}{\param{const wxColour\& }{back}}

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


\membersection{wxStyledTextCtrl::SetCaretLineVisible}\label{wxstyledtextctrlsetcaretlinevisible}

\func{void}{SetCaretLineVisible}{\param{bool }{show}}

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


\membersection{wxStyledTextCtrl::SetCaretPeriod}\label{wxstyledtextctrlsetcaretperiod}

\func{void}{SetCaretPeriod}{\param{int }{periodMilliseconds}}

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


\membersection{wxStyledTextCtrl::SetCaretSticky}\label{wxstyledtextctrlsetcaretsticky}

\func{void}{SetCaretSticky}{\param{bool }{useCaretStickyBehaviour}}

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


\membersection{wxStyledTextCtrl::SetCaretWidth}\label{wxstyledtextctrlsetcaretwidth}

\func{void}{SetCaretWidth}{\param{int }{pixelWidth}}

Set the width of the insert mode caret.


\membersection{wxStyledTextCtrl::SetCharsDefault}\label{wxstyledtextctrlsetcharsdefault}

\func{void}{SetCharsDefault}{\void}

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


\membersection{wxStyledTextCtrl::SetCodePage}\label{wxstyledtextctrlsetcodepage}

\func{void}{SetCodePage}{\param{int }{codePage}}

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


\membersection{wxStyledTextCtrl::SetControlCharSymbol}\label{wxstyledtextctrlsetcontrolcharsymbol}

\func{void}{SetControlCharSymbol}{\param{int }{symbol}}

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


\membersection{wxStyledTextCtrl::SetCurrentPos}\label{wxstyledtextctrlsetcurrentpos}

\func{void}{SetCurrentPos}{\param{int }{pos}}

Sets the position of the caret.


\membersection{wxStyledTextCtrl::SetDocPointer}\label{wxstyledtextctrlsetdocpointer}

\func{void}{SetDocPointer}{\param{void* }{docPointer}}

Change the document object used.


\membersection{wxStyledTextCtrl::SetEOLMode}\label{wxstyledtextctrlseteolmode}

\func{void}{SetEOLMode}{\param{int }{eolMode}}

Set the current end of line mode.


\membersection{wxStyledTextCtrl::SetEdgeColour}\label{wxstyledtextctrlsetedgecolour}

\func{void}{SetEdgeColour}{\param{const wxColour\& }{edgeColour}}

Change the colour used in edge indication.


\membersection{wxStyledTextCtrl::SetEdgeColumn}\label{wxstyledtextctrlsetedgecolumn}

\func{void}{SetEdgeColumn}{\param{int }{column}}

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


\membersection{wxStyledTextCtrl::SetEdgeMode}\label{wxstyledtextctrlsetedgemode}

\func{void}{SetEdgeMode}{\param{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).


\membersection{wxStyledTextCtrl::SetEndAtLastLine}\label{wxstyledtextctrlsetendatlastline}

\func{void}{SetEndAtLastLine}{\param{bool }{endAtLastLine}}

Sets the scroll range so that maximum scroll position has
the last line at the bottom of the view (default).
Setting this to false allows scrolling one page below the last line.


\membersection{wxStyledTextCtrl::SetFoldExpanded}\label{wxstyledtextctrlsetfoldexpanded}

\func{void}{SetFoldExpanded}{\param{int }{line}, \param{bool }{expanded}}

Show the children of a header line.


\membersection{wxStyledTextCtrl::SetFoldFlags}\label{wxstyledtextctrlsetfoldflags}

\func{void}{SetFoldFlags}{\param{int }{flags}}

Set some style options for folding.


\membersection{wxStyledTextCtrl::SetFoldLevel}\label{wxstyledtextctrlsetfoldlevel}

\func{void}{SetFoldLevel}{\param{int }{line}, \param{int }{level}}

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


\membersection{wxStyledTextCtrl::SetFoldMarginColour}\label{wxstyledtextctrlsetfoldmargincolour}

\func{void}{SetFoldMarginColour}{\param{bool }{useSetting}, \param{const wxColour\& }{back}}

Set the colours used as a chequerboard pattern in the fold margin


\membersection{wxStyledTextCtrl::SetFoldMarginHiColour}\label{wxstyledtextctrlsetfoldmarginhicolour}

\func{void}{SetFoldMarginHiColour}{\param{bool }{useSetting}, \param{const wxColour\& }{fore}}


\membersection{wxStyledTextCtrl::SetHScrollBar}\label{wxstyledtextctrlsethscrollbar}

\func{void}{SetHScrollBar}{\param{wxScrollBar* }{bar}}

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


\membersection{wxStyledTextCtrl::SetHighlightGuide}\label{wxstyledtextctrlsethighlightguide}

\func{void}{SetHighlightGuide}{\param{int }{column}}

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


\membersection{wxStyledTextCtrl::SetHotspotActiveBackground}\label{wxstyledtextctrlsethotspotactivebackground}

\func{void}{SetHotspotActiveBackground}{\param{bool }{useSetting}, \param{const wxColour\& }{back}}

Set a back colour for active hotspots.


\membersection{wxStyledTextCtrl::SetHotspotActiveForeground}\label{wxstyledtextctrlsethotspotactiveforeground}

\func{void}{SetHotspotActiveForeground}{\param{bool }{useSetting}, \param{const wxColour\& }{fore}}

Set a fore colour for active hotspots.


\membersection{wxStyledTextCtrl::SetHotspotActiveUnderline}\label{wxstyledtextctrlsethotspotactiveunderline}

\func{void}{SetHotspotActiveUnderline}{\param{bool }{underline}}

Enable / Disable underlining active hotspots.


\membersection{wxStyledTextCtrl::SetHotspotSingleLine}\label{wxstyledtextctrlsethotspotsingleline}

\func{void}{SetHotspotSingleLine}{\param{bool }{singleLine}}

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


\membersection{wxStyledTextCtrl::SetIndent}\label{wxstyledtextctrlsetindent}

\func{void}{SetIndent}{\param{int }{indentSize}}

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


\membersection{wxStyledTextCtrl::SetIndentationGuides}\label{wxstyledtextctrlsetindentationguides}

\func{void}{SetIndentationGuides}{\param{bool }{show}}

Show or hide indentation guides.


\membersection{wxStyledTextCtrl::SetKeyWords}\label{wxstyledtextctrlsetkeywords}

\func{void}{SetKeyWords}{\param{int }{keywordSet}, \param{const wxString\& }{keyWords}}

Set up the key words used by the lexer.


\membersection{wxStyledTextCtrl::SetLastKeydownProcessed}\label{wxstyledtextctrlsetlastkeydownprocessed}

\func{void}{SetLastKeydownProcessed}{\param{bool }{val}}


\membersection{wxStyledTextCtrl::SetLayoutCache}\label{wxstyledtextctrlsetlayoutcache}

\func{void}{SetLayoutCache}{\param{int }{mode}}

Sets the degree of caching of layout information.


\membersection{wxStyledTextCtrl::SetLexer}\label{wxstyledtextctrlsetlexer}

\func{void}{SetLexer}{\param{int }{lexer}}

Set the lexing language of the document.


\membersection{wxStyledTextCtrl::SetLexerLanguage}\label{wxstyledtextctrlsetlexerlanguage}

\func{void}{SetLexerLanguage}{\param{const wxString\& }{language}}

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


\membersection{wxStyledTextCtrl::SetLineIndentation}\label{wxstyledtextctrlsetlineindentation}

\func{void}{SetLineIndentation}{\param{int }{line}, \param{int }{indentSize}}

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


\membersection{wxStyledTextCtrl::SetLineState}\label{wxstyledtextctrlsetlinestate}

\func{void}{SetLineState}{\param{int }{line}, \param{int }{state}}

Used to hold extra styling information for each line.


\membersection{wxStyledTextCtrl::SetMarginLeft}\label{wxstyledtextctrlsetmarginleft}

\func{void}{SetMarginLeft}{\param{int }{pixelWidth}}

Sets the size in pixels of the left margin.


\membersection{wxStyledTextCtrl::SetMarginMask}\label{wxstyledtextctrlsetmarginmask}

\func{void}{SetMarginMask}{\param{int }{margin}, \param{int }{mask}}

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


\membersection{wxStyledTextCtrl::SetMarginRight}\label{wxstyledtextctrlsetmarginright}

\func{void}{SetMarginRight}{\param{int }{pixelWidth}}

Sets the size in pixels of the right margin.


\membersection{wxStyledTextCtrl::SetMarginSensitive}\label{wxstyledtextctrlsetmarginsensitive}

\func{void}{SetMarginSensitive}{\param{int }{margin}, \param{bool }{sensitive}}

Make a margin sensitive or insensitive to mouse clicks.


\membersection{wxStyledTextCtrl::SetMarginType}\label{wxstyledtextctrlsetmargintype}

\func{void}{SetMarginType}{\param{int }{margin}, \param{int }{marginType}}

Set a margin to be either numeric or symbolic.


\membersection{wxStyledTextCtrl::SetMarginWidth}\label{wxstyledtextctrlsetmarginwidth}

\func{void}{SetMarginWidth}{\param{int }{margin}, \param{int }{pixelWidth}}

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


\membersection{wxStyledTextCtrl::SetMargins}\label{wxstyledtextctrlsetmargins}

\func{void}{SetMargins}{\param{int }{left}, \param{int }{right}}

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


\membersection{wxStyledTextCtrl::SetModEventMask}\label{wxstyledtextctrlsetmodeventmask}

\func{void}{SetModEventMask}{\param{int }{mask}}

Set which document modification events are sent to the container.


\membersection{wxStyledTextCtrl::SetMouseDownCaptures}\label{wxstyledtextctrlsetmousedowncaptures}

\func{void}{SetMouseDownCaptures}{\param{bool }{captures}}

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


\membersection{wxStyledTextCtrl::SetMouseDwellTime}\label{wxstyledtextctrlsetmousedwelltime}

\func{void}{SetMouseDwellTime}{\param{int }{periodMilliseconds}}

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


\membersection{wxStyledTextCtrl::SetOvertype}\label{wxstyledtextctrlsetovertype}

\func{void}{SetOvertype}{\param{bool }{overtype}}

Set to overtype (true) or insert mode.


\membersection{wxStyledTextCtrl::SetPasteConvertEndings}\label{wxstyledtextctrlsetpasteconvertendings}

\func{void}{SetPasteConvertEndings}{\param{bool }{convert}}

Enable/Disable convert-on-paste for line endings


\membersection{wxStyledTextCtrl::SetPrintColourMode}\label{wxstyledtextctrlsetprintcolourmode}

\func{void}{SetPrintColourMode}{\param{int }{mode}}

Modify colours when printing for clearer printed text.


\membersection{wxStyledTextCtrl::SetPrintMagnification}\label{wxstyledtextctrlsetprintmagnification}

\func{void}{SetPrintMagnification}{\param{int }{magnification}}

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


\membersection{wxStyledTextCtrl::SetPrintWrapMode}\label{wxstyledtextctrlsetprintwrapmode}

\func{void}{SetPrintWrapMode}{\param{int }{mode}}

Set printing to line wrapped (SC\_WRAP\_WORD) or not line wrapped (SC\_WRAP\_NONE).


\membersection{wxStyledTextCtrl::SetProperty}\label{wxstyledtextctrlsetproperty}

\func{void}{SetProperty}{\param{const wxString\& }{key}, \param{const wxString\& }{value}}

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


\membersection{wxStyledTextCtrl::SetReadOnly}\label{wxstyledtextctrlsetreadonly}

\func{void}{SetReadOnly}{\param{bool }{readOnly}}

Set to read only or read write.


\membersection{wxStyledTextCtrl::SetSTCCursor}\label{wxstyledtextctrlsetstccursor}

\func{void}{SetSTCCursor}{\param{int }{cursorType}}

Sets the cursor to one of the SC\_CURSOR* values.


\membersection{wxStyledTextCtrl::SetSTCFocus}\label{wxstyledtextctrlsetstcfocus}

\func{void}{SetSTCFocus}{\param{bool }{focus}}

Change internal focus flag.


\membersection{wxStyledTextCtrl::SetSavePoint}\label{wxstyledtextctrlsetsavepoint}

\func{void}{SetSavePoint}{\void}

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


\membersection{wxStyledTextCtrl::SetScrollWidth}\label{wxstyledtextctrlsetscrollwidth}

\func{void}{SetScrollWidth}{\param{int }{pixelWidth}}

Sets the document width assumed for scrolling.


\membersection{wxStyledTextCtrl::SetSearchFlags}\label{wxstyledtextctrlsetsearchflags}

\func{void}{SetSearchFlags}{\param{int }{flags}}

Set the search flags used by SearchInTarget.


\membersection{wxStyledTextCtrl::SetSelAlpha}\label{wxstyledtextctrlsetselalpha}

\func{void}{SetSelAlpha}{\param{int }{alpha}}

Set the alpha of the selection.


\membersection{wxStyledTextCtrl::SetSelBackground}\label{wxstyledtextctrlsetselbackground}

\func{void}{SetSelBackground}{\param{bool }{useSetting}, \param{const wxColour\& }{back}}

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


\membersection{wxStyledTextCtrl::SetSelForeground}\label{wxstyledtextctrlsetselforeground}

\func{void}{SetSelForeground}{\param{bool }{useSetting}, \param{const wxColour\& }{fore}}

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


\membersection{wxStyledTextCtrl::SetSelection}\label{wxstyledtextctrlsetselection}

\func{void}{SetSelection}{\param{int }{start}, \param{int }{end}}

Select a range of text.


\membersection{wxStyledTextCtrl::SetSelectionEnd}\label{wxstyledtextctrlsetselectionend}

\func{void}{SetSelectionEnd}{\param{int }{pos}}

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


\membersection{wxStyledTextCtrl::SetSelectionMode}\label{wxstyledtextctrlsetselectionmode}

\func{void}{SetSelectionMode}{\param{int }{mode}}

Set the selection mode to stream (SC\_SEL\_STREAM) or rectangular (SC\_SEL\_RECTANGLE) or
by lines (SC\_SEL\_LINES).


\membersection{wxStyledTextCtrl::SetSelectionStart}\label{wxstyledtextctrlsetselectionstart}

\func{void}{SetSelectionStart}{\param{int }{pos}}

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


\membersection{wxStyledTextCtrl::SetStatus}\label{wxstyledtextctrlsetstatus}

\func{void}{SetStatus}{\param{int }{statusCode}}

Change error status - 0 = OK.


\membersection{wxStyledTextCtrl::SetStyleBits}\label{wxstyledtextctrlsetstylebits}

\func{void}{SetStyleBits}{\param{int }{bits}}

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


\membersection{wxStyledTextCtrl::SetStyleBytes}\label{wxstyledtextctrlsetstylebytes}

\func{void}{SetStyleBytes}{\param{int }{length}, \param{char* }{styleBytes}}

Set the styles for a segment of the document.


\membersection{wxStyledTextCtrl::SetStyling}\label{wxstyledtextctrlsetstyling}

\func{void}{SetStyling}{\param{int }{length}, \param{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.


\membersection{wxStyledTextCtrl::SetTabIndents}\label{wxstyledtextctrlsettabindents}

\func{void}{SetTabIndents}{\param{bool }{tabIndents}}

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


\membersection{wxStyledTextCtrl::SetTabWidth}\label{wxstyledtextctrlsettabwidth}

\func{void}{SetTabWidth}{\param{int }{tabWidth}}

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


\membersection{wxStyledTextCtrl::SetTargetEnd}\label{wxstyledtextctrlsettargetend}

\func{void}{SetTargetEnd}{\param{int }{pos}}

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


\membersection{wxStyledTextCtrl::SetTargetStart}\label{wxstyledtextctrlsettargetstart}

\func{void}{SetTargetStart}{\param{int }{pos}}

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


\membersection{wxStyledTextCtrl::SetText}\label{wxstyledtextctrlsettext}

\func{void}{SetText}{\param{const wxString\& }{text}}

Replace the contents of the document with the argument text.


\membersection{wxStyledTextCtrl::SetTextRaw}\label{wxstyledtextctrlsettextraw}

\func{void}{SetTextRaw}{\param{const char* }{text}}

Replace the contents of the document with the argument text.


\membersection{wxStyledTextCtrl::SetTwoPhaseDraw}\label{wxstyledtextctrlsettwophasedraw}

\func{void}{SetTwoPhaseDraw}{\param{bool }{twoPhase}}

In twoPhaseDraw mode, drawing is performed in two phases, first the background
and then the foreground. This avoids chopping off characters that overlap the next run.


\membersection{wxStyledTextCtrl::SetUndoCollection}\label{wxstyledtextctrlsetundocollection}

\func{void}{SetUndoCollection}{\param{bool }{collectUndo}}

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


\membersection{wxStyledTextCtrl::SetUseAntiAliasing}\label{wxstyledtextctrlsetuseantialiasing}

\func{void}{SetUseAntiAliasing}{\param{bool }{useAA}}

Specify whether anti-aliased fonts should be used.  Will have no effect
on some platforms, but on some (wxMac for example) can greatly improve
performance.


\membersection{wxStyledTextCtrl::SetUseHorizontalScrollBar}\label{wxstyledtextctrlsetusehorizontalscrollbar}

\func{void}{SetUseHorizontalScrollBar}{\param{bool }{show}}

Show or hide the horizontal scroll bar.


\membersection{wxStyledTextCtrl::SetUseTabs}\label{wxstyledtextctrlsetusetabs}

\func{void}{SetUseTabs}{\param{bool }{useTabs}}

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


\membersection{wxStyledTextCtrl::SetUseVerticalScrollBar}\label{wxstyledtextctrlsetuseverticalscrollbar}

\func{void}{SetUseVerticalScrollBar}{\param{bool }{show}}

Show or hide the vertical scroll bar.


\membersection{wxStyledTextCtrl::SetVScrollBar}\label{wxstyledtextctrlsetvscrollbar}

\func{void}{SetVScrollBar}{\param{wxScrollBar* }{bar}}

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


\membersection{wxStyledTextCtrl::SetViewEOL}\label{wxstyledtextctrlsetvieweol}

\func{void}{SetViewEOL}{\param{bool }{visible}}

Make the end of line characters visible or invisible.


\membersection{wxStyledTextCtrl::SetViewWhiteSpace}\label{wxstyledtextctrlsetviewwhitespace}

\func{void}{SetViewWhiteSpace}{\param{int }{viewWS}}

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


\membersection{wxStyledTextCtrl::SetVisiblePolicy}\label{wxstyledtextctrlsetvisiblepolicy}

\func{void}{SetVisiblePolicy}{\param{int }{visiblePolicy}, \param{int }{visibleSlop}}

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


\membersection{wxStyledTextCtrl::SetWhitespaceBackground}\label{wxstyledtextctrlsetwhitespacebackground}

\func{void}{SetWhitespaceBackground}{\param{bool }{useSetting}, \param{const wxColour\& }{back}}

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


\membersection{wxStyledTextCtrl::SetWhitespaceChars}\label{wxstyledtextctrlsetwhitespacechars}

\func{void}{SetWhitespaceChars}{\param{const wxString\& }{characters}}

Set the set of characters making up whitespace for when moving or selecting by word.
Should be called after SetWordChars.


\membersection{wxStyledTextCtrl::SetWhitespaceForeground}\label{wxstyledtextctrlsetwhitespaceforeground}

\func{void}{SetWhitespaceForeground}{\param{bool }{useSetting}, \param{const wxColour\& }{fore}}

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


\membersection{wxStyledTextCtrl::SetWordChars}\label{wxstyledtextctrlsetwordchars}

\func{void}{SetWordChars}{\param{const wxString\& }{characters}}

Set the set of characters making up words for when moving or selecting by word.
First sets deaults like SetCharsDefault.


\membersection{wxStyledTextCtrl::SetWrapMode}\label{wxstyledtextctrlsetwrapmode}

\func{void}{SetWrapMode}{\param{int }{mode}}

Sets whether text is word wrapped.


\membersection{wxStyledTextCtrl::SetWrapStartIndent}\label{wxstyledtextctrlsetwrapstartindent}

\func{void}{SetWrapStartIndent}{\param{int }{indent}}

Set the start indent for wrapped lines.


\membersection{wxStyledTextCtrl::SetWrapVisualFlags}\label{wxstyledtextctrlsetwrapvisualflags}

\func{void}{SetWrapVisualFlags}{\param{int }{wrapVisualFlags}}

Set the display mode of visual flags for wrapped lines.


\membersection{wxStyledTextCtrl::SetWrapVisualFlagsLocation}\label{wxstyledtextctrlsetwrapvisualflagslocation}

\func{void}{SetWrapVisualFlagsLocation}{\param{int }{wrapVisualFlagsLocation}}

Set the location of visual flags for wrapped lines.


\membersection{wxStyledTextCtrl::SetXCaretPolicy}\label{wxstyledtextctrlsetxcaretpolicy}

\func{void}{SetXCaretPolicy}{\param{int }{caretPolicy}, \param{int }{caretSlop}}

Set the way the caret is kept visible when going sideway.
The exclusion zone is given in pixels.


\membersection{wxStyledTextCtrl::SetXOffset}\label{wxstyledtextctrlsetxoffset}

\func{void}{SetXOffset}{\param{int }{newOffset}}

Get and Set the xOffset (ie, horizonal scroll position).


\membersection{wxStyledTextCtrl::SetYCaretPolicy}\label{wxstyledtextctrlsetycaretpolicy}

\func{void}{SetYCaretPolicy}{\param{int }{caretPolicy}, \param{int }{caretSlop}}

Set the way the line the caret is on is kept visible.
The exclusion zone is given in lines.


\membersection{wxStyledTextCtrl::SetZoom}\label{wxstyledtextctrlsetzoom}

\func{void}{SetZoom}{\param{int }{zoom}}

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


\membersection{wxStyledTextCtrl::ShowLines}\label{wxstyledtextctrlshowlines}

\func{void}{ShowLines}{\param{int }{lineStart}, \param{int }{lineEnd}}

Make a range of lines visible.


\membersection{wxStyledTextCtrl::StartRecord}\label{wxstyledtextctrlstartrecord}

\func{void}{StartRecord}{\void}

Start notifying the container of all key presses and commands.


\membersection{wxStyledTextCtrl::StartStyling}\label{wxstyledtextctrlstartstyling}

\func{void}{StartStyling}{\param{int }{pos}, \param{int }{mask}}

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


\membersection{wxStyledTextCtrl::StopRecord}\label{wxstyledtextctrlstoprecord}

\func{void}{StopRecord}{\void}

Stop notifying the container of all key presses and commands.


\membersection{wxStyledTextCtrl::StutteredPageDown}\label{wxstyledtextctrlstutteredpagedown}

\func{void}{StutteredPageDown}{\void}

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


\membersection{wxStyledTextCtrl::StutteredPageDownExtend}\label{wxstyledtextctrlstutteredpagedownextend}

\func{void}{StutteredPageDownExtend}{\void}

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


\membersection{wxStyledTextCtrl::StutteredPageUp}\label{wxstyledtextctrlstutteredpageup}

\func{void}{StutteredPageUp}{\void}

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


\membersection{wxStyledTextCtrl::StutteredPageUpExtend}\label{wxstyledtextctrlstutteredpageupextend}

\func{void}{StutteredPageUpExtend}{\void}

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


\membersection{wxStyledTextCtrl::StyleClearAll}\label{wxstyledtextctrlstyleclearall}

\func{void}{StyleClearAll}{\void}

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


\membersection{wxStyledTextCtrl::StyleResetDefault}\label{wxstyledtextctrlstyleresetdefault}

\func{void}{StyleResetDefault}{\void}

Reset the default style to its state at startup


\membersection{wxStyledTextCtrl::StyleSetBackground}\label{wxstyledtextctrlstylesetbackground}

\func{void}{StyleSetBackground}{\param{int }{style}, \param{const wxColour\& }{back}}

Set the background colour of a style.


\membersection{wxStyledTextCtrl::StyleSetBold}\label{wxstyledtextctrlstylesetbold}

\func{void}{StyleSetBold}{\param{int }{style}, \param{bool }{bold}}

Set a style to be bold or not.


\membersection{wxStyledTextCtrl::StyleSetCase}\label{wxstyledtextctrlstylesetcase}

\func{void}{StyleSetCase}{\param{int }{style}, \param{int }{caseForce}}

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


\membersection{wxStyledTextCtrl::StyleSetChangeable}\label{wxstyledtextctrlstylesetchangeable}

\func{void}{StyleSetChangeable}{\param{int }{style}, \param{bool }{changeable}}

Set a style to be changeable or not (read only).
Experimental feature, currently buggy.


\membersection{wxStyledTextCtrl::StyleSetCharacterSet}\label{wxstyledtextctrlstylesetcharacterset}

\func{void}{StyleSetCharacterSet}{\param{int }{style}, \param{int }{characterSet}}

Set the character set of the font in a style.  Converts the Scintilla
character set values to a wxFontEncoding.


\membersection{wxStyledTextCtrl::StyleSetEOLFilled}\label{wxstyledtextctrlstyleseteolfilled}

\func{void}{StyleSetEOLFilled}{\param{int }{style}, \param{bool }{filled}}

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


\membersection{wxStyledTextCtrl::StyleSetFaceName}\label{wxstyledtextctrlstylesetfacename}

\func{void}{StyleSetFaceName}{\param{int }{style}, \param{const wxString\& }{fontName}}

Set the font of a style.


\membersection{wxStyledTextCtrl::StyleSetFont}\label{wxstyledtextctrlstylesetfont}

\func{void}{StyleSetFont}{\param{int }{styleNum}, \param{wxFont\& }{font}}

Set style size, face, bold, italic, and underline attributes from
a wxFont's attributes.


\membersection{wxStyledTextCtrl::StyleSetFontAttr}\label{wxstyledtextctrlstylesetfontattr}

\func{void}{StyleSetFontAttr}{\param{int }{styleNum}, \param{int }{size}, \param{const wxString\& }{faceName}, \param{bool }{bold}, \param{bool }{italic}, \param{bool }{underline}, \param{wxFontEncoding }{encoding = wxFONTENCODING\_DEFAULT}}

Set all font style attributes at once.


\membersection{wxStyledTextCtrl::StyleSetFontEncoding}\label{wxstyledtextctrlstylesetfontencoding}

\func{void}{StyleSetFontEncoding}{\param{int }{style}, \param{wxFontEncoding }{encoding}}

Set the font encoding to be used by a style.


\membersection{wxStyledTextCtrl::StyleSetForeground}\label{wxstyledtextctrlstylesetforeground}

\func{void}{StyleSetForeground}{\param{int }{style}, \param{const wxColour\& }{fore}}

Set the foreground colour of a style.


\membersection{wxStyledTextCtrl::StyleSetHotSpot}\label{wxstyledtextctrlstylesethotspot}

\func{void}{StyleSetHotSpot}{\param{int }{style}, \param{bool }{hotspot}}

Set a style to be a hotspot or not.


\membersection{wxStyledTextCtrl::StyleSetItalic}\label{wxstyledtextctrlstylesetitalic}

\func{void}{StyleSetItalic}{\param{int }{style}, \param{bool }{italic}}

Set a style to be italic or not.


\membersection{wxStyledTextCtrl::StyleSetSize}\label{wxstyledtextctrlstylesetsize}

\func{void}{StyleSetSize}{\param{int }{style}, \param{int }{sizePoints}}

Set the size of characters of a style.


\membersection{wxStyledTextCtrl::StyleSetSpec}\label{wxstyledtextctrlstylesetspec}

\func{void}{StyleSetSpec}{\param{int }{styleNum}, \param{const wxString\& }{spec}}

Extract style settings from a spec-string which is composed of one or
more of the following comma separated elements:
bold                    turns on bold
italic                  turns on italics
fore:[name or \#RRGGBB]  sets the foreground colour
back:[name or \#RRGGBB]  sets the background colour
face:[facename]         sets the font face name to use
size:[num]              sets the font size in points
eol                     turns on eol filling
underline               turns on underlining


\membersection{wxStyledTextCtrl::StyleSetUnderline}\label{wxstyledtextctrlstylesetunderline}

\func{void}{StyleSetUnderline}{\param{int }{style}, \param{bool }{underline}}

Set a style to be underlined or not.


\membersection{wxStyledTextCtrl::StyleSetVisible}\label{wxstyledtextctrlstylesetvisible}

\func{void}{StyleSetVisible}{\param{int }{style}, \param{bool }{visible}}

Set a style to be visible or not.


\membersection{wxStyledTextCtrl::Tab}\label{wxstyledtextctrltab}

\func{void}{Tab}{\void}

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


\membersection{wxStyledTextCtrl::TargetFromSelection}\label{wxstyledtextctrltargetfromselection}

\func{void}{TargetFromSelection}{\void}

Make the target range start and end be the same as the selection range start and end.


\membersection{wxStyledTextCtrl::TextHeight}\label{wxstyledtextctrltextheight}

\func{int}{TextHeight}{\param{int }{line}}

Retrieve the height of a particular line of text in pixels.


\membersection{wxStyledTextCtrl::TextWidth}\label{wxstyledtextctrltextwidth}

\func{int}{TextWidth}{\param{int }{style}, \param{const wxString\& }{text}}

Measure the pixel width of some text in a particular style.
NUL terminated text argument.
Does not handle tab or control characters.


\membersection{wxStyledTextCtrl::ToggleCaretSticky}\label{wxstyledtextctrltogglecaretsticky}

\func{void}{ToggleCaretSticky}{\void}

Switch between sticky and non-sticky: meant to be bound to a key.


\membersection{wxStyledTextCtrl::ToggleFold}\label{wxstyledtextctrltogglefold}

\func{void}{ToggleFold}{\param{int }{line}}

Switch a header line between expanded and contracted.


\membersection{wxStyledTextCtrl::Undo}\label{wxstyledtextctrlundo}

\func{void}{Undo}{\void}

Undo one action in the undo history.


\membersection{wxStyledTextCtrl::UpperCase}\label{wxstyledtextctrluppercase}

\func{void}{UpperCase}{\void}

Transform the selection to upper case.


\membersection{wxStyledTextCtrl::UsePopUp}\label{wxstyledtextctrlusepopup}

\func{void}{UsePopUp}{\param{bool }{allowPopUp}}

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


\membersection{wxStyledTextCtrl::UserListShow}\label{wxstyledtextctrluserlistshow}

\func{void}{UserListShow}{\param{int }{listType}, \param{const wxString\& }{itemList}}

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


\membersection{wxStyledTextCtrl::VCHome}\label{wxstyledtextctrlvchome}

\func{void}{VCHome}{\void}

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


\membersection{wxStyledTextCtrl::VCHomeExtend}\label{wxstyledtextctrlvchomeextend}

\func{void}{VCHomeExtend}{\void}

Like VCHome but extending selection to new caret position.


\membersection{wxStyledTextCtrl::VCHomeRectExtend}\label{wxstyledtextctrlvchomerectextend}

\func{void}{VCHomeRectExtend}{\void}

Move caret to before first visible character on line.
If already there move to first character on line.
In either case, extend rectangular selection to new caret position.


\membersection{wxStyledTextCtrl::VCHomeWrap}\label{wxstyledtextctrlvchomewrap}

\func{void}{VCHomeWrap}{\void}


\membersection{wxStyledTextCtrl::VCHomeWrapExtend}\label{wxstyledtextctrlvchomewrapextend}

\func{void}{VCHomeWrapExtend}{\void}


\membersection{wxStyledTextCtrl::VisibleFromDocLine}\label{wxstyledtextctrlvisiblefromdocline}

\func{int}{VisibleFromDocLine}{\param{int }{line}}

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


\membersection{wxStyledTextCtrl::WordEndPosition}\label{wxstyledtextctrlwordendposition}

\func{int}{WordEndPosition}{\param{int }{pos}, \param{bool }{onlyWordCharacters}}

Get position of end of word.


\membersection{wxStyledTextCtrl::WordLeft}\label{wxstyledtextctrlwordleft}

\func{void}{WordLeft}{\void}

Move caret left one word.


\membersection{wxStyledTextCtrl::WordLeftEnd}\label{wxstyledtextctrlwordleftend}

\func{void}{WordLeftEnd}{\void}

Move caret left one word, position cursor at end of word.


\membersection{wxStyledTextCtrl::WordLeftEndExtend}\label{wxstyledtextctrlwordleftendextend}

\func{void}{WordLeftEndExtend}{\void}

Move caret left one word, position cursor at end of word, extending selection to new caret position.


\membersection{wxStyledTextCtrl::WordLeftExtend}\label{wxstyledtextctrlwordleftextend}

\func{void}{WordLeftExtend}{\void}

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


\membersection{wxStyledTextCtrl::WordPartLeft}\label{wxstyledtextctrlwordpartleft}

\func{void}{WordPartLeft}{\void}

Move to the previous change in capitalisation.


\membersection{wxStyledTextCtrl::WordPartLeftExtend}\label{wxstyledtextctrlwordpartleftextend}

\func{void}{WordPartLeftExtend}{\void}

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


\membersection{wxStyledTextCtrl::WordPartRight}\label{wxstyledtextctrlwordpartright}

\func{void}{WordPartRight}{\void}

Move to the change next in capitalisation.


\membersection{wxStyledTextCtrl::WordPartRightExtend}\label{wxstyledtextctrlwordpartrightextend}

\func{void}{WordPartRightExtend}{\void}

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


\membersection{wxStyledTextCtrl::WordRight}\label{wxstyledtextctrlwordright}

\func{void}{WordRight}{\void}

Move caret right one word.


\membersection{wxStyledTextCtrl::WordRightEnd}\label{wxstyledtextctrlwordrightend}

\func{void}{WordRightEnd}{\void}

Move caret right one word, position cursor at end of word.


\membersection{wxStyledTextCtrl::WordRightEndExtend}\label{wxstyledtextctrlwordrightendextend}

\func{void}{WordRightEndExtend}{\void}

Move caret right one word, position cursor at end of word, extending selection to new caret position.


\membersection{wxStyledTextCtrl::WordRightExtend}\label{wxstyledtextctrlwordrightextend}

\func{void}{WordRightExtend}{\void}

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


\membersection{wxStyledTextCtrl::WordStartPosition}\label{wxstyledtextctrlwordstartposition}

\func{int}{WordStartPosition}{\param{int }{pos}, \param{bool }{onlyWordCharacters}}

Get position of start of word.


\membersection{wxStyledTextCtrl::WrapCount}\label{wxstyledtextctrlwrapcount}

\func{int}{WrapCount}{\param{int }{line}}

The number of display lines needed to wrap a document line


\membersection{wxStyledTextCtrl::ZoomIn}\label{wxstyledtextctrlzoomin}

\func{void}{ZoomIn}{\void}

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


\membersection{wxStyledTextCtrl::ZoomOut}\label{wxstyledtextctrlzoomout}

\func{void}{ZoomOut}{\void}

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