| Version: 2.9.5

- Main Page
- Related Pages
- Categories
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Member Functions | List of all members
wxStyledTextEvent Class Reference
Events | Scintilla Text Editor

`#include <wx/stc/stc.h>`

Inheritance diagram for wxStyledTextEvent:
[legend]

## Detailed Description

The type of events sent from wxStyledTextCtrl.

Todo:
  list styled text ctrl events.

##

Library: page_libs_stc
Category: Events, Scintilla Text Editor

## Public Member Functions

| wxStyledTextEvent (wxEventType commandType=0, int id=0)
| wxStyledTextEvent (const wxStyledTextEvent &event)
| ~wxStyledTextEvent ()
void | SetPosition (int pos)
void | SetKey (int k)
void | SetModifiers (int m)
void | SetModificationType (int t)
void | SetText (const wxString &t)
void | SetLength (int len)
void | SetLinesAdded (int num)
void | SetLine (int val)
void | SetFoldLevelNow (int val)
void | SetFoldLevelPrev (int val)
void | SetMargin (int val)
void | SetMessage (int val)
void | SetWParam (int val)
void | SetLParam (int val)
void | SetListType (int val)
void | SetX (int val)
void | SetY (int val)
void | SetToken (int val)
void | SetAnnotationLinesAdded (int val)
void | SetUpdated (int val)
void | SetDragText (const wxString &val)
void | SetDragFlags (int flags)
void | SetDragResult (wxDragResult val)
int | GetPosition () const
int | GetKey () const
int | GetModifiers () const
int | GetModificationType () const
wxString | GetText () const
int | GetLength () const
int | GetLinesAdded () const
int | GetLine () const
int | GetFoldLevelNow () const
int | GetFoldLevelPrev () const
int | GetMargin () const
int | GetMessage () const
int | GetWParam () const
int | GetLParam () const
int | GetListType () const
int | GetX () const
int | GetY () const
int | GetToken () const
int | GetAnnotationsLinesAdded () const
int | GetUpdated () const
wxString | GetDragText ()
int | GetDragFlags ()
wxDragResult | GetDragResult ()
bool | GetShift () const
bool | GetControl () const
bool | GetAlt () const
Public Member Functions inherited from wxCommandEvent
| wxCommandEvent (wxEventType commandEventType=wxEVT_NULL, int id=0)
| Constructor.
void * | GetClientData () const
| Returns client data pointer for a listbox or choice selection event (not valid for a deselection).
wxClientData * | GetClientObject () const
| Returns client object pointer for a listbox or choice selection event (not valid for a deselection).
long | GetExtraLong () const
| Returns extra information dependent on the event objects type.
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.
int | GetSelection () const
| Returns item index for a listbox or choice selection event (not valid for a deselection).
wxString | GetString () const
| Returns item string for a listbox or choice selection event.
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.
bool | IsSelection () const
| For a listbox or similar event, returns true if it is a selection, false if it is a deselection.
void | SetClientData (void *clientData)
| Sets the client data for this event.
void | SetClientObject (wxClientData *clientObject)
| Sets the client object for this event.
void | SetExtraLong (long extraLong)
| Sets the m_extraLong member.
void | SetInt (int intCommand)
| Sets the m_commandInt member.
void | SetString (const wxString &string)
| Sets the m_commandString member.
Public Member Functions inherited from wxEvent
| wxEvent (int id=0, wxEventType eventType=wxEVT_NULL)
| Constructor.
virtual wxEvent * | Clone () const =0
| Returns a copy of the event.
wxObject * | GetEventObject () const
| Returns the object (usually a window) associated with the event, if any.
wxEventType | GetEventType () const
| Returns the identifier of the given event type, such as `wxEVT_BUTTON`.
virtual wxEventCategory | GetEventCategory () const
| Returns a generic category for this event.
int | GetId () const
| Returns the identifier associated with this event, such as a button command id.
wxObject * | GetEventUserData () const
| Return the user data associated with a dynamically connected event handler.
bool | GetSkipped () const
| Returns true if the event handler should be skipped, false otherwise.
long | GetTimestamp () const
| Gets the timestamp for the event.
bool | IsCommandEvent () const
| Returns true if the event is or is derived from wxCommandEvent else it returns false.
void | ResumePropagation (int propagationLevel)
| Sets the propagation level to the given value (for example returned from an earlier call to wxEvent::StopPropagation).
void | SetEventObject (wxObject *object)
| Sets the originating object.
void | SetEventType (wxEventType type)
| Sets the event type.
void | SetId (int id)
| Sets the identifier associated with this event, such as a button command id.
void | SetTimestamp (long timeStamp=0)
| Sets the timestamp for the event.
bool | ShouldPropagate () const
| Test if this event should be propagated or not, i.e. if the propagation level is currently greater than 0.
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.
int | StopPropagation ()
| Stop the event from propagating to its parent window.
Public Member Functions inherited from wxObject
| wxObject ()
| Default ctor; initializes to NULL the internal reference data.
| wxObject (const wxObject &other)
| Copy ctor.
virtual | ~wxObject ()
| Destructor.
virtual wxClassInfo * | GetClassInfo () const
| This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar).
wxObjectRefData * | GetRefData () const
| Returns the wxObject::m_refData pointer, i.e. the data referenced by this object.
bool | IsKindOf (const wxClassInfo *info) const
| Determines whether this class is a subclass of (or the same class as) the given class.
bool | IsSameAs (const wxObject &obj) const
| Returns true if this object has the same data pointer as obj.
void | Ref (const wxObject &clone)
| Makes this object refer to the data in clone.
void | SetRefData (wxObjectRefData *data)
| Sets the wxObject::m_refData pointer.
void | UnRef ()
| Decrements the reference count in the associated data, and if it is zero, deletes the data.
void | UnShare ()
| This is the same of AllocExclusive() but this method is public.
void | operator delete (void *buf)
| The delete operator is defined for debugging versions of the library only, when the identifier `WXDEBUG` is defined.
void * | operator new (size_t size, const wxString &filename=NULL, int lineNum=0)
| The new operator is defined for debugging versions of the library only, when the identifier `WXDEBUG` is defined.

