Version: 3.1.1

#include <wx/stc/stc.h>

+ Inheritance diagram for wxStyledTextEvent:

Detailed Description

The type of events sent from wxStyledTextCtrl.

Events using this class

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

void handlerFuncName(wxStyledTextEvent& event)

Event macros:

  • 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.
    Since
    3.1.1
  • EVT_STC_AUTOCOMP_SELECTION(id, fn):
    Process a wxEVT_STC_AUTOCOMP_SELECTION event.
  • 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.
    Since
    3.1.0
  • EVT_STC_CLIPBOARD_PASTE(id, fn):
    Process a wxEVT_STC_CLIPBOARD_PASTE event.
    Since
    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.
    Since
    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 wxStyledTextEvent. However a few of the notifications would only offer information available in other wxWidgets event types, and in those cases a corresponding wxStyledTextEvent 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 relevent 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

wxEVT_STC_AUTOCOMP_SELECTION

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.
  • 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

wxEVT_STC_CLIPBOARD_PASTE

wxEVT_STC_DO_DROP

wxEVT_STC_DOUBLECLICK

wxEVT_STC_DRAG_OVER

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

wxEVT_STC_HOTSPOT_CLICK

wxEVT_STC_HOTSPOT_DCLICK

wxEVT_STC_HOTSPOT_RELEASE_CLICK

wxEVT_STC_INDICATOR_CLICK

wxEVT_STC_INDICATOR_RELEASE

wxEVT_STC_MACRORECORD

wxEVT_STC_MARGIN_RIGHT_CLICK

wxEVT_STC_MARGINCLICK

wxEVT_STC_MODIFIED

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 wxSTC_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

wxEVT_STC_ZOOM

  • Generated when the zoom factor of the control has been changed either by the user or a call to wxStyledTextCtrl::ZoomIn/ZoomOut.
  • Valid event functions: none.

Library:  wxSTC
Category:  Events, Scintilla Text Editor

Public Member Functions

 wxStyledTextEvent (wxEventType commandType=0, int id=0)
 Constructor. More...
 
 wxStyledTextEvent (const wxStyledTextEvent &event)
 Copy constructor. More...
 
 ~wxStyledTextEvent ()
 Destructor. More...
 
bool GetAlt () const
 Returns true if the Alt key is pressed. More...
 
int GetAnnotationsLinesAdded () const
 Returns the number of lines that have been added to or removed from an annotation. More...
 
bool GetControl () const
 Returns true if the Control key is pressed. More...
 
int GetDragFlags ()
 Returns flags for the drag operation associated with this event. More...
 
wxDragResult GetDragResult ()
 Returns drag result for this event. More...
 
wxString GetDragText ()
 
int GetFoldLevelNow () const
 Returns the current fold level for the line. More...
 
int GetFoldLevelPrev () const
 Returns previous fold level for the line. More...
 
int GetKey () const
 Returns the key code of the key that generated this event. More...
 
int GetLength () const
 Returns the length (number of characters) of this event. More...
 
int GetLine () const
 Returns zero-based line number for this event. More...
 
int GetLinesAdded () const
 Returns the number of lines added or deleted with this event. More...
 
int GetListCompletionMethod () const
 Returns a value describing the action that closed the list. More...
 
int GetListType () const
 Returns the list type for this event. More...
 
int GetLParam () const
 Returns the value of the LParam field for this event. More...
 
int GetMargin () const
 Returns the zero-based index of the margin that generated this event. More...
 
int GetMessage () const
 Returns a message number while a macro is being recorded. More...
 
int GetModificationType () const
 Returns the modification type for this event. More...
 
int GetModifiers () const
 Returns the modifiers of the key press or mouse click for this event. More...
 
int GetPosition () const
 Returns the zero-based text position associated this event. More...
 
bool GetShift () const
 Returns true if the Shift key is pressed. More...
 
wxString GetText () const
 
int GetToken () const
 Returns the token value for this event. More...
 
int GetUpdated () const
 Returns the value of the updated field for this event. More...
 
int GetWParam () const
 Returns value of the WParam field for this event. More...
 
int GetX () const
 Returns the X coordinate of the mouse for this event. More...
 
int GetY () const
 Returns the Y coordinate of the mouse for this event. More...
 
void SetAnnotationLinesAdded (int val)
 Sets the annotation lines added value for this event. More...
 
void SetDragFlags (int flags)
 Sets the drag flags for this event. More...
 
void SetDragResult (wxDragResult val)
 Sets the drag result for this event. More...
 
void SetDragText (const wxString &val)
 Sets the drag text for this event. More...
 
