From 66ad556c74932cc0ec03aa84890c98185f04f282 Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Wed, 13 Sep 2006 11:44:16 +0000 Subject: [PATCH] document wxChildFocusEvent git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@41188 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/latex/wx/category.tex | 1 + docs/latex/wx/chfocevt.tex | 52 ++++++++++++++++++++++++++++++++++++++ docs/latex/wx/classes.tex | 1 + 3 files changed, 54 insertions(+) create mode 100644 docs/latex/wx/chfocevt.tex diff --git a/docs/latex/wx/category.tex b/docs/latex/wx/category.tex index 1a6ceda264..c8110b3cdc 100644 --- a/docs/latex/wx/category.tex +++ b/docs/latex/wx/category.tex @@ -236,6 +236,7 @@ An event object contains information about a specific event. Event handlers \twocolitem{\helpref{wxActivateEvent}{wxactivateevent}}{A window or application activation event} \twocolitem{\helpref{wxCalendarEvent}{wxcalendarevent}}{Used with \helpref{wxCalendarCtrl}{wxcalendarctrl}} \twocolitem{\helpref{wxCalculateLayoutEvent}{wxcalculatelayoutevent}}{Used to calculate window layout} +\twocolitem{\helpref{wxChildFocusEvent}{wxchildfocusevent}}{A child window focus event} \twocolitem{\helpref{wxClipboardTextEvent}{wxclipboardtextevent}}{A clipboard copy/cut/paste treebook event event} \twocolitem{\helpref{wxCloseEvent}{wxcloseevent}}{A close window or end session event} \twocolitem{\helpref{wxCommandEvent}{wxcommandevent}}{An event from a variety of standard controls} diff --git a/docs/latex/wx/chfocevt.tex b/docs/latex/wx/chfocevt.tex new file mode 100644 index 0000000000..8db4b617bd --- /dev/null +++ b/docs/latex/wx/chfocevt.tex @@ -0,0 +1,52 @@ +\section{\class{wxChildFocusEvent}}\label{wxchildfocusevent} + +A child focus event is sent to a (parent-)window when one of its child windows gains focus, +so that the window could restore the focus back to its corresponding child +if it loses it now and regains later. + +Notice that child window is the direct child of the window receiving event. +Use \helpref{FindFocus}{wxwindowfindfocus) to retreive the window which is actually getting focus. + +\wxheading{Derived from} + +\helpref{wxCommandEvent}{wxcommandevent}\\ +\helpref{wxEvent}{wxevent}\\ +\helpref{wxObject}{wxobject} + +\wxheading{Include files} + + + +\wxheading{Event table macros} + +To process a child focus event, use this event handler macro to direct input to a member +function that takes a wxChildFocusEvent argument. + +\twocolwidtha{7cm} +\begin{twocollist}\itemsep=0pt +\twocolitem{{\bf EVT\_CHILD\_FOCUS(func)}}{Process a wxEVT\_CHILD\_FOCUS event.} +\end{twocollist}% + +\wxheading{See also} + +\helpref{Event handling overview}{eventhandlingoverview} + +\latexignore{\rtfignore{\wxheading{Members}}} + + +\membersection{wxChildFocusEvent::wxChildFocusEvent}\label{wxchildfocuseventctor} + +\func{}{wxChildFocusEvent}{\param{wxWindow *}{win = NULL}} + +Constructor. + +\wxheading{Parameters} + +\docparam{win}{The direct child which is (or which contains the window which is) receiving the focus.} + + +\membersection{wxChildFocusEvent::GetWindow}\label{wxchildfocuseventgetwindow} + +Returns the direct child which receives the focus, or a (grand-)parent of the control receiving the focus. + +To get the actually focused control use \helpref{wxWindow::FindFocus}{wxwindowfindfocus} diff --git a/docs/latex/wx/classes.tex b/docs/latex/wx/classes.tex index 9f43d36ef8..21cf4dc08a 100644 --- a/docs/latex/wx/classes.tex +++ b/docs/latex/wx/classes.tex @@ -55,6 +55,7 @@ \input conditn.tex \input config.tex \input ipcconn.tex +\input chfocevt.tex \input cntxtevt.tex \input cshelp.tex \input control.tex -- 2.45.2