wx.stc.StyledTextEvent

The type of events sent from wx.stc.StyledTextCtrl.

Events Emitted by this Class

Handlers bound for the following event types will receive a wx.stc.StyledTextEvent parameter.

• EVT_STC_AUTOCOMP_CANCELLED(id, fn): Process a wxEVT_STC_AUTOCOMP_CANCELLED event.

• EVT_STC_AUTOCOMP_CHAR_DELETED(id, fn): Process a wxEVT_STC_AUTOCOMP_CHAR_DELETED event.

• EVT_STC_AUTOCOMP_COMPLETED(id, fn): Process a wxEVT_STC_AUTOCOMP_COMPLETED event.

  Added in version 4.1/wxWidgets-3.1.1.

• EVT_STC_AUTOCOMP_SELECTION(id, fn): Process a wxEVT_STC_AUTOCOMP_SELECTION event.

• EVT_STC_AUTOCOMP_SELECTION_CHANGE(id, fn): Process a wxEVT_STC_AUTOCOMP_SELECTION_CHANGE event.

  Added in version 4.1/wxWidgets-3.1.3.

• EVT_STC_CALLTIP_CLICK(id, fn): Process a wxEVT_STC_CALLTIP_CLICK event.

• EVT_STC_CHANGE(id, fn): Process a wxEVT_STC_CHANGE event.

• EVT_STC_CHARADDED(id, fn): Process a wxEVT_STC_CHARADDED event.

• EVT_STC_CLIPBOARD_COPY(id, fn): Process a wxEVT_STC_CLIPBOARD_COPY event.

  Added in version 4.1/wxWidgets-3.1.0.

• EVT_STC_CLIPBOARD_PASTE(id, fn): Process a wxEVT_STC_CLIPBOARD_PASTE event.

  Added in version 4.1/wxWidgets-3.1.0.

• EVT_STC_DO_DROP(id, fn): Process a wxEVT_STC_DO_DROP event.

• EVT_STC_DOUBLECLICK(id, fn): Process a wxEVT_STC_DOUBLECLICK event.

• EVT_STC_DRAG_OVER(id, fn): Process a wxEVT_STC_DRAG_OVER event.

• EVT_STC_DWELLEND(id, fn): Process a wxEVT_STC_DWELLEND event.

• EVT_STC_DWELLSTART(id, fn): Process a wxEVT_STC_DWELLSTART event.

• EVT_STC_HOTSPOT_CLICK(id, fn): Process a wxEVT_STC_HOTSPOT_CLICK event.

• EVT_STC_HOTSPOT_DCLICK(id, fn): Process a wxEVT_STC_HOTSPOT_DCLICK event.

• EVT_STC_HOTSPOT_RELEASE_CLICK(id, fn): Process a wxEVT_STC_HOTSPOT_RELEASE_CLICK event.

• EVT_STC_INDICATOR_CLICK(id, fn): Process a wxEVT_STC_INDICATOR_CLICK event.

• EVT_STC_INDICATOR_RELEASE(id, fn): Process a wxEVT_STC_INDICATOR_RELEASE event.

• EVT_STC_MACRORECORD(id, fn): Process a wxEVT_STC_MACRORECORD event.

• EVT_STC_MARGIN_RIGHT_CLICK(id, fn): Process a wxEVT_STC_MARGIN_RIGHT_CLICK event.

  Added in version 4.1/wxWidgets-3.1.1.

• EVT_STC_MARGINCLICK(id, fn): Process a wxEVT_STC_MARGINCLICK event.

• EVT_STC_MODIFIED(id, fn): Process a wxEVT_STC_MODIFIED event.

• EVT_STC_NEEDSHOWN(id, fn): Process a wxEVT_STC_NEEDSHOWN event.

• EVT_STC_PAINTED(id, fn): Process a wxEVT_STC_PAINTED event.

• EVT_STC_ROMODIFYATTEMPT(id, fn): Process a wxEVT_STC_ROMODIFYATTEMPT event.

