docs/latex/wx/richtextevent.tex

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