From 4acaa5e2fe17e16bdcaea3d55e86776749eb2546 Mon Sep 17 00:00:00 2001 From: Julian Smart Date: Wed, 1 Jun 2005 09:56:43 +0000 Subject: [PATCH] Added documentation for wxWindowCreateEvent, wxWindowDestroyEvent Added missing event to wxTreeEvent doc git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@34489 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/latex/wx/category.tex | 2 ++ docs/latex/wx/classes.tex | 2 ++ docs/latex/wx/createevt.tex | 39 ++++++++++++++++++++++++++++++++++++ docs/latex/wx/destroyevt.tex | 39 ++++++++++++++++++++++++++++++++++++ docs/latex/wx/treeevt.tex | 1 + 5 files changed, 83 insertions(+) create mode 100644 docs/latex/wx/createevt.tex create mode 100644 docs/latex/wx/destroyevt.tex diff --git a/docs/latex/wx/category.tex b/docs/latex/wx/category.tex index da93d49889..3c73efd946 100644 --- a/docs/latex/wx/category.tex +++ b/docs/latex/wx/category.tex @@ -251,6 +251,8 @@ An event object contains information about a specific event. Event handlers \twocolitem{\helpref{wxTimerEvent}{wxtimerevent}}{A timer expiration event} \twocolitem{\helpref{wxTreeEvent}{wxtreeevent}}{A tree control event} \twocolitem{\helpref{wxUpdateUIEvent}{wxupdateuievent}}{A user interface update event} +\twocolitem{\helpref{wxWindowCreateEvent}{wxwindowcreateevent}}{A window creation event} +\twocolitem{\helpref{wxWindowDestroyEvent}{wxwindowdestroyevent}}{A window destruction event} \twocolitem{\helpref{wxWizardEvent}{wxwizardevent}}{A wizard event} \end{twocollist} diff --git a/docs/latex/wx/classes.tex b/docs/latex/wx/classes.tex index d9c2cc0483..0bfe2874dc 100644 --- a/docs/latex/wx/classes.tex +++ b/docs/latex/wx/classes.tex @@ -359,7 +359,9 @@ \input vlbox.tex \input vscroll.tex \input window.tex +\input createevt.tex \input windowdc.tex +\input destroyevt.tex \input wnddisbl.tex \input wizard.tex \input wizevt.tex diff --git a/docs/latex/wx/createevt.tex b/docs/latex/wx/createevt.tex new file mode 100644 index 0000000000..6d4e50f60f --- /dev/null +++ b/docs/latex/wx/createevt.tex @@ -0,0 +1,39 @@ +\section{\class{wxWindowCreateEvent}}\label{wxwindowcreateevent} + +This event is sent just after the actual window associated with a wxWindow object +has been created. Since it is derived from wxCommandEvent, the event propagates up +the window hierarchy. + +\wxheading{Derived from} + +\helpref{wxCommandEvent}{wxevent}\\ +\helpref{wxEvent}{wxevent}\\ +\helpref{wxObject}{wxobject} + +\wxheading{Include files} + + + +\wxheading{Event table macros} + +To process a window creation event, use this event handler macro to direct input to a member +function that takes a wxWindowCreateEvent argument. + +\twocolwidtha{7cm} +\begin{twocollist}\itemsep=0pt +\twocolitem{{\bf EVT\_WINDOW\_CREATE(func)}}{Process a wxEVT\_CREATE event.} +\end{twocollist}% + +\wxheading{See also} + +\helpref{Event handling overview}{eventhandlingoverview},\rtfsp +\helpref{wxWindowDestroyEvent}{wxwindowdestroyevent} + +\latexignore{\rtfignore{\wxheading{Members}}} + +\membersection{wxWindowCreateEvent::wxWindowCreateEvent}\label{wxwindowcreateeventctor} + +\func{}{wxWindowCreateEvent}{\param{wxWindow* }{win = NULL}} + +Constructor. + diff --git a/docs/latex/wx/destroyevt.tex b/docs/latex/wx/destroyevt.tex new file mode 100644 index 0000000000..8934525afb --- /dev/null +++ b/docs/latex/wx/destroyevt.tex @@ -0,0 +1,39 @@ +\section{\class{wxWindowDestroyEvent}}\label{wxwindowdestroyevent} + +This event is sent just before the actual window associated with a wxWindow object +is destroyed. Since it is derived from wxCommandEvent, the event propagates up +the window hierarchy. + +\wxheading{Derived from} + +\helpref{wxCommandEvent}{wxevent}\\ +\helpref{wxEvent}{wxevent}\\ +\helpref{wxObject}{wxobject} + +\wxheading{Include files} + + + +\wxheading{Event table macros} + +To process a window destruction event, use this event handler macro to direct input to a member +function that takes a wxWindowDestroyEvent argument. + +\twocolwidtha{7cm} +\begin{twocollist}\itemsep=0pt +\twocolitem{{\bf EVT\_WINDOW\_DESTROY(func)}}{Process a wxEVT\_DESTROY event.} +\end{twocollist}% + +\wxheading{See also} + +\helpref{Event handling overview}{eventhandlingoverview},\rtfsp +\helpref{wxWindowCreateEvent}{wxwindowcreateevent} + +\latexignore{\rtfignore{\wxheading{Members}}} + +\membersection{wxWindowDestroyEvent::wxWindowDestroyEvent}\label{wxwindowdestroyeventctor} + +\func{}{wxWindowDestroyEvent}{\param{wxWindow* }{win = NULL}} + +Constructor. + diff --git a/docs/latex/wx/treeevt.tex b/docs/latex/wx/treeevt.tex index 3b325f2d85..71ca900065 100644 --- a/docs/latex/wx/treeevt.tex +++ b/docs/latex/wx/treeevt.tex @@ -42,6 +42,7 @@ functions that take a wxTreeEvent argument. \twocolitem{{\bf EVT\_TREE\_KEY\_DOWN(id, func)}}{A key has been pressed.} \twocolitem{{\bf EVT\_TREE\_ITEM\_GETTOOLTIP(id, func)}}{The opportunity to set the item tooltip is being given to the application (call wxTreeEvent::SetToolTip). Windows only.} +\twocolitem{{\bf EVT\_TREE\_ITEM\_MENU(id, func)}}{The context menu for the selected item has been requested, either by a right click or by using the menu key.} \end{twocollist} \wxheading{See also} -- 2.47.2