• EVT_STC_SAVEPOINTLEFT(id, fn): Process a wxEVT_STC_SAVEPOINTLEFT event.

• EVT_STC_SAVEPOINTREACHED(id, fn): Process a wxEVT_STC_SAVEPOINTREACHED event.

• EVT_STC_START_DRAG(id, fn): Process a wxEVT_STC_START_DRAG event.

• EVT_STC_STYLENEEDED(id, fn): Process a wxEVT_STC_STYLENEEDED event.

• EVT_STC_UPDATEUI(id, fn): Process a wxEVT_STC_UPDATEUI event.

• EVT_STC_USERLISTSELECTION(id, fn): Process a wxEVT_STC_USERLISTSELECTION event.

• EVT_STC_ZOOM(id, fn): Process a wxEVT_STC_ZOOM event.

Most of the Scintilla notifications are mapped to a similarly named wx.stc.StyledTextEvent. However a few of the notifications would only offer information available in other wxWidgets event types, and in those cases a corresponding wx.stc.StyledTextEvent is not defined. Currently, the wxEVT_KEY_DOWN event is used instead of the SCN_KEY notification. The regular wxWidgets drag and drop functionality can be used instead of the SCN_URIDROPPED notification. The wxEVT_SET_FOCUS event is used instead of the SCN_FOCUSIN notification. And the wxEVT_KILL_FOCUS event is used instead of the SCN_FOCUSOUT notification.

Event Types

