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.

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.