This is the event class for wxRichTextCtrl notifications.
Events using this class
The following event handler macros redirect the events to member function handlers 'func' with prototypes like:
Event macros:
- EVT_RICHTEXT_LEFT_CLICK(id, func):
Process a wxEVT_RICHTEXT_LEFT_CLICK event, generated when the user releases the left mouse button over an object.
- EVT_RICHTEXT_RIGHT_CLICK(id, func):
Process a wxEVT_RICHTEXT_RIGHT_CLICK event, generated when the user releases the right mouse button over an object.
- EVT_RICHTEXT_MIDDLE_CLICK(id, func):
Process a wxEVT_RICHTEXT_MIDDLE_CLICK event, generated when the user releases the middle mouse button over an object.
- EVT_RICHTEXT_LEFT_DCLICK(id, func):
Process a wxEVT_RICHTEXT_LEFT_DCLICK event, generated when the user double-clicks an object.
- EVT_RICHTEXT_RETURN(id, func):
Process a wxEVT_RICHTEXT_RETURN event, generated when the user presses the return key. Valid event functions: GetFlags, GetPosition.
- EVT_RICHTEXT_CHARACTER(id, func):
Process a wxEVT_RICHTEXT_CHARACTER event, generated when the user presses a character key. Valid event functions: GetFlags, GetPosition, GetCharacter.
- EVT_RICHTEXT_CONSUMING_CHARACTER(id, func):
Process a wxEVT_RICHTEXT_CONSUMING_CHARACTER event, generated when the user presses a character key but before it is processed and inserted into the control. Call Veto to prevent normal processing. Valid event functions: GetFlags, GetPosition, GetCharacter, Veto.
- EVT_RICHTEXT_DELETE(id, func):
Process a wxEVT_RICHTEXT_DELETE event, generated when the user presses the backspace or delete key. Valid event functions: GetFlags, GetPosition.
- EVT_RICHTEXT_RETURN(id, func):
Process a wxEVT_RICHTEXT_RETURN event, generated when the user presses the return key. Valid event functions: GetFlags, GetPosition.
- EVT_RICHTEXT_STYLE_CHANGED(id, func):
Process a wxEVT_RICHTEXT_STYLE_CHANGED event, generated when styling has been applied to the control. Valid event functions: GetPosition, GetRange.
- EVT_RICHTEXT_STYLESHEET_CHANGED(id, func):
Process a wxEVT_RICHTEXT_STYLESHEET_CHANGING event, generated when the control's stylesheet has changed, for example the user added, edited or deleted a style. Valid event functions: GetRange, GetPosition.
- EVT_RICHTEXT_STYLESHEET_REPLACING(id, func):
Process a wxEVT_RICHTEXT_STYLESHEET_REPLACING event, generated when the control's stylesheet is about to be replaced, for example when a file is loaded into the control. Valid event functions: Veto, GetOldStyleSheet, GetNewStyleSheet.
- EVT_RICHTEXT_STYLESHEET_REPLACED(id, func):
Process a wxEVT_RICHTEXT_STYLESHEET_REPLACED event, generated when the control's stylesheet has been replaced, for example when a file is loaded into the control. Valid event functions: GetOldStyleSheet, GetNewStyleSheet.
- EVT_RICHTEXT_PROPERTIES_CHANGED(id, func):
Process a wxEVT_RICHTEXT_PROPERTIES_CHANGED event, generated when properties have been applied to the control. Valid event functions: GetPosition, GetRange.
- EVT_RICHTEXT_CONTENT_INSERTED(id, func):
Process a wxEVT_RICHTEXT_CONTENT_INSERTED event, generated when content has been inserted into the control. Valid event functions: GetPosition, GetRange.
- EVT_RICHTEXT_CONTENT_DELETED(id, func):
Process a wxEVT_RICHTEXT_CONTENT_DELETED event, generated when content has been deleted from the control. Valid event functions: GetPosition, GetRange.
- EVT_RICHTEXT_BUFFER_RESET(id, func):
Process a wxEVT_RICHTEXT_BUFFER_RESET event, generated when the buffer has been reset by deleting all content. You can use this to set a default style for the first new paragraph.
- EVT_RICHTEXT_SELECTION_CHANGED(id, func):
Process a wxEVT_RICHTEXT_SELECTION_CHANGED event, generated when the selection range has changed.
- EVT_RICHTEXT_FOCUS_OBJECT_CHANGED(id, func):
Process a wxEVT_RICHTEXT_FOCUS_OBJECT_CHANGED event, generated when the current focus object has changed.
|
| | wxRichTextEvent (wxEventType commandType=wxEVT_NULL, int winid=0) |
| | Constructor.
|
| |
| | wxRichTextEvent (const wxRichTextEvent &event) |
| | Copy constructor.
|
| |
| long | GetPosition () const |
| | Returns the buffer position at which the event occurred.
|
| |
| void | SetPosition (long pos) |
| | Sets the buffer position variable.
|
| |
| int | GetFlags () const |
| | Returns flags indicating modifier keys pressed.
|
| |
| void | SetFlags (int flags) |
| | Sets flags indicating modifier keys pressed.
|
| |
| wxRichTextStyleSheet * | GetOldStyleSheet () const |
| | Returns the old style sheet.
|
| |
| void | SetOldStyleSheet (wxRichTextStyleSheet *sheet) |
| | Sets the old style sheet variable.
|
| |
| wxRichTextStyleSheet * | GetNewStyleSheet () const |
| | Returns the new style sheet.
|
| |
| void | SetNewStyleSheet (wxRichTextStyleSheet *sheet) |
| | Sets the new style sheet variable.
|
| |
| const wxRichTextRange & | GetRange () const |
| | Gets the range for the current operation.
|
| |
| void | SetRange (const wxRichTextRange &range) |
| | Sets the range variable.
|
| |
| wxChar | GetCharacter () const |
| | Returns the character pressed, within a wxEVT_RICHTEXT_CHARACTER event.
|
| |
| void | SetCharacter (wxChar ch) |
| | Sets the character variable.
|
| |
| wxRichTextParagraphLayoutBox * | GetContainer () const |
| | Returns the container for which the event is relevant.
|
| |
| void | SetContainer (wxRichTextParagraphLayoutBox *container) |
| | Sets the container for which the event is relevant.
|
| |
| wxRichTextParagraphLayoutBox * | GetOldContainer () const |
| | Returns the old container, for a focus change event.
|
| |
| void | SetOldContainer (wxRichTextParagraphLayoutBox *container) |
| | Sets the old container, for a focus change event.
|
| |
| virtual wxEvent * | Clone () const |
| | Returns a copy of the event.
|
| |
| | wxNotifyEvent (wxEventType eventType=wxEVT_NULL, int id=0) |
| | Constructor (used internally by wxWidgets only).
|
| |
| void | Allow () |
| | This is the opposite of Veto(): it explicitly allows the event to be processed.
|
| |
| bool | IsAllowed () const |
| | Returns true if the change is allowed (Veto() hasn't been called) or false otherwise (if it was).
|
| |
| void | Veto () |
| | Prevents the change announced by this event from happening.
|
| |
 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.
|
| |
| | wxEvent (int id=0, wxEventType eventType=wxEVT_NULL) |
| | Constructor.
|
| |
| 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.
|
| |
| | 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.
|
| |
