wxRichTextEvent Class Reference
[Events, Rich Text]

#include <wx/richtext/richtextctrl.h>

Inheritance diagram for wxRichTextEvent:

List of all members.

---

Detailed Description

This is the event class for wxRichTextCtrl notifications.

Events:

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

void handlerFuncName(wxRichTextEvent& event)

Event macros:

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

Library:  wxRichText

Category:  Events, Rich Text

Public Member Functions
	wxRichTextEvent (const wxRichTextEvent &event)
	wxRichTextEvent (wxEventType commandType=wxEVT_NULL, int id=0)
wxEvent *	Clone () const
wxChar	GetCharacter () const
int	GetFlags () const
wxRichTextStyleSheet *	GetNewStyleSheet () const
wxRichTextStyleSheet *	GetOldStyleSheet () const
long	GetPosition () const
const wxRichTextRange &	GetRange () const
void	SetCharacter (wxChar ch)
void	SetFlags (int flags)
void	SetNewStyleSheet (wxRichTextStyleSheet *sheet)
void	SetOldStyleSheet (wxRichTextStyleSheet *sheet)
void	SetPosition (long pos)
void	SetRange (const wxRichTextRange &range)

---

Constructor & Destructor Documentation

wxRichTextEvent::wxRichTextEvent

(

const wxRichTextEvent &

event

)

Copy constructor.

wxRichTextEvent::wxRichTextEvent	(	wxEventType	commandType = wxEVT_NULL,
		int	id = 0
	)

Constructor.

Parameters:

	commandType	The type of the event.
	id	Window identifier. The value wxID_ANY indicates a default value.

---

Member Function Documentation

wxEvent* wxRichTextEvent::Clone

(

)

const [virtual]

Clones the event.

Implements wxEvent.

wxChar wxRichTextEvent::GetCharacter

(

)

const

Returns the character pressed, within a wxEVT_COMMAND_RICHTEXT_CHARACTER event.

int wxRichTextEvent::GetFlags

(

)

const

Returns flags indicating modifier keys pressed.

Possible values are wxRICHTEXT_CTRL_DOWN, wxRICHTEXT_SHIFT_DOWN, and wxRICHTEXT_ALT_DOWN.

wxRichTextStyleSheet* wxRichTextEvent::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.

wxRichTextStyleSheet* wxRichTextEvent::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.

long wxRichTextEvent::GetPosition

(

)

const

Returns the buffer position at which the event occured.

const wxRichTextRange& wxRichTextEvent::GetRange

(

)

const

Gets the range for the current operation.

void wxRichTextEvent::SetCharacter

(

wxChar

ch

)

Sets the character variable.

void wxRichTextEvent::SetFlags

(

int

flags

)

Sets flags indicating modifier keys pressed.

Possible values are wxRICHTEXT_CTRL_DOWN, wxRICHTEXT_SHIFT_DOWN, and wxRICHTEXT_ALT_DOWN.

void wxRichTextEvent::SetNewStyleSheet

(

wxRichTextStyleSheet *

sheet

)

Sets the new style sheet variable.

void wxRichTextEvent::SetOldStyleSheet

(

wxRichTextStyleSheet *

sheet

)

Sets the old style sheet variable.

void wxRichTextEvent::SetPosition

(

long

pos

)

Sets the buffer position variable.

void wxRichTextEvent::SetRange

(

const wxRichTextRange &

range

)

Sets the range variable.