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