wxRichTextEvent

wxRichTextEvent

This is the event class for wxRichTextCtrl notifications.

Event table macros

To process a rich text event, use these event handler macros to direct input to a member function that takes a wxRichTextEvent argument.

EVT_RICHTEXT_CHARACTER(id, func) Process a wxEVT_COMMAND_RICHTEXT_CHARACTER event, generated when the user presses a character key. Valid event functions: GetFlags, GetPosition, GetCharacter.

EVT_RICHTEXT_DELETE(id, func) Process a wxEVT_COMMAND_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_COMMAND_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_COMMAND_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_COMMAND_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_COMMAND_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_COMMAND_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_CONTENT_INSERTED(id, func) Process a wxEVT_COMMAND_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_COMMAND_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_COMMAND_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.

Derived from

wxNotifyEvent

Include files

Data structures

Members

wxRichTextEvent::wxRichTextEvent
wxRichTextEvent::Clone
wxRichTextEvent::GetCharacter
wxRichTextEvent::GetFlags
wxRichTextEvent::GetNewStyleSheet
wxRichTextEvent::GetOldStyleSheet
wxRichTextEvent::GetPosition
wxRichTextEvent::GetRange
wxRichTextEvent::SetCharacter
wxRichTextEvent::SetFlags
wxRichTextEvent::SetNewStyleSheet
wxRichTextEvent::SetOldStyleSheet
wxRichTextEvent::SetPosition
wxRichTextEvent::SetRange

wxRichTextEvent::wxRichTextEvent

wxRichTextEvent(const wxRichTextEvent& event)

wxRichTextEvent(wxEventType commandType = wxEVT_NULL, int winid = 0)

Constructors.

wxRichTextEvent::Clone

wxEvent* Clone() const

Clones the event.

wxRichTextEvent::GetCharacter

wxChar GetCharacter() const

Returns the character pressed, within a wxEVT_COMMAND_RICHTEXT_CHARACTER event.

wxRichTextEvent::GetFlags

int GetFlags() const

Returns flags indicating modifier keys pressed. Possible values are wxRICHTEXT_CTRL_DOWN, wxRICHTEXT_SHIFT_DOWN, and wxRICHTEXT_ALT_DOWN.

wxRichTextEvent::GetNewStyleSheet

wxRichTextStyleSheet* GetNewStyleSheet() const

Returns the new style sheet. Can be used in a wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGING or wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGED event handler.

wxRichTextEvent::GetOldStyleSheet

wxRichTextStyleSheet* GetOldStyleSheet() const

Returns the old style sheet. Can be used in a wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGING or wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGED event handler.

wxRichTextEvent::GetPosition

long GetPosition() const

Returns the buffer position at which the event occured.

wxRichTextEvent::GetRange

wxRichTextRange GetRange() const

Gets the range for the current operation.

wxRichTextEvent::SetCharacter

void SetCharacter(wxChar ch)

Sets the character variable.

wxRichTextEvent::SetFlags

void SetFlags(int flags)

Sets flags indicating modifier keys pressed. Possible values are wxRICHTEXT_CTRL_DOWN, wxRICHTEXT_SHIFT_DOWN, and wxRICHTEXT_ALT_DOWN.

wxRichTextEvent::SetNewStyleSheet

void SetNewStyleSheet(wxRichTextStyleSheet* sheet)

Sets the new style sheet variable.

wxRichTextEvent::SetOldStyleSheet

void SetOldStyleSheet(wxRichTextStyleSheet* sheet)

Sets the old style sheet variable.

wxRichTextEvent::SetPosition

void SetPosition(long pos)

Sets the buffer position variable.

wxRichTextEvent::SetRange

void SetRange(const wxRichTextRange& range)

Sets the range variable.

EVT_RICHTEXT_CHARACTER(id, func)	Process a wxEVT_COMMAND_RICHTEXT_CHARACTER event, generated when the user presses a character key. Valid event functions: GetFlags, GetPosition, GetCharacter.
EVT_RICHTEXT_DELETE(id, func)	Process a wxEVT_COMMAND_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_COMMAND_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_COMMAND_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_COMMAND_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_COMMAND_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_COMMAND_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_CONTENT_INSERTED(id, func)	Process a wxEVT_COMMAND_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_COMMAND_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_COMMAND_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.