[wxWidgets.git] / docs / latex / wx / richtextevent.tex

\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.}
\end{twocollist}%
 
\wxheading{Derived from}

\helpref{wxNotifyEvent}{wxnotifyevent}

\wxheading{Include files}

<wx/richtext/richtextctrl.h>

\wxheading{Library}

\helpref{wxRichtext}{librarieslist}

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