Commited FRM's stockitem patch (empty stock items).

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

diff --git a/docs/latex/wx/panel.tex b/docs/latex/wx/panel.tex
index 6dfeb8fe6ecd564249024d761bc59fbfe1967c77..6ccfa0a7f64689cd9afc351c1f33e644e1088393 100644 (file)
--- a/docs/latex/wx/panel.tex
+++ b/docs/latex/wx/panel.tex
@@ -29,21 +29,19 @@ See also \helpref{window styles overview}{windowstyles}.
 
 By default, a panel has the same colouring as a dialog.
 
 
 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}}}
 
 \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}{\void}
 
 Default constructor.
 

-\func{}{wxPanel}{\param{wxWindow* }{parent}, \param{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{long}{ style = wxTAB\_TRAVERSAL},\rtfsp
 \param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp
 \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
 \param{long}{ style = wxTAB\_TRAVERSAL},\rtfsp


@@ -58,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
 \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
 
 \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}.}
 
 
 \docparam{style}{The window style. See \helpref{wxPanel}{wxpanel}.}
 


@@ -73,7 +71,7 @@ individual dialog boxes.}
 
 \helpref{wxPanel::Create}{wxpanelcreate}
 
 
 \helpref{wxPanel::Create}{wxpanelcreate}
 

-\membersection{wxPanel::\destruct{wxPanel}}
+\membersection{wxPanel::\destruct{wxPanel}}\label{wxpaneldtor}

 
 \func{}{\destruct{wxPanel}}{\void}
 
 
 \func{}{\destruct{wxPanel}}{\void}
 


@@ -81,22 +79,15 @@ Destructor. Deletes any child windows before deleting the physical window.
 
 \membersection{wxPanel::Create}\label{wxpanelcreate}
 
 
 \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
 \param{const wxString\& }{name = ``panel"}}
 
 \param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp
 \param{const wxSize\& }{size = wxDefaultSize},\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.
 
 for details.
 

-\membersection{wxPanel::GetDefaultItem}\label{wxpanelgetdefaultitem}
-
-\constfunc{wxButton*}{GetDefaultItem}{\void}
-
-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}
 
 \func{void}{InitDialog}{\void}
 \membersection{wxPanel::InitDialog}\label{wxpanelinitdialog}
 
 \func{void}{InitDialog}{\void}


@@ -130,13 +121,33 @@ propagate the notification to child windows and controls.
 
 \helpref{wxSysColourChangedEvent}{wxsyscolourchangedevent}
 
 
 \helpref{wxSysColourChangedEvent}{wxsyscolourchangedevent}
 

-\membersection{wxPanel::SetDefaultItem}\label{wxpanelsetdefaultitem}

 
 

-\func{void}{SetDefaultItem}{\param{wxButton }{*btn}}
+\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}

 
 

-Changes the default button for the panel.
+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}
 
 
 \wxheading{See also}
 

-\helpref{GetDefaultItem}{wxpanelgetdefaultitem}
+\helpref{wxFocusEvent}{wxfocusevent}
+\helpref{wxPanel::SetFocus}{wxpanelsetfocus}