1\section{\class{wxRichTextEvent}}\label{wxrichtextevent}
2
3This is the event class for \helpref{wxRichTextCtrl}{wxrichtextctrl} notifications.
4
5\wxheading{Event table macros}
6
7To process a rich text event, use these event handler macros to direct input to a member
8function that takes a wxRichTextEvent argument.
9
10\twocolwidtha{10cm}
11\begin{twocollist}\itemsep=0pt
12%\twocolitem{{\bf EVT\_RICHTEXT\_LEFT\_CLICK(id, func)}}{Process a wxEVT\_COMMAND\_RICHTEXT\_LEFT\_CLICK event. Not currently implemented.}
13%\twocolitem{{\bf EVT\_RICHTEXT\_RIGHT\_CLICK(id, func)}}{Process a wxEVT\_COMMAND\_RICHTEXT\_RIGHT\_CLICK event. Not currently implemented.}
14%\twocolitem{{\bf EVT\_RICHTEXT\_MIDDLE\_CLICK(id, func)}}{Process a wxEVT\_COMMAND\_RICHTEXT\_MIDDLE\_CLICK event. Not currently implemented.}
15%\twocolitem{{\bf EVT\_RICHTEXT\_LEFT\_DCLICK(id, func)}}{Process a wxEVT\_COMMAND\_RICHTEXT\_LEFT\_DCLICK event. Not currently implemented.}
16\twocolitem{{\bf 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.}
17\twocolitem{{\bf 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.}
18\twocolitem{{\bf 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.}
19%\twocolitem{{\bf EVT\_RICHTEXT\_SELECTION\_CHANGED(id, func)}}{Process a wxEVT\_COMMAND\_RICHTEXT\_SELECTION\_CHANGED event, generated when the selection has been changed. Not currently implemented.}
20\twocolitem{{\bf 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.}
21%\twocolitem{{\bf EVT\_RICHTEXT\_STYLESHEET\_CHANGING(id, func)}}{Process a wxEVT\_COMMAND\_RICHTEXT\_STYLESHEET\_CHANGING event, generated when the control's stylesheet is about to change, for example the user added, edited or deleted a style.}
22\twocolitem{{\bf 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.}
23\twocolitem{{\bf 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.}
24\twocolitem{{\bf 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.}
25\twocolitem{{\bf 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.}
26\twocolitem{{\bf 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.}
27\twocolitem{{\bf 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.}
28\end{twocollist}%
29 
30\wxheading{Derived from}
31
32\helpref{wxNotifyEvent}{wxnotifyevent}
33
34\wxheading{Include files}
35
36<wx/richtext/richtextctrl.h>
37
38\wxheading{Data structures}
39
40\latexignore{\rtfignore{\wxheading{Members}}}
41
42\membersection{wxRichTextEvent::wxRichTextEvent}\label{wxrichtexteventwxrichtextevent}
43
44\func{}{wxRichTextEvent}{\param{const wxRichTextEvent\& }{event}}
45
46\func{}{wxRichTextEvent}{\param{wxEventType }{commandType = wxEVT\_NULL}, \param{int }{winid = 0}}
47
48Constructors.
49
50\membersection{wxRichTextEvent::Clone}\label{wxrichtexteventclone}
51
52\constfunc{wxEvent*}{Clone}{\void}
53
54Clones the event.
55
56\membersection{wxRichTextEvent::GetCharacter}\label{wxrichtexteventgetcharacter}
57
58\constfunc{wxChar}{GetCharacter}{\void}
59
60Returns the character pressed, within a wxEVT\_COMMAND\_RICHTEXT\_CHARACTER event.
61
62\membersection{wxRichTextEvent::GetFlags}\label{wxrichtexteventgetflags}
63
64\constfunc{int}{GetFlags}{\void}
65
66Returns flags indicating modifier keys pressed. Possible values are wxRICHTEXT\_CTRL\_DOWN,
67wxRICHTEXT\_SHIFT\_DOWN, and wxRICHTEXT\_ALT\_DOWN.
68
69\membersection{wxRichTextEvent::GetNewStyleSheet}\label{wxrichtexteventgetnewstylesheet}
70
71\constfunc{wxRichTextStyleSheet*}{GetNewStyleSheet}{\void}
72
73Returns the new style sheet. Can be used in a wxEVT\_COMMAND\_RICHTEXT\_STYLESHEET\_CHANGING or
74wxEVT\_COMMAND\_RICHTEXT\_STYLESHEET\_CHANGED event handler.
75
76\membersection{wxRichTextEvent::GetOldStyleSheet}\label{wxrichtexteventgetoldstylesheet}
77
78\constfunc{wxRichTextStyleSheet*}{GetOldStyleSheet}{\void}
79
80Returns the old style sheet. Can be used in a wxEVT\_COMMAND\_RICHTEXT\_STYLESHEET\_CHANGING or
81wxEVT\_COMMAND\_RICHTEXT\_STYLESHEET\_CHANGED event handler.
82
83\membersection{wxRichTextEvent::GetPosition}\label{wxrichtexteventgetposition}
84
85\constfunc{long}{GetPosition}{\void}
86
87Returns the buffer position at which the event occured.
88
89\membersection{wxRichTextEvent::GetRange}\label{wxrichtexteventgetrange}
90
91\constfunc{wxRichTextRange}{GetRange}{\void}
92
93Gets the range for the current operation.
94
95\membersection{wxRichTextEvent::SetCharacter}\label{wxrichtexteventsetcharacter}
96
97\func{void}{SetCharacter}{\param{wxChar }{ch}}
98
99Sets the character variable.
100
101\membersection{wxRichTextEvent::SetFlags}\label{wxrichtexteventsetflags}
102
103\func{void}{SetFlags}{\param{int }{flags}}
104
105Sets flags indicating modifier keys pressed. Possible values are wxRICHTEXT\_CTRL\_DOWN,
106wxRICHTEXT\_SHIFT\_DOWN, and wxRICHTEXT\_ALT\_DOWN.
107
108\membersection{wxRichTextEvent::SetNewStyleSheet}\label{wxrichtexteventsetnewstylesheet}
109
110\func{void}{SetNewStyleSheet}{\param{wxRichTextStyleSheet*}{ sheet}}
111
112Sets the new style sheet variable.
113
114\membersection{wxRichTextEvent::SetOldStyleSheet}\label{wxrichtexteventsetoldstylesheet}
115
116\func{void}{SetOldStyleSheet}{\param{wxRichTextStyleSheet*}{ sheet}}
117
118Sets the old style sheet variable.
119
120\membersection{wxRichTextEvent::SetPosition}\label{wxrichtexteventsetposition}
121
122\func{void}{SetPosition}{\param{long }{pos}}
123
124Sets the buffer position variable.
125
126\membersection{wxRichTextEvent::SetRange}\label{wxrichtexteventsetrange}
127
128\func{void}{SetRange}{\param{const wxRichTextRange\&}{ range}}
129
130Sets the range variable.
131
132