void SetFoldLevelNow (int val)
 Sets the current fold level for this event. More...
 
void SetFoldLevelPrev (int val)
 Sets the previous fold level for this event. More...
 
void SetKey (int k)
 Sets the key code for this event. More...
 
void SetLength (int len)
 Sets the length value for this event. More...
 
void SetLine (int val)
 Sets line number for this event. More...
 
void SetLinesAdded (int num)
 Sets the number of lines added for this event. More...
 
void SetListCompletionMethod (int val)
 Sets the list completion method for this event. More...
 
void SetListType (int val)
 Sets the list type for this event. More...
 
void SetLParam (int val)
 Sets value of the LParam field for this event. More...
 
void SetMargin (int val)
 Sets margin number for this event. More...
 
void SetMessage (int val)
 Sets message number for this event. More...
 
void SetModificationType (int t)
 Sets the modification type for this event. More...
 
void SetModifiers (int m)
 Sets the value of the modifiers field for this event. More...
 
void SetPosition (int pos)
 Sets file position for this event. More...
 
void SetText (const wxString &t)
 Sets the text for this event. More...
 
void SetToken (int val)
 Sets the token for this event. More...
 
void SetUpdated (int val)
 Sets the value of the updated field for this event. More...
 
void SetWParam (int val)
 Sets the value of the WParam field for this event. More...
 
void SetX (int val)
 Sets the X value for this event. More...
 
void SetY (int val)
 Sets the Y value for this event. More...
 
- Public Member Functions inherited from wxCommandEvent
 wxCommandEvent (wxEventType commandEventType=wxEVT_NULL, int id=0)
 Constructor. More...
 
void * GetClientData () const
 Returns client data pointer for a listbox or choice selection event (not valid for a deselection). More...
 
wxClientDataGetClientObject () const
 Returns client object pointer for a listbox or choice selection event (not valid for a deselection). More...
 
long GetExtraLong () const
 Returns extra information dependent on the event objects type. More...
 
int GetInt () const
 Returns the integer identifier corresponding to a listbox, choice or radiobox selection (only if the event was a selection, not a deselection), or a boolean value representing the value of a checkbox. More...
 
int GetSelection () const
 Returns item index for a listbox or choice selection event (not valid for a deselection). More...
 
wxString GetString () const
 Returns item string for a listbox or choice selection event. More...
 
bool IsChecked () const
 This method can be used with checkbox and menu events: for the checkboxes, the method returns true for a selection event and false for a deselection one. More...
 
bool IsSelection () const
 For a listbox or similar event, returns true if it is a selection, false if it is a deselection. More...
 
void SetClientData (void *clientData)
 Sets the client data for this event. More...
 
void SetClientObject (wxClientData *clientObject)
 Sets the client object for this event. More...
 
void SetExtraLong (long extraLong)
 Sets the m_extraLong member. More...
 
void SetInt (int intCommand)
 Sets the m_commandInt member. More...
 
void SetString (const wxString &string)
 Sets the m_commandString member. More...
 
- Public Member Functions inherited from wxEvent
 wxEvent (int id=0, wxEventType eventType=wxEVT_NULL)
 Constructor. More...
 
virtual wxEventClone () const =0
 Returns a copy of the event. More...
 
wxObjectGetEventObject () const
 Returns the object (usually a window) associated with the event, if any. More...
 
wxEventType GetEventType () const
 Returns the identifier of the given event type, such as wxEVT_BUTTON. More...
 
virtual wxEventCategory GetEventCategory () const
 Returns a generic category for this event. More...
 
int GetId () const
 Returns the identifier associated with this event, such as a button command id. More...
 
wxObjectGetEventUserData () const
 Return the user data associated with a dynamically connected event handler. More...
 
bool GetSkipped () const
 Returns true if the event handler should be skipped, false otherwise. More...
 
long GetTimestamp () const
 Gets the timestamp for the event. More...
 
bool IsCommandEvent () const
 Returns true if the event is or is derived from wxCommandEvent else it returns false. More...
 
void ResumePropagation (int propagationLevel)
 Sets the propagation level to the given value (for example returned from an earlier call to wxEvent::StopPropagation). More...
 
void SetEventObject (wxObject *object)
 Sets the originating object. More...
 
void SetEventType (wxEventType type)
 Sets the event type. More...
 
void SetId (int id)
 Sets the identifier associated with this event, such as a button command id. More...
 
void SetTimestamp (long timeStamp=0)
 Sets the timestamp for the event. More...
 
bool ShouldPropagate () const
 Test if this event should be propagated or not, i.e. if the propagation level is currently greater than 0. More...
 