## Additional Inherited Members

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

## Constructor & Destructor Documentation

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

wxStyledTextEvent::wxStyledTextEvent | ( | const wxStyledTextEvent & | event | ) |

wxStyledTextEvent::~wxStyledTextEvent | ( |  | ) |

## Member Function Documentation

bool wxStyledTextEvent::GetAlt | ( |  | ) | const

int wxStyledTextEvent::GetAnnotationsLinesAdded | ( |  | ) | const

bool wxStyledTextEvent::GetControl | ( |  | ) | const

int wxStyledTextEvent::GetDragFlags | ( |  | ) |

wxDragResult wxStyledTextEvent::GetDragResult | ( |  | ) |

wxString wxStyledTextEvent::GetDragText | ( |  | ) |

int wxStyledTextEvent::GetFoldLevelNow | ( |  | ) | const

int wxStyledTextEvent::GetFoldLevelPrev | ( |  | ) | const

int wxStyledTextEvent::GetKey | ( |  | ) | const

int wxStyledTextEvent::GetLength | ( |  | ) | const

int wxStyledTextEvent::GetLine | ( |  | ) | const

int wxStyledTextEvent::GetLinesAdded | ( |  | ) | const

int wxStyledTextEvent::GetListType | ( |  | ) | const

int wxStyledTextEvent::GetLParam | ( |  | ) | const

int wxStyledTextEvent::GetMargin | ( |  | ) | const

int wxStyledTextEvent::GetMessage | ( |  | ) | const

int wxStyledTextEvent::GetModificationType | ( |  | ) | const

int wxStyledTextEvent::GetModifiers | ( |  | ) | const

int wxStyledTextEvent::GetPosition | ( |  | ) | const

bool wxStyledTextEvent::GetShift | ( |  | ) | const

wxString wxStyledTextEvent::GetText | ( |  | ) | const

int wxStyledTextEvent::GetToken | ( |  | ) | const

int wxStyledTextEvent::GetUpdated | ( |  | ) | const

int wxStyledTextEvent::GetWParam | ( |  | ) | const

int wxStyledTextEvent::GetX | ( |  | ) | const

int wxStyledTextEvent::GetY | ( |  | ) | const

void wxStyledTextEvent::SetAnnotationLinesAdded | ( | int | val | ) |

void wxStyledTextEvent::SetDragFlags | ( | int | flags | ) |

void wxStyledTextEvent::SetDragResult | ( | wxDragResult | val | ) |

void wxStyledTextEvent::SetDragText | ( | const wxString & | val | ) |

void wxStyledTextEvent::SetFoldLevelNow | ( | int | val | ) |

void wxStyledTextEvent::SetFoldLevelPrev | ( | int | val | ) |

void wxStyledTextEvent::SetKey | ( | int | k | ) |

void wxStyledTextEvent::SetLength | ( | int | len | ) |

void wxStyledTextEvent::SetLine | ( | int | val | ) |

void wxStyledTextEvent::SetLinesAdded | ( | int | num | ) |

void wxStyledTextEvent::SetListType | ( | int | val | ) |

void wxStyledTextEvent::SetLParam | ( | int | val | ) |

void wxStyledTextEvent::SetMargin | ( | int | val | ) |

void wxStyledTextEvent::SetMessage | ( | int | val | ) |

void wxStyledTextEvent::SetModificationType | ( | int | t | ) |

void wxStyledTextEvent::SetModifiers | ( | int | m | ) |

void wxStyledTextEvent::SetPosition | ( | int | pos | ) |

void wxStyledTextEvent::SetText | ( | const wxString & | t | ) |

void wxStyledTextEvent::SetToken | ( | int | val | ) |

void wxStyledTextEvent::SetUpdated | ( | int | val | ) |

void wxStyledTextEvent::SetWParam | ( | int | val | ) |

void wxStyledTextEvent::SetX | ( | int | val | ) |

void wxStyledTextEvent::SetY | ( | int | val | ) |