]> git.saurik.com Git - wxWidgets.git/blob - interface/wx/panel.h
added support for wxCAL_SHOW_WEEK_NUMBERS to generic version of wxCalendarCtrl (...
[wxWidgets.git] / interface / wx / panel.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: panel.h
3 // Purpose: interface of wxPanel
4 // Author: wxWidgets team
5 // RCS-ID: $Id$
6 // Licence: wxWindows license
7 /////////////////////////////////////////////////////////////////////////////
8
9 /**
10 @class wxPanel
11
12 A panel is a window on which controls are placed. It is usually placed within
13 a frame. Its main feature over its parent class wxWindow is code for handling
14 child windows and TAB traversal. Since wxWidgets 2.9, there is support both
15 for TAB traversal implemented by wxWidgets itself as well as native TAB
16 traversal (such as for GTK 2.0).
17
18 @note Tab traversal is implemented through an otherwise undocumented
19 intermediate wxControlContainer class from which any class can derive
20 in addition to the normal wxWindow base class. Please see @c wx/containr.h
21 and @c wx/panel.h to find out how this is achieved.
22
23 @note if not all characters are being intercepted by your OnKeyDown or
24 OnChar handler, it may be because you are using the @c wxTAB_TRAVERSAL style,
25 which grabs some keypresses for use by child controls.
26
27 @remarks By default, a panel has the same colouring as a dialog.
28
29 @library{wxbase}
30 @category{miscwnd}
31
32 @see wxDialog
33 */
34 class wxPanel : public wxWindow
35 {
36 public:
37
38 /**
39 Default constructor.
40 */
41 wxPanel();
42
43 /**
44 Constructor.
45
46 @param parent
47 The parent window.
48 @param id
49 An identifier for the panel. @c wxID_ANY is taken to mean a default.
50 @param pos
51 The panel position. The value @c wxDefaultPosition indicates a default position,
52 chosen by either the windowing system or wxWidgets, depending on platform.
53 @param size
54 The panel size. The value @c wxDefaultSize indicates a default size, chosen by
55 either the windowing system or wxWidgets, depending on platform.
56 @param style
57 The window style. See wxPanel.
58 @param name
59 Window name.
60
61 @see Create()
62 */
63 wxPanel(wxWindow* parent, wxWindowID id = wxID_ANY,
64 const wxPoint& pos = wxDefaultPosition,
65 const wxSize& size = wxDefaultSize,
66 long style = wxTAB_TRAVERSAL,
67 const wxString& name = wxPanelNameStr);
68
69 /**
70 Destructor. Deletes any child windows before deleting the physical window.
71 */
72 virtual ~wxPanel();
73
74 /**
75 This method is overridden from wxWindow::AcceptsFocus()
76 and returns @true only if there is no child window in the panel which
77 can accept the focus. This is reevaluated each time a child
78 window is added or removed from the panel.
79 */
80 bool AcceptsFocus() const;
81
82 /**
83 Used for two-step panel construction. See wxPanel() for details.
84 */
85 bool Create(wxWindow* parent, wxWindowID id = wxID_ANY,
86 const wxPoint& pos = wxDefaultPosition,
87 const wxSize& size = wxDefaultSize,
88 long style = wxTAB_TRAVERSAL,
89 const wxString& name = wxPanelNameStr);
90
91 /**
92 Sends a wxInitDialogEvent, which in turn transfers data to the dialog via
93 validators.
94
95 @see wxInitDialogEvent
96 */
97 virtual void InitDialog();
98
99 /**
100 See wxWindow::SetAutoLayout(): when auto layout is on, this function gets
101 called automatically when the window is resized.
102 */
103 virtual bool Layout();
104
105 /**
106 The default handler for wxEVT_SYS_COLOUR_CHANGED.
107
108 @param event
109 The colour change event.
110
111 @remarks Changes the panel's colour to conform to the current settings
112 (Windows only). Add an event table entry for your panel
113 class if you wish the behaviour to be different (such
114 as keeping a user-defined background colour). If you do
115 override this function, call wxEvent::Skip() to propagate
116 the notification to child windows and controls.
117
118 @see wxSysColourChangedEvent
119 */
120 void OnSysColourChanged(wxSysColourChangedEvent& event);
121
122 /**
123 Overrides wxWindow::SetFocus().
124
125 This method uses the (undocumented) mix-in class wxControlContainer which manages
126 the focus and TAB logic for controls which usually have child controls.
127
128 In practice, if you call this method and the control has at least
129 one child window, the focus will be given to the child window.
130
131 @see wxFocusEvent, wxWindow::SetFocus()
132 */
133 virtual void SetFocus();
134
135 /**
136 In contrast to SetFocus() (see above) this will set the focus to the panel
137 even if there are child windows in the panel. This is only rarely needed.
138 */
139 void SetFocusIgnoringChildren();
140 };
141