wxWidgets/docs/latex/wx/richtextevent.tex
Julian Smart 5f35b46aab First cut at wxRichTextCtrl documentation
Put wxTextAttr into separate file to allow correct ordering


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@39924 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2006-07-01 20:30:58 +00:00

71 lines
2.4 KiB
TeX

\section{\class{wxRichTextEvent}}\label{wxrichtextevent}
This is the event class for wxRichTextCtrl notifications. Note that event generation
is very incomplete; we need to implement events such as selection of text, deletion,
insertion, and so on.
\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{7cm}
\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\_RETURN(id, func)}}{Process a wxEVT\_COMMAND\_RICHTEXT\_RETURN event, generated when the user presses the return key.}
\end{twocollist}%
\wxheading{Derived from}
\helpref{wxNotifyEvent}{wxnotifyevent}
\wxheading{Include files}
<wx/richtext/richtextctrl.h>
\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::GetFlags}\label{wxrichtexteventgetflags}
\constfunc{int}{GetFlags}{\void}
Returns flags indicating modifier keys pressed.
\membersection{wxRichTextEvent::GetIndex}\label{wxrichtexteventgetindex}
\constfunc{int}{GetIndex}{\void}
Not currently used.
\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, andwxRICHTEXT\_ALT\_DOWN.
\membersection{wxRichTextEvent::SetIndex}\label{wxrichtexteventsetindex}
\func{void}{SetIndex}{\param{int }{n}}
Not currently used.