void Skip (bool skip=true)
 This method can be used inside an event handler to control whether further event handlers bound to this event will be called after the current one returns. More...
 
int StopPropagation ()
 Stop the event from propagating to its parent window. More...
 
- Public Member Functions inherited from wxObject
 wxObject ()
 Default ctor; initializes to NULL the internal reference data. More...
 
 wxObject (const wxObject &other)
 Copy ctor. More...
 
virtual ~wxObject ()
 Destructor. More...
 
virtual wxClassInfoGetClassInfo () const
 This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar). More...
 
wxObjectRefDataGetRefData () const
 Returns the wxObject::m_refData pointer, i.e. the data referenced by this object. More...
 
bool IsKindOf (const wxClassInfo *info) const
 Determines whether this class is a subclass of (or the same class as) the given class. More...
 
bool IsSameAs (const wxObject &obj) const
 Returns true if this object has the same data pointer as obj. More...
 
void Ref (const wxObject &clone)
 Makes this object refer to the data in clone. More...
 
void SetRefData (wxObjectRefData *data)
 Sets the wxObject::m_refData pointer. More...
 
void UnRef ()
 Decrements the reference count in the associated data, and if it is zero, deletes the data. More...
 
void UnShare ()
 This is the same of AllocExclusive() but this method is public. More...
 
void operator delete (void *buf)
 The delete operator is defined for debugging versions of the library only, when the identifier WXDEBUG is defined. More...
 
void * operator new (size_t size, const wxString &filename=NULL, int lineNum=0)
 The new operator is defined for debugging versions of the library only, when the identifier WXDEBUG is defined. More...
 

Additional Inherited Members

- Protected Member Functions inherited from wxObject
void AllocExclusive ()
 Ensure that this object's data is not shared with any other object. More...
 
virtual wxObjectRefDataCreateRefData () const
 Creates a new instance of the wxObjectRefData-derived class specific to this object and returns it. More...
 
virtual wxObjectRefDataCloneRefData (const wxObjectRefData *data) const
 Creates a new instance of the wxObjectRefData-derived class specific to this object and initializes it copying data. More...
 
- Protected Attributes inherited from wxEvent
int m_propagationLevel
 Indicates how many levels the event can propagate. More...
 
- Protected Attributes inherited from wxObject
wxObjectRefDatam_refData
 Pointer to an object which is the object's reference-counted data. More...
 

Constructor & Destructor Documentation

wxStyledTextEvent::wxStyledTextEvent ( wxEventType  commandType = 0,
int  id = 0 
)

Constructor.

wxStyledTextEvent::wxStyledTextEvent ( const wxStyledTextEvent event)

Copy constructor.

wxStyledTextEvent::~wxStyledTextEvent ( )

Destructor.

Member Function Documentation

bool wxStyledTextEvent::GetAlt ( ) const

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
int wxStyledTextEvent::GetAnnotationsLinesAdded ( ) const

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 wxSTC_MOD_CHANGEANNOTATION.

bool wxStyledTextEvent::GetControl ( ) const

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
int wxStyledTextEvent::GetDragFlags ( )

Returns flags for the drag operation associated with this event.

This method is valid for wxEVT_STC_START_DRAG events.

wxDragResult wxStyledTextEvent::GetDragResult ( )

Returns drag result for this event.

This method is valid for wxEVT_STC_DRAG_OVER and wxEVT_STC_DO_DROP events.

wxString wxStyledTextEvent::GetDragText ( )
Deprecated:
Use GetString() instead.
int wxStyledTextEvent::GetFoldLevelNow ( ) const

Returns the current fold level for the line.

This method is valid for wxEVT_STC_MODIFIED events when the result of GetModificationType() includes wxSTC_MOD_CHANGEFOLD.

int wxStyledTextEvent::GetFoldLevelPrev ( ) const

Returns previous fold level for the line.

This method is valid for wxEVT_STC_MODIFIED events when the result of GetModificationType() includes wxSTC_MOD_CHANGEFOLD.

int wxStyledTextEvent::GetKey ( ) const

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
int wxStyledTextEvent::GetLength ( ) const

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

This method is valid for wxEVT_STC_MODIFIED and wxEVT_STC_NEEDSHOWN events.

int wxStyledTextEvent::GetLine ( ) const

Returns zero-based line number for this event.

This method is valid for wxEVT_STC_DOUBLECLICK and wxEVT_STC_MODIFIED events.

int wxStyledTextEvent::GetLinesAdded ( ) const

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 wxSTC_MOD_INSERTTEXT or wxSTC_MOD_DELETETEXT.