The following is a brief description of when the control generates these events and a list of which methods provide relevant information. Additional details can be found in the Scintilla documentation (http://www.scintilla.org/ScintillaDoc.html#Notifications). wxEVT_STC_AUTOCOMP_CANCELLED

• Generated when an autocompletion list has been canceled.

• Valid event functions: none.

wxEVT_STC_AUTOCOMP_CHAR_DELETED

• Generated when a character has been deleted from an autocompletion list.

• Valid event functions: none.

wxEVT_STC_AUTOCOMP_COMPLETED

• Generated after an autocompletion list has closed and inserted its text into the control.

• Valid event functions: GetKey, GetPosition, GetString GetListCompletionMethod.

wxEVT_STC_AUTOCOMP_SELECTION

• Generated when an entry has been selected in an autocompletion list but before the text has been inserted.

• To prevent the insertion, call wx.stc.StyledTextCtrl.AutoCompCancel in the event handler.

• Valid event functions: GetKey, GetPosition, GetString GetListCompletionMethod.

wxEVT_STC_AUTOCOMP_SELECTION_CHANGE

• Generated when items are highlighted in an autocompletion or user list.

• GetPosition will return the position at which the list is being shown.

• For a user list, GetListType will return the list type. The list type is a value input in to the wx.stc.StyledTextCtrl.UserListShow method when a user list is created.

• For an autocompletion list, GetListType will always return zero.

• Valid event functions: GetListType, GetPosition, GetString

wxEVT_STC_CALLTIP_CLICK

• Generated when a calltip has been clicked.

• GetPosition will return 1 if the up arrow has been clicked, 2 if the down arrow has been clicked, and 0 for all other clicks.

• Valid event functions: GetPosition.

wxEVT_STC_CHANGE

• Generated when the text of the document has changed.

• This an older style event and should probably not be used in new code. Use wxEVT_STC_MODIFIED instead.

• Valid event functions: none.

wxEVT_STC_CHARADDED

• Generated when a character has been added to the control.

• Valid event functions: GetKey.

wxEVT_STC_CLIPBOARD_COPY

• Generated when text is being cut or copied to the clipboard.

• Use wx.stc.StyledTextEvent.SetString to modify the text that will be placed on the clipboard.

• Valid event functions: GetString SetString

wxEVT_STC_CLIPBOARD_PASTE

• Generated when text is being pasted from the clipboard.

• Use wx.stc.StyledTextEvent.SetString to modify the text that will be inserted into the control.

• Valid event functions: GetPosition, GetString SetString

wxEVT_STC_DO_DROP

• Generated when text is being dropped into the control.

• Details of the drag may be altered by changing the respective fields of the event.

• Valid event functions: GetDragResult, SetDragResult, GetPosition, SetPosition, GetString SetString GetX, GetY.

wxEVT_STC_DOUBLECLICK

• Generated when the control has been double-clicked.

• Valid event functions: GetLine, GetModifiers, GetPosition, GetAlt, GetControl, GetShift.

wxEVT_STC_DRAG_OVER

• Generated repeatedly as text is being dragged inside the control.

• Valid event functions: GetDragResult, SetDragResult, GetPosition, GetX, GetY.

wxEVT_STC_DWELLEND

• Generated when the mouse has been moved after a wxEVT_STC_DWELLSTART event.

• Valid event functions: GetPosition, GetX, GetY.

wxEVT_STC_DWELLSTART

• Generated when the mouse has remained still for a certain amount of time.

• The amount of time can be specified with wx.stc.StyledTextCtrl.SetMouseDwellTime .

• Valid event functions: GetPosition, GetX, GetY.

wxEVT_STC_HOTSPOT_CLICK

• Generated when a hotspot has been clicked.

• Valid event functions: GetModifiers, GetPosition, GetAlt, GetControl, GetShift.

wxEVT_STC_HOTSPOT_DCLICK

• Generated when a hotspot has been double-clicked.

• Valid event functions: GetModifiers, GetPosition, GetAlt, GetControl, GetShift.

wxEVT_STC_HOTSPOT_RELEASE_CLICK

• Generated when a click-over hotspot has been released.

• Valid event functions: GetModifiers, GetPosition, GetAlt, GetControl, GetShift.

wxEVT_STC_INDICATOR_CLICK

• Generated when an indicator has been clicked.

• Valid event functions: GetModifiers, GetPosition, GetAlt, GetControl, GetShift.

wxEVT_STC_INDICATOR_RELEASE

• Generated when a click over an indicator has been released.

• Valid event functions: GetModifiers, GetPosition, GetAlt, GetControl, GetShift.

wxEVT_STC_MACRORECORD

• Generated while macro recording is in progress.

• Valid event functions: GetMessage, GetLParam, GetWParam.

wxEVT_STC_MARGIN_RIGHT_CLICK

• Generated when one of the margins is clicked with the right mouse button.

• This event is only generated if SetMarginSensitive has been called for one or more of the margins.

• Valid event functions: GetMargin, GetModifiers, GetPosition, GetAlt, GetControl, GetShift.

wxEVT_STC_MARGINCLICK

• Generated when one of the margins is clicked.

• This event is only generated if SetMarginSensitive has been called for one or more of the margins.

• Valid event functions: GetMargin, GetModifiers, GetPosition, GetAlt, GetControl, GetShift.

wxEVT_STC_MODIFIED

• Generated when the contents of the control have changed or are about to change.

• You should not attempt to make any changes to the control inside a handler for this event.

• Valid event functions: GetAnnotationsLinesAdded, GetFoldLevelNow, GetFoldLevelPrev, GetLength, GetLine, GetLinesAdded, GetModificationType, GetPosition, GetString GetToken.

wxEVT_STC_NEEDSHOWN

• Generated when certain lines should be made visible by scrolling the text in the control.

• Valid event functions: GetLength, GetPosition.

wxEVT_STC_PAINTED

• Generated when the control has been refreshed.

• Valid event functions: none.

wxEVT_STC_ROMODIFYATTEMPT

• Generated when an attempt has been made to change the control’s text after it has been set read-only.

• Valid event functions: none.

wxEVT_STC_SAVEPOINTREACHED

• Generated when the undo history has been made empty.

• Valid event functions: none.

wxEVT_STC_SAVEPOINTLEFT

• Generated when the undo history is no longer empty.

• Valid event functions: none.

wxEVT_STC_START_DRAG

• Generated when text is being dragged from the control.

• Details of the drag may be altered by changing the respective fields of the event; in particular, set an empty string to prohibit the drag entirely.

• Valid event functions: GetDragFlags, SetDragFlags, GetPosition, GetString SetString

wxEVT_STC_STYLENEEDED

• Generated when the control has determined that style bytes should be set for a portion of the document.

• These events are only sent if the lexer is set to STC_LEX_CONTAINER.

• Valid event functions: GetPosition.

wxEVT_STC_UPDATEUI

• Generated when the text, style, cursor position, selection, or scrolling of the control has changed.

• Valid event functions: GetUpdated.

wxEVT_STC_USERLISTSELECTION

• Generated when a selection has been made from a user list.

• Valid event functions: GetListType, GetPosition, GetString GetKey, GetListCompletionMethod.

wxEVT_STC_ZOOM

• Generated when the zoom factor of the control has been changed either by the user or a call to wx.stc.StyledTextCtrl.ZoomIn / ZoomOut.

• Valid event functions: none.

Class Hierarchy

Inheritance diagram for class StyledTextEvent:

Methods Summary

__init__	Constructor.
GetAlt	Returns True if the Alt key is pressed.
GetAnnotationsLinesAdded	Returns the number of lines that have been added to or removed from an annotation.
GetControl	Returns True if the Control key is pressed.
GetDragFlags	Returns flags for the drag operation associated with this event.
GetDragResult	Returns drag result for this event.
GetDragText
GetFoldLevelNow	Returns the current fold level for the line.
GetFoldLevelPrev	Returns previous fold level for the line.
GetKey	Returns the key code of the key that generated this event.
GetLParam	Returns the value of the LParam field for this event.
GetLength	Returns the length (number of characters) of this event.
GetLine	Returns zero-based line number for this event.
GetLinesAdded	Returns the number of lines added or deleted with this event.
GetListCompletionMethod	Returns a value describing the action that closed the list.
GetListType	Returns the list type for this event.
GetMargin	Returns the zero-based index of the margin that generated this event.
GetMessage	Returns a message number while a macro is being recorded.
GetModificationType	Returns the modification type for this event.
GetModifiers	Returns the modifiers of the key press or mouse click for this event.
GetPosition	Returns the zero-based text position associated this event.
GetShift	Returns True if the Shift key is pressed.
GetText
GetToken	Returns the token value for this event.
GetUpdated	Returns the value of the updated field for this event.
GetWParam	Returns value of the WParam field for this event.
GetX	Returns the X coordinate of the mouse for this event.
GetY	Returns the Y coordinate of the mouse for this event.
SetAnnotationLinesAdded	Sets the annotation lines added value for this event.
SetDragFlags	Sets the drag flags for this event.
SetDragResult	Sets the drag result for this event.
SetDragText	Sets the drag text for this event.
SetFoldLevelNow	Sets the current fold level for this event.
SetFoldLevelPrev	Sets the previous fold level for this event.
SetKey	Sets the key code for this event.
SetLParam	Sets value of the LParam field for this event.
SetLength	Sets the length value for this event.
SetLine	Sets line number for this event.
SetLinesAdded	Sets the number of lines added for this event.
SetListCompletionMethod	Sets the list completion method for this event.
SetListType	Sets the list type for this event.
SetMargin	Sets margin number for this event.
SetMessage	Sets message number for this event.
SetModificationType	Sets the modification type for this event.
SetModifiers	Sets the value of the modifiers field for this event.
SetPosition	Sets file position for this event.
SetText	Sets the text for this event.
SetToken	Sets the token for this event.
SetUpdated	Sets the value of the updated field for this event.
SetWParam	Sets the value of the WParam field for this event.
SetX	Sets the X value for this event.
SetY	Sets the Y value for this event.

Properties Summary

Alt	See GetAlt
AnnotationsLinesAdded	See GetAnnotationsLinesAdded
Control	See GetControl
DragFlags	See GetDragFlags and SetDragFlags
DragResult	See GetDragResult and SetDragResult
DragText	See GetDragText and SetDragText
FoldLevelNow	See GetFoldLevelNow and SetFoldLevelNow
FoldLevelPrev	See GetFoldLevelPrev and SetFoldLevelPrev
Key	See GetKey and SetKey
LParam	See GetLParam and SetLParam
Length	See GetLength and SetLength
Line	See GetLine and SetLine
LinesAdded	See GetLinesAdded and SetLinesAdded
ListCompletionMethod	See GetListCompletionMethod and SetListCompletionMethod
ListType	See GetListType and SetListType
Margin	See GetMargin and SetMargin
Message	See GetMessage and SetMessage
ModificationType	See GetModificationType and SetModificationType
Modifiers	See GetModifiers and SetModifiers
Position	See GetPosition and SetPosition
Shift	See GetShift
Text	See GetText and SetText
Token	See GetToken and SetToken
Updated	See GetUpdated and SetUpdated
WParam	See GetWParam and SetWParam
X	See GetX and SetX
Y	See GetY and SetY

Class API

class wx.stc.StyledTextEvent(CommandEvent)

Possible constructors:

StyledTextEvent(commandType=0, id=0) -> None

StyledTextEvent(event) -> None

The type of events sent from StyledTextCtrl.

Methods

__init__(self, *args, **kw)

Overloaded Implementations:

---

__init__ (self, commandType=0, id=0)

Constructor.

Parameters:

• commandType (wx.EventType)

• id (int)

Return type:

None

---

__init__ (self, event)

Copy constructor.

Parameters:

event (wx.stc.StyledTextEvent)

Return type:

None

---

---

GetAlt(self)

Returns True if the Alt key is pressed.

This method is valid for the following event types:

• wxEVT_STC_DOUBLECLICK

• wxEVT_STC_MARGINCLICK

• wxEVT_STC_HOTSPOT_CLICK

• wxEVT_STC_HOTSPOT_DCLICK

• wxEVT_STC_HOTSPOT_RELEASE_CLICK

• wxEVT_STC_INDICATOR_CLICK

• wxEVT_STC_INDICATOR_RELEASE

• wxEVT_STC_MARGIN_RIGHT_CLICK

Return type:

bool

---

GetAnnotationsLinesAdded(self)

Returns the number of lines that have been added to or removed from an annotation.

This method is valid for wxEVT_STC_MODIFIED events when the result of GetModificationType includes STC_MOD_CHANGEANNOTATION.

Return type:

int

---

GetControl(self)

Returns True if the Control key is pressed.

This method is valid for the following event types:

• wxEVT_STC_DOUBLECLICK

• wxEVT_STC_MARGINCLICK

• wxEVT_STC_HOTSPOT_CLICK

• wxEVT_STC_HOTSPOT_DCLICK

• wxEVT_STC_HOTSPOT_RELEASE_CLICK

• wxEVT_STC_INDICATOR_CLICK

• wxEVT_STC_INDICATOR_RELEASE

• wxEVT_STC_MARGIN_RIGHT_CLICK

Return type:

bool

---

GetDragFlags(self)

Returns flags for the drag operation associated with this event.

This method is valid for wxEVT_STC_START_DRAG events.

Return type:

int

---

GetDragResult(self)

Returns drag result for this event.

This method is valid for wxEVT_STC_DRAG_OVER and wxEVT_STC_DO_DROP events.

Return type:

wx.DragResult

---

GetDragText(self)

Return type:

str

Deprecated

Use GetString instead.

---

GetFoldLevelNow(self)

Returns the current fold level for the line.

This method is valid for wxEVT_STC_MODIFIED events when the result of GetModificationType includes STC_MOD_CHANGEFOLD.

Return type:

int

---

GetFoldLevelPrev(self)

Returns previous fold level for the line.

This method is valid for wxEVT_STC_MODIFIED events when the result of GetModificationType includes STC_MOD_CHANGEFOLD.

Return type:

int

---

GetKey(self)

Returns the key code of the key that generated this event.

This method is valid for the following event types:

• wxEVT_STC_CHARADDED

• wxEVT_STC_USERLISTSELECTION

• wxEVT_STC_AUTOCOMP_SELECTION

• wxEVT_STC_AUTOCOMP_COMPLETED

Return type:

int

---

GetLParam(self)

Returns the value of the LParam field for this event.

This method is valid for wxEVT_STC_MACRORECORD events.

Return type:

int

---

GetLength(self)

Returns the length (number of characters) of this event.

This method is valid for wxEVT_STC_MODIFIED and wxEVT_STC_NEEDSHOWN events.

Return type:

int

---

GetLine(self)

Returns zero-based line number for this event.

This method is valid for wxEVT_STC_DOUBLECLICK and wxEVT_STC_MODIFIED events.

Return type:

int

---

GetLinesAdded(self)

Returns the number of lines added or deleted with this event.

This method is valid for wxEVT_STC_MODIFIED events when the result of GetModificationType includes STC_MOD_INSERTTEXT or STC_MOD_DELETETEXT.

Return type:

int

---

GetListCompletionMethod(self)

Returns a value describing the action that closed the list.

The returned value will be one of the following constants:

STC_AC_FILLUP	A fillup character caused the completion.
STC_AC_DOUBLECLICK	A double-click caused the completion.
STC_AC_TAB	The tab key caused the completion.
STC_AC_NEWLINE	The enter key caused the completion.
STC_AC_COMMAND	The wx.stc.StyledTextCtrl.AutoCompComplete method was called.

This method is valid for wxEVT_STC_USERLISTSELECTION , wxEVT_STC_AUTOCOMP_SELECTION , and wxEVT_STC_AUTOCOMP_COMPLETED events.

Return type:

int

Added in version 4.1/wxWidgets-3.1.1.

---

GetListType(self)

Returns the list type for this event.

The list type is an integer passed to a list when it is created with the wx.stc.StyledTextCtrl.UserListShow method and can be used to distinguish lists if more than one is used.

This method is valid for wxEVT_STC_AUTOCOMP_SELECTION_CHANGE and wxEVT_STC_USERLISTSELECTION events.

Return type:

int

---

GetMargin(self)

Returns the zero-based index of the margin that generated this event.

This method is valid for wxEVT_STC_MARGINCLICK and wxEVT_STC_MARGIN_RIGHT_CLICK events.

Return type:

int

---

GetMessage(self)

Returns a message number while a macro is being recorded.

Many of the wx.stc.StyledTextCtrl methods such as InsertText and Paste have an event number associated with them. This method returns that number while a macro is being recorded so that the macro can be played back later.

This method is valid for wxEVT_STC_MACRORECORD events.

Return type:

int

---

GetModificationType(self)

Returns the modification type for this event.

The modification type is a bit list that describes the change that generated this event. It may contain one or more of the following values:

• STC_MOD_INSERTTEXT

• STC_MOD_DELETETEXT

• STC_MOD_CHANGESTYLE

• STC_MOD_CHANGEFOLD

• STC_PERFORMED_USER

• STC_PERFORMED_UNDO

• STC_PERFORMED_REDO

• STC_MULTISTEPUNDOREDO

• STC_LASTSTEPINUNDOREDO

• STC_MOD_CHANGEMARKER

• STC_MOD_BEFOREINSERT

• STC_MOD_BEFOREDELETE

• STC_MULTILINEUNDOREDO

• STC_STARTACTION

• STC_MOD_CHANGEINDICATOR

• STC_MOD_CHANGELINESTATE

• STC_MOD_CHANGEMARGIN

• STC_MOD_CHANGEANNOTATION

• STC_MOD_CONTAINER

• STC_MOD_LEXERSTATE

• STC_MOD_INSERTCHECK

• STC_MOD_CHANGETABSTOPS

This method is valid for wxEVT_STC_MODIFIED events.

Return type:

int

---

GetModifiers(self)

Returns the modifiers of the key press or mouse click for this event.

The returned value is a bit list that may contain one or more of the following values:

• STC_KEYMOD_SHIFT

• STC_KEYMOD_CTRL

• STC_KEYMOD_ALT

• STC_KEYMOD_SUPER

• STC_KEYMOD_META

In addition, the value can be checked for equality with STC_KEYMOD_NORM to test if no modifiers are present.

This method is valid for the following event types:

• wxEVT_STC_DOUBLECLICK

• wxEVT_STC_MARGINCLICK

• wxEVT_STC_HOTSPOT_CLICK

• wxEVT_STC_HOTSPOT_DCLICK

• wxEVT_STC_HOTSPOT_RELEASE_CLICK

• wxEVT_STC_INDICATOR_CLICK

• wxEVT_STC_INDICATOR_RELEASE

• wxEVT_STC_MARGIN_RIGHT_CLICK

Return type:

int

---

GetPosition(self)

Returns the zero-based text position associated this event.

This method is valid for the following event types:

• wxEVT_STC_STYLENEEDED

• wxEVT_STC_DOUBLECLICK

• wxEVT_STC_MODIFIED

• wxEVT_STC_MARGINCLICK

• wxEVT_STC_NEEDSHOWN

• wxEVT_STC_USERLISTSELECTION

• wxEVT_STC_DWELLSTART

• wxEVT_STC_DWELLEND

• wxEVT_STC_HOTSPOT_CLICK

• wxEVT_STC_HOTSPOT_DCLICK

• wxEVT_STC_HOTSPOT_RELEASE_CLICK

• wxEVT_STC_INDICATOR_CLICK

• wxEVT_STC_INDICATOR_RELEASE

• wxEVT_STC_CALLTIP_CLICK

• wxEVT_STC_AUTOCOMP_SELECTION

• wxEVT_STC_AUTOCOMP_SELECTION_CHANGE

• wxEVT_STC_AUTOCOMP_COMPLETED

• wxEVT_STC_MARGIN_RIGHT_CLICK

Return type:

int

---

GetShift(self)

Returns True if the Shift key is pressed.

This method is valid for the following event types:

• wxEVT_STC_DOUBLECLICK

• wxEVT_STC_MARGINCLICK

• wxEVT_STC_HOTSPOT_CLICK

• wxEVT_STC_HOTSPOT_DCLICK

• wxEVT_STC_HOTSPOT_RELEASE_CLICK

• wxEVT_STC_INDICATOR_CLICK

• wxEVT_STC_INDICATOR_RELEASE

• wxEVT_STC_MARGIN_RIGHT_CLICK

Return type:

bool

---

GetText(self)

Return type:

str

Deprecated

Use GetString instead.

---

GetToken(self)

Returns the token value for this event.

The token is an integer value that can be set with a call to the wx.stc.StyledTextCtrl.AddUndoAction method.

This method is valid for wxEVT_STC_MODIFIED events when the result of GetModificationType includes STC_MOD_CONTAINER.

Return type:

int

---

GetUpdated(self)

Returns the value of the updated field for this event.

The value of this field is a bit list that describes the change that generated this event. It may contain one or more of the following values:

• STC_UPDATE_CONTENT

• STC_UPDATE_SELECTION

• STC_UPDATE_V_SCROLL

• STC_UPDATE_H_SCROLL

This method is valid for wxEVT_STC_UPDATEUI events.

Return type:

int

---

GetWParam(self)

Returns value of the WParam field for this event.

This method is valid for wxEVT_STC_MACRORECORD events.

Return type:

int

---

GetX(self)

Returns the X coordinate of the mouse for this event.

This method is valid for the following event types:

• wxEVT_STC_DWELLSTART

• wxEVT_STC_DWELLEND

• wxEVT_STC_START_DRAG

• wxEVT_STC_DRAG_OVER

• wxEVT_STC_DO_DROP

Return type:

int

---

GetY(self)

Returns the Y coordinate of the mouse for this event.

This method is valid for the following event types:

• wxEVT_STC_DWELLSTART

• wxEVT_STC_DWELLEND

• wxEVT_STC_START_DRAG

• wxEVT_STC_DRAG_OVER

• wxEVT_STC_DO_DROP

Return type:

int

---

SetAnnotationLinesAdded(self, val)

Sets the annotation lines added value for this event.

Parameters:

val (int)

Return type:

None

---

SetDragFlags(self, flags)

Sets the drag flags for this event.

Parameters:

flags (int)

Return type:

None

---

SetDragResult(self, val)

Sets the drag result for this event.

Parameters:

val (DragResult)

Return type:

None

---

SetDragText(self, val)

Sets the drag text for this event.

Parameters:

val (string)

Return type:

None

---

SetFoldLevelNow(self, val)

Sets the current fold level for this event.

Parameters:

val (int)

Return type:

None

---

SetFoldLevelPrev(self, val)

Sets the previous fold level for this event.

Parameters:

val (int)

Return type:

None

---

SetKey(self, k)

Sets the key code for this event.

Parameters:

k (int)

Return type:

None

---

SetLParam(self, val)

Sets value of the LParam field for this event.

Parameters:

val (int)

Return type:

None

---

SetLength(self, len)

Sets the length value for this event.

Parameters:

len (int)

Return type:

None

---

SetLine(self, val)

Sets line number for this event.

Parameters:

val (int)

Return type:

None

---

SetLinesAdded(self, num)

Sets the number of lines added for this event.

Parameters:

num (int)

Return type:

None

---

SetListCompletionMethod(self, val)

Sets the list completion method for this event.

Parameters:

val (int)

Return type:

None

Added in version 4.1/wxWidgets-3.1.1.

---

SetListType(self, val)

Sets the list type for this event.

Parameters:

val (int)

Return type:

None

---

SetMargin(self, val)

Sets margin number for this event.

Parameters:

val (int)

Return type:

None

---

SetMessage(self, val)

Sets message number for this event.

Parameters:

val (int)

Return type:

None

---

SetModificationType(self, t)

Sets the modification type for this event.

Parameters:

t (int)

Return type:

None

---

SetModifiers(self, m)

Sets the value of the modifiers field for this event.

Parameters:

m (int)

Return type:

None

---

SetPosition(self, pos)

Sets file position for this event.

Parameters:

pos (int)

Return type:

None

---

SetText(self, t)

Sets the text for this event.

Parameters:

t (string)

Return type:

None

---

SetToken(self, val)

Sets the token for this event.

Parameters:

val (int)

Return type:

None

---

SetUpdated(self, val)

Sets the value of the updated field for this event.

Parameters:

val (int)

Return type:

None

---

SetWParam(self, val)

Sets the value of the WParam field for this event.

Parameters:

val (int)

Return type:

None

---

SetX(self, val)

Sets the X value for this event.

Parameters:

val (int)

Return type:

None

---

SetY(self, val)

Sets the Y value for this event.

Parameters:

val (int)

Return type:

None

Properties

Alt

See GetAlt

---

AnnotationsLinesAdded

See GetAnnotationsLinesAdded

---

Control

See GetControl

---

DragFlags

See GetDragFlags and SetDragFlags

---

DragResult

See GetDragResult and SetDragResult

---

DragText

See GetDragText and SetDragText

---

FoldLevelNow

See GetFoldLevelNow and SetFoldLevelNow

---

FoldLevelPrev

See GetFoldLevelPrev and SetFoldLevelPrev

---

Key

See GetKey and SetKey

---

LParam

See GetLParam and SetLParam

---

Length

See GetLength and SetLength

---

Line

See GetLine and SetLine

---

LinesAdded

See GetLinesAdded and SetLinesAdded

---

ListCompletionMethod

See GetListCompletionMethod and SetListCompletionMethod

---

ListType

See GetListType and SetListType

---

Margin

See GetMargin and SetMargin

---

Message

See GetMessage and SetMessage

---

ModificationType

See GetModificationType and SetModificationType

---

Modifiers

See GetModifiers and SetModifiers

---

Position

See GetPosition and SetPosition

---

Shift

See GetShift

---

Text

See GetText and SetText

---

Token

See GetToken and SetToken

---

Updated

See GetUpdated and SetUpdated

---

WParam

See GetWParam and SetWParam

---

X

See GetX and SetX

---

Y

See GetY and SetY