projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| 5f35b46a JS |
1 | \section{\class{wxRichTextEvent}}\label{wxrichtextevent} |
| 2 | ||
| 3 | This is the event class for wxRichTextCtrl notifications. Note that event generation | |
| 4 | is very incomplete; we need to implement events such as selection of text, deletion, | |
| 5 | insertion, and so on. | |
| 6 | ||
| 7 | \wxheading{Event table macros} | |
| 8 | ||
| 9 | To process a rich text event, use these event handler macros to direct input to a member | |
| 10 | function that takes a wxRichTextEvent argument. | |
| 11 | ||
| 12 | \twocolwidtha{7cm} | |
| 13 | \begin{twocollist}\itemsep=0pt | |
| 14 | \twocolitem{{\bf EVT\_RICHTEXT\_LEFT\_CLICK(id, func)}}{Process a wxEVT\_COMMAND\_RICHTEXT\_LEFT\_CLICK event. Not currently implemented.} | |
| 15 | \twocolitem{{\bf EVT\_RICHTEXT\_RIGHT\_CLICK(id, func)}}{Process a wxEVT\_COMMAND\_RICHTEXT\_RIGHT\_CLICK event. Not currently implemented.} | |
| 16 | \twocolitem{{\bf EVT\_RICHTEXT\_MIDDLE\_CLICK(id, func)}}{Process a wxEVT\_COMMAND\_RICHTEXT\_MIDDLE\_CLICK event. Not currently implemented.} | |
| 17 | \twocolitem{{\bf EVT\_RICHTEXT\_LEFT\_DCLICK(id, func)}}{Process a wxEVT\_COMMAND\_RICHTEXT\_LEFT\_DCLICK event. Not currently implemented.} | |
| 18 | \twocolitem{{\bf EVT\_RICHTEXT\_RETURN(id, func)}}{Process a wxEVT\_COMMAND\_RICHTEXT\_RETURN event, generated when the user presses the return key.} | |
| 19 | \end{twocollist}% | |
| 20 | ||
| 21 | \wxheading{Derived from} | |
| 22 | ||
| 23 | \helpref{wxNotifyEvent}{wxnotifyevent} | |
| 24 | ||
| 25 | \wxheading{Include files} | |
| 26 | ||
| 27 | <wx/richtext/richtextctrl.h> | |
| 28 | ||
| 29 | \wxheading{Data structures} | |
| 30 | ||
| 31 | \latexignore{\rtfignore{\wxheading{Members}}} | |
| 32 | ||
| 33 | \membersection{wxRichTextEvent::wxRichTextEvent}\label{wxrichtexteventwxrichtextevent} | |
| 34 | ||
| 35 | \func{}{wxRichTextEvent}{\param{const wxRichTextEvent\& }{event}} | |
| 36 | ||
| 37 | \func{}{wxRichTextEvent}{\param{wxEventType }{commandType = wxEVT\_NULL}, \param{int }{winid = 0}} | |
| 38 | ||
| 39 | Constructors. | |
| 40 | ||
| 41 | \membersection{wxRichTextEvent::Clone}\label{wxrichtexteventclone} | |
| 42 | ||
| 43 | \constfunc{wxEvent*}{Clone}{\void} | |
| 44 | ||
| 45 | Clones the event. | |
| 46 | ||
| 47 | \membersection{wxRichTextEvent::GetFlags}\label{wxrichtexteventgetflags} | |
| 48 | ||
| 49 | \constfunc{int}{GetFlags}{\void} | |
| 50 | ||
| 51 | Returns flags indicating modifier keys pressed. | |
| 52 | ||
| 53 | \membersection{wxRichTextEvent::GetIndex}\label{wxrichtexteventgetindex} | |
| 54 | ||
| 55 | \constfunc{int}{GetIndex}{\void} | |
| 56 | ||
| 57 | Not currently used. | |
| 58 | ||
| 59 | \membersection{wxRichTextEvent::SetFlags}\label{wxrichtexteventsetflags} | |
| 60 | ||
| 61 | \func{void}{SetFlags}{\param{int }{flags}} | |
| 62 | ||
| 63 | Sets flags indicating modifier keys pressed. Possible values are wxRICHTEXT\_CTRL\_DOWN, | |
| 64 | wxRICHTEXT\_SHIFT\_DOWN, andwxRICHTEXT\_ALT\_DOWN. | |
| 65 | ||
| 66 | \membersection{wxRichTextEvent::SetIndex}\label{wxrichtexteventsetindex} | |
| 67 | ||
| 68 | \func{void}{SetIndex}{\param{int }{n}} | |
| 69 | ||
| 70 | Not currently used. |