Added wxMemoryDC::SelectObjectAsSource() and make SelectObject() unshare

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

\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.

{\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.

See also \helpref{window styles overview}{windowstyles}.

\wxheading{Remarks}

By default, a panel has the same colouring as a dialog.

\wxheading{See also}

\helpref{wxDialog}{wxdialog}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxPanel::wxPanel}\label{wxpanelctor}

\func{}{wxPanel}{\void}

Default constructor.

\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 wxString\& }{name = ``panel"}}

Constructor.

\wxheading{Parameters}

\docparam{parent}{The parent window.}

\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 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 wxWidgets, depending on platform.}

\docparam{style}{The window style. See \helpref{wxPanel}{wxpanel}.}

\docparam{name}{Used to associate a name with the window,
allowing the application user to set Motif resource values for
individual dialog boxes.}

\wxheading{See also}

\helpref{wxPanel::Create}{wxpanelcreate}

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

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

Destructor. Deletes any child windows before deleting the physical window.

\membersection{wxPanel::Create}\label{wxpanelcreate}

\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"}}

Used for two-step panel construction. See \helpref{wxPanel::wxPanel}{wxpanelctor}\rtfsp
for details.

\membersection{wxPanel::InitDialog}\label{wxpanelinitdialog}

\func{void}{InitDialog}{\void}

Sends a \helpref{wxInitDialogEvent}{wxinitdialogevent}, which
in turn transfers data to the dialog via validators.

\wxheading{See also}

\helpref{wxInitDialogEvent}{wxinitdialogevent}

\membersection{wxPanel::OnSysColourChanged}\label{wxpanelonsyscolourchanged}

\func{void}{OnSysColourChanged}{\param{wxSysColourChangedEvent\& }{event}}

The default handler for wxEVT\_SYS\_COLOUR\_CHANGED.

\wxheading{Parameters}

\docparam{event}{The colour change event.}

\wxheading{Remarks}

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 wxEvent::Skip to
propagate the notification to child windows and controls.

\wxheading{See also}

\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}