git.saurik.com Git - wxWidgets.git/blame_incremental

... / ...

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