int wxStyledTextEvent::GetListCompletionMethod ( ) const

Returns a value describing the action that closed the list.

The returned value will be one of the following constants:

wxSTC_AC_FILLUP A fillup character caused the completion.
wxSTC_AC_DOUBLECLICK A double-click caused the completion.
wxSTC_AC_TAB The tab key caused the completion.
wxSTC_AC_NEWLINE The enter key caused the completion.
wxSTC_AC_COMMAND The wxStyledTextCtrl::AutoCompComplete method was called.

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

Since
3.1.1
int wxStyledTextEvent::GetListType ( ) const

Returns the list type for this event.

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

This method is valid for wxEVT_STC_USERLISTSELECTION events.

int wxStyledTextEvent::GetLParam ( ) const

Returns the value of the LParam field for this event.

This method is valid for wxEVT_STC_MACRORECORD events.

int wxStyledTextEvent::GetMargin ( ) const

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.

int wxStyledTextEvent::GetMessage ( ) const

Returns a message number while a macro is being recorded.

Many of the wxStyledTextCtrl 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.

int wxStyledTextEvent::GetModifiers ( ) const

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:

In addition, the value can be checked for equality with wxSTC_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
int wxStyledTextEvent::GetPosition ( ) const

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_COMPLETED
  • wxEVT_STC_MARGIN_RIGHT_CLICK
bool wxStyledTextEvent::GetShift ( ) const

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
wxString wxStyledTextEvent::GetText ( ) const
Deprecated:
Use GetString() instead.
int wxStyledTextEvent::GetToken ( ) const

Returns the token value for this event.

The token is an integer value that can be set with a call to the wxStyledTextCtrl::AddUndoAction method.

This method is valid for wxEVT_STC_MODIFIED events when the result of GetModificationType() includes wxSTC_MOD_CONTAINER.

int wxStyledTextEvent::GetUpdated ( ) const

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:

This method is valid for wxEVT_STC_UPDATEUI events.

int wxStyledTextEvent::GetWParam ( ) const

Returns value of the WParam field for this event.

This method is valid for wxEVT_STC_MACRORECORD events.

int wxStyledTextEvent::GetX ( ) const

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
int wxStyledTextEvent::GetY ( ) const

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
void wxStyledTextEvent::SetAnnotationLinesAdded ( int  val)

Sets the annotation lines added value for this event.

void wxStyledTextEvent::SetDragFlags ( int  flags)

Sets the drag flags for this event.

void wxStyledTextEvent::SetDragResult ( wxDragResult  val)

Sets the drag result for this event.

void wxStyledTextEvent::SetDragText ( const wxString val)

Sets the drag text for this event.

Deprecated:
void wxStyledTextEvent::SetFoldLevelNow ( int  val)

Sets the current fold level for this event.

void wxStyledTextEvent::SetFoldLevelPrev ( int  val)

Sets the previous fold level for this event.

void wxStyledTextEvent::SetKey ( int  k)

Sets the key code for this event.

void wxStyledTextEvent::SetLength ( int  len)

Sets the length value for this event.

void wxStyledTextEvent::SetLine ( int  val)

Sets line number for this event.

void wxStyledTextEvent::SetLinesAdded ( int  num)

Sets the number of lines added for this event.

void wxStyledTextEvent::SetListCompletionMethod ( int  val)

Sets the list completion method for this event.

Since
3.1.1
void wxStyledTextEvent::SetListType ( int  val)

Sets the list type for this event.

void wxStyledTextEvent::SetLParam ( int  val)

Sets value of the LParam field for this event.

void wxStyledTextEvent::SetMargin ( int  val)

Sets margin number for this event.

void wxStyledTextEvent::SetMessage ( int  val)

Sets message number for this event.

void wxStyledTextEvent::SetModificationType ( int  t)

Sets the modification type for this event.

void wxStyledTextEvent::SetModifiers ( int  m)

Sets the value of the modifiers field for this event.

void wxStyledTextEvent::SetPosition ( int  pos)

Sets file position for this event.

void wxStyledTextEvent::SetText ( const wxString t)

Sets the text for this event.

Deprecated:
void wxStyledTextEvent::SetToken ( int  val)

Sets the token for this event.

void wxStyledTextEvent::SetUpdated ( int  val)

Sets the value of the updated field for this event.

void wxStyledTextEvent::SetWParam ( int  val)

Sets the value of the WParam field for this event.

void wxStyledTextEvent::SetX ( int  val)

Sets the X value for this event.

void wxStyledTextEvent::SetY ( int  val)

Sets the Y value for this event.