X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ababa106ae015f05e14cd2487100954ef50ca694..c699b4583b6047191ac326728654c6fe8920aa7b:/docs/latex/wx/panel.tex diff --git a/docs/latex/wx/panel.tex b/docs/latex/wx/panel.tex index 355cc31ca4..90b4ad50e1 100644 --- a/docs/latex/wx/panel.tex +++ b/docs/latex/wx/panel.tex @@ -1,13 +1,19 @@ \section{\class{wxPanel}}\label{wxpanel} -A panel is a window on which controls are placed. It is usually placed within a frame. -It contains minimal extra functionality over and above its parent class wxWindow; its main -purpose is to be similar in appearance and functionality to a dialog, but with the flexibility of -having any window as a parent. +A panel is a window on which controls are placed. It is usually placed within +a frame. Its main feature over its parent class wxWindow is code for handling +child windows and TAB traversal. Since wxWidgets 2.9, there is support both +for TAB traversal implemented by wxWidgets itself as well as native TAB +traversal (such as for GTK 2.0). -{\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. +{\it Note:} Tab traversal is implemented through an otherwise undocumented +intermediate wxControlContainer class from which any class can derive +in addition to the normal wxWindow base class. Please see +and to find out how this is achieved. + +{\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} @@ -41,7 +47,7 @@ By default, a panel has the same colouring as a dialog. Default constructor. -\func{}{wxPanel}{\param{wxWindow* }{parent}, \param{wxWindowID }{id = $-1$},\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{long}{ style = wxTAB\_TRAVERSAL},\rtfsp @@ -79,7 +85,7 @@ Destructor. Deletes any child windows before deleting the physical window. \membersection{wxPanel::Create}\label{wxpanelcreate} -\func{bool}{Create}{\param{wxWindow* }{parent}, \param{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{long}{ style = wxTAB\_TRAVERSAL},\rtfsp @@ -88,12 +94,16 @@ Destructor. Deletes any child windows before deleting the physical window. Used for two-step panel construction. See \helpref{wxPanel::wxPanel}{wxpanelctor}\rtfsp for details. -\membersection{wxPanel::GetDefaultItem}\label{wxpanelgetdefaultitem} -\constfunc{wxButton*}{GetDefaultItem}{\void} +\membersection{wxPanel::AcceptsFocus}\label{wxpanelacceptsfocus} + +\constfunc{bool}{AcceptsFocus}{\void} + +This method is overridden from \helpref{wxWindow::AcceptsFocus}{wxwindowacceptsfocus} +and returns true only if there is no child window in the panel which +can accept the focus. This is reevaluated each time a child +window is added or removed from the panel. -Returns a pointer to the button which is the default for this window, or NULL. -The default button is the one activated by pressing the Enter key. \membersection{wxPanel::InitDialog}\label{wxpanelinitdialog} @@ -129,17 +139,6 @@ propagate the notification to child windows and controls. \helpref{wxSysColourChangedEvent}{wxsyscolourchangedevent} -\membersection{wxPanel::SetDefaultItem}\label{wxpanelsetdefaultitem} - -\func{void}{SetDefaultItem}{\param{wxButton }{*btn}} - -Changes the default button for the panel. - -\wxheading{See also} - -\helpref{GetDefaultItem}{wxpanelgetdefaultitem} - - \membersection{wxPanel::SetFocus}\label{wxpanelsetfocus} \func{virtual void}{SetFocus}{\void} @@ -161,7 +160,7 @@ one child window, the focus will be given to the child window. \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 +this will set the focus to the panel even if there are child windows in the panel. This is only rarely needed. \wxheading{See also}