many wxItemContainer-related changes:

[wxWidgets.git] / docs / latex / wx / panel.tex

diff --git a/docs/latex/wx/panel.tex b/docs/latex/wx/panel.tex
index d5079ff6317a82eecd7a7deb9d17fd22d0d84d75..6ccfa0a7f64689cd9afc351c1f33e644e1088393 100644 (file)
--- a/docs/latex/wx/panel.tex
+++ b/docs/latex/wx/panel.tex
@@ -5,12 +5,20 @@ It contains minimal extra functionality over and above its parent class wxWindow
 purpose is to be similar in appearance and functionality to a dialog, but with the flexibility of
 having any window as a parent.
 
+{\it Note:} if not all characters are being intercepted by your OnKeyDown or OnChar handler,
+it may be because you are using the wxTAB\_TRAVERSAL style, which grabs some keypresses for use
+by child controls.
+
 \wxheading{Derived from}
 
 \helpref{wxWindow}{wxwindow}\\
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/panel.h>
+
 \wxheading{Window styles}
 
 There are no specific styles for this window.
@@ -21,24 +29,22 @@ See also \helpref{window styles overview}{windowstyles}.
 
 By default, a panel has the same colouring as a dialog.
 
-A panel may be loaded from a wxWindows resource file (extension {\tt wxr}).
-
 \wxheading{See also}
 
 \helpref{wxDialog}{wxdialog}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxPanel::wxPanel}\label{wxpanelconstr}
+\membersection{wxPanel::wxPanel}\label{wxpanelctor}
 
 \func{}{wxPanel}{\void}
 
 Default constructor.
 
-\func{}{wxPanel}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id},\rtfsp
+\func{}{wxPanel}{\param{wxWindow* }{parent}, \param{wxWindowID }{id = \texttt{wxID\_ANY}},\rtfsp
 \param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp
 \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
-\param{const long}{ style = wxTAB\_TRAVERSAL},\rtfsp
+\param{long}{ style = wxTAB\_TRAVERSAL},\rtfsp
 \param{const wxString\& }{name = ``panel"}}
 
 Constructor.
@@ -50,10 +56,10 @@ Constructor.
 \docparam{id}{An identifier for the panel. A value of -1 is taken to mean a default.}
 
 \docparam{pos}{The panel position. A value of (-1, -1) indicates a default position, chosen by
-either the windowing system or wxWindows, depending on platform.}
+either the windowing system or wxWidgets, depending on platform.}
 
 \docparam{size}{The panel size. A value of (-1, -1) indicates a default size, chosen by
-either the windowing system or wxWindows, depending on platform.}
+either the windowing system or wxWidgets, depending on platform.}
 
 \docparam{style}{The window style. See \helpref{wxPanel}{wxpanel}.}
 
@@ -65,7 +71,7 @@ individual dialog boxes.}
 
 \helpref{wxPanel::Create}{wxpanelcreate}
 
-\membersection{wxPanel::\destruct{wxPanel}}
+\membersection{wxPanel::\destruct{wxPanel}}\label{wxpaneldtor}
 
 \func{}{\destruct{wxPanel}}{\void}
 
@@ -73,25 +79,25 @@ Destructor. Deletes any child windows before deleting the physical window.
 
 \membersection{wxPanel::Create}\label{wxpanelcreate}
 
-\func{bool}{Create}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id},\rtfsp
+\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id = \texttt{wxID\_ANY}},\rtfsp
 \param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp
 \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
-\param{const long}{ style = wxTAB\_TRAVERSAL},\rtfsp
+\param{long}{ style = wxTAB\_TRAVERSAL},\rtfsp
 \param{const wxString\& }{name = ``panel"}}
 
-Used for two-step panel construction. See \helpref{wxPanel::wxPanel}{wxpanelconstr}\rtfsp
+Used for two-step panel construction. See \helpref{wxPanel::wxPanel}{wxpanelctor}\rtfsp
 for details.
 
 \membersection{wxPanel::InitDialog}\label{wxpanelinitdialog}
 
 \func{void}{InitDialog}{\void}
 
-Sends an \helpref{wxWindow::OnInitDialog}{wxwindowoninitdialog} event, which
+Sends a \helpref{wxInitDialogEvent}{wxinitdialogevent}, which
 in turn transfers data to the dialog via validators.
 
 \wxheading{See also}
 
-\helpref{wxWindow::OnInitDialog}{wxwindowoninitdialog}
+\helpref{wxInitDialogEvent}{wxinitdialogevent}
 
 \membersection{wxPanel::OnSysColourChanged}\label{wxpanelonsyscolourchanged}
 
@@ -108,7 +114,7 @@ The default handler for wxEVT\_SYS\_COLOUR\_CHANGED.
 Changes the panel's colour to conform to the current settings (Windows only).
 Add an event table entry for your panel class if you wish the behaviour
 to be different (such as keeping a user-defined
-background colour). If you do override this function, call \helpref{wxWindow::OnSysColourChanged}{wxwindowonsyscolourchanged} to
+background colour). If you do override this function, call wxEvent::Skip to
 propagate the notification to child windows and controls.
 
 \wxheading{See also}
@@ -116,3 +122,32 @@ propagate the notification to child windows and controls.
 \helpref{wxSysColourChangedEvent}{wxsyscolourchangedevent}
 
 
+\membersection{wxPanel::SetFocus}\label{wxpanelsetfocus}
+
+\func{virtual void}{SetFocus}{\void}
+
+Overrides \helpref{wxWindow::SetFocus}{wxwindowsetfocus}. This method
+uses the (undocumented) mix-in class wxControlContainer which manages
+the focus and TAB logic for controls which usually have child controls.
+In practice, if you call this method and the control has at least
+one child window, the focus will be given to the child window.
+
+\wxheading{See also}
+
+\helpref{wxFocusEvent}{wxfocusevent}
+\helpref{wxWindow::SetFocus}{wxwindowsetfocus}
+
+
+\membersection{wxPanel::SetFocusIgnoringChildren}\label{wxpanelsetfocusignoringchildren}
+
+\func{virtual void}{SetFocusIgnoringChildren}{\void}
+
+In contrast to \helpref{wxPanel::SetFocus}{wxpanelsetfocus} (see above)
+this will set the focus to the panel even of there are child windows
+in the panel. This is only rarely needed.
+
+\wxheading{See also}
+
+\helpref{wxFocusEvent}{wxfocusevent}
+\helpref{wxPanel::SetFocus}{wxpanelsetfocus}
+