]>
Commit | Line | Data |
---|---|---|
f03fc89f | 1 | /////////////////////////////////////////////////////////////////////////////// |
23895080 | 2 | // Name: wx/window.h |
789295bf | 3 | // Purpose: wxWindowBase class - the interface of wxWindow |
f03fc89f | 4 | // Author: Vadim Zeitlin |
566d84a7 | 5 | // Modified by: Ron Lee |
f03fc89f VZ |
6 | // Created: 01/02/97 |
7 | // RCS-ID: $Id$ | |
77ffb593 | 8 | // Copyright: (c) wxWidgets team |
65571936 | 9 | // Licence: wxWindows licence |
f03fc89f VZ |
10 | /////////////////////////////////////////////////////////////////////////////// |
11 | ||
34138703 JS |
12 | #ifndef _WX_WINDOW_H_BASE_ |
13 | #define _WX_WINDOW_H_BASE_ | |
c801d85f | 14 | |
12028905 | 15 | #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) |
58654ed0 VZ |
16 | #pragma interface "windowbase.h" |
17 | #endif | |
18 | ||
f03fc89f VZ |
19 | // ---------------------------------------------------------------------------- |
20 | // headers which we must include here | |
21 | // ---------------------------------------------------------------------------- | |
22 | ||
23 | #include "wx/event.h" // the base class | |
24 | ||
25 | #include "wx/list.h" // defines wxWindowList | |
26 | ||
27 | #include "wx/cursor.h" // we have member variables of these classes | |
28 | #include "wx/font.h" // so we can't do without them | |
29 | #include "wx/colour.h" | |
30 | #include "wx/region.h" | |
5e4ff78a | 31 | #include "wx/utils.h" |
88ac883a | 32 | |
674ac8b9 | 33 | #include "wx/validate.h" // for wxDefaultValidator (always include it) |
8d99be5f | 34 | |
574c939e | 35 | #if wxUSE_PALETTE |
d577d610 | 36 | #include "wx/palette.h" |
574c939e KB |
37 | #endif // wxUSE_PALETTE |
38 | ||
88ac883a VZ |
39 | #if wxUSE_ACCEL |
40 | #include "wx/accel.h" | |
41 | #endif // wxUSE_ACCEL | |
f03fc89f | 42 | |
45a959a3 JS |
43 | #if wxUSE_ACCESSIBILITY |
44 | #include "wx/access.h" | |
45 | #endif | |
46 | ||
6522713c VZ |
47 | // when building wxUniv/Foo we don't want the code for native menu use to be |
48 | // compiled in - it should only be used when building real wxFoo | |
49 | #ifdef __WXUNIVERSAL__ | |
50 | #define wxUSE_MENUS_NATIVE 0 | |
51 | #else // __WXMSW__ | |
52 | #define wxUSE_MENUS_NATIVE wxUSE_MENUS | |
53 | #endif // __WXUNIVERSAL__/__WXMSW__ | |
54 | ||
f03fc89f VZ |
55 | // ---------------------------------------------------------------------------- |
56 | // forward declarations | |
57 | // ---------------------------------------------------------------------------- | |
58 | ||
789295bf | 59 | class WXDLLEXPORT wxCaret; |
f03fc89f VZ |
60 | class WXDLLEXPORT wxControl; |
61 | class WXDLLEXPORT wxCursor; | |
eb082a08 | 62 | class WXDLLEXPORT wxDC; |
f03fc89f VZ |
63 | class WXDLLEXPORT wxDropTarget; |
64 | class WXDLLEXPORT wxItemResource; | |
65 | class WXDLLEXPORT wxLayoutConstraints; | |
66 | class WXDLLEXPORT wxResourceTable; | |
67 | class WXDLLEXPORT wxSizer; | |
68 | class WXDLLEXPORT wxToolTip; | |
f03fc89f VZ |
69 | class WXDLLEXPORT wxWindowBase; |
70 | class WXDLLEXPORT wxWindow; | |
71 | ||
45a959a3 JS |
72 | #if wxUSE_ACCESSIBILITY |
73 | class WXDLLEXPORT wxAccessible; | |
74 | #endif | |
75 | ||
1b69c815 VZ |
76 | // ---------------------------------------------------------------------------- |
77 | // helper stuff used by wxWindow | |
78 | // ---------------------------------------------------------------------------- | |
79 | ||
80 | // struct containing all the visual attributes of a control | |
81 | struct WXDLLEXPORT wxVisualAttributes | |
82 | { | |
83 | // the font used for control label/text inside it | |
84 | wxFont font; | |
85 | ||
86 | // the foreground colour | |
87 | wxColour colFg; | |
88 | ||
89 | // the background colour, may be wxNullColour if the controls background | |
90 | // colour is not solid | |
91 | wxColour colBg; | |
92 | }; | |
93 | ||
94 | // different window variants, on platforms like eg mac uses different | |
95 | // rendering sizes | |
400a9e41 | 96 | enum wxWindowVariant |
1b69c815 VZ |
97 | { |
98 | wxWINDOW_VARIANT_NORMAL, // Normal size | |
99 | wxWINDOW_VARIANT_SMALL, // Smaller size (about 25 % smaller than normal) | |
100 | wxWINDOW_VARIANT_MINI, // Mini size (about 33 % smaller than normal) | |
101 | wxWINDOW_VARIANT_LARGE, // Large size (about 25 % larger than normal) | |
102 | wxWINDOW_VARIANT_MAX | |
103 | }; | |
104 | ||
f03fc89f VZ |
105 | // ---------------------------------------------------------------------------- |
106 | // (pseudo)template list classes | |
107 | // ---------------------------------------------------------------------------- | |
108 | ||
f6bcfd97 | 109 | WX_DECLARE_LIST_3(wxWindow, wxWindowBase, wxWindowList, wxWindowListNode, class WXDLLEXPORT); |
f03fc89f VZ |
110 | |
111 | // ---------------------------------------------------------------------------- | |
112 | // global variables | |
113 | // ---------------------------------------------------------------------------- | |
114 | ||
115 | WXDLLEXPORT_DATA(extern wxWindowList) wxTopLevelWindows; | |
116 | ||
f03fc89f VZ |
117 | // ---------------------------------------------------------------------------- |
118 | // wxWindowBase is the base class for all GUI controls/widgets, this is the public | |
119 | // interface of this class. | |
120 | // | |
121 | // Event handler: windows have themselves as their event handlers by default, | |
122 | // but their event handlers could be set to another object entirely. This | |
123 | // separation can reduce the amount of derivation required, and allow | |
124 | // alteration of a window's functionality (e.g. by a resource editor that | |
125 | // temporarily switches event handlers). | |
126 | // ---------------------------------------------------------------------------- | |
127 | ||
128 | class WXDLLEXPORT wxWindowBase : public wxEvtHandler | |
129 | { | |
f03fc89f VZ |
130 | public: |
131 | // creating the window | |
132 | // ------------------- | |
133 | ||
06f6df7d VZ |
134 | // default ctor, initializes everything which can be initialized before |
135 | // Create() | |
6463b9f5 | 136 | wxWindowBase() ; |
f03fc89f VZ |
137 | |
138 | // pseudo ctor (can't be virtual, called from ctor) | |
139 | bool CreateBase(wxWindowBase *parent, | |
d9e2e4c2 | 140 | wxWindowID winid, |
f03fc89f VZ |
141 | const wxPoint& pos = wxDefaultPosition, |
142 | const wxSize& size = wxDefaultSize, | |
143 | long style = 0, | |
8d99be5f | 144 | const wxValidator& validator = wxDefaultValidator, |
f03fc89f VZ |
145 | const wxString& name = wxPanelNameStr); |
146 | ||
147 | virtual ~wxWindowBase(); | |
148 | ||
f03fc89f VZ |
149 | // deleting the window |
150 | // ------------------- | |
151 | ||
d4864e97 | 152 | // ask the window to close itself, return true if the event handler |
f03fc89f | 153 | // honoured our request |
d4864e97 | 154 | bool Close( bool force = false ); |
f03fc89f VZ |
155 | |
156 | // the following functions delete the C++ objects (the window itself | |
157 | // or its children) as well as the GUI windows and normally should | |
158 | // never be used directly | |
159 | ||
d4864e97 | 160 | // delete window unconditionally (dangerous!), returns true if ok |
f03fc89f | 161 | virtual bool Destroy(); |
d4864e97 | 162 | // delete all children of this window, returns true if ok |
f03fc89f VZ |
163 | bool DestroyChildren(); |
164 | ||
165 | // is the window being deleted? | |
166 | bool IsBeingDeleted() const { return m_isBeingDeleted; } | |
167 | ||
168 | // window attributes | |
169 | // ----------------- | |
170 | ||
77ffb593 | 171 | // NB: in future versions of wxWidgets Set/GetTitle() will only work |
456bc6d9 VZ |
172 | // with the top level windows (such as dialogs and frames) and |
173 | // Set/GetLabel() only with the other ones (i.e. all controls). | |
174 | ||
f03fc89f VZ |
175 | // the title (or label, see below) of the window: the text which the |
176 | // window shows | |
fe6b43a3 VS |
177 | virtual void SetTitle( const wxString& WXUNUSED(title) ) {} |
178 | virtual wxString GetTitle() const { return wxEmptyString; } | |
f03fc89f VZ |
179 | |
180 | // label is just the same as the title (but for, e.g., buttons it | |
181 | // makes more sense to speak about labels) | |
eba0e4d4 RR |
182 | virtual void SetLabel(const wxString& label) { SetTitle(label); } |
183 | virtual wxString GetLabel() const { return GetTitle(); } | |
f03fc89f VZ |
184 | |
185 | // the window name is used for ressource setting in X, it is not the | |
186 | // same as the window title/label | |
187 | virtual void SetName( const wxString &name ) { m_windowName = name; } | |
188 | virtual wxString GetName() const { return m_windowName; } | |
189 | ||
69d90995 SC |
190 | // sets the window variant, calls internally DoSetVariant if variant has changed |
191 | void SetWindowVariant( wxWindowVariant variant ) ; | |
192 | wxWindowVariant GetWindowVariant() const { return m_windowVariant ; } | |
400a9e41 | 193 | |
69d90995 | 194 | |
f03fc89f VZ |
195 | // window id uniquely identifies the window among its siblings unless |
196 | // it is -1 which means "don't care" | |
d9e2e4c2 | 197 | void SetId( wxWindowID winid ) { m_windowId = winid; } |
f03fc89f VZ |
198 | wxWindowID GetId() const { return m_windowId; } |
199 | ||
200 | // generate a control id for the controls which were not given one by | |
201 | // user | |
69418a8e | 202 | static int NewControlId() { return --ms_lastControlId; } |
c539ab55 VZ |
203 | // get the id of the control following the one with the given |
204 | // (autogenerated) id | |
d9e2e4c2 | 205 | static int NextControlId(int winid) { return winid - 1; } |
c539ab55 VZ |
206 | // get the id of the control preceding the one with the given |
207 | // (autogenerated) id | |
d9e2e4c2 | 208 | static int PrevControlId(int winid) { return winid + 1; } |
f03fc89f VZ |
209 | |
210 | // moving/resizing | |
211 | // --------------- | |
212 | ||
213 | // set the window size and/or position | |
214 | void SetSize( int x, int y, int width, int height, | |
215 | int sizeFlags = wxSIZE_AUTO ) | |
216 | { DoSetSize(x, y, width, height, sizeFlags); } | |
217 | ||
218 | void SetSize( int width, int height ) | |
219 | { DoSetSize( -1, -1, width, height, wxSIZE_USE_EXISTING ); } | |
220 | ||
221 | void SetSize( const wxSize& size ) | |
222 | { SetSize( size.x, size.y); } | |
223 | ||
224 | void SetSize(const wxRect& rect, int sizeFlags = wxSIZE_AUTO) | |
225 | { DoSetSize(rect.x, rect.y, rect.width, rect.height, sizeFlags); } | |
226 | ||
1e6feb95 VZ |
227 | void Move(int x, int y, int flags = wxSIZE_USE_EXISTING) |
228 | { DoSetSize(x, y, -1, -1, flags); } | |
f03fc89f | 229 | |
1e6feb95 VZ |
230 | void Move(const wxPoint& pt, int flags = wxSIZE_USE_EXISTING) |
231 | { Move(pt.x, pt.y, flags); } | |
f03fc89f VZ |
232 | |
233 | // Z-order | |
234 | virtual void Raise() = 0; | |
235 | virtual void Lower() = 0; | |
236 | ||
237 | // client size is the size of area available for subwindows | |
238 | void SetClientSize( int width, int height ) | |
239 | { DoSetClientSize(width, height); } | |
240 | ||
241 | void SetClientSize( const wxSize& size ) | |
242 | { DoSetClientSize(size.x, size.y); } | |
243 | ||
244 | void SetClientSize(const wxRect& rect) | |
245 | { SetClientSize( rect.width, rect.height ); } | |
246 | ||
247 | // get the window position and/or size (pointers may be NULL) | |
248 | void GetPosition( int *x, int *y ) const { DoGetPosition(x, y); } | |
249 | wxPoint GetPosition() const | |
250 | { | |
251 | int w, h; | |
252 | DoGetPosition(&w, &h); | |
253 | ||
254 | return wxPoint(w, h); | |
255 | } | |
256 | ||
311a173b | 257 | void SetPosition( const wxPoint& pt ) { Move( pt ) ; } |
38759b67 | 258 | |
f03fc89f VZ |
259 | void GetSize( int *w, int *h ) const { DoGetSize(w, h); } |
260 | wxSize GetSize() const | |
261 | { | |
262 | int w, h; | |
263 | DoGetSize(& w, & h); | |
264 | return wxSize(w, h); | |
265 | } | |
266 | ||
267 | wxRect GetRect() const | |
268 | { | |
269 | int x, y, w, h; | |
270 | GetPosition(& x, & y); | |
271 | GetSize(& w, & h); | |
272 | ||
273 | return wxRect(x, y, w, h); | |
274 | } | |
275 | ||
276 | void GetClientSize( int *w, int *h ) const { DoGetClientSize(w, h); } | |
277 | wxSize GetClientSize() const | |
278 | { | |
279 | int w, h; | |
280 | DoGetClientSize(& w, & h); | |
281 | ||
282 | return wxSize(w, h); | |
283 | } | |
284 | ||
1e6feb95 VZ |
285 | // get the origin of the client area of the window relative to the |
286 | // window top left corner (the client area may be shifted because of | |
287 | // the borders, scrollbars, other decorations...) | |
288 | virtual wxPoint GetClientAreaOrigin() const; | |
289 | ||
290 | // get the client rectangle in window (i.e. client) coordinates | |
291 | wxRect GetClientRect() const | |
292 | { | |
293 | return wxRect(GetClientAreaOrigin(), GetClientSize()); | |
294 | } | |
295 | ||
f68586e5 | 296 | // get the size best suited for the window (in fact, minimal |
9f884528 RD |
297 | // acceptable size using which it will still look "nice" in |
298 | // most situations) | |
299 | wxSize GetBestSize() const | |
300 | { | |
301 | if (m_bestSizeCache.IsFullySpecified()) | |
302 | return m_bestSizeCache; | |
303 | return DoGetBestSize(); | |
304 | } | |
f68586e5 VZ |
305 | void GetBestSize(int *w, int *h) const |
306 | { | |
9f884528 | 307 | wxSize s = GetBestSize(); |
f68586e5 VZ |
308 | if ( w ) |
309 | *w = s.x; | |
310 | if ( h ) | |
311 | *h = s.y; | |
312 | } | |
313 | ||
9f884528 RD |
314 | // reset the cached best size value so it will be recalculated the |
315 | // next time it is needed. | |
316 | void InvalidateBestSize() { m_bestSizeCache = wxDefaultSize; } | |
317 | void CacheBestSize(const wxSize& size) const | |
318 | { wxConstCast(this, wxWindowBase)->m_bestSizeCache = size; } | |
319 | ||
2b5f62a0 VZ |
320 | // There are times (and windows) where 'Best' size and 'Min' size |
321 | // are vastly out of sync. This should be remedied somehow, but in | |
322 | // the meantime, this method will return the larger of BestSize | |
323 | // (the window's smallest legible size), and any user specified | |
324 | // MinSize hint. | |
325 | wxSize GetAdjustedBestSize() const | |
326 | { | |
9f884528 | 327 | wxSize s( GetBestSize() ); |
2b5f62a0 VZ |
328 | return wxSize( wxMax( s.x, GetMinWidth() ), wxMax( s.y, GetMinHeight() ) ); |
329 | } | |
330 | ||
9f884528 RD |
331 | // This function will merge the window's best size into the window's |
332 | // minimum size, giving priority to the min size components, and | |
333 | // returns the results. | |
334 | wxSize GetBestFittingSize() const; | |
335 | ||
336 | // A 'Smart' SetSize that will fill in default size values with 'best' | |
337 | // size. Sets the minsize to what was passed in. | |
338 | void SetBestFittingSize(const wxSize& size=wxDefaultSize); | |
339 | ||
2b5f62a0 | 340 | // the generic centre function - centers the window on parent by` |
7eb4e9cc VZ |
341 | // default or on screen if it doesn't have parent or |
342 | // wxCENTER_ON_SCREEN flag is given | |
c39eda94 VZ |
343 | void Centre( int direction = wxBOTH ); |
344 | void Center( int direction = wxBOTH ) { Centre(direction); } | |
7eb4e9cc VZ |
345 | |
346 | // centre on screen (only works for top level windows) | |
347 | void CentreOnScreen(int dir = wxBOTH) { Centre(dir | wxCENTER_ON_SCREEN); } | |
348 | void CenterOnScreen(int dir = wxBOTH) { CentreOnScreen(dir); } | |
349 | ||
350 | // centre with respect to the the parent window | |
351 | void CentreOnParent(int dir = wxBOTH) { Centre(dir | wxCENTER_FRAME); } | |
352 | void CenterOnParent(int dir = wxBOTH) { CentreOnParent(dir); } | |
f03fc89f VZ |
353 | |
354 | // set window size to wrap around its children | |
355 | virtual void Fit(); | |
356 | ||
2b5f62a0 VZ |
357 | // set virtual size to satisfy children |
358 | virtual void FitInside(); | |
359 | ||
f03fc89f VZ |
360 | // set min/max size of the window |
361 | virtual void SetSizeHints( int minW, int minH, | |
362 | int maxW = -1, int maxH = -1, | |
363 | int incW = -1, int incH = -1 ); | |
1ec25e8f RD |
364 | void SetSizeHints( const wxSize& minSize, |
365 | const wxSize& maxSize=wxDefaultSize, | |
366 | const wxSize& incSize=wxDefaultSize) | |
367 | { | |
368 | SetSizeHints(minSize.x, minSize.y, | |
369 | maxSize.x, maxSize.y, | |
370 | incSize.x, incSize.y); | |
371 | } | |
f03fc89f | 372 | |
566d84a7 RL |
373 | virtual void SetVirtualSizeHints( int minW, int minH, |
374 | int maxW = -1, int maxH = -1 ); | |
1ec25e8f RD |
375 | void SetVirtualSizeHints( const wxSize& minSize, |
376 | const wxSize& maxSize=wxDefaultSize) | |
377 | { | |
378 | SetVirtualSizeHints(minSize.x, minSize.y, maxSize.x, maxSize.y); | |
379 | } | |
566d84a7 | 380 | |
e7dda1ff VS |
381 | virtual int GetMinWidth() const { return m_minWidth; } |
382 | virtual int GetMinHeight() const { return m_minHeight; } | |
738f9e5a RR |
383 | int GetMaxWidth() const { return m_maxWidth; } |
384 | int GetMaxHeight() const { return m_maxHeight; } | |
57c4d796 | 385 | |
34c3ffca RL |
386 | // Override this method to control the values given to Sizers etc. |
387 | virtual wxSize GetMaxSize() const { return wxSize( m_maxWidth, m_maxHeight ); } | |
1ec25e8f | 388 | virtual wxSize GetMinSize() const { return wxSize( m_minWidth, m_minHeight ); } |
400a9e41 | 389 | |
49f1dc5e RD |
390 | void SetMinSize(const wxSize& minSize) { SetSizeHints(minSize); } |
391 | void SetMaxSize(const wxSize& maxSize) { SetSizeHints(GetMinSize(), maxSize); } | |
392 | ||
566d84a7 RL |
393 | // Methods for accessing the virtual size of a window. For most |
394 | // windows this is just the client area of the window, but for | |
395 | // some like scrolled windows it is more or less independent of | |
396 | // the screen window size. You may override the DoXXXVirtual | |
397 | // methods below for classes where that is is the case. | |
398 | ||
399 | void SetVirtualSize( const wxSize &size ) { DoSetVirtualSize( size.x, size.y ); } | |
400 | void SetVirtualSize( int x, int y ) { DoSetVirtualSize( x, y ); } | |
401 | ||
402 | wxSize GetVirtualSize() const { return DoGetVirtualSize(); } | |
403 | void GetVirtualSize( int *x, int *y ) const | |
404 | { | |
405 | wxSize s( DoGetVirtualSize() ); | |
406 | ||
407 | if( x ) | |
408 | *x = s.GetWidth(); | |
409 | if( y ) | |
410 | *y = s.GetHeight(); | |
411 | } | |
412 | ||
413 | // Override these methods for windows that have a virtual size | |
414 | // independent of their client size. eg. the virtual area of a | |
415 | // wxScrolledWindow. Default is to alias VirtualSize to ClientSize. | |
416 | ||
417 | virtual void DoSetVirtualSize( int x, int y ); | |
418 | virtual wxSize DoGetVirtualSize() const; // { return m_virtualSize; } | |
419 | ||
2b5f62a0 VZ |
420 | // Return the largest of ClientSize and BestSize (as determined |
421 | // by a sizer, interior children, or other means) | |
422 | ||
423 | virtual wxSize GetBestVirtualSize() const | |
424 | { | |
425 | wxSize client( GetClientSize() ); | |
426 | wxSize best( GetBestSize() ); | |
427 | ||
428 | return wxSize( wxMax( client.x, best.x ), wxMax( client.y, best.y ) ); | |
429 | } | |
430 | ||
f03fc89f VZ |
431 | // window state |
432 | // ------------ | |
433 | ||
d4864e97 | 434 | // returns true if window was shown/hidden, false if the nothing was |
f03fc89f | 435 | // done (window was already shown/hidden) |
d4864e97 VZ |
436 | virtual bool Show( bool show = true ); |
437 | bool Hide() { return Show(false); } | |
f03fc89f | 438 | |
d4864e97 VZ |
439 | // returns true if window was enabled/disabled, false if nothing done |
440 | virtual bool Enable( bool enable = true ); | |
441 | bool Disable() { return Enable(false); } | |
f03fc89f VZ |
442 | |
443 | bool IsShown() const { return m_isShown; } | |
444 | bool IsEnabled() const { return m_isEnabled; } | |
445 | ||
446 | // get/set window style (setting style won't update the window and so | |
447 | // is only useful for internal usage) | |
448 | virtual void SetWindowStyleFlag( long style ) { m_windowStyle = style; } | |
449 | virtual long GetWindowStyleFlag() const { return m_windowStyle; } | |
450 | ||
451 | // just some (somewhat shorter) synonims | |
452 | void SetWindowStyle( long style ) { SetWindowStyleFlag(style); } | |
453 | long GetWindowStyle() const { return GetWindowStyleFlag(); } | |
454 | ||
455 | bool HasFlag(int flag) const { return (m_windowStyle & flag) != 0; } | |
d80cd92a | 456 | virtual bool IsRetained() const { return HasFlag(wxRETAINED); } |
f03fc89f | 457 | |
d80cd92a VZ |
458 | // extra style: the less often used style bits which can't be set with |
459 | // SetWindowStyleFlag() | |
b2d5a7ee | 460 | virtual void SetExtraStyle(long exStyle) { m_exStyle = exStyle; } |
d80cd92a | 461 | long GetExtraStyle() const { return m_exStyle; } |
f03fc89f VZ |
462 | |
463 | // make the window modal (all other windows unresponsive) | |
d4864e97 | 464 | virtual void MakeModal(bool modal = true); |
f03fc89f | 465 | |
b8e7b673 VZ |
466 | |
467 | // (primitive) theming support | |
468 | // --------------------------- | |
469 | ||
a2d93e73 JS |
470 | virtual void SetThemeEnabled(bool enableTheme) { m_themeEnabled = enableTheme; } |
471 | virtual bool GetThemeEnabled() const { return m_themeEnabled; } | |
472 | ||
bd507486 RD |
473 | // Returns true if this class should have the background colour |
474 | // changed to match the parent window's theme. For example when a | |
475 | // page is added to a notebook it and it's children may need to have | |
476 | // the colours adjusted depending on the current theme settings, but | |
477 | // not all windows/controls can do this without looking wrong. | |
cc0bffac RD |
478 | virtual void ApplyParentThemeBackground(const wxColour& WXUNUSED(bg)) |
479 | { /* do nothing */ } | |
400a9e41 | 480 | |
d4864e97 | 481 | |
456bc6d9 VZ |
482 | // focus and keyboard handling |
483 | // --------------------------- | |
f03fc89f VZ |
484 | |
485 | // set focus to this window | |
486 | virtual void SetFocus() = 0; | |
487 | ||
d577d610 VZ |
488 | // set focus to this window as the result of a keyboard action |
489 | virtual void SetFocusFromKbd() { SetFocus(); } | |
490 | ||
f03fc89f VZ |
491 | // return the window which currently has the focus or NULL |
492 | static wxWindow *FindFocus() /* = 0: implement in derived classes */; | |
493 | ||
494 | // can this window have focus? | |
495 | virtual bool AcceptsFocus() const { return IsShown() && IsEnabled(); } | |
496 | ||
1e6feb95 VZ |
497 | // can this window be given focus by keyboard navigation? if not, the |
498 | // only way to give it focus (provided it accepts it at all) is to | |
499 | // click it | |
500 | virtual bool AcceptsFocusFromKeyboard() const { return AcceptsFocus(); } | |
501 | ||
456bc6d9 VZ |
502 | // NB: these methods really don't belong here but with the current |
503 | // class hierarchy there is no other place for them :-( | |
504 | ||
505 | // get the default child of this parent, i.e. the one which is | |
506 | // activated by pressing <Enter> | |
507 | virtual wxWindow *GetDefaultItem() const { return NULL; } | |
508 | ||
509 | // set this child as default, return the old default | |
510 | virtual wxWindow *SetDefaultItem(wxWindow * WXUNUSED(child)) | |
511 | { return NULL; } | |
512 | ||
036da5e3 VZ |
513 | // set this child as temporary default |
514 | virtual void SetTmpDefaultItem(wxWindow * WXUNUSED(win)) { } | |
515 | ||
a24de76b | 516 | // navigates in the specified direction by sending a wxNavigationKeyEvent |
eedc82f4 | 517 | virtual bool Navigate(int flags = wxNavigationKeyEvent::IsForward); |
5f6cfda7 | 518 | |
a24de76b VZ |
519 | // move this window just before/after the specified one in tab order |
520 | // (the other window must be our sibling!) | |
521 | void MoveBeforeInTabOrder(wxWindow *win) | |
522 | { DoMoveInTabOrder(win, MoveBefore); } | |
523 | void MoveAfterInTabOrder(wxWindow *win) | |
524 | { DoMoveInTabOrder(win, MoveAfter); } | |
525 | ||
526 | ||
f03fc89f VZ |
527 | // parent/children relations |
528 | // ------------------------- | |
529 | ||
530 | // get the list of children | |
531 | const wxWindowList& GetChildren() const { return m_children; } | |
532 | wxWindowList& GetChildren() { return m_children; } | |
533 | ||
1978421a SC |
534 | // needed just for extended runtime |
535 | const wxWindowList& GetWindowChildren() const { return GetChildren() ; } | |
536 | ||
f03fc89f VZ |
537 | // get the parent or the parent of the parent |
538 | wxWindow *GetParent() const { return m_parent; } | |
539 | inline wxWindow *GetGrandParent() const; | |
540 | ||
541 | // is this window a top level one? | |
8487f887 | 542 | virtual bool IsTopLevel() const; |
f03fc89f | 543 | |
87b6002d | 544 | // it doesn't really change parent, use Reparent() instead |
f03fc89f | 545 | void SetParent( wxWindowBase *parent ) { m_parent = (wxWindow *)parent; } |
d4864e97 VZ |
546 | // change the real parent of this window, return true if the parent |
547 | // was changed, false otherwise (error or newParent == oldParent) | |
f03fc89f VZ |
548 | virtual bool Reparent( wxWindowBase *newParent ); |
549 | ||
146ba0fe VZ |
550 | // implementation mostly |
551 | virtual void AddChild( wxWindowBase *child ); | |
552 | virtual void RemoveChild( wxWindowBase *child ); | |
553 | ||
554 | // looking for windows | |
555 | // ------------------- | |
556 | ||
f03fc89f VZ |
557 | // find window among the descendants of this one either by id or by |
558 | // name (return NULL if not found) | |
d9e2e4c2 | 559 | wxWindow *FindWindow( long winid ); |
f03fc89f VZ |
560 | wxWindow *FindWindow( const wxString& name ); |
561 | ||
146ba0fe | 562 | // Find a window among any window (all return NULL if not found) |
d9e2e4c2 | 563 | static wxWindow *FindWindowById( long winid, const wxWindow *parent = NULL ); |
146ba0fe VZ |
564 | static wxWindow *FindWindowByName( const wxString& name, |
565 | const wxWindow *parent = NULL ); | |
566 | static wxWindow *FindWindowByLabel( const wxString& label, | |
567 | const wxWindow *parent = NULL ); | |
f03fc89f VZ |
568 | |
569 | // event handler stuff | |
570 | // ------------------- | |
571 | ||
572 | // get the current event handler | |
573 | wxEvtHandler *GetEventHandler() const { return m_eventHandler; } | |
574 | ||
575 | // replace the event handler (allows to completely subclass the | |
576 | // window) | |
577 | void SetEventHandler( wxEvtHandler *handler ) { m_eventHandler = handler; } | |
578 | ||
579 | // push/pop event handler: allows to chain a custom event handler to | |
580 | // alreasy existing ones | |
581 | void PushEventHandler( wxEvtHandler *handler ); | |
d4864e97 | 582 | wxEvtHandler *PopEventHandler( bool deleteHandler = false ); |
f03fc89f | 583 | |
2e36d5cf | 584 | // find the given handler in the event handler chain and remove (but |
d4864e97 VZ |
585 | // not delete) it from the event handler chain, return true if it was |
586 | // found and false otherwise (this also results in an assert failure so | |
2e36d5cf VZ |
587 | // this function should only be called when the handler is supposed to |
588 | // be there) | |
589 | bool RemoveEventHandler(wxEvtHandler *handler); | |
590 | ||
1e6feb95 VZ |
591 | // validators |
592 | // ---------- | |
f03fc89f | 593 | |
88ac883a | 594 | #if wxUSE_VALIDATORS |
f03fc89f VZ |
595 | // a window may have an associated validator which is used to control |
596 | // user input | |
597 | virtual void SetValidator( const wxValidator &validator ); | |
598 | virtual wxValidator *GetValidator() { return m_windowValidator; } | |
88ac883a | 599 | #endif // wxUSE_VALIDATORS |
f03fc89f | 600 | |
f03fc89f VZ |
601 | |
602 | // dialog oriented functions | |
603 | // ------------------------- | |
604 | ||
d4864e97 | 605 | // validate the correctness of input, return true if ok |
f03fc89f VZ |
606 | virtual bool Validate(); |
607 | ||
608 | // transfer data between internal and GUI representations | |
609 | virtual bool TransferDataToWindow(); | |
610 | virtual bool TransferDataFromWindow(); | |
611 | ||
612 | virtual void InitDialog(); | |
613 | ||
88ac883a | 614 | #if wxUSE_ACCEL |
f03fc89f VZ |
615 | // accelerators |
616 | // ------------ | |
617 | virtual void SetAcceleratorTable( const wxAcceleratorTable& accel ) | |
618 | { m_acceleratorTable = accel; } | |
619 | wxAcceleratorTable *GetAcceleratorTable() | |
620 | { return &m_acceleratorTable; } | |
5048c832 | 621 | |
540b6b09 VZ |
622 | #endif // wxUSE_ACCEL |
623 | ||
624 | #if wxUSE_HOTKEY | |
625 | // hot keys (system wide accelerators) | |
626 | // ----------------------------------- | |
627 | ||
628 | virtual bool RegisterHotKey(int hotkeyId, int modifiers, int keycode); | |
5048c832 | 629 | virtual bool UnregisterHotKey(int hotkeyId); |
540b6b09 | 630 | #endif // wxUSE_HOTKEY |
5048c832 | 631 | |
f03fc89f VZ |
632 | |
633 | // dialog units translations | |
634 | // ------------------------- | |
635 | ||
636 | wxPoint ConvertPixelsToDialog( const wxPoint& pt ); | |
637 | wxPoint ConvertDialogToPixels( const wxPoint& pt ); | |
638 | wxSize ConvertPixelsToDialog( const wxSize& sz ) | |
639 | { | |
640 | wxPoint pt(ConvertPixelsToDialog(wxPoint(sz.x, sz.y))); | |
641 | ||
642 | return wxSize(pt.x, pt.y); | |
643 | } | |
644 | ||
645 | wxSize ConvertDialogToPixels( const wxSize& sz ) | |
646 | { | |
647 | wxPoint pt(ConvertDialogToPixels(wxPoint(sz.x, sz.y))); | |
648 | ||
649 | return wxSize(pt.x, pt.y); | |
650 | } | |
651 | ||
652 | // mouse functions | |
653 | // --------------- | |
654 | ||
655 | // move the mouse to the specified position | |
656 | virtual void WarpPointer(int x, int y) = 0; | |
657 | ||
94633ad9 VZ |
658 | // start or end mouse capture, these functions maintain the stack of |
659 | // windows having captured the mouse and after calling ReleaseMouse() | |
660 | // the mouse is not released but returns to the window which had had | |
661 | // captured it previously (if any) | |
662 | void CaptureMouse(); | |
663 | void ReleaseMouse(); | |
f03fc89f | 664 | |
1e6feb95 VZ |
665 | // get the window which currently captures the mouse or NULL |
666 | static wxWindow *GetCapture(); | |
667 | ||
668 | // does this window have the capture? | |
669 | virtual bool HasCapture() const | |
670 | { return (wxWindow *)this == GetCapture(); } | |
671 | ||
f03fc89f VZ |
672 | // painting the window |
673 | // ------------------- | |
674 | ||
675 | // mark the specified rectangle (or the whole window) as "dirty" so it | |
676 | // will be repainted | |
d4864e97 | 677 | virtual void Refresh( bool eraseBackground = true, |
f03fc89f | 678 | const wxRect *rect = (const wxRect *) NULL ) = 0; |
1e6feb95 VZ |
679 | |
680 | // a less awkward wrapper for Refresh | |
d4864e97 | 681 | void RefreshRect(const wxRect& rect) { Refresh(true, &rect); } |
1e6feb95 VZ |
682 | |
683 | // repaint all invalid areas of the window immediately | |
684 | virtual void Update() { } | |
685 | ||
5da0803c VZ |
686 | // clear the window background |
687 | virtual void ClearBackground(); | |
f03fc89f | 688 | |
0cc7251e VZ |
689 | // freeze the window: don't redraw it until it is thawed |
690 | virtual void Freeze() { } | |
691 | ||
692 | // thaw the window: redraw it after it had been frozen | |
693 | virtual void Thaw() { } | |
694 | ||
f03fc89f | 695 | // adjust DC for drawing on this window |
f6147cfc | 696 | virtual void PrepareDC( wxDC & WXUNUSED(dc) ) { } |
f03fc89f VZ |
697 | |
698 | // the update region of the window contains the areas which must be | |
699 | // repainted by the program | |
700 | const wxRegion& GetUpdateRegion() const { return m_updateRegion; } | |
701 | wxRegion& GetUpdateRegion() { return m_updateRegion; } | |
702 | ||
1e6feb95 VZ |
703 | // get the update rectangleregion bounding box in client coords |
704 | wxRect GetUpdateClientRect() const; | |
705 | ||
f03fc89f VZ |
706 | // these functions verify whether the given point/rectangle belongs to |
707 | // (or at least intersects with) the update region | |
708 | bool IsExposed( int x, int y ) const; | |
709 | bool IsExposed( int x, int y, int w, int h ) const; | |
710 | ||
711 | bool IsExposed( const wxPoint& pt ) const | |
712 | { return IsExposed(pt.x, pt.y); } | |
713 | bool IsExposed( const wxRect& rect ) const | |
714 | { return IsExposed(rect.x, rect.y, rect.width, rect.height); } | |
715 | ||
716 | // colours, fonts and cursors | |
717 | // -------------------------- | |
718 | ||
1b69c815 VZ |
719 | // get the default attributes for the controls of this class: we |
720 | // provide a virtual function which can be used to query the default | |
721 | // attributes of an existing control and a static function which can | |
722 | // be used even when no existing object of the given class is | |
723 | // available, but which won't return any styles specific to this | |
724 | // particular control, of course (e.g. "Ok" button might have | |
725 | // different -- bold for example -- font) | |
726 | virtual wxVisualAttributes GetDefaultAttributes() const | |
727 | { | |
728 | return GetClassDefaultAttributes(GetWindowVariant()); | |
729 | } | |
730 | ||
731 | static wxVisualAttributes | |
732 | GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL); | |
733 | ||
f03fc89f | 734 | // set/retrieve the window colours (system defaults are used by |
b8e7b673 | 735 | // default): SetXXX() functions return true if colour was changed, |
f8ff87ed VS |
736 | // SetDefaultXXX() reset the "m_inheritXXX" flag after setting the |
737 | // value to prevent it from being inherited by our children | |
b8e7b673 | 738 | virtual bool SetBackgroundColour(const wxColour& colour); |
fa47d7a7 | 739 | void SetOwnBackgroundColour(const wxColour& colour) |
b8e7b673 VZ |
740 | { |
741 | if ( SetBackgroundColour(colour) ) | |
f8ff87ed | 742 | m_inheritBgCol = false; |
b8e7b673 | 743 | } |
1b69c815 | 744 | wxColour GetBackgroundColour() const; |
b8e7b673 VZ |
745 | |
746 | virtual bool SetForegroundColour(const wxColour& colour); | |
fa47d7a7 | 747 | void SetOwnForegroundColour(const wxColour& colour) |
b8e7b673 VZ |
748 | { |
749 | if ( SetForegroundColour(colour) ) | |
f8ff87ed | 750 | m_inheritFgCol = false; |
b8e7b673 | 751 | } |
1b69c815 | 752 | wxColour GetForegroundColour() const; |
f03fc89f | 753 | |
b8e7b673 VZ |
754 | // set/retrieve the font for the window (SetFont() returns true if the |
755 | // font really changed) | |
756 | virtual bool SetFont(const wxFont& font) = 0; | |
fa47d7a7 | 757 | void SetOwnFont(const wxFont& font) |
b8e7b673 VZ |
758 | { |
759 | if ( SetFont(font) ) | |
f8ff87ed | 760 | m_inheritFont = false; |
b8e7b673 | 761 | } |
29094af0 | 762 | wxFont GetFont() const; |
b8e7b673 | 763 | |
d4864e97 | 764 | // set/retrieve the cursor for this window (SetCursor() returns true |
f03fc89f VZ |
765 | // if the cursor was really changed) |
766 | virtual bool SetCursor( const wxCursor &cursor ); | |
767 | const wxCursor& GetCursor() const { return m_cursor; } | |
f03fc89f | 768 | |
789295bf VZ |
769 | #if wxUSE_CARET |
770 | // associate a caret with the window | |
771 | void SetCaret(wxCaret *caret); | |
772 | // get the current caret (may be NULL) | |
773 | wxCaret *GetCaret() const { return m_caret; } | |
774 | #endif // wxUSE_CARET | |
775 | ||
f03fc89f VZ |
776 | // get the (average) character size for the current font |
777 | virtual int GetCharHeight() const = 0; | |
778 | virtual int GetCharWidth() const = 0; | |
779 | ||
780 | // get the width/height/... of the text using current or specified | |
781 | // font | |
782 | virtual void GetTextExtent(const wxString& string, | |
783 | int *x, int *y, | |
784 | int *descent = (int *) NULL, | |
785 | int *externalLeading = (int *) NULL, | |
786 | const wxFont *theFont = (const wxFont *) NULL) | |
787 | const = 0; | |
788 | ||
1e6feb95 VZ |
789 | // client <-> screen coords |
790 | // ------------------------ | |
791 | ||
f03fc89f | 792 | // translate to/from screen/client coordinates (pointers may be NULL) |
dabc0cd5 VZ |
793 | void ClientToScreen( int *x, int *y ) const |
794 | { DoClientToScreen(x, y); } | |
795 | void ScreenToClient( int *x, int *y ) const | |
796 | { DoScreenToClient(x, y); } | |
1e6feb95 VZ |
797 | |
798 | // wxPoint interface to do the same thing | |
dabc0cd5 VZ |
799 | wxPoint ClientToScreen(const wxPoint& pt) const |
800 | { | |
801 | int x = pt.x, y = pt.y; | |
802 | DoClientToScreen(&x, &y); | |
803 | ||
804 | return wxPoint(x, y); | |
805 | } | |
806 | ||
807 | wxPoint ScreenToClient(const wxPoint& pt) const | |
808 | { | |
809 | int x = pt.x, y = pt.y; | |
810 | DoScreenToClient(&x, &y); | |
811 | ||
812 | return wxPoint(x, y); | |
813 | } | |
f03fc89f | 814 | |
1e6feb95 VZ |
815 | // test where the given (in client coords) point lies |
816 | wxHitTest HitTest(wxCoord x, wxCoord y) const | |
817 | { return DoHitTest(x, y); } | |
818 | ||
819 | wxHitTest HitTest(const wxPoint& pt) const | |
820 | { return DoHitTest(pt.x, pt.y); } | |
821 | ||
f03fc89f VZ |
822 | // misc |
823 | // ---- | |
824 | ||
aede4ebb VZ |
825 | // get the window border style from the given flags: this is different from |
826 | // simply doing flags & wxBORDER_MASK because it uses GetDefaultBorder() to | |
827 | // translate wxBORDER_DEFAULT to something reasonable | |
828 | wxBorder GetBorder(long flags) const; | |
829 | ||
830 | // get border for the flags of this window | |
831 | wxBorder GetBorder() const { return GetBorder(GetWindowStyleFlag()); } | |
1e6feb95 | 832 | |
d4864e97 | 833 | // send wxUpdateUIEvents to this window, and children if recurse is true |
e39af974 JS |
834 | virtual void UpdateWindowUI(long flags = wxUPDATE_UI_NONE); |
835 | ||
836 | // do the window-specific processing after processing the update event | |
837 | virtual void DoUpdateWindowUI(wxUpdateUIEvent& event) ; | |
f03fc89f | 838 | |
1e6feb95 | 839 | #if wxUSE_MENUS |
45b8a256 | 840 | bool PopupMenu(wxMenu *menu, const wxPoint& pos = wxDefaultPosition) |
a1665b22 | 841 | { return DoPopupMenu(menu, pos.x, pos.y); } |
971562cb | 842 | bool PopupMenu(wxMenu *menu, int x, int y) |
a1665b22 | 843 | { return DoPopupMenu(menu, x, y); } |
1e6feb95 | 844 | #endif // wxUSE_MENUS |
f03fc89f VZ |
845 | |
846 | // scrollbars | |
847 | // ---------- | |
848 | ||
1e6feb95 VZ |
849 | // does the window have the scrollbar for this orientation? |
850 | bool HasScrollbar(int orient) const | |
851 | { | |
852 | return (m_windowStyle & | |
853 | (orient == wxHORIZONTAL ? wxHSCROLL : wxVSCROLL)) != 0; | |
854 | } | |
855 | ||
f03fc89f VZ |
856 | // configure the window scrollbars |
857 | virtual void SetScrollbar( int orient, | |
858 | int pos, | |
1e6feb95 | 859 | int thumbvisible, |
f03fc89f | 860 | int range, |
d4864e97 VZ |
861 | bool refresh = true ) = 0; |
862 | virtual void SetScrollPos( int orient, int pos, bool refresh = true ) = 0; | |
f03fc89f VZ |
863 | virtual int GetScrollPos( int orient ) const = 0; |
864 | virtual int GetScrollThumb( int orient ) const = 0; | |
865 | virtual int GetScrollRange( int orient ) const = 0; | |
866 | ||
867 | // scroll window to the specified position | |
868 | virtual void ScrollWindow( int dx, int dy, | |
869 | const wxRect* rect = (wxRect *) NULL ) = 0; | |
870 | ||
b9b3393e | 871 | // scrolls window by line/page: note that not all controls support this |
9cd6d737 | 872 | // |
d4864e97 VZ |
873 | // return true if the position changed, false otherwise |
874 | virtual bool ScrollLines(int WXUNUSED(lines)) { return false; } | |
875 | virtual bool ScrollPages(int WXUNUSED(pages)) { return false; } | |
9cd6d737 VZ |
876 | |
877 | // convenient wrappers for ScrollLines/Pages | |
878 | bool LineUp() { return ScrollLines(-1); } | |
879 | bool LineDown() { return ScrollLines(1); } | |
880 | bool PageUp() { return ScrollPages(-1); } | |
881 | bool PageDown() { return ScrollPages(1); } | |
b9b3393e | 882 | |
bd83cb56 VZ |
883 | // context-sensitive help |
884 | // ---------------------- | |
885 | ||
886 | // these are the convenience functions wrapping wxHelpProvider methods | |
887 | ||
888 | #if wxUSE_HELP | |
889 | // associate this help text with this window | |
890 | void SetHelpText(const wxString& text); | |
891 | // associate this help text with all windows with the same id as this | |
892 | // one | |
893 | void SetHelpTextForId(const wxString& text); | |
894 | // get the help string associated with this window (may be empty) | |
895 | wxString GetHelpText() const; | |
896 | #endif // wxUSE_HELP | |
897 | ||
f03fc89f VZ |
898 | // tooltips |
899 | // -------- | |
bd83cb56 | 900 | |
f03fc89f VZ |
901 | #if wxUSE_TOOLTIPS |
902 | // the easiest way to set a tooltip for a window is to use this method | |
903 | void SetToolTip( const wxString &tip ); | |
904 | // attach a tooltip to the window | |
905 | void SetToolTip( wxToolTip *tip ) { DoSetToolTip(tip); } | |
906 | // get the associated tooltip or NULL if none | |
907 | wxToolTip* GetToolTip() const { return m_tooltip; } | |
311a173b | 908 | wxString GetToolTipText() const ; |
f03fc89f VZ |
909 | #endif // wxUSE_TOOLTIPS |
910 | ||
911 | // drag and drop | |
912 | // ------------- | |
913 | #if wxUSE_DRAG_AND_DROP | |
914 | // set/retrieve the drop target associated with this window (may be | |
915 | // NULL; it's owned by the window and will be deleted by it) | |
916 | virtual void SetDropTarget( wxDropTarget *dropTarget ) = 0; | |
917 | virtual wxDropTarget *GetDropTarget() const { return m_dropTarget; } | |
918 | #endif // wxUSE_DRAG_AND_DROP | |
919 | ||
920 | // constraints and sizers | |
921 | // ---------------------- | |
922 | #if wxUSE_CONSTRAINTS | |
923 | // set the constraints for this window or retrieve them (may be NULL) | |
924 | void SetConstraints( wxLayoutConstraints *constraints ); | |
925 | wxLayoutConstraints *GetConstraints() const { return m_constraints; } | |
926 | ||
f03fc89f VZ |
927 | // implementation only |
928 | void UnsetConstraints(wxLayoutConstraints *c); | |
929 | wxWindowList *GetConstraintsInvolvedIn() const | |
930 | { return m_constraintsInvolvedIn; } | |
931 | void AddConstraintReference(wxWindowBase *otherWin); | |
932 | void RemoveConstraintReference(wxWindowBase *otherWin); | |
933 | void DeleteRelatedConstraints(); | |
934 | void ResetConstraints(); | |
935 | ||
936 | // these methods may be overriden for special layout algorithms | |
d4864e97 | 937 | virtual void SetConstraintSizes(bool recurse = true); |
f03fc89f VZ |
938 | virtual bool LayoutPhase1(int *noChanges); |
939 | virtual bool LayoutPhase2(int *noChanges); | |
4b7f2165 | 940 | virtual bool DoPhase(int phase); |
f03fc89f VZ |
941 | |
942 | // these methods are virtual but normally won't be overridden | |
f03fc89f VZ |
943 | virtual void SetSizeConstraint(int x, int y, int w, int h); |
944 | virtual void MoveConstraint(int x, int y); | |
945 | virtual void GetSizeConstraint(int *w, int *h) const ; | |
946 | virtual void GetClientSizeConstraint(int *w, int *h) const ; | |
947 | virtual void GetPositionConstraint(int *x, int *y) const ; | |
948 | ||
461e93f9 JS |
949 | #endif // wxUSE_CONSTRAINTS |
950 | ||
951 | // when using constraints or sizers, it makes sense to update | |
952 | // children positions automatically whenever the window is resized | |
953 | // - this is done if autoLayout is on | |
954 | void SetAutoLayout( bool autoLayout ) { m_autoLayout = autoLayout; } | |
955 | bool GetAutoLayout() const { return m_autoLayout; } | |
956 | ||
957 | // lay out the window and its children | |
958 | virtual bool Layout(); | |
959 | ||
f03fc89f | 960 | // sizers |
d4864e97 VZ |
961 | void SetSizer(wxSizer *sizer, bool deleteOld = true ); |
962 | void SetSizerAndFit( wxSizer *sizer, bool deleteOld = true ); | |
566d84a7 | 963 | |
f03fc89f | 964 | wxSizer *GetSizer() const { return m_windowSizer; } |
be90c029 RD |
965 | |
966 | // Track if this window is a member of a sizer | |
1ebfafde | 967 | void SetContainingSizer(wxSizer* sizer); |
be90c029 RD |
968 | wxSizer *GetContainingSizer() const { return m_containingSizer; } |
969 | ||
45a959a3 JS |
970 | // accessibility |
971 | // ---------------------- | |
972 | #if wxUSE_ACCESSIBILITY | |
973 | // Override to create a specific accessible object. | |
974 | virtual wxAccessible* CreateAccessible(); | |
975 | ||
976 | // Sets the accessible object. | |
977 | void SetAccessible(wxAccessible* accessible) ; | |
978 | ||
979 | // Returns the accessible object. | |
980 | wxAccessible* GetAccessible() { return m_accessible; }; | |
981 | ||
982 | // Returns the accessible object, creating if necessary. | |
983 | wxAccessible* GetOrCreateAccessible() ; | |
984 | #endif | |
985 | ||
f03fc89f VZ |
986 | // implementation |
987 | // -------------- | |
988 | ||
989 | // event handlers | |
990 | void OnSysColourChanged( wxSysColourChangedEvent& event ); | |
991 | void OnInitDialog( wxInitDialogEvent &event ); | |
72fc5caf | 992 | void OnMiddleClick( wxMouseEvent& event ); |
bd83cb56 VZ |
993 | #if wxUSE_HELP |
994 | void OnHelp(wxHelpEvent& event); | |
995 | #endif // wxUSE_HELP | |
f03fc89f | 996 | |
e39af974 JS |
997 | // virtual function for implementing internal idle |
998 | // behaviour | |
999 | virtual void OnInternalIdle() {} | |
1000 | ||
1001 | // call internal idle recursively | |
5109ae5d | 1002 | // void ProcessInternalIdle() ; |
e39af974 JS |
1003 | |
1004 | // get the handle of the window for the underlying window system: this | |
d7c24517 VZ |
1005 | // is only used for wxWin itself or for user code which wants to call |
1006 | // platform-specific APIs | |
d22699b5 | 1007 | virtual WXWidget GetHandle() const = 0; |
cc2b7472 | 1008 | |
574c939e KB |
1009 | #if wxUSE_PALETTE |
1010 | // Store the palette used by DCs in wxWindow so that the dcs can share | |
1011 | // a palette. And we can respond to palette messages. | |
1012 | wxPalette GetPalette() const { return m_palette; } | |
b95edd47 | 1013 | |
574c939e KB |
1014 | // When palette is changed tell the DC to set the system palette to the |
1015 | // new one. | |
b95edd47 VZ |
1016 | void SetPalette(const wxPalette& pal); |
1017 | ||
1018 | // return true if we have a specific palette | |
1019 | bool HasCustomPalette() const { return m_hasCustomPalette; } | |
1020 | ||
1021 | // return the first parent window with a custom palette or NULL | |
1022 | wxWindow *GetAncestorWithCustomPalette() const; | |
574c939e KB |
1023 | #endif // wxUSE_PALETTE |
1024 | ||
b8e7b673 VZ |
1025 | // inherit the parents visual attributes if they had been explicitly set |
1026 | // by the user (i.e. we don't inherit default attributes) and if we don't | |
1027 | // have our own explicitly set | |
1028 | virtual void InheritAttributes(); | |
1029 | ||
1030 | // returns false from here if this window doesn't want to inherit the | |
1031 | // parents colours even if InheritAttributes() would normally do it | |
1032 | // | |
1033 | // this just provides a simple way to customize InheritAttributes() | |
1034 | // behaviour in the most common case | |
1035 | virtual bool ShouldInheritColours() const { return false; } | |
1036 | ||
245c5d2e RD |
1037 | protected: |
1038 | // event handling specific to wxWindow | |
1039 | virtual bool TryValidator(wxEvent& event); | |
1040 | virtual bool TryParent(wxEvent& event); | |
1041 | ||
a24de76b VZ |
1042 | // common part of MoveBefore/AfterInTabOrder() |
1043 | enum MoveKind | |
1044 | { | |
1045 | MoveBefore, // insert before the given window | |
1046 | MoveAfter // insert after the given window | |
1047 | }; | |
1048 | virtual void DoMoveInTabOrder(wxWindow *win, MoveKind move); | |
4caf847c | 1049 | |
ec5bb70d VZ |
1050 | #if wxUSE_CONSTRAINTS |
1051 | // satisfy the constraints for the windows but don't set the window sizes | |
1052 | void SatisfyConstraints(); | |
1053 | #endif // wxUSE_CONSTRAINTS | |
566d84a7 | 1054 | |
7de59551 RD |
1055 | // Send the wxWindowDestroyEvent |
1056 | void SendDestroyEvent(); | |
1057 | ||
7af6f327 | 1058 | // the window id - a number which uniquely identifies a window among |
d7c24517 | 1059 | // its siblings unless it is -1 |
f03fc89f | 1060 | wxWindowID m_windowId; |
456bc6d9 | 1061 | |
f03fc89f VZ |
1062 | // the parent window of this window (or NULL) and the list of the children |
1063 | // of this window | |
1064 | wxWindow *m_parent; | |
1065 | wxWindowList m_children; | |
1066 | ||
1067 | // the minimal allowed size for the window (no minimal size if variable(s) | |
1068 | // contain(s) -1) | |
ec5bb70d VZ |
1069 | int m_minWidth, |
1070 | m_minHeight, | |
1071 | m_maxWidth, | |
1072 | m_maxHeight; | |
f03fc89f VZ |
1073 | |
1074 | // event handler for this window: usually is just 'this' but may be | |
1075 | // changed with SetEventHandler() | |
1076 | wxEvtHandler *m_eventHandler; | |
1077 | ||
88ac883a | 1078 | #if wxUSE_VALIDATORS |
f03fc89f VZ |
1079 | // associated validator or NULL if none |
1080 | wxValidator *m_windowValidator; | |
88ac883a | 1081 | #endif // wxUSE_VALIDATORS |
f03fc89f VZ |
1082 | |
1083 | #if wxUSE_DRAG_AND_DROP | |
1084 | wxDropTarget *m_dropTarget; | |
1085 | #endif // wxUSE_DRAG_AND_DROP | |
1086 | ||
1087 | // visual window attributes | |
1088 | wxCursor m_cursor; | |
1b69c815 VZ |
1089 | wxFont m_font; // see m_hasFont |
1090 | wxColour m_backgroundColour, // m_hasBgCol | |
1091 | m_foregroundColour; // m_hasFgCol | |
f03fc89f | 1092 | |
789295bf VZ |
1093 | #if wxUSE_CARET |
1094 | wxCaret *m_caret; | |
1095 | #endif // wxUSE_CARET | |
1096 | ||
f03fc89f VZ |
1097 | // the region which should be repainted in response to paint event |
1098 | wxRegion m_updateRegion; | |
1099 | ||
88ac883a | 1100 | #if wxUSE_ACCEL |
f03fc89f VZ |
1101 | // the accelerator table for the window which translates key strokes into |
1102 | // command events | |
1103 | wxAcceleratorTable m_acceleratorTable; | |
88ac883a | 1104 | #endif // wxUSE_ACCEL |
f03fc89f | 1105 | |
f03fc89f VZ |
1106 | // the tooltip for this window (may be NULL) |
1107 | #if wxUSE_TOOLTIPS | |
1108 | wxToolTip *m_tooltip; | |
1109 | #endif // wxUSE_TOOLTIPS | |
1110 | ||
1111 | // constraints and sizers | |
1112 | #if wxUSE_CONSTRAINTS | |
1113 | // the constraints for this window or NULL | |
1114 | wxLayoutConstraints *m_constraints; | |
1115 | ||
1116 | // constraints this window is involved in | |
1117 | wxWindowList *m_constraintsInvolvedIn; | |
461e93f9 | 1118 | #endif // wxUSE_CONSTRAINTS |
f03fc89f | 1119 | |
be90c029 | 1120 | // this window's sizer |
f03fc89f | 1121 | wxSizer *m_windowSizer; |
be90c029 RD |
1122 | |
1123 | // The sizer this window is a member of, if any | |
1124 | wxSizer *m_containingSizer; | |
f03fc89f VZ |
1125 | |
1126 | // Layout() window automatically when its size changes? | |
1127 | bool m_autoLayout:1; | |
f03fc89f VZ |
1128 | |
1129 | // window state | |
1130 | bool m_isShown:1; | |
1131 | bool m_isEnabled:1; | |
1132 | bool m_isBeingDeleted:1; | |
1133 | ||
23895080 VZ |
1134 | // was the window colours/font explicitly changed by user? |
1135 | bool m_hasBgCol:1; | |
1136 | bool m_hasFgCol:1; | |
1137 | bool m_hasFont:1; | |
f8ff87ed VS |
1138 | |
1139 | // and should it be inherited by children? | |
1140 | bool m_inheritBgCol:1; | |
1141 | bool m_inheritFgCol:1; | |
1142 | bool m_inheritFont:1; | |
23895080 | 1143 | |
f03fc89f | 1144 | // window attributes |
d80cd92a VZ |
1145 | long m_windowStyle, |
1146 | m_exStyle; | |
f03fc89f | 1147 | wxString m_windowName; |
a2d93e73 | 1148 | bool m_themeEnabled; |
f03fc89f | 1149 | |
071e5fd9 | 1150 | #if wxUSE_PALETTE |
574c939e | 1151 | wxPalette m_palette; |
b95edd47 VZ |
1152 | bool m_hasCustomPalette; |
1153 | #endif // wxUSE_PALETTE | |
574c939e | 1154 | |
45a959a3 JS |
1155 | #if wxUSE_ACCESSIBILITY |
1156 | wxAccessible* m_accessible; | |
1157 | #endif | |
2654f7e4 | 1158 | |
566d84a7 RL |
1159 | // Virtual size (scrolling) |
1160 | wxSize m_virtualSize; | |
1161 | ||
1162 | int m_minVirtualWidth; // VirtualSizeHints | |
1163 | int m_minVirtualHeight; | |
1164 | int m_maxVirtualWidth; | |
1165 | int m_maxVirtualHeight; | |
400a9e41 | 1166 | |
69d90995 | 1167 | wxWindowVariant m_windowVariant ; |
45e0dc94 | 1168 | |
1e6feb95 VZ |
1169 | // override this to change the default (i.e. used when no style is |
1170 | // specified) border for the window class | |
1171 | virtual wxBorder GetDefaultBorder() const; | |
1172 | ||
5c2be659 RD |
1173 | // Get the default size for the new window if no explicit size given. TLWs |
1174 | // have their own default size so this is just for non top-level windows. | |
66202a7e RD |
1175 | static int WidthDefault(int w) { return w == -1 ? 20 : w; } |
1176 | static int HeightDefault(int h) { return h == -1 ? 20 : h; } | |
f03fc89f | 1177 | |
9f884528 RD |
1178 | |
1179 | // Used to save the results of DoGetBestSize so it doesn't need to be | |
1180 | // recalculated each time the value is needed. | |
1181 | wxSize m_bestSizeCache; | |
1182 | ||
fe161a26 RD |
1183 | // keep the old name for compatibility, at least until all the internal |
1184 | // usages of it are changed to SetBestFittingSize | |
1185 | void SetBestSize(const wxSize& size) { SetBestFittingSize(size); } | |
1186 | ||
d3b5db4b RD |
1187 | // set the initial window size if none is given (i.e. at least one of the |
1188 | // components of the size passed to ctor/Create() is -1) | |
1189 | // | |
1190 | // normally just calls SetBestSize() for controls, but can be overridden | |
1191 | // not to do it for the controls which have to do some additional | |
1192 | // initialization (e.g. add strings to list box) before their best size | |
1193 | // can be accurately calculated | |
1194 | virtual void SetInitialBestSize(const wxSize& WXUNUSED(size)) {} | |
1195 | ||
9f884528 | 1196 | |
d3b5db4b | 1197 | |
f03fc89f VZ |
1198 | // more pure virtual functions |
1199 | // --------------------------- | |
1200 | ||
1201 | // NB: we must have DoSomething() function when Something() is an overloaded | |
1202 | // method: indeed, we can't just have "virtual Something()" in case when | |
1203 | // the function is overloaded because then we'd have to make virtual all | |
1204 | // the variants (otherwise only the virtual function may be called on a | |
1205 | // pointer to derived class according to C++ rules) which is, in | |
1206 | // general, absolutely not needed. So instead we implement all | |
1207 | // overloaded Something()s in terms of DoSomething() which will be the | |
1208 | // only one to be virtual. | |
1209 | ||
dabc0cd5 VZ |
1210 | // coordinates translation |
1211 | virtual void DoClientToScreen( int *x, int *y ) const = 0; | |
1212 | virtual void DoScreenToClient( int *x, int *y ) const = 0; | |
1213 | ||
1e6feb95 VZ |
1214 | virtual wxHitTest DoHitTest(wxCoord x, wxCoord y) const; |
1215 | ||
94633ad9 | 1216 | // capture/release the mouse, used by Capture/ReleaseMouse() |
a83e1475 VZ |
1217 | virtual void DoCaptureMouse() = 0; |
1218 | virtual void DoReleaseMouse() = 0; | |
be90c029 | 1219 | |
f03fc89f VZ |
1220 | // retrieve the position/size of the window |
1221 | virtual void DoGetPosition( int *x, int *y ) const = 0; | |
1222 | virtual void DoGetSize( int *width, int *height ) const = 0; | |
1223 | virtual void DoGetClientSize( int *width, int *height ) const = 0; | |
1224 | ||
f68586e5 VZ |
1225 | // get the size which best suits the window: for a control, it would be |
1226 | // the minimal size which doesn't truncate the control, for a panel - the | |
1227 | // same size as it would have after a call to Fit() | |
1228 | virtual wxSize DoGetBestSize() const; | |
1229 | ||
f03fc89f VZ |
1230 | // this is the virtual function to be overriden in any derived class which |
1231 | // wants to change how SetSize() or Move() works - it is called by all | |
1232 | // versions of these functions in the base class | |
1233 | virtual void DoSetSize(int x, int y, | |
1234 | int width, int height, | |
1235 | int sizeFlags = wxSIZE_AUTO) = 0; | |
1236 | ||
1237 | // same as DoSetSize() for the client size | |
1238 | virtual void DoSetClientSize(int width, int height) = 0; | |
1239 | ||
9d9b7755 VZ |
1240 | // move the window to the specified location and resize it: this is called |
1241 | // from both DoSetSize() and DoSetClientSize() and would usually just | |
1242 | // reposition this window except for composite controls which will want to | |
1243 | // arrange themselves inside the given rectangle | |
1244 | virtual void DoMoveWindow(int x, int y, int width, int height) = 0; | |
1245 | ||
f03fc89f VZ |
1246 | #if wxUSE_TOOLTIPS |
1247 | virtual void DoSetToolTip( wxToolTip *tip ); | |
1248 | #endif // wxUSE_TOOLTIPS | |
1249 | ||
1e6feb95 | 1250 | #if wxUSE_MENUS |
971562cb | 1251 | virtual bool DoPopupMenu(wxMenu *menu, int x, int y) = 0; |
1e6feb95 | 1252 | #endif // wxUSE_MENUS |
a1665b22 | 1253 | |
716e96df VZ |
1254 | // Makes an adjustment to the window position to make it relative to the |
1255 | // parents client area, e.g. if the parent is a frame with a toolbar, its | |
1256 | // (0, 0) is just below the toolbar | |
1257 | virtual void AdjustForParentClientOrigin(int& x, int& y, | |
1258 | int sizeFlags = 0) const; | |
8d99be5f | 1259 | |
69d90995 SC |
1260 | // implements the window variants |
1261 | virtual void DoSetWindowVariant( wxWindowVariant variant ) ; | |
45e0dc94 | 1262 | |
f03fc89f VZ |
1263 | private: |
1264 | // contains the last id generated by NewControlId | |
1265 | static int ms_lastControlId; | |
1266 | ||
a83e1475 VZ |
1267 | // the stack of windows which have captured the mouse |
1268 | static struct WXDLLEXPORT wxWindowNext *ms_winCaptureNext; | |
1269 | ||
1e6feb95 VZ |
1270 | DECLARE_ABSTRACT_CLASS(wxWindowBase) |
1271 | DECLARE_NO_COPY_CLASS(wxWindowBase) | |
f03fc89f VZ |
1272 | DECLARE_EVENT_TABLE() |
1273 | }; | |
1274 | ||
1275 | // ---------------------------------------------------------------------------- | |
1276 | // now include the declaration of wxWindow class | |
1277 | // ---------------------------------------------------------------------------- | |
1278 | ||
1e6feb95 | 1279 | // include the declaration of the platform-specific class |
2049ba38 | 1280 | #if defined(__WXMSW__) |
a5b3669d VZ |
1281 | #ifdef __WXUNIVERSAL__ |
1282 | #define wxWindowNative wxWindowMSW | |
1283 | #else // !wxUniv | |
1e6feb95 | 1284 | #define wxWindowMSW wxWindow |
a5b3669d | 1285 | #endif // wxUniv/!wxUniv |
f03fc89f | 1286 | #include "wx/msw/window.h" |
2049ba38 | 1287 | #elif defined(__WXMOTIF__) |
f03fc89f | 1288 | #include "wx/motif/window.h" |
2049ba38 | 1289 | #elif defined(__WXGTK__) |
a5b3669d VZ |
1290 | #ifdef __WXUNIVERSAL__ |
1291 | #define wxWindowNative wxWindowGTK | |
1292 | #else // !wxUniv | |
1e6feb95 | 1293 | #define wxWindowGTK wxWindow |
1e6feb95 | 1294 | #endif // wxUniv |
f03fc89f | 1295 | #include "wx/gtk/window.h" |
83df96d6 JS |
1296 | #elif defined(__WXX11__) |
1297 | #ifdef __WXUNIVERSAL__ | |
1298 | #define wxWindowNative wxWindowX11 | |
1299 | #else // !wxUniv | |
1300 | #define wxWindowX11 wxWindow | |
83df96d6 JS |
1301 | #endif // wxUniv |
1302 | #include "wx/x11/window.h" | |
711c76db | 1303 | #elif defined(__WXMGL__) |
386c7058 VS |
1304 | #ifdef __WXUNIVERSAL__ |
1305 | #define wxWindowNative wxWindowMGL | |
1306 | #else // !wxUniv | |
1307 | #define wxWindowMGL wxWindow | |
386c7058 VS |
1308 | #endif // wxUniv |
1309 | #include "wx/mgl/window.h" | |
34138703 | 1310 | #elif defined(__WXMAC__) |
e766c8a9 SC |
1311 | #ifdef __WXUNIVERSAL__ |
1312 | #define wxWindowNative wxWindowMac | |
1313 | #else // !wxUniv | |
1314 | #define wxWindowMac wxWindow | |
e766c8a9 | 1315 | #endif // wxUniv |
f03fc89f | 1316 | #include "wx/mac/window.h" |
e64df9bc DE |
1317 | #elif defined(__WXCOCOA__) |
1318 | #ifdef __WXUNIVERSAL__ | |
1319 | #define wxWindowNative wxWindowCocoa | |
1320 | #else // !wxUniv | |
1321 | #define wxWindowCocoa wxWindow | |
e64df9bc DE |
1322 | #endif // wxUniv |
1323 | #include "wx/cocoa/window.h" | |
1777b9bb | 1324 | #elif defined(__WXPM__) |
210a651b DW |
1325 | #ifdef __WXUNIVERSAL__ |
1326 | #define wxWindowNative wxWindowOS2 | |
1327 | #else // !wxUniv | |
1328 | #define wxWindowOS2 wxWindow | |
210a651b | 1329 | #endif // wxUniv/!wxUniv |
1777b9bb | 1330 | #include "wx/os2/window.h" |
c801d85f KB |
1331 | #endif |
1332 | ||
1e6feb95 VZ |
1333 | // for wxUniversal, we now derive the real wxWindow from wxWindow<platform>, |
1334 | // for the native ports we already have defined it above | |
1335 | #if defined(__WXUNIVERSAL__) | |
a5b3669d VZ |
1336 | #ifndef wxWindowNative |
1337 | #error "wxWindowNative must be defined above!" | |
1338 | #endif | |
1339 | ||
1e6feb95 VZ |
1340 | #include "wx/univ/window.h" |
1341 | #endif // wxUniv | |
1342 | ||
f03fc89f VZ |
1343 | // ---------------------------------------------------------------------------- |
1344 | // inline functions which couldn't be declared in the class body because of | |
1345 | // forward dependencies | |
1346 | // ---------------------------------------------------------------------------- | |
1347 | ||
bacd69f9 | 1348 | inline wxWindow *wxWindowBase::GetGrandParent() const |
f03fc89f VZ |
1349 | { |
1350 | return m_parent ? m_parent->GetParent() : (wxWindow *)NULL; | |
1351 | } | |
1352 | ||
1353 | // ---------------------------------------------------------------------------- | |
3723b7b1 | 1354 | // global functions |
f03fc89f VZ |
1355 | // ---------------------------------------------------------------------------- |
1356 | ||
3723b7b1 JS |
1357 | // Find the wxWindow at the current mouse position, also returning the mouse |
1358 | // position. | |
1359 | WXDLLEXPORT extern wxWindow* wxFindWindowAtPointer(wxPoint& pt); | |
1360 | ||
1361 | // Get the current mouse position. | |
1362 | WXDLLEXPORT extern wxPoint wxGetMousePosition(); | |
1363 | ||
1e6feb95 VZ |
1364 | // get the currently active window of this application or NULL |
1365 | WXDLLEXPORT extern wxWindow *wxGetActiveWindow(); | |
1366 | ||
33b494d6 VZ |
1367 | // get the (first) top level parent window |
1368 | WXDLLEXPORT wxWindow* wxGetTopLevelParent(wxWindow *win); | |
1369 | ||
f68586e5 | 1370 | // deprecated (doesn't start with 'wx' prefix), use wxWindow::NewControlId() |
6d56eb5c | 1371 | inline int NewControlId() { return wxWindowBase::NewControlId(); } |
f03fc89f | 1372 | |
45a959a3 JS |
1373 | #if wxUSE_ACCESSIBILITY |
1374 | // ---------------------------------------------------------------------------- | |
1375 | // accessible object for windows | |
1376 | // ---------------------------------------------------------------------------- | |
1377 | ||
1378 | class WXDLLEXPORT wxWindowAccessible: public wxAccessible | |
1379 | { | |
1380 | public: | |
f81387bd | 1381 | wxWindowAccessible(wxWindow* win): wxAccessible(win) { if (win) win->SetAccessible(this); } |
45a959a3 JS |
1382 | virtual ~wxWindowAccessible() {}; |
1383 | ||
1384 | // Overridables | |
1385 | ||
1386 | // Can return either a child object, or an integer | |
1387 | // representing the child element, starting from 1. | |
1388 | virtual wxAccStatus HitTest(const wxPoint& pt, int* childId, wxAccessible** childObject); | |
1389 | ||
1390 | // Returns the rectangle for this object (id = 0) or a child element (id > 0). | |
1391 | virtual wxAccStatus GetLocation(wxRect& rect, int elementId); | |
1392 | ||
1393 | // Navigates from fromId to toId/toObject. | |
1394 | virtual wxAccStatus Navigate(wxNavDir navDir, int fromId, | |
1395 | int* toId, wxAccessible** toObject); | |
1396 | ||
1397 | // Gets the name of the specified object. | |
1398 | virtual wxAccStatus GetName(int childId, wxString* name); | |
1399 | ||
1400 | // Gets the number of children. | |
a37e4a07 | 1401 | virtual wxAccStatus GetChildCount(int* childCount); |
45a959a3 JS |
1402 | |
1403 | // Gets the specified child (starting from 1). | |
1404 | // If *child is NULL and return value is wxACC_OK, | |
1405 | // this means that the child is a simple element and | |
1406 | // not an accessible object. | |
1407 | virtual wxAccStatus GetChild(int childId, wxAccessible** child); | |
1408 | ||
1409 | // Gets the parent, or NULL. | |
1410 | virtual wxAccStatus GetParent(wxAccessible** parent); | |
1411 | ||
1412 | // Performs the default action. childId is 0 (the action for this object) | |
1413 | // or > 0 (the action for a child). | |
1414 | // Return wxACC_NOT_SUPPORTED if there is no default action for this | |
1415 | // window (e.g. an edit control). | |
1416 | virtual wxAccStatus DoDefaultAction(int childId); | |
1417 | ||
1418 | // Gets the default action for this object (0) or > 0 (the action for a child). | |
1419 | // Return wxACC_OK even if there is no action. actionName is the action, or the empty | |
1420 | // string if there is no action. | |
1421 | // The retrieved string describes the action that is performed on an object, | |
1422 | // not what the object does as a result. For example, a toolbar button that prints | |
1423 | // a document has a default action of "Press" rather than "Prints the current document." | |
1424 | virtual wxAccStatus GetDefaultAction(int childId, wxString* actionName); | |
1425 | ||
1426 | // Returns the description for this object or a child. | |
1427 | virtual wxAccStatus GetDescription(int childId, wxString* description); | |
1428 | ||
1429 | // Returns help text for this object or a child, similar to tooltip text. | |
1430 | virtual wxAccStatus GetHelpText(int childId, wxString* helpText); | |
1431 | ||
1432 | // Returns the keyboard shortcut for this object or child. | |
1433 | // Return e.g. ALT+K | |
1434 | virtual wxAccStatus GetKeyboardShortcut(int childId, wxString* shortcut); | |
1435 | ||
1436 | // Returns a role constant. | |
1437 | virtual wxAccStatus GetRole(int childId, wxAccRole* role); | |
1438 | ||
1439 | // Returns a state constant. | |
1440 | virtual wxAccStatus GetState(int childId, long* state); | |
1441 | ||
1442 | // Returns a localized string representing the value for the object | |
1443 | // or child. | |
1444 | virtual wxAccStatus GetValue(int childId, wxString* strValue); | |
1445 | ||
1446 | // Selects the object or child. | |
1447 | virtual wxAccStatus Select(int childId, wxAccSelectionFlags selectFlags); | |
1448 | ||
1449 | // Gets the window with the keyboard focus. | |
1450 | // If childId is 0 and child is NULL, no object in | |
1451 | // this subhierarchy has the focus. | |
1452 | // If this object has the focus, child should be 'this'. | |
1453 | virtual wxAccStatus GetFocus(int* childId, wxAccessible** child); | |
1454 | ||
1455 | // Gets a variant representing the selected children | |
1456 | // of this object. | |
1457 | // Acceptable values: | |
d4864e97 | 1458 | // - a null variant (IsNull() returns true) |
45a959a3 JS |
1459 | // - a list variant (GetType() == wxT("list") |
1460 | // - an integer representing the selected child element, | |
1461 | // or 0 if this object is selected (GetType() == wxT("long") | |
1462 | // - a "void*" pointer to a wxAccessible child object | |
1463 | virtual wxAccStatus GetSelections(wxVariant* selections); | |
1464 | }; | |
1465 | ||
1466 | #endif // wxUSE_ACCESSIBILITY | |
1467 | ||
1468 | ||
c801d85f | 1469 | #endif |
34138703 | 1470 | // _WX_WINDOW_H_BASE_ |
34c3ffca | 1471 |