]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/richtextevent.tex
document GetAnimation() (patch 1695722)
[wxWidgets.git] / docs / latex / wx / richtextevent.tex
CommitLineData
5f35b46a
JS
1\section{\class{wxRichTextEvent}}\label{wxrichtextevent}
2
48c8439f 3This is the event class for \helpref{wxRichTextCtrl}{wxrichtextctrl} notifications.
5f35b46a
JS
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
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
37\wxheading{Data structures}
38
39\latexignore{\rtfignore{\wxheading{Members}}}
40
41\membersection{wxRichTextEvent::wxRichTextEvent}\label{wxrichtexteventwxrichtextevent}
42
43\func{}{wxRichTextEvent}{\param{const wxRichTextEvent\& }{event}}
44
45\func{}{wxRichTextEvent}{\param{wxEventType }{commandType = wxEVT\_NULL}, \param{int }{winid = 0}}
46
47Constructors.
48
49\membersection{wxRichTextEvent::Clone}\label{wxrichtexteventclone}
50
51\constfunc{wxEvent*}{Clone}{\void}
52
53Clones the event.
54
48c8439f
JS
55\membersection{wxRichTextEvent::GetCharacter}\label{wxrichtexteventgetcharacter}
56
57\constfunc{wxChar}{GetCharacter}{\void}
58
59Returns the character pressed, within a wxEVT\_COMMAND\_RICHTEXT\_CHARACTER event.
60
5f35b46a
JS
61\membersection{wxRichTextEvent::GetFlags}\label{wxrichtexteventgetflags}
62
63\constfunc{int}{GetFlags}{\void}
64
48c8439f
JS
65Returns flags indicating modifier keys pressed. Possible values are wxRICHTEXT\_CTRL\_DOWN,
66wxRICHTEXT\_SHIFT\_DOWN, and wxRICHTEXT\_ALT\_DOWN.
67
68\membersection{wxRichTextEvent::GetNewStyleSheet}\label{wxrichtexteventgetnewstylesheet}
69
70\constfunc{wxRichTextStyleSheet*}{GetNewStyleSheet}{\void}
71
72Returns the new style sheet. Can be used in a wxEVT\_COMMAND\_RICHTEXT\_STYLESHEET\_CHANGING or
73wxEVT\_COMMAND\_RICHTEXT\_STYLESHEET\_CHANGED event handler.
74
75\membersection{wxRichTextEvent::GetOldStyleSheet}\label{wxrichtexteventgetoldstylesheet}
76
77\constfunc{wxRichTextStyleSheet*}{GetOldStyleSheet}{\void}
78
79Returns the old style sheet. Can be used in a wxEVT\_COMMAND\_RICHTEXT\_STYLESHEET\_CHANGING or
80wxEVT\_COMMAND\_RICHTEXT\_STYLESHEET\_CHANGED event handler.
81
82\membersection{wxRichTextEvent::GetPosition}\label{wxrichtexteventgetposition}
83
84\constfunc{long}{GetPosition}{\void}
85
86Returns the buffer position at which the event occured.
5f35b46a 87
48c8439f 88\membersection{wxRichTextEvent::GetRange}\label{wxrichtexteventgetrange}
5f35b46a 89
48c8439f 90\constfunc{wxRichTextRange}{GetRange}{\void}
5f35b46a 91
48c8439f
JS
92Gets the range for the current operation.
93
94\membersection{wxRichTextEvent::SetCharacter}\label{wxrichtexteventsetcharacter}
95
96\func{void}{SetCharacter}{\param{wxChar }{ch}}
97
98Sets the character variable.
5f35b46a
JS
99
100\membersection{wxRichTextEvent::SetFlags}\label{wxrichtexteventsetflags}
101
102\func{void}{SetFlags}{\param{int }{flags}}
103
104Sets flags indicating modifier keys pressed. Possible values are wxRICHTEXT\_CTRL\_DOWN,
48c8439f
JS
105wxRICHTEXT\_SHIFT\_DOWN, and wxRICHTEXT\_ALT\_DOWN.
106
107\membersection{wxRichTextEvent::SetNewStyleSheet}\label{wxrichtexteventsetnewstylesheet}
108
109\func{void}{SetNewStyleSheet}{\param{wxRichTextStyleSheet*}{ sheet}}
110
111Sets the new style sheet variable.
112
113\membersection{wxRichTextEvent::SetOldStyleSheet}\label{wxrichtexteventsetoldstylesheet}
114
115\func{void}{SetOldStyleSheet}{\param{wxRichTextStyleSheet*}{ sheet}}
116
117Sets the old style sheet variable.
118
119\membersection{wxRichTextEvent::SetPosition}\label{wxrichtexteventsetposition}
120
121\func{void}{SetPosition}{\param{long }{pos}}
122
123Sets the buffer position variable.
5f35b46a 124
48c8439f 125\membersection{wxRichTextEvent::SetRange}\label{wxrichtexteventsetrange}
5f35b46a 126
48c8439f 127\func{void}{SetRange}{\param{const wxRichTextRange\&}{ range}}
5f35b46a 128
48c8439f 129Sets the range variable.
62a268cc 130