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