X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7c913512a4c9f36e11e07ea707002fab1608d324..7ace5fd8e03c5b49d672e0363a8d4960bbf80592:/interface/panel.h?ds=sidebyside diff --git a/interface/panel.h b/interface/panel.h index 91662b9e1a..6e6e8b3d68 100644 --- a/interface/panel.h +++ b/interface/panel.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: panel.h -// Purpose: documentation for wxPanel class +// Purpose: interface of wxPanel // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -16,59 +16,56 @@ for TAB traversal implemented by wxWidgets itself as well as native TAB traversal (such as for GTK 2.0). - @e 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 wx/containr.h - and wx/panel.h to find out how this is achieved. + @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 @c wx/containr.h + and @c wx/panel.h to find out how this is achieved. - @e 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. + @note if not all characters are being intercepted by your OnKeyDown or + OnChar handler, it may be because you are using the @c wxTAB_TRAVERSAL style, + which grabs some keypresses for use by child controls. + + @remarks By default, a panel has the same colouring as a dialog. @library{wxbase} @category{miscwnd} - @seealso - wxDialog + @see wxDialog */ class wxPanel : public wxWindow { public: - //@{ + + /** + Default constructor. + */ + wxPanel(); + /** Constructor. - + @param parent - The parent window. - + The parent window. @param id - An identifier for the panel. A value of -1 is taken to mean a default. - + An identifier for the panel. @c wxID_ANY is taken to mean a default. @param pos - The panel position. The value wxDefaultPosition indicates a default position, chosen by - either the windowing system or wxWidgets, depending on platform. - + The panel position. The value @c wxDefaultPosition indicates a default position, + chosen by either the windowing system or wxWidgets, depending on platform. @param size - The panel size. The value wxDefaultSize indicates a default size, chosen by - either the windowing system or wxWidgets, depending on platform. - + The panel size. The value @c wxDefaultSize indicates a default size, chosen by + either the windowing system or wxWidgets, depending on platform. @param style - The window style. See wxPanel. - + The window style. See wxPanel. @param name - Used to associate a name with the window, - allowing the application user to set Motif resource values for - individual dialog boxes. - - @sa Create() + Window name. + + @see Create() */ - wxPanel(); wxPanel(wxWindow* parent, wxWindowID id = wxID_ANY, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = wxTAB_TRAVERSAL, const wxString& name = "panel"); - //@} /** Destructor. Deletes any child windows before deleting the physical window. @@ -76,16 +73,15 @@ public: ~wxPanel(); /** - This method is overridden from wxWindow::AcceptsFocus + This method is overridden from wxWindow::AcceptsFocus() 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. */ - bool AcceptsFocus(); + bool AcceptsFocus() const; /** - Used for two-step panel construction. See wxPanel() - for details. + Used for two-step panel construction. See wxPanel() for details. */ bool Create(wxWindow* parent, wxWindowID id = wxID_ANY, const wxPoint& pos = wxDefaultPosition, @@ -94,46 +90,47 @@ public: const wxString& name = "panel"); /** - Sends a wxInitDialogEvent, which - in turn transfers data to the dialog via validators. - - @sa wxInitDialogEvent + Sends a wxInitDialogEvent, which in turn transfers data to the dialog via + validators. + + @see wxInitDialogEvent */ void InitDialog(); /** The default handler for wxEVT_SYS_COLOUR_CHANGED. - + @param event - The colour change event. - + The colour change event. + @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. - - @sa wxSysColourChangedEvent + (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. + + @see wxSysColourChangedEvent */ void OnSysColourChanged(wxSysColourChangedEvent& event); /** - Overrides wxWindow::SetFocus. This method - uses the (undocumented) mix-in class wxControlContainer which manages + Overrides wxWindow::SetFocus(). + + 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. - - @sa wxFocusEvent, wxWindow::SetFocus + + @see wxFocusEvent, wxWindow::SetFocus() */ virtual void SetFocus(); /** - In contrast to SetFocus() (see above) - this will set the focus to the panel even if there are child windows - in the panel. This is only rarely needed. + In contrast to SetFocus() (see above) this will set the focus to the panel + even if there are child windows in the panel. This is only rarely needed. */ virtual void SetFocusIgnoringChildren(); }; +