]> git.saurik.com Git - wxWidgets.git/blame - include/wx/window.h
make access for virtuals match base
[wxWidgets.git] / include / wx / window.h
CommitLineData
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$
99d80019 8// Copyright: (c) Vadim Zeitlin
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
f03fc89f
VZ
15// ----------------------------------------------------------------------------
16// headers which we must include here
17// ----------------------------------------------------------------------------
18
19#include "wx/event.h" // the base class
20
21#include "wx/list.h" // defines wxWindowList
22
23#include "wx/cursor.h" // we have member variables of these classes
24#include "wx/font.h" // so we can't do without them
25#include "wx/colour.h"
26#include "wx/region.h"
5e4ff78a 27#include "wx/utils.h"
978af864 28#include "wx/intl.h"
88ac883a 29
674ac8b9 30#include "wx/validate.h" // for wxDefaultValidator (always include it)
8d99be5f 31
574c939e 32#if wxUSE_PALETTE
d577d610 33 #include "wx/palette.h"
574c939e
KB
34#endif // wxUSE_PALETTE
35
88ac883a
VZ
36#if wxUSE_ACCEL
37 #include "wx/accel.h"
38#endif // wxUSE_ACCEL
f03fc89f 39
45a959a3
JS
40#if wxUSE_ACCESSIBILITY
41#include "wx/access.h"
42#endif
43
6522713c
VZ
44// when building wxUniv/Foo we don't want the code for native menu use to be
45// compiled in - it should only be used when building real wxFoo
46#ifdef __WXUNIVERSAL__
47 #define wxUSE_MENUS_NATIVE 0
22dd3847 48#else // !__WXUNIVERSAL__
6522713c 49 #define wxUSE_MENUS_NATIVE wxUSE_MENUS
22dd3847 50#endif // __WXUNIVERSAL__/!__WXUNIVERSAL__
6522713c 51
47a8a4d5
VZ
52
53// Define this macro if the corresponding operating system handles the state
54// of children windows automatically when the parent is enabled/disabled.
55// Otherwise wx itself must ensure that when the parent is disabled its
56// children are disabled too, and their initial state is restored when the
57// parent is enabled back.
58#if defined(__WXMSW__) || defined(__WXPM__)
59 // must do everything ourselves
60 #undef wxHAS_NATIVE_ENABLED_MANAGEMENT
61#else
62 #define wxHAS_NATIVE_ENABLED_MANAGEMENT
63#endif
64
f03fc89f
VZ
65// ----------------------------------------------------------------------------
66// forward declarations
67// ----------------------------------------------------------------------------
68
b5dbe15d
VS
69class WXDLLIMPEXP_FWD_CORE wxCaret;
70class WXDLLIMPEXP_FWD_CORE wxControl;
71class WXDLLIMPEXP_FWD_CORE wxCursor;
72class WXDLLIMPEXP_FWD_CORE wxDC;
73class WXDLLIMPEXP_FWD_CORE wxDropTarget;
74class WXDLLIMPEXP_FWD_CORE wxItemResource;
75class WXDLLIMPEXP_FWD_CORE wxLayoutConstraints;
76class WXDLLIMPEXP_FWD_CORE wxResourceTable;
77class WXDLLIMPEXP_FWD_CORE wxSizer;
78class WXDLLIMPEXP_FWD_CORE wxToolTip;
79class WXDLLIMPEXP_FWD_CORE wxWindowBase;
80class WXDLLIMPEXP_FWD_CORE wxWindow;
81class WXDLLIMPEXP_FWD_CORE wxScrollHelper;
f03fc89f 82
45a959a3 83#if wxUSE_ACCESSIBILITY
b5dbe15d 84class WXDLLIMPEXP_FWD_CORE wxAccessible;
45a959a3
JS
85#endif
86
1b69c815
VZ
87// ----------------------------------------------------------------------------
88// helper stuff used by wxWindow
89// ----------------------------------------------------------------------------
90
91// struct containing all the visual attributes of a control
92struct WXDLLEXPORT wxVisualAttributes
93{
94 // the font used for control label/text inside it
95 wxFont font;
96
97 // the foreground colour
98 wxColour colFg;
99
100 // the background colour, may be wxNullColour if the controls background
101 // colour is not solid
102 wxColour colBg;
103};
104
105// different window variants, on platforms like eg mac uses different
106// rendering sizes
400a9e41 107enum wxWindowVariant
1b69c815
VZ
108{
109 wxWINDOW_VARIANT_NORMAL, // Normal size
110 wxWINDOW_VARIANT_SMALL, // Smaller size (about 25 % smaller than normal)
111 wxWINDOW_VARIANT_MINI, // Mini size (about 33 % smaller than normal)
112 wxWINDOW_VARIANT_LARGE, // Large size (about 25 % larger than normal)
113 wxWINDOW_VARIANT_MAX
114};
115
ff9f7a12
SC
116#if wxUSE_SYSTEM_OPTIONS
117 #define wxWINDOW_DEFAULT_VARIANT wxT("window-default-variant")
118#endif
119
376d7d97
VZ
120// valid values for Show/HideWithEffect()
121enum wxShowEffect
122{
123 wxSHOW_EFFECT_ROLL,
124 wxSHOW_EFFECT_SLIDE,
125 wxSHOW_EFFECT_BLEND,
126 wxSHOW_EFFECT_EXPAND,
127 wxSHOW_EFFECT_MAX
128};
129
f03fc89f
VZ
130// ----------------------------------------------------------------------------
131// (pseudo)template list classes
132// ----------------------------------------------------------------------------
133
f6bcfd97 134WX_DECLARE_LIST_3(wxWindow, wxWindowBase, wxWindowList, wxWindowListNode, class WXDLLEXPORT);
f03fc89f
VZ
135
136// ----------------------------------------------------------------------------
137// global variables
138// ----------------------------------------------------------------------------
139
16cba29d 140extern WXDLLEXPORT_DATA(wxWindowList) wxTopLevelWindows;
e7445ff8 141extern WXDLLIMPEXP_DATA_CORE(wxList) wxPendingDelete;
f03fc89f 142
f03fc89f
VZ
143// ----------------------------------------------------------------------------
144// wxWindowBase is the base class for all GUI controls/widgets, this is the public
145// interface of this class.
146//
147// Event handler: windows have themselves as their event handlers by default,
148// but their event handlers could be set to another object entirely. This
149// separation can reduce the amount of derivation required, and allow
150// alteration of a window's functionality (e.g. by a resource editor that
151// temporarily switches event handlers).
152// ----------------------------------------------------------------------------
153
154class WXDLLEXPORT wxWindowBase : public wxEvtHandler
155{
f03fc89f
VZ
156public:
157 // creating the window
158 // -------------------
159
06f6df7d
VZ
160 // default ctor, initializes everything which can be initialized before
161 // Create()
6463b9f5 162 wxWindowBase() ;
f03fc89f
VZ
163
164 // pseudo ctor (can't be virtual, called from ctor)
165 bool CreateBase(wxWindowBase *parent,
d9e2e4c2 166 wxWindowID winid,
f03fc89f
VZ
167 const wxPoint& pos = wxDefaultPosition,
168 const wxSize& size = wxDefaultSize,
169 long style = 0,
8d99be5f 170 const wxValidator& validator = wxDefaultValidator,
f03fc89f
VZ
171 const wxString& name = wxPanelNameStr);
172
173 virtual ~wxWindowBase();
174
f03fc89f
VZ
175 // deleting the window
176 // -------------------
177
d4864e97 178 // ask the window to close itself, return true if the event handler
f03fc89f 179 // honoured our request
d4864e97 180 bool Close( bool force = false );
f03fc89f
VZ
181
182 // the following functions delete the C++ objects (the window itself
183 // or its children) as well as the GUI windows and normally should
184 // never be used directly
185
d4864e97 186 // delete window unconditionally (dangerous!), returns true if ok
f03fc89f 187 virtual bool Destroy();
d4864e97 188 // delete all children of this window, returns true if ok
f03fc89f
VZ
189 bool DestroyChildren();
190
191 // is the window being deleted?
192 bool IsBeingDeleted() const { return m_isBeingDeleted; }
193
194 // window attributes
195 // -----------------
196
ffd84c94
WS
197 // label is just the same as the title (but for, e.g., buttons it
198 // makes more sense to speak about labels), title access
199 // is available from wxTLW classes only (frames, dialogs)
faa49bfd
WS
200 virtual void SetLabel(const wxString& label) = 0;
201 virtual wxString GetLabel() const = 0;
f03fc89f
VZ
202
203 // the window name is used for ressource setting in X, it is not the
204 // same as the window title/label
205 virtual void SetName( const wxString &name ) { m_windowName = name; }
206 virtual wxString GetName() const { return m_windowName; }
207
978af864
VZ
208 // sets the window variant, calls internally DoSetVariant if variant
209 // has changed
210 void SetWindowVariant(wxWindowVariant variant);
211 wxWindowVariant GetWindowVariant() const { return m_windowVariant; }
400a9e41 212
69d90995 213
978af864
VZ
214 // get or change the layout direction (LTR or RTL) for this window,
215 // wxLayout_Default is returned if layout direction is not supported
216 virtual wxLayoutDirection GetLayoutDirection() const
217 { return wxLayout_Default; }
218 virtual void SetLayoutDirection(wxLayoutDirection WXUNUSED(dir))
219 { }
220
221 // mirror coordinates for RTL layout if this window uses it and if the
222 // mirroring is not done automatically like Win32
223 virtual wxCoord AdjustForLayoutDirection(wxCoord x,
224 wxCoord width,
225 wxCoord widthTotal) const;
f03fc89f 226
f35fdf7e
VZ
227
228 // window id uniquely identifies the window among its siblings unless
229 // it is wxID_ANY which means "don't care"
230 void SetId( wxWindowID winid ) { m_windowId = winid; }
231 wxWindowID GetId() const { return m_windowId; }
232
233 // returns true if this id value belong to the range reserved for the
234 // auto-generated (by NewControlId()) ids (they're always negative)
235 static bool IsAutoGeneratedId(wxWindowID id);
236
237 // generate a unique id (or count of them consecutively), returns a
238 // valid id in IsAutoGeneratedId() range or wxID_NONE if failed
239 static wxWindowID NewControlId(int count = 1);
240
241 // mark an id previously returned by NewControlId() as being unused any
242 // more so that it can be reused again for another control later
243 static void ReleaseControlId(wxWindowID id);
244
f03fc89f
VZ
245
246 // moving/resizing
247 // ---------------
248
249 // set the window size and/or position
250 void SetSize( int x, int y, int width, int height,
251 int sizeFlags = wxSIZE_AUTO )
252 { DoSetSize(x, y, width, height, sizeFlags); }
253
254 void SetSize( int width, int height )
a0d9c6cb 255 { DoSetSize( wxDefaultCoord, wxDefaultCoord, width, height, wxSIZE_USE_EXISTING ); }
f03fc89f
VZ
256
257 void SetSize( const wxSize& size )
258 { SetSize( size.x, size.y); }
259
260 void SetSize(const wxRect& rect, int sizeFlags = wxSIZE_AUTO)
261 { DoSetSize(rect.x, rect.y, rect.width, rect.height, sizeFlags); }
262
1e6feb95 263 void Move(int x, int y, int flags = wxSIZE_USE_EXISTING)
a0d9c6cb 264 { DoSetSize(x, y, wxDefaultCoord, wxDefaultCoord, flags); }
f03fc89f 265
1e6feb95
VZ
266 void Move(const wxPoint& pt, int flags = wxSIZE_USE_EXISTING)
267 { Move(pt.x, pt.y, flags); }
f03fc89f 268
3c81c9aa
VZ
269 void SetPosition(const wxPoint& pt) { Move(pt); }
270
f03fc89f
VZ
271 // Z-order
272 virtual void Raise() = 0;
273 virtual void Lower() = 0;
274
275 // client size is the size of area available for subwindows
276 void SetClientSize( int width, int height )
277 { DoSetClientSize(width, height); }
278
279 void SetClientSize( const wxSize& size )
280 { DoSetClientSize(size.x, size.y); }
281
282 void SetClientSize(const wxRect& rect)
283 { SetClientSize( rect.width, rect.height ); }
284
3c81c9aa
VZ
285 // get the window position (pointers may be NULL): notice that it is in
286 // client coordinates for child windows and screen coordinates for the
287 // top level ones, use GetScreenPosition() if you need screen
288 // coordinates for all kinds of windows
f03fc89f
VZ
289 void GetPosition( int *x, int *y ) const { DoGetPosition(x, y); }
290 wxPoint GetPosition() const
291 {
3c81c9aa
VZ
292 int x, y;
293 DoGetPosition(&x, &y);
f03fc89f 294
3c81c9aa 295 return wxPoint(x, y);
f03fc89f
VZ
296 }
297
3c81c9aa
VZ
298 // get the window position in screen coordinates
299 void GetScreenPosition(int *x, int *y) const { DoGetScreenPosition(x, y); }
300 wxPoint GetScreenPosition() const
301 {
302 int x, y;
303 DoGetScreenPosition(&x, &y);
38759b67 304
3c81c9aa
VZ
305 return wxPoint(x, y);
306 }
307
308 // get the window size (pointers may be NULL)
f03fc89f
VZ
309 void GetSize( int *w, int *h ) const { DoGetSize(w, h); }
310 wxSize GetSize() const
311 {
312 int w, h;
313 DoGetSize(& w, & h);
314 return wxSize(w, h);
315 }
316
3c81c9aa
VZ
317 void GetClientSize( int *w, int *h ) const { DoGetClientSize(w, h); }
318 wxSize GetClientSize() const
319 {
320 int w, h;
321 DoGetClientSize(&w, &h);
322
323 return wxSize(w, h);
324 }
325
326 // get the position and size at once
f03fc89f
VZ
327 wxRect GetRect() const
328 {
329 int x, y, w, h;
3c81c9aa
VZ
330 GetPosition(&x, &y);
331 GetSize(&w, &h);
f03fc89f
VZ
332
333 return wxRect(x, y, w, h);
334 }
335
3c81c9aa 336 wxRect GetScreenRect() const
f03fc89f 337 {
3c81c9aa
VZ
338 int x, y, w, h;
339 GetScreenPosition(&x, &y);
340 GetSize(&w, &h);
f03fc89f 341
3c81c9aa 342 return wxRect(x, y, w, h);
f03fc89f
VZ
343 }
344
1e6feb95
VZ
345 // get the origin of the client area of the window relative to the
346 // window top left corner (the client area may be shifted because of
347 // the borders, scrollbars, other decorations...)
348 virtual wxPoint GetClientAreaOrigin() const;
349
350 // get the client rectangle in window (i.e. client) coordinates
351 wxRect GetClientRect() const
352 {
353 return wxRect(GetClientAreaOrigin(), GetClientSize());
354 }
355
f68586e5 356 // get the size best suited for the window (in fact, minimal
9f884528
RD
357 // acceptable size using which it will still look "nice" in
358 // most situations)
359 wxSize GetBestSize() const
360 {
361 if (m_bestSizeCache.IsFullySpecified())
362 return m_bestSizeCache;
363 return DoGetBestSize();
364 }
f68586e5
VZ
365 void GetBestSize(int *w, int *h) const
366 {
9f884528 367 wxSize s = GetBestSize();
f68586e5
VZ
368 if ( w )
369 *w = s.x;
370 if ( h )
371 *h = s.y;
372 }
373
f4fe2f20
RR
374 void SetScrollHelper( wxScrollHelper *sh ) { m_scrollHelper = sh; }
375 wxScrollHelper *GetScrollHelper() { return m_scrollHelper; }
376
9f884528
RD
377 // reset the cached best size value so it will be recalculated the
378 // next time it is needed.
992b2ec4 379 void InvalidateBestSize();
9f884528
RD
380 void CacheBestSize(const wxSize& size) const
381 { wxConstCast(this, wxWindowBase)->m_bestSizeCache = size; }
a0d9c6cb 382
2b5f62a0 383
9f884528
RD
384 // This function will merge the window's best size into the window's
385 // minimum size, giving priority to the min size components, and
386 // returns the results.
170acdc9
RD
387 wxSize GetEffectiveMinSize() const;
388 wxDEPRECATED( wxSize GetBestFittingSize() const ); // replaced by GetEffectiveMinSize
d6f582e7 389 wxDEPRECATED( wxSize GetAdjustedMinSize() const ); // replaced by GetEffectiveMinSize
a0d9c6cb 390
9f884528
RD
391 // A 'Smart' SetSize that will fill in default size values with 'best'
392 // size. Sets the minsize to what was passed in.
170acdc9
RD
393 void SetInitialSize(const wxSize& size=wxDefaultSize);
394 wxDEPRECATED( void SetBestFittingSize(const wxSize& size=wxDefaultSize) ); // replaced by SetInitialSize
9f884528 395
47a8a4d5 396
2b5f62a0 397 // the generic centre function - centers the window on parent by`
7eb4e9cc
VZ
398 // default or on screen if it doesn't have parent or
399 // wxCENTER_ON_SCREEN flag is given
1f464296
VZ
400 void Centre(int dir = wxBOTH) { DoCentre(dir); }
401 void Center(int dir = wxBOTH) { DoCentre(dir); }
7eb4e9cc
VZ
402
403 // centre with respect to the the parent window
1f464296 404 void CentreOnParent(int dir = wxBOTH) { DoCentre(dir); }
7eb4e9cc 405 void CenterOnParent(int dir = wxBOTH) { CentreOnParent(dir); }
f03fc89f
VZ
406
407 // set window size to wrap around its children
408 virtual void Fit();
409
2b5f62a0
VZ
410 // set virtual size to satisfy children
411 virtual void FitInside();
412
9379c0d7 413
b21f4960
RR
414 // SetSizeHints is actually for setting the size hints
415 // for the wxTLW for a Window Manager - hence the name -
416 // and it is therefore overridden in wxTLW to do that.
417 // In wxWindow(Base), it has (unfortunately) been abused
418 // to mean the same as SetMinSize() and SetMaxSize().
47a8a4d5 419
f03fc89f 420 virtual void SetSizeHints( int minW, int minH,
a0d9c6cb 421 int maxW = wxDefaultCoord, int maxH = wxDefaultCoord,
571f6981 422 int incW = wxDefaultCoord, int incH = wxDefaultCoord )
9379c0d7 423 { DoSetSizeHints(minW, minH, maxW, maxH, incW, incH); }
6fb99eb3 424
1ec25e8f
RD
425 void SetSizeHints( const wxSize& minSize,
426 const wxSize& maxSize=wxDefaultSize,
427 const wxSize& incSize=wxDefaultSize)
9379c0d7
RR
428 { DoSetSizeHints(minSize.x, minSize.y, maxSize.x, maxSize.y, incSize.x, incSize.y); }
429
9379c0d7
RR
430 // Methods for setting virtual size hints
431 // FIXME: What are virtual size hints?
f03fc89f 432
566d84a7 433 virtual void SetVirtualSizeHints( int minW, int minH,
a0d9c6cb 434 int maxW = wxDefaultCoord, int maxH = wxDefaultCoord );
1ec25e8f
RD
435 void SetVirtualSizeHints( const wxSize& minSize,
436 const wxSize& maxSize=wxDefaultSize)
437 {
438 SetVirtualSizeHints(minSize.x, minSize.y, maxSize.x, maxSize.y);
439 }
566d84a7 440
57c4d796 441
47a8a4d5 442 // Call these to override what GetBestSize() returns. This
a1b05a60
RR
443 // method is only virtual because it is overriden in wxTLW
444 // as a different API for SetSizeHints().
445 virtual void SetMinSize(const wxSize& minSize) { m_minWidth = minSize.x; m_minHeight = minSize.y; }
446 virtual void SetMaxSize(const wxSize& maxSize) { m_maxWidth = maxSize.x; m_maxHeight = maxSize.y; }
447
448 // Override these methods to impose restrictions on min/max size.
47a8a4d5 449 // The easier way is to call SetMinSize() and SetMaxSize() which
a1b05a60 450 // will have the same effect. Doing both is non-sense.
b4350341
VZ
451 virtual wxSize GetMinSize() const { return wxSize(m_minWidth, m_minHeight); }
452 virtual wxSize GetMaxSize() const { return wxSize(m_maxWidth, m_maxHeight); }
400a9e41 453
a1b05a60
RR
454 // Get the min and max values one by one
455 int GetMinWidth() const { return GetMinSize().x; }
456 int GetMinHeight() const { return GetMinSize().y; }
457 int GetMaxWidth() const { return GetMaxSize().x; }
458 int GetMaxHeight() const { return GetMaxSize().y; }
9379c0d7 459
a0d9c6cb 460
566d84a7
RL
461 // Methods for accessing the virtual size of a window. For most
462 // windows this is just the client area of the window, but for
463 // some like scrolled windows it is more or less independent of
464 // the screen window size. You may override the DoXXXVirtual
465 // methods below for classes where that is is the case.
466
467 void SetVirtualSize( const wxSize &size ) { DoSetVirtualSize( size.x, size.y ); }
468 void SetVirtualSize( int x, int y ) { DoSetVirtualSize( x, y ); }
469
470 wxSize GetVirtualSize() const { return DoGetVirtualSize(); }
471 void GetVirtualSize( int *x, int *y ) const
472 {
473 wxSize s( DoGetVirtualSize() );
474
475 if( x )
476 *x = s.GetWidth();
477 if( y )
478 *y = s.GetHeight();
479 }
480
481 // Override these methods for windows that have a virtual size
482 // independent of their client size. eg. the virtual area of a
e5ecf1fc 483 // wxScrolledWindow.
566d84a7
RL
484
485 virtual void DoSetVirtualSize( int x, int y );
85b38e0b 486 virtual wxSize DoGetVirtualSize() const;
e5ecf1fc 487
2b5f62a0
VZ
488 // Return the largest of ClientSize and BestSize (as determined
489 // by a sizer, interior children, or other means)
490
491 virtual wxSize GetBestVirtualSize() const
492 {
493 wxSize client( GetClientSize() );
494 wxSize best( GetBestSize() );
495
496 return wxSize( wxMax( client.x, best.x ), wxMax( client.y, best.y ) );
497 }
498
333d7052
VZ
499 // return the size of the left/right and top/bottom borders in x and y
500 // components of the result respectively
501 virtual wxSize GetWindowBorderSize() const;
502
503
f03fc89f
VZ
504 // window state
505 // ------------
506
d4864e97 507 // returns true if window was shown/hidden, false if the nothing was
f03fc89f 508 // done (window was already shown/hidden)
d4864e97
VZ
509 virtual bool Show( bool show = true );
510 bool Hide() { return Show(false); }
f03fc89f 511
376d7d97
VZ
512 // show or hide the window with a special effect, not implemented on
513 // most platforms (where it is the same as Show()/Hide() respectively)
514 //
515 // timeout specifies how long the animation should take, in ms, the
516 // default value of 0 means to use the default (system-dependent) value
517 //
518 // direction is only used with wxSHOW_EFFECT_ROLL and SLIDE values
519 virtual bool ShowWithEffect(wxShowEffect effect,
520 unsigned timeout = 0,
521 wxDirection dir = wxBOTTOM)
522 {
523 wxUnusedVar(effect);
524 wxUnusedVar(timeout);
525 wxUnusedVar(dir);
526
527 return Show();
528 }
529
530 virtual bool HideWithEffect(wxShowEffect effect,
531 unsigned timeout = 0,
532 wxDirection dir = wxBOTTOM)
533 {
534 wxUnusedVar(effect);
535 wxUnusedVar(timeout);
536 wxUnusedVar(dir);
537
538 return Hide();
539 }
540
d4864e97
VZ
541 // returns true if window was enabled/disabled, false if nothing done
542 virtual bool Enable( bool enable = true );
543 bool Disable() { return Enable(false); }
f03fc89f 544
b08cd3bf 545 virtual bool IsShown() const { return m_isShown; }
47a8a4d5
VZ
546 // returns true if the window is really enabled and false otherwise,
547 // whether because it had been explicitly disabled itself or because
548 // its parent is currently disabled -- then this method returns false
549 // whatever is the intrinsic state of this window, use IsThisEnabled(0
550 // to retrieve it. In other words, this relation always holds:
551 //
552 // IsEnabled() == IsThisEnabled() && parent.IsEnabled()
553 //
554 bool IsEnabled() const;
555
556 // returns the internal window state independently of the parent(s)
557 // state, i.e. the state in which the window would be if all its
558 // parents were enabled (use IsEnabled() above to get the effective
559 // window state)
560 bool IsThisEnabled() const { return m_isEnabled; }
f03fc89f 561
9c72cf76
VS
562 // returns true if the window is visible, i.e. IsShown() returns true
563 // if called on it and all its parents up to the first TLW
865a74c7 564 virtual bool IsShownOnScreen() const;
9c72cf76 565
f03fc89f
VZ
566 // get/set window style (setting style won't update the window and so
567 // is only useful for internal usage)
568 virtual void SetWindowStyleFlag( long style ) { m_windowStyle = style; }
569 virtual long GetWindowStyleFlag() const { return m_windowStyle; }
570
571 // just some (somewhat shorter) synonims
572 void SetWindowStyle( long style ) { SetWindowStyleFlag(style); }
573 long GetWindowStyle() const { return GetWindowStyleFlag(); }
574
d63312a9 575 // check if the flag is set
f03fc89f 576 bool HasFlag(int flag) const { return (m_windowStyle & flag) != 0; }
d80cd92a 577 virtual bool IsRetained() const { return HasFlag(wxRETAINED); }
f03fc89f 578
d63312a9
VZ
579 // turn the flag on if it had been turned off before and vice versa,
580 // return true if the flag is currently turned on
581 bool ToggleWindowStyle(int flag);
582
d80cd92a
VZ
583 // extra style: the less often used style bits which can't be set with
584 // SetWindowStyleFlag()
b2d5a7ee 585 virtual void SetExtraStyle(long exStyle) { m_exStyle = exStyle; }
d80cd92a 586 long GetExtraStyle() const { return m_exStyle; }
f03fc89f 587
a2979ead
VZ
588 bool HasExtraStyle(int exFlag) const { return (m_exStyle & exFlag) != 0; }
589
f03fc89f 590 // make the window modal (all other windows unresponsive)
d4864e97 591 virtual void MakeModal(bool modal = true);
f03fc89f 592
b8e7b673
VZ
593
594 // (primitive) theming support
595 // ---------------------------
596
a2d93e73
JS
597 virtual void SetThemeEnabled(bool enableTheme) { m_themeEnabled = enableTheme; }
598 virtual bool GetThemeEnabled() const { return m_themeEnabled; }
599
d4864e97 600
456bc6d9
VZ
601 // focus and keyboard handling
602 // ---------------------------
f03fc89f
VZ
603
604 // set focus to this window
605 virtual void SetFocus() = 0;
606
d577d610
VZ
607 // set focus to this window as the result of a keyboard action
608 virtual void SetFocusFromKbd() { SetFocus(); }
609
f03fc89f 610 // return the window which currently has the focus or NULL
0fe02759 611 static wxWindow *FindFocus();
6fb99eb3 612
0fe02759 613 static wxWindow *DoFindFocus() /* = 0: implement in derived classes */;
f03fc89f 614
ad02525d
VZ
615 // can this window have focus in principle?
616 //
617 // the difference between AcceptsFocus[FromKeyboard]() and CanAcceptFocus
618 // [FromKeyboard]() is that the former functions are meant to be
619 // overridden in the derived classes to simply return false if the
620 // control can't have focus, while the latter are meant to be used by
621 // this class clients and take into account the current window state
622 virtual bool AcceptsFocus() const { return true; }
623
edc09871
VZ
624 // can this window or one of its children accept focus?
625 //
626 // usually it's the same as AcceptsFocus() but is overridden for
627 // container windows
628 virtual bool AcceptsFocusRecursively() const { return AcceptsFocus(); }
f03fc89f 629
1e6feb95
VZ
630 // can this window be given focus by keyboard navigation? if not, the
631 // only way to give it focus (provided it accepts it at all) is to
632 // click it
633 virtual bool AcceptsFocusFromKeyboard() const { return AcceptsFocus(); }
634
edc09871
VZ
635
636 // this is mostly a helper for the various functions using it below
637 bool CanBeFocused() const { return IsShown() && IsEnabled(); }
638
639 // can this window itself have focus?
640 bool IsFocusable() const { return AcceptsFocus() && CanBeFocused(); }
641
642 // can this window have focus right now?
643 //
644 // if this method returns true, it means that calling SetFocus() will
645 // put focus either to this window or one of its children, if you need
646 // to know whether this window accepts focus itself, use IsFocusable()
647 bool CanAcceptFocus() const
648 { return AcceptsFocusRecursively() && CanBeFocused(); }
649
ad02525d
VZ
650 // can this window be assigned focus from keyboard right now?
651 bool CanAcceptFocusFromKeyboard() const
edc09871 652 { return AcceptsFocusFromKeyboard() && CanBeFocused(); }
ad02525d 653
80332672
VZ
654 // call this when the return value of AcceptsFocus() changes
655 virtual void SetCanFocus(bool WXUNUSED(canFocus)) { }
656
5644933f
VZ
657 // navigates inside this window
658 bool NavigateIn(int flags = wxNavigationKeyEvent::IsForward)
659 { return DoNavigateIn(flags); }
660
661 // navigates in the specified direction from this window, this is
662 // equivalent to GetParent()->NavigateIn()
663 bool Navigate(int flags = wxNavigationKeyEvent::IsForward)
664 { return m_parent && ((wxWindowBase *)m_parent)->DoNavigateIn(flags); }
5f6cfda7 665
a24de76b
VZ
666 // move this window just before/after the specified one in tab order
667 // (the other window must be our sibling!)
668 void MoveBeforeInTabOrder(wxWindow *win)
c944775f 669 { DoMoveInTabOrder(win, OrderBefore); }
a24de76b 670 void MoveAfterInTabOrder(wxWindow *win)
c944775f 671 { DoMoveInTabOrder(win, OrderAfter); }
a24de76b
VZ
672
673
f03fc89f
VZ
674 // parent/children relations
675 // -------------------------
676
677 // get the list of children
678 const wxWindowList& GetChildren() const { return m_children; }
679 wxWindowList& GetChildren() { return m_children; }
680
1978421a
SC
681 // needed just for extended runtime
682 const wxWindowList& GetWindowChildren() const { return GetChildren() ; }
683
c944775f
VZ
684 // get the window before/after this one in the parents children list,
685 // returns NULL if this is the first/last window
686 wxWindow *GetPrevSibling() const { return DoGetSibling(OrderBefore); }
687 wxWindow *GetNextSibling() const { return DoGetSibling(OrderAfter); }
688
f03fc89f
VZ
689 // get the parent or the parent of the parent
690 wxWindow *GetParent() const { return m_parent; }
691 inline wxWindow *GetGrandParent() const;
692
693 // is this window a top level one?
8487f887 694 virtual bool IsTopLevel() const;
f03fc89f 695
87b6002d 696 // it doesn't really change parent, use Reparent() instead
f03fc89f 697 void SetParent( wxWindowBase *parent ) { m_parent = (wxWindow *)parent; }
d4864e97
VZ
698 // change the real parent of this window, return true if the parent
699 // was changed, false otherwise (error or newParent == oldParent)
f03fc89f
VZ
700 virtual bool Reparent( wxWindowBase *newParent );
701
146ba0fe
VZ
702 // implementation mostly
703 virtual void AddChild( wxWindowBase *child );
704 virtual void RemoveChild( wxWindowBase *child );
705
049908c5
VS
706 // returns true if the child is in the client area of the window, i.e. is
707 // not scrollbar, toolbar etc.
708 virtual bool IsClientAreaChild(const wxWindow *WXUNUSED(child)) const
709 { return true; }
710
146ba0fe
VZ
711 // looking for windows
712 // -------------------
713
f03fc89f
VZ
714 // find window among the descendants of this one either by id or by
715 // name (return NULL if not found)
6b73af79
VZ
716 wxWindow *FindWindow(long winid) const;
717 wxWindow *FindWindow(const wxString& name) const;
f03fc89f 718
146ba0fe 719 // Find a window among any window (all return NULL if not found)
d9e2e4c2 720 static wxWindow *FindWindowById( long winid, const wxWindow *parent = NULL );
146ba0fe
VZ
721 static wxWindow *FindWindowByName( const wxString& name,
722 const wxWindow *parent = NULL );
723 static wxWindow *FindWindowByLabel( const wxString& label,
724 const wxWindow *parent = NULL );
f03fc89f
VZ
725
726 // event handler stuff
727 // -------------------
728
729 // get the current event handler
730 wxEvtHandler *GetEventHandler() const { return m_eventHandler; }
731
732 // replace the event handler (allows to completely subclass the
733 // window)
734 void SetEventHandler( wxEvtHandler *handler ) { m_eventHandler = handler; }
735
736 // push/pop event handler: allows to chain a custom event handler to
737 // alreasy existing ones
738 void PushEventHandler( wxEvtHandler *handler );
d4864e97 739 wxEvtHandler *PopEventHandler( bool deleteHandler = false );
f03fc89f 740
2e36d5cf 741 // find the given handler in the event handler chain and remove (but
d4864e97
VZ
742 // not delete) it from the event handler chain, return true if it was
743 // found and false otherwise (this also results in an assert failure so
2e36d5cf
VZ
744 // this function should only be called when the handler is supposed to
745 // be there)
746 bool RemoveEventHandler(wxEvtHandler *handler);
747
937013e0
VS
748 // Process an event by calling GetEventHandler()->ProcessEvent() and
749 // handling any exceptions thrown by event handlers. It's mostly useful
750 // when processing wx events when called from C code (e.g. in GTK+
751 // callback) when the exception wouldn't correctly propagate to
752 // wxEventLoop.
753 bool HandleWindowEvent(wxEvent& event) const;
754
1e6feb95
VZ
755 // validators
756 // ----------
f03fc89f 757
88ac883a 758#if wxUSE_VALIDATORS
f03fc89f
VZ
759 // a window may have an associated validator which is used to control
760 // user input
761 virtual void SetValidator( const wxValidator &validator );
762 virtual wxValidator *GetValidator() { return m_windowValidator; }
88ac883a 763#endif // wxUSE_VALIDATORS
f03fc89f 764
f03fc89f
VZ
765
766 // dialog oriented functions
767 // -------------------------
768
d4864e97 769 // validate the correctness of input, return true if ok
f03fc89f
VZ
770 virtual bool Validate();
771
772 // transfer data between internal and GUI representations
773 virtual bool TransferDataToWindow();
774 virtual bool TransferDataFromWindow();
775
776 virtual void InitDialog();
777
88ac883a 778#if wxUSE_ACCEL
f03fc89f
VZ
779 // accelerators
780 // ------------
781 virtual void SetAcceleratorTable( const wxAcceleratorTable& accel )
782 { m_acceleratorTable = accel; }
783 wxAcceleratorTable *GetAcceleratorTable()
784 { return &m_acceleratorTable; }
5048c832 785
540b6b09
VZ
786#endif // wxUSE_ACCEL
787
788#if wxUSE_HOTKEY
789 // hot keys (system wide accelerators)
790 // -----------------------------------
791
792 virtual bool RegisterHotKey(int hotkeyId, int modifiers, int keycode);
5048c832 793 virtual bool UnregisterHotKey(int hotkeyId);
540b6b09 794#endif // wxUSE_HOTKEY
5048c832 795
f03fc89f
VZ
796
797 // dialog units translations
798 // -------------------------
799
800 wxPoint ConvertPixelsToDialog( const wxPoint& pt );
801 wxPoint ConvertDialogToPixels( const wxPoint& pt );
802 wxSize ConvertPixelsToDialog( const wxSize& sz )
803 {
804 wxPoint pt(ConvertPixelsToDialog(wxPoint(sz.x, sz.y)));
805
806 return wxSize(pt.x, pt.y);
807 }
808
809 wxSize ConvertDialogToPixels( const wxSize& sz )
810 {
811 wxPoint pt(ConvertDialogToPixels(wxPoint(sz.x, sz.y)));
812
813 return wxSize(pt.x, pt.y);
814 }
815
816 // mouse functions
817 // ---------------
818
819 // move the mouse to the specified position
820 virtual void WarpPointer(int x, int y) = 0;
821
94633ad9
VZ
822 // start or end mouse capture, these functions maintain the stack of
823 // windows having captured the mouse and after calling ReleaseMouse()
824 // the mouse is not released but returns to the window which had had
825 // captured it previously (if any)
826 void CaptureMouse();
827 void ReleaseMouse();
f03fc89f 828
1e6feb95
VZ
829 // get the window which currently captures the mouse or NULL
830 static wxWindow *GetCapture();
831
832 // does this window have the capture?
833 virtual bool HasCapture() const
834 { return (wxWindow *)this == GetCapture(); }
835
f03fc89f
VZ
836 // painting the window
837 // -------------------
838
839 // mark the specified rectangle (or the whole window) as "dirty" so it
840 // will be repainted
d4864e97 841 virtual void Refresh( bool eraseBackground = true,
f03fc89f 842 const wxRect *rect = (const wxRect *) NULL ) = 0;
1e6feb95
VZ
843
844 // a less awkward wrapper for Refresh
8cfa09bd
VZ
845 void RefreshRect(const wxRect& rect, bool eraseBackground = true)
846 {
847 Refresh(eraseBackground, &rect);
848 }
1e6feb95
VZ
849
850 // repaint all invalid areas of the window immediately
851 virtual void Update() { }
852
5da0803c
VZ
853 // clear the window background
854 virtual void ClearBackground();
f03fc89f 855
0cc7251e
VZ
856 // freeze the window: don't redraw it until it is thawed
857 virtual void Freeze() { }
858
859 // thaw the window: redraw it after it had been frozen
860 virtual void Thaw() { }
861
d4a1433f
VZ
862 // return true if window had been frozen and not unthawed yet
863 virtual bool IsFrozen() const { return false; }
864
f03fc89f 865 // adjust DC for drawing on this window
f6147cfc 866 virtual void PrepareDC( wxDC & WXUNUSED(dc) ) { }
f03fc89f 867
2e992e06
VZ
868 // return true if the window contents is double buffered by the system
869 virtual bool IsDoubleBuffered() const { return false; }
870
f03fc89f
VZ
871 // the update region of the window contains the areas which must be
872 // repainted by the program
873 const wxRegion& GetUpdateRegion() const { return m_updateRegion; }
874 wxRegion& GetUpdateRegion() { return m_updateRegion; }
875
1e6feb95
VZ
876 // get the update rectangleregion bounding box in client coords
877 wxRect GetUpdateClientRect() const;
878
f03fc89f
VZ
879 // these functions verify whether the given point/rectangle belongs to
880 // (or at least intersects with) the update region
657b4fd4
RD
881 virtual bool DoIsExposed( int x, int y ) const;
882 virtual bool DoIsExposed( int x, int y, int w, int h ) const;
f03fc89f 883
657b4fd4
RD
884 bool IsExposed( int x, int y ) const
885 { return DoIsExposed(x, y); }
886 bool IsExposed( int x, int y, int w, int h ) const
887 { return DoIsExposed(x, y, w, h); }
f03fc89f 888 bool IsExposed( const wxPoint& pt ) const
657b4fd4 889 { return DoIsExposed(pt.x, pt.y); }
f03fc89f 890 bool IsExposed( const wxRect& rect ) const
657b4fd4 891 { return DoIsExposed(rect.x, rect.y, rect.width, rect.height); }
f03fc89f
VZ
892
893 // colours, fonts and cursors
894 // --------------------------
895
1b69c815
VZ
896 // get the default attributes for the controls of this class: we
897 // provide a virtual function which can be used to query the default
898 // attributes of an existing control and a static function which can
899 // be used even when no existing object of the given class is
900 // available, but which won't return any styles specific to this
901 // particular control, of course (e.g. "Ok" button might have
902 // different -- bold for example -- font)
903 virtual wxVisualAttributes GetDefaultAttributes() const
904 {
905 return GetClassDefaultAttributes(GetWindowVariant());
906 }
907
908 static wxVisualAttributes
909 GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
910
f03fc89f 911 // set/retrieve the window colours (system defaults are used by
b8e7b673 912 // default): SetXXX() functions return true if colour was changed,
f8ff87ed
VS
913 // SetDefaultXXX() reset the "m_inheritXXX" flag after setting the
914 // value to prevent it from being inherited by our children
b8e7b673 915 virtual bool SetBackgroundColour(const wxColour& colour);
fa47d7a7 916 void SetOwnBackgroundColour(const wxColour& colour)
b8e7b673
VZ
917 {
918 if ( SetBackgroundColour(colour) )
f8ff87ed 919 m_inheritBgCol = false;
b8e7b673 920 }
1b69c815 921 wxColour GetBackgroundColour() const;
e5ecf1fc
WS
922 bool InheritsBackgroundColour() const
923 {
924 return m_inheritBgCol;
925 }
926 bool UseBgCol() const
927 {
928 return m_hasBgCol;
929 }
b8e7b673
VZ
930
931 virtual bool SetForegroundColour(const wxColour& colour);
fa47d7a7 932 void SetOwnForegroundColour(const wxColour& colour)
b8e7b673
VZ
933 {
934 if ( SetForegroundColour(colour) )
f8ff87ed 935 m_inheritFgCol = false;
b8e7b673 936 }
1b69c815 937 wxColour GetForegroundColour() const;
f03fc89f 938
50c53860
JS
939 // Set/get the background style.
940 // Pass one of wxBG_STYLE_SYSTEM, wxBG_STYLE_COLOUR, wxBG_STYLE_CUSTOM
941 virtual bool SetBackgroundStyle(wxBackgroundStyle style) { m_backgroundStyle = style; return true; }
942 virtual wxBackgroundStyle GetBackgroundStyle() const { return m_backgroundStyle; }
943
7c7a653b
VZ
944 // returns true if the control has "transparent" areas such as a
945 // wxStaticText and wxCheckBox and the background should be adapted
946 // from a parent window
947 virtual bool HasTransparentBackground() { return false; }
948
b8e7b673
VZ
949 // set/retrieve the font for the window (SetFont() returns true if the
950 // font really changed)
951 virtual bool SetFont(const wxFont& font) = 0;
fa47d7a7 952 void SetOwnFont(const wxFont& font)
b8e7b673
VZ
953 {
954 if ( SetFont(font) )
f8ff87ed 955 m_inheritFont = false;
b8e7b673 956 }
29094af0 957 wxFont GetFont() const;
b8e7b673 958
d4864e97 959 // set/retrieve the cursor for this window (SetCursor() returns true
f03fc89f
VZ
960 // if the cursor was really changed)
961 virtual bool SetCursor( const wxCursor &cursor );
962 const wxCursor& GetCursor() const { return m_cursor; }
f03fc89f 963
789295bf
VZ
964#if wxUSE_CARET
965 // associate a caret with the window
966 void SetCaret(wxCaret *caret);
967 // get the current caret (may be NULL)
968 wxCaret *GetCaret() const { return m_caret; }
969#endif // wxUSE_CARET
970
f03fc89f
VZ
971 // get the (average) character size for the current font
972 virtual int GetCharHeight() const = 0;
973 virtual int GetCharWidth() const = 0;
974
975 // get the width/height/... of the text using current or specified
976 // font
977 virtual void GetTextExtent(const wxString& string,
978 int *x, int *y,
979 int *descent = (int *) NULL,
980 int *externalLeading = (int *) NULL,
981 const wxFont *theFont = (const wxFont *) NULL)
982 const = 0;
983
6b062263
VZ
984 wxSize GetTextExtent(const wxString& string) const
985 {
986 wxCoord w, h;
987 GetTextExtent(string, &w, &h);
988 return wxSize(w, h);
989 }
990
1e6feb95
VZ
991 // client <-> screen coords
992 // ------------------------
993
f03fc89f 994 // translate to/from screen/client coordinates (pointers may be NULL)
dabc0cd5
VZ
995 void ClientToScreen( int *x, int *y ) const
996 { DoClientToScreen(x, y); }
997 void ScreenToClient( int *x, int *y ) const
998 { DoScreenToClient(x, y); }
1e6feb95
VZ
999
1000 // wxPoint interface to do the same thing
dabc0cd5
VZ
1001 wxPoint ClientToScreen(const wxPoint& pt) const
1002 {
1003 int x = pt.x, y = pt.y;
1004 DoClientToScreen(&x, &y);
1005
1006 return wxPoint(x, y);
1007 }
1008
1009 wxPoint ScreenToClient(const wxPoint& pt) const
1010 {
1011 int x = pt.x, y = pt.y;
1012 DoScreenToClient(&x, &y);
1013
1014 return wxPoint(x, y);
1015 }
f03fc89f 1016
1e6feb95
VZ
1017 // test where the given (in client coords) point lies
1018 wxHitTest HitTest(wxCoord x, wxCoord y) const
1019 { return DoHitTest(x, y); }
1020
1021 wxHitTest HitTest(const wxPoint& pt) const
1022 { return DoHitTest(pt.x, pt.y); }
1023
f03fc89f
VZ
1024 // misc
1025 // ----
1026
aede4ebb
VZ
1027 // get the window border style from the given flags: this is different from
1028 // simply doing flags & wxBORDER_MASK because it uses GetDefaultBorder() to
1029 // translate wxBORDER_DEFAULT to something reasonable
1030 wxBorder GetBorder(long flags) const;
1031
1032 // get border for the flags of this window
1033 wxBorder GetBorder() const { return GetBorder(GetWindowStyleFlag()); }
1e6feb95 1034
d4864e97 1035 // send wxUpdateUIEvents to this window, and children if recurse is true
e39af974
JS
1036 virtual void UpdateWindowUI(long flags = wxUPDATE_UI_NONE);
1037
1038 // do the window-specific processing after processing the update event
1039 virtual void DoUpdateWindowUI(wxUpdateUIEvent& event) ;
f03fc89f 1040
1e6feb95 1041#if wxUSE_MENUS
00a77b7c
VZ
1042 // show popup menu at the given position, generate events for the items
1043 // selected in it
45b8a256 1044 bool PopupMenu(wxMenu *menu, const wxPoint& pos = wxDefaultPosition)
a1665b22 1045 { return DoPopupMenu(menu, pos.x, pos.y); }
971562cb 1046 bool PopupMenu(wxMenu *menu, int x, int y)
a1665b22 1047 { return DoPopupMenu(menu, x, y); }
00a77b7c
VZ
1048
1049 // simply return the id of the selected item or wxID_NONE without
1050 // generating any events
1051 int GetPopupMenuSelectionFromUser(wxMenu& menu, const wxPoint& pos)
1052 { return DoGetPopupMenuSelectionFromUser(menu, pos.x, pos.y); }
1053 int GetPopupMenuSelectionFromUser(wxMenu& menu, int x, int y)
1054 { return DoGetPopupMenuSelectionFromUser(menu, x, y); }
1e6feb95 1055#endif // wxUSE_MENUS
f03fc89f 1056
e71c530e
VZ
1057 // override this method to return true for controls having multiple pages
1058 virtual bool HasMultiplePages() const { return false; }
1059
1060
f03fc89f
VZ
1061 // scrollbars
1062 // ----------
1063
1e6feb95
VZ
1064 // does the window have the scrollbar for this orientation?
1065 bool HasScrollbar(int orient) const
1066 {
1067 return (m_windowStyle &
1068 (orient == wxHORIZONTAL ? wxHSCROLL : wxVSCROLL)) != 0;
1069 }
1070
f03fc89f
VZ
1071 // configure the window scrollbars
1072 virtual void SetScrollbar( int orient,
1073 int pos,
1e6feb95 1074 int thumbvisible,
f03fc89f 1075 int range,
d4864e97
VZ
1076 bool refresh = true ) = 0;
1077 virtual void SetScrollPos( int orient, int pos, bool refresh = true ) = 0;
f03fc89f
VZ
1078 virtual int GetScrollPos( int orient ) const = 0;
1079 virtual int GetScrollThumb( int orient ) const = 0;
1080 virtual int GetScrollRange( int orient ) const = 0;
1081
1082 // scroll window to the specified position
1083 virtual void ScrollWindow( int dx, int dy,
1084 const wxRect* rect = (wxRect *) NULL ) = 0;
1085
b9b3393e 1086 // scrolls window by line/page: note that not all controls support this
9cd6d737 1087 //
d4864e97
VZ
1088 // return true if the position changed, false otherwise
1089 virtual bool ScrollLines(int WXUNUSED(lines)) { return false; }
1090 virtual bool ScrollPages(int WXUNUSED(pages)) { return false; }
9cd6d737
VZ
1091
1092 // convenient wrappers for ScrollLines/Pages
1093 bool LineUp() { return ScrollLines(-1); }
1094 bool LineDown() { return ScrollLines(1); }
1095 bool PageUp() { return ScrollPages(-1); }
1096 bool PageDown() { return ScrollPages(1); }
b9b3393e 1097
c1142003
VZ
1098 // call this to always show one or both scrollbars, even if the window
1099 // is big enough to not require them
1100 virtual void AlwaysShowScrollbars(bool WXUNUSED(horz) = true,
1101 bool WXUNUSED(vert) = true)
1102 {
1103 }
1104
1105 // return true if AlwaysShowScrollbars() had been called before for the
1106 // corresponding orientation
1107 virtual bool IsScrollbarAlwaysShown(int WXUNUSED(orient)) const
1108 {
1109 return false;
1110 }
1111
bd83cb56
VZ
1112 // context-sensitive help
1113 // ----------------------
1114
1115 // these are the convenience functions wrapping wxHelpProvider methods
1116
1117#if wxUSE_HELP
1118 // associate this help text with this window
1119 void SetHelpText(const wxString& text);
1120 // associate this help text with all windows with the same id as this
1121 // one
1122 void SetHelpTextForId(const wxString& text);
dc6588e7
VZ
1123 // get the help string associated with the given position in this window
1124 //
1125 // notice that pt may be invalid if event origin is keyboard or unknown
1126 // and this method should return the global window help text then
1127 virtual wxString GetHelpTextAtPoint(const wxPoint& pt,
1128 wxHelpEvent::Origin origin) const;
1129 // returns the position-independent help text
1130 wxString GetHelpText() const
1131 {
1132 return GetHelpTextAtPoint(wxDefaultPosition, wxHelpEvent::Origin_Unknown);
1133 }
1134
1135#else // !wxUSE_HELP
6c3c55cf
VZ
1136 // silently ignore SetHelpText() calls
1137 void SetHelpText(const wxString& WXUNUSED(text)) { }
1138 void SetHelpTextForId(const wxString& WXUNUSED(text)) { }
bd83cb56
VZ
1139#endif // wxUSE_HELP
1140
f03fc89f
VZ
1141 // tooltips
1142 // --------
bd83cb56 1143
f03fc89f
VZ
1144#if wxUSE_TOOLTIPS
1145 // the easiest way to set a tooltip for a window is to use this method
1146 void SetToolTip( const wxString &tip );
1147 // attach a tooltip to the window
1148 void SetToolTip( wxToolTip *tip ) { DoSetToolTip(tip); }
1149 // get the associated tooltip or NULL if none
1150 wxToolTip* GetToolTip() const { return m_tooltip; }
311a173b 1151 wxString GetToolTipText() const ;
7649d8fc
JS
1152#else
1153 // make it much easier to compile apps in an environment
1154 // that doesn't support tooltips, such as PocketPC
1155 inline void SetToolTip( const wxString & WXUNUSED(tip) ) {}
f03fc89f
VZ
1156#endif // wxUSE_TOOLTIPS
1157
1158 // drag and drop
1159 // -------------
1160#if wxUSE_DRAG_AND_DROP
1161 // set/retrieve the drop target associated with this window (may be
1162 // NULL; it's owned by the window and will be deleted by it)
1163 virtual void SetDropTarget( wxDropTarget *dropTarget ) = 0;
1164 virtual wxDropTarget *GetDropTarget() const { return m_dropTarget; }
1165#endif // wxUSE_DRAG_AND_DROP
1166
1167 // constraints and sizers
1168 // ----------------------
1169#if wxUSE_CONSTRAINTS
1170 // set the constraints for this window or retrieve them (may be NULL)
1171 void SetConstraints( wxLayoutConstraints *constraints );
1172 wxLayoutConstraints *GetConstraints() const { return m_constraints; }
1173
f03fc89f
VZ
1174 // implementation only
1175 void UnsetConstraints(wxLayoutConstraints *c);
1176 wxWindowList *GetConstraintsInvolvedIn() const
1177 { return m_constraintsInvolvedIn; }
1178 void AddConstraintReference(wxWindowBase *otherWin);
1179 void RemoveConstraintReference(wxWindowBase *otherWin);
1180 void DeleteRelatedConstraints();
1181 void ResetConstraints();
1182
90e572f1 1183 // these methods may be overridden for special layout algorithms
d4864e97 1184 virtual void SetConstraintSizes(bool recurse = true);
f03fc89f
VZ
1185 virtual bool LayoutPhase1(int *noChanges);
1186 virtual bool LayoutPhase2(int *noChanges);
4b7f2165 1187 virtual bool DoPhase(int phase);
f03fc89f
VZ
1188
1189 // these methods are virtual but normally won't be overridden
f03fc89f
VZ
1190 virtual void SetSizeConstraint(int x, int y, int w, int h);
1191 virtual void MoveConstraint(int x, int y);
1192 virtual void GetSizeConstraint(int *w, int *h) const ;
1193 virtual void GetClientSizeConstraint(int *w, int *h) const ;
1194 virtual void GetPositionConstraint(int *x, int *y) const ;
1195
461e93f9
JS
1196#endif // wxUSE_CONSTRAINTS
1197
1198 // when using constraints or sizers, it makes sense to update
1199 // children positions automatically whenever the window is resized
1200 // - this is done if autoLayout is on
1201 void SetAutoLayout( bool autoLayout ) { m_autoLayout = autoLayout; }
1202 bool GetAutoLayout() const { return m_autoLayout; }
1203
1204 // lay out the window and its children
1205 virtual bool Layout();
1206
f03fc89f 1207 // sizers
d4864e97
VZ
1208 void SetSizer(wxSizer *sizer, bool deleteOld = true );
1209 void SetSizerAndFit( wxSizer *sizer, bool deleteOld = true );
566d84a7 1210
f03fc89f 1211 wxSizer *GetSizer() const { return m_windowSizer; }
be90c029
RD
1212
1213 // Track if this window is a member of a sizer
1ebfafde 1214 void SetContainingSizer(wxSizer* sizer);
be90c029
RD
1215 wxSizer *GetContainingSizer() const { return m_containingSizer; }
1216
45a959a3
JS
1217 // accessibility
1218 // ----------------------
1219#if wxUSE_ACCESSIBILITY
1220 // Override to create a specific accessible object.
1221 virtual wxAccessible* CreateAccessible();
1222
1223 // Sets the accessible object.
1224 void SetAccessible(wxAccessible* accessible) ;
1225
1226 // Returns the accessible object.
47b378bd 1227 wxAccessible* GetAccessible() { return m_accessible; }
45a959a3
JS
1228
1229 // Returns the accessible object, creating if necessary.
1230 wxAccessible* GetOrCreateAccessible() ;
1231#endif
1232
b137e493 1233
b58d5e2d
RD
1234 // Set window transparency if the platform supports it
1235 virtual bool SetTransparent(wxByte WXUNUSED(alpha)) { return false; }
1236 virtual bool CanSetTransparent() { return false; }
1237
1238
f03fc89f
VZ
1239 // implementation
1240 // --------------
1241
1242 // event handlers
1243 void OnSysColourChanged( wxSysColourChangedEvent& event );
1244 void OnInitDialog( wxInitDialogEvent &event );
72fc5caf 1245 void OnMiddleClick( wxMouseEvent& event );
bd83cb56
VZ
1246#if wxUSE_HELP
1247 void OnHelp(wxHelpEvent& event);
1248#endif // wxUSE_HELP
f03fc89f 1249
e39af974
JS
1250 // virtual function for implementing internal idle
1251 // behaviour
1252 virtual void OnInternalIdle() {}
1253
1254 // call internal idle recursively
5109ae5d 1255// void ProcessInternalIdle() ;
e39af974
JS
1256
1257 // get the handle of the window for the underlying window system: this
d7c24517
VZ
1258 // is only used for wxWin itself or for user code which wants to call
1259 // platform-specific APIs
d22699b5 1260 virtual WXWidget GetHandle() const = 0;
ed4780ea
VZ
1261 // associate the window with a new native handle
1262 virtual void AssociateHandle(WXWidget WXUNUSED(handle)) { }
1263 // dissociate the current native handle from the window
1264 virtual void DissociateHandle() { }
cc2b7472 1265
574c939e
KB
1266#if wxUSE_PALETTE
1267 // Store the palette used by DCs in wxWindow so that the dcs can share
1268 // a palette. And we can respond to palette messages.
1269 wxPalette GetPalette() const { return m_palette; }
b95edd47 1270
574c939e
KB
1271 // When palette is changed tell the DC to set the system palette to the
1272 // new one.
b95edd47
VZ
1273 void SetPalette(const wxPalette& pal);
1274
1275 // return true if we have a specific palette
1276 bool HasCustomPalette() const { return m_hasCustomPalette; }
1277
1278 // return the first parent window with a custom palette or NULL
1279 wxWindow *GetAncestorWithCustomPalette() const;
574c939e
KB
1280#endif // wxUSE_PALETTE
1281
b8e7b673
VZ
1282 // inherit the parents visual attributes if they had been explicitly set
1283 // by the user (i.e. we don't inherit default attributes) and if we don't
1284 // have our own explicitly set
1285 virtual void InheritAttributes();
1286
1287 // returns false from here if this window doesn't want to inherit the
1288 // parents colours even if InheritAttributes() would normally do it
1289 //
1290 // this just provides a simple way to customize InheritAttributes()
1291 // behaviour in the most common case
1292 virtual bool ShouldInheritColours() const { return false; }
1293
c04c7a3d
VS
1294 // returns true if the window can be positioned outside of parent's client
1295 // area (normal windows can't, but e.g. menubar or statusbar can):
1296 virtual bool CanBeOutsideClientArea() const { return false; }
1297
dc797d8e
JS
1298 // returns true if the platform should explicitly apply a theme border. Currently
1299 // used only by Windows
a047aff2
JS
1300 virtual bool CanApplyThemeBorder() const { return true; }
1301
245c5d2e
RD
1302protected:
1303 // event handling specific to wxWindow
1304 virtual bool TryValidator(wxEvent& event);
1305 virtual bool TryParent(wxEvent& event);
1306
c944775f 1307 enum WindowOrder
a24de76b 1308 {
c944775f
VZ
1309 OrderBefore, // insert before the given window
1310 OrderAfter // insert after the given window
a24de76b 1311 };
c944775f
VZ
1312
1313 // common part of GetPrev/NextSibling()
1314 wxWindow *DoGetSibling(WindowOrder order) const;
1315
1316 // common part of MoveBefore/AfterInTabOrder()
1317 virtual void DoMoveInTabOrder(wxWindow *win, WindowOrder move);
4caf847c 1318
5644933f
VZ
1319 // implementation of Navigate() and NavigateIn()
1320 virtual bool DoNavigateIn(int flags);
1321
ec5bb70d
VZ
1322#if wxUSE_CONSTRAINTS
1323 // satisfy the constraints for the windows but don't set the window sizes
1324 void SatisfyConstraints();
1325#endif // wxUSE_CONSTRAINTS
566d84a7 1326
7de59551
RD
1327 // Send the wxWindowDestroyEvent
1328 void SendDestroyEvent();
1329
0fe02759
VS
1330 // returns the main window of composite control; this is the window
1331 // that FindFocus returns if the focus is in one of composite control's
1332 // windows
6fb99eb3 1333 virtual wxWindow *GetMainWindowOfCompositeControl()
0fe02759
VS
1334 { return (wxWindow*)this; }
1335
47a8a4d5
VZ
1336 // this method should be implemented to use operating system specific code
1337 // to really enable/disable the widget, it will only be called when we
1338 // really need to enable/disable window and so no additional checks on the
1339 // widgets state are necessary
1340 virtual void DoEnable(bool WXUNUSED(enable)) { }
1341
1342 // called when the on-screen widget state changes and provides an
1343 // an opportunity for the widget to update its visual state (colours,
1344 // fonts, anything else) as necessary
1345 virtual void OnEnabled(bool WXUNUSED(enabled)) { }
1346
1347
7af6f327 1348 // the window id - a number which uniquely identifies a window among
a0d9c6cb 1349 // its siblings unless it is wxID_ANY
f03fc89f 1350 wxWindowID m_windowId;
456bc6d9 1351
f03fc89f
VZ
1352 // the parent window of this window (or NULL) and the list of the children
1353 // of this window
1354 wxWindow *m_parent;
1355 wxWindowList m_children;
1356
1357 // the minimal allowed size for the window (no minimal size if variable(s)
a0d9c6cb 1358 // contain(s) wxDefaultCoord)
ec5bb70d
VZ
1359 int m_minWidth,
1360 m_minHeight,
1361 m_maxWidth,
1362 m_maxHeight;
f03fc89f
VZ
1363
1364 // event handler for this window: usually is just 'this' but may be
1365 // changed with SetEventHandler()
1366 wxEvtHandler *m_eventHandler;
1367
88ac883a 1368#if wxUSE_VALIDATORS
f03fc89f
VZ
1369 // associated validator or NULL if none
1370 wxValidator *m_windowValidator;
88ac883a 1371#endif // wxUSE_VALIDATORS
f03fc89f
VZ
1372
1373#if wxUSE_DRAG_AND_DROP
1374 wxDropTarget *m_dropTarget;
1375#endif // wxUSE_DRAG_AND_DROP
1376
1377 // visual window attributes
1378 wxCursor m_cursor;
1b69c815
VZ
1379 wxFont m_font; // see m_hasFont
1380 wxColour m_backgroundColour, // m_hasBgCol
1381 m_foregroundColour; // m_hasFgCol
f03fc89f 1382
789295bf
VZ
1383#if wxUSE_CARET
1384 wxCaret *m_caret;
1385#endif // wxUSE_CARET
1386
f03fc89f
VZ
1387 // the region which should be repainted in response to paint event
1388 wxRegion m_updateRegion;
1389
88ac883a 1390#if wxUSE_ACCEL
f03fc89f
VZ
1391 // the accelerator table for the window which translates key strokes into
1392 // command events
1393 wxAcceleratorTable m_acceleratorTable;
88ac883a 1394#endif // wxUSE_ACCEL
f03fc89f 1395
f03fc89f
VZ
1396 // the tooltip for this window (may be NULL)
1397#if wxUSE_TOOLTIPS
1398 wxToolTip *m_tooltip;
1399#endif // wxUSE_TOOLTIPS
1400
1401 // constraints and sizers
1402#if wxUSE_CONSTRAINTS
1403 // the constraints for this window or NULL
1404 wxLayoutConstraints *m_constraints;
1405
1406 // constraints this window is involved in
1407 wxWindowList *m_constraintsInvolvedIn;
461e93f9 1408#endif // wxUSE_CONSTRAINTS
f03fc89f 1409
be90c029 1410 // this window's sizer
f03fc89f 1411 wxSizer *m_windowSizer;
be90c029
RD
1412
1413 // The sizer this window is a member of, if any
1414 wxSizer *m_containingSizer;
f03fc89f
VZ
1415
1416 // Layout() window automatically when its size changes?
1417 bool m_autoLayout:1;
f03fc89f 1418
f35fdf7e
VZ
1419 // true if we had automatically allocated the id value for this window
1420 // (i.e. wxID_ANY had been passed to the ctor)
1421 bool m_freeId:1;
1422
f03fc89f
VZ
1423 // window state
1424 bool m_isShown:1;
1425 bool m_isEnabled:1;
1426 bool m_isBeingDeleted:1;
1427
23895080
VZ
1428 // was the window colours/font explicitly changed by user?
1429 bool m_hasBgCol:1;
1430 bool m_hasFgCol:1;
1431 bool m_hasFont:1;
a0d9c6cb 1432
f8ff87ed
VS
1433 // and should it be inherited by children?
1434 bool m_inheritBgCol:1;
1435 bool m_inheritFgCol:1;
1436 bool m_inheritFont:1;
23895080 1437
f03fc89f 1438 // window attributes
d80cd92a
VZ
1439 long m_windowStyle,
1440 m_exStyle;
f03fc89f 1441 wxString m_windowName;
a2d93e73 1442 bool m_themeEnabled;
50c53860 1443 wxBackgroundStyle m_backgroundStyle;
071e5fd9 1444#if wxUSE_PALETTE
574c939e 1445 wxPalette m_palette;
b95edd47
VZ
1446 bool m_hasCustomPalette;
1447#endif // wxUSE_PALETTE
574c939e 1448
45a959a3
JS
1449#if wxUSE_ACCESSIBILITY
1450 wxAccessible* m_accessible;
1451#endif
2654f7e4 1452
566d84a7
RL
1453 // Virtual size (scrolling)
1454 wxSize m_virtualSize;
1455
f4fe2f20
RR
1456 wxScrollHelper *m_scrollHelper;
1457
566d84a7
RL
1458 int m_minVirtualWidth; // VirtualSizeHints
1459 int m_minVirtualHeight;
1460 int m_maxVirtualWidth;
1461 int m_maxVirtualHeight;
400a9e41 1462
69d90995 1463 wxWindowVariant m_windowVariant ;
45e0dc94 1464
1e6feb95
VZ
1465 // override this to change the default (i.e. used when no style is
1466 // specified) border for the window class
1467 virtual wxBorder GetDefaultBorder() const;
1468
a047aff2
JS
1469 // this allows you to implement standard control borders without
1470 // repeating the code in different classes that are not derived from
1471 // wxControl
dc797d8e 1472 virtual wxBorder GetDefaultBorderForControl() const { return wxBORDER_THEME; }
a047aff2 1473
5c2be659
RD
1474 // Get the default size for the new window if no explicit size given. TLWs
1475 // have their own default size so this is just for non top-level windows.
a0d9c6cb
WS
1476 static int WidthDefault(int w) { return w == wxDefaultCoord ? 20 : w; }
1477 static int HeightDefault(int h) { return h == wxDefaultCoord ? 20 : h; }
f03fc89f 1478
9f884528
RD
1479
1480 // Used to save the results of DoGetBestSize so it doesn't need to be
1481 // recalculated each time the value is needed.
1482 wxSize m_bestSizeCache;
1483
170acdc9
RD
1484 wxDEPRECATED( void SetBestSize(const wxSize& size) ); // use SetInitialSize
1485 wxDEPRECATED( virtual void SetInitialBestSize(const wxSize& size) ); // use SetInitialSize
d3b5db4b 1486
a0d9c6cb 1487
d3b5db4b 1488
f03fc89f
VZ
1489 // more pure virtual functions
1490 // ---------------------------
1491
1492 // NB: we must have DoSomething() function when Something() is an overloaded
1493 // method: indeed, we can't just have "virtual Something()" in case when
1494 // the function is overloaded because then we'd have to make virtual all
1495 // the variants (otherwise only the virtual function may be called on a
1496 // pointer to derived class according to C++ rules) which is, in
1497 // general, absolutely not needed. So instead we implement all
1498 // overloaded Something()s in terms of DoSomething() which will be the
1499 // only one to be virtual.
1500
dabc0cd5
VZ
1501 // coordinates translation
1502 virtual void DoClientToScreen( int *x, int *y ) const = 0;
1503 virtual void DoScreenToClient( int *x, int *y ) const = 0;
1504
1e6feb95
VZ
1505 virtual wxHitTest DoHitTest(wxCoord x, wxCoord y) const;
1506
94633ad9 1507 // capture/release the mouse, used by Capture/ReleaseMouse()
a83e1475
VZ
1508 virtual void DoCaptureMouse() = 0;
1509 virtual void DoReleaseMouse() = 0;
be90c029 1510
f03fc89f 1511 // retrieve the position/size of the window
3c81c9aa
VZ
1512 virtual void DoGetPosition(int *x, int *y) const = 0;
1513 virtual void DoGetScreenPosition(int *x, int *y) const;
1514 virtual void DoGetSize(int *width, int *height) const = 0;
1515 virtual void DoGetClientSize(int *width, int *height) const = 0;
f03fc89f 1516
f68586e5
VZ
1517 // get the size which best suits the window: for a control, it would be
1518 // the minimal size which doesn't truncate the control, for a panel - the
1519 // same size as it would have after a call to Fit()
1520 virtual wxSize DoGetBestSize() const;
1521
ee146bca
VZ
1522 // called from DoGetBestSize() to convert best virtual size (returned by
1523 // the window sizer) to the best size for the window itself; this is
1524 // overridden at wxScrolledWindow level to clump down virtual size to real
1525 virtual wxSize GetWindowSizeForVirtualSize(const wxSize& size) const
1526 {
1527 return size;
1528 }
1529
f03fc89f
VZ
1530 // this is the virtual function to be overriden in any derived class which
1531 // wants to change how SetSize() or Move() works - it is called by all
1532 // versions of these functions in the base class
1533 virtual void DoSetSize(int x, int y,
1534 int width, int height,
1535 int sizeFlags = wxSIZE_AUTO) = 0;
1536
1537 // same as DoSetSize() for the client size
1538 virtual void DoSetClientSize(int width, int height) = 0;
1539
b2e10dac
PC
1540 virtual void DoSetSizeHints( int minW, int minH,
1541 int maxW, int maxH,
1542 int incW, int incH );
1543
9d9b7755
VZ
1544 // move the window to the specified location and resize it: this is called
1545 // from both DoSetSize() and DoSetClientSize() and would usually just
1546 // reposition this window except for composite controls which will want to
1547 // arrange themselves inside the given rectangle
69deca26
VS
1548 //
1549 // Important note: the coordinates passed to this method are in parent's
1550 // *window* coordinates and not parent's client coordinates (as the values
1551 // passed to DoSetSize and returned by DoGetPosition are)!
9d9b7755
VZ
1552 virtual void DoMoveWindow(int x, int y, int width, int height) = 0;
1553
1f464296
VZ
1554 // centre the window in the specified direction on parent, note that
1555 // wxCENTRE_ON_SCREEN shouldn't be specified here, it only makes sense for
1556 // TLWs
1557 virtual void DoCentre(int dir);
1558
f03fc89f
VZ
1559#if wxUSE_TOOLTIPS
1560 virtual void DoSetToolTip( wxToolTip *tip );
1561#endif // wxUSE_TOOLTIPS
1562
1e6feb95 1563#if wxUSE_MENUS
971562cb 1564 virtual bool DoPopupMenu(wxMenu *menu, int x, int y) = 0;
1e6feb95 1565#endif // wxUSE_MENUS
a1665b22 1566
716e96df
VZ
1567 // Makes an adjustment to the window position to make it relative to the
1568 // parents client area, e.g. if the parent is a frame with a toolbar, its
1569 // (0, 0) is just below the toolbar
1570 virtual void AdjustForParentClientOrigin(int& x, int& y,
1571 int sizeFlags = 0) const;
8d99be5f 1572
69d90995
SC
1573 // implements the window variants
1574 virtual void DoSetWindowVariant( wxWindowVariant variant ) ;
45e0dc94 1575
63e819f2 1576 // Must be called when mouse capture is lost to send
72f8c792
VS
1577 // wxMouseCaptureLostEvent to windows on capture stack.
1578 static void NotifyCaptureLost();
63e819f2 1579
f03fc89f 1580private:
47a8a4d5
VZ
1581 // recursively call our own and our children OnEnabled() when the
1582 // enabled/disabled status changed because a parent window had been
1583 // enabled/disabled
1584 void NotifyWindowOnEnableChange(bool enabled);
1585
00a77b7c
VZ
1586#if wxUSE_MENUS
1587 // temporary event handler used by GetPopupMenuSelectionFromUser()
1588 void InternalOnPopupMenu(wxCommandEvent& event);
1589
1590 // implementation of the public GetPopupMenuSelectionFromUser() method
1591 int DoGetPopupMenuSelectionFromUser(wxMenu& menu, int x, int y);
1592#endif // wxUSE_MENUS
47a8a4d5 1593
a83e1475 1594 // the stack of windows which have captured the mouse
b5dbe15d 1595 static struct WXDLLIMPEXP_FWD_CORE wxWindowNext *ms_winCaptureNext;
63e819f2
VS
1596 // the window that currently has mouse capture
1597 static wxWindow *ms_winCaptureCurrent;
1598 // indicates if execution is inside CaptureMouse/ReleaseMouse
1599 static bool ms_winCaptureChanging;
a83e1475 1600
1e6feb95
VZ
1601 DECLARE_ABSTRACT_CLASS(wxWindowBase)
1602 DECLARE_NO_COPY_CLASS(wxWindowBase)
f03fc89f
VZ
1603 DECLARE_EVENT_TABLE()
1604};
1605
170acdc9
RD
1606
1607
1608// Inlines for some deprecated methods
1609inline wxSize wxWindowBase::GetBestFittingSize() const
1610{
1611 return GetEffectiveMinSize();
1612}
1613
1614inline void wxWindowBase::SetBestFittingSize(const wxSize& size)
1615{
1616 SetInitialSize(size);
1617}
1618
1619inline void wxWindowBase::SetBestSize(const wxSize& size)
1620{
1621 SetInitialSize(size);
1622}
1623
1624inline void wxWindowBase::SetInitialBestSize(const wxSize& size)
1625{
1626 SetInitialSize(size);
1627}
1628
1629
f03fc89f
VZ
1630// ----------------------------------------------------------------------------
1631// now include the declaration of wxWindow class
1632// ----------------------------------------------------------------------------
1633
1e6feb95 1634// include the declaration of the platform-specific class
4055ed82 1635#if defined(__WXPALMOS__)
ffecfa5a
JS
1636 #ifdef __WXUNIVERSAL__
1637 #define wxWindowNative wxWindowPalm
1638 #else // !wxUniv
1639 #define wxWindowPalm wxWindow
1640 #endif // wxUniv/!wxUniv
1641 #include "wx/palmos/window.h"
1642#elif defined(__WXMSW__)
a5b3669d
VZ
1643 #ifdef __WXUNIVERSAL__
1644 #define wxWindowNative wxWindowMSW
1645 #else // !wxUniv
1e6feb95 1646 #define wxWindowMSW wxWindow
a5b3669d 1647 #endif // wxUniv/!wxUniv
f03fc89f 1648 #include "wx/msw/window.h"
2049ba38 1649#elif defined(__WXMOTIF__)
f03fc89f 1650 #include "wx/motif/window.h"
1be7a35c 1651#elif defined(__WXGTK20__)
a5b3669d
VZ
1652 #ifdef __WXUNIVERSAL__
1653 #define wxWindowNative wxWindowGTK
1654 #else // !wxUniv
1e6feb95 1655 #define wxWindowGTK wxWindow
1e6feb95 1656 #endif // wxUniv
f03fc89f 1657 #include "wx/gtk/window.h"
1be7a35c
MR
1658#elif defined(__WXGTK__)
1659 #ifdef __WXUNIVERSAL__
1660 #define wxWindowNative wxWindowGTK
1661 #else // !wxUniv
1662 #define wxWindowGTK wxWindow
1663 #endif // wxUniv
1664 #include "wx/gtk1/window.h"
83df96d6
JS
1665#elif defined(__WXX11__)
1666 #ifdef __WXUNIVERSAL__
1667 #define wxWindowNative wxWindowX11
1668 #else // !wxUniv
1669 #define wxWindowX11 wxWindow
83df96d6
JS
1670 #endif // wxUniv
1671 #include "wx/x11/window.h"
711c76db 1672#elif defined(__WXMGL__)
b3c86150 1673 #define wxWindowNative wxWindowMGL
386c7058 1674 #include "wx/mgl/window.h"
b3c86150
VS
1675#elif defined(__WXDFB__)
1676 #define wxWindowNative wxWindowDFB
1677 #include "wx/dfb/window.h"
34138703 1678#elif defined(__WXMAC__)
e766c8a9
SC
1679 #ifdef __WXUNIVERSAL__
1680 #define wxWindowNative wxWindowMac
1681 #else // !wxUniv
1682 #define wxWindowMac wxWindow
e766c8a9 1683 #endif // wxUniv
f03fc89f 1684 #include "wx/mac/window.h"
e64df9bc
DE
1685#elif defined(__WXCOCOA__)
1686 #ifdef __WXUNIVERSAL__
1687 #define wxWindowNative wxWindowCocoa
1688 #else // !wxUniv
1689 #define wxWindowCocoa wxWindow
e64df9bc
DE
1690 #endif // wxUniv
1691 #include "wx/cocoa/window.h"
1777b9bb 1692#elif defined(__WXPM__)
210a651b
DW
1693 #ifdef __WXUNIVERSAL__
1694 #define wxWindowNative wxWindowOS2
1695 #else // !wxUniv
1696 #define wxWindowOS2 wxWindow
210a651b 1697 #endif // wxUniv/!wxUniv
1777b9bb 1698 #include "wx/os2/window.h"
c801d85f
KB
1699#endif
1700
1e6feb95
VZ
1701// for wxUniversal, we now derive the real wxWindow from wxWindow<platform>,
1702// for the native ports we already have defined it above
1703#if defined(__WXUNIVERSAL__)
a5b3669d
VZ
1704 #ifndef wxWindowNative
1705 #error "wxWindowNative must be defined above!"
1706 #endif
1707
1e6feb95
VZ
1708 #include "wx/univ/window.h"
1709#endif // wxUniv
1710
f03fc89f
VZ
1711// ----------------------------------------------------------------------------
1712// inline functions which couldn't be declared in the class body because of
1713// forward dependencies
1714// ----------------------------------------------------------------------------
1715
bacd69f9 1716inline wxWindow *wxWindowBase::GetGrandParent() const
f03fc89f
VZ
1717{
1718 return m_parent ? m_parent->GetParent() : (wxWindow *)NULL;
1719}
1720
1721// ----------------------------------------------------------------------------
3723b7b1 1722// global functions
f03fc89f
VZ
1723// ----------------------------------------------------------------------------
1724
3723b7b1
JS
1725// Find the wxWindow at the current mouse position, also returning the mouse
1726// position.
16cba29d 1727extern WXDLLEXPORT wxWindow* wxFindWindowAtPointer(wxPoint& pt);
3723b7b1
JS
1728
1729// Get the current mouse position.
16cba29d 1730extern WXDLLEXPORT wxPoint wxGetMousePosition();
3723b7b1 1731
1e6feb95 1732// get the currently active window of this application or NULL
16cba29d 1733extern WXDLLEXPORT wxWindow *wxGetActiveWindow();
1e6feb95 1734
33b494d6
VZ
1735// get the (first) top level parent window
1736WXDLLEXPORT wxWindow* wxGetTopLevelParent(wxWindow *win);
1737
40ff126a
WS
1738#if WXWIN_COMPATIBILITY_2_6
1739 // deprecated (doesn't start with 'wx' prefix), use wxWindow::NewControlId()
1740 wxDEPRECATED( int NewControlId() );
1741 inline int NewControlId() { return wxWindowBase::NewControlId(); }
1742#endif // WXWIN_COMPATIBILITY_2_6
f03fc89f 1743
45a959a3
JS
1744#if wxUSE_ACCESSIBILITY
1745// ----------------------------------------------------------------------------
1746// accessible object for windows
1747// ----------------------------------------------------------------------------
1748
1749class WXDLLEXPORT wxWindowAccessible: public wxAccessible
1750{
1751public:
f81387bd 1752 wxWindowAccessible(wxWindow* win): wxAccessible(win) { if (win) win->SetAccessible(this); }
6fb99eb3 1753 virtual ~wxWindowAccessible() {}
45a959a3
JS
1754
1755// Overridables
1756
1757 // Can return either a child object, or an integer
1758 // representing the child element, starting from 1.
1759 virtual wxAccStatus HitTest(const wxPoint& pt, int* childId, wxAccessible** childObject);
1760
1761 // Returns the rectangle for this object (id = 0) or a child element (id > 0).
1762 virtual wxAccStatus GetLocation(wxRect& rect, int elementId);
1763
1764 // Navigates from fromId to toId/toObject.
1765 virtual wxAccStatus Navigate(wxNavDir navDir, int fromId,
1766 int* toId, wxAccessible** toObject);
1767
1768 // Gets the name of the specified object.
1769 virtual wxAccStatus GetName(int childId, wxString* name);
1770
1771 // Gets the number of children.
a37e4a07 1772 virtual wxAccStatus GetChildCount(int* childCount);
45a959a3
JS
1773
1774 // Gets the specified child (starting from 1).
1775 // If *child is NULL and return value is wxACC_OK,
1776 // this means that the child is a simple element and
1777 // not an accessible object.
1778 virtual wxAccStatus GetChild(int childId, wxAccessible** child);
1779
1780 // Gets the parent, or NULL.
1781 virtual wxAccStatus GetParent(wxAccessible** parent);
1782
1783 // Performs the default action. childId is 0 (the action for this object)
1784 // or > 0 (the action for a child).
1785 // Return wxACC_NOT_SUPPORTED if there is no default action for this
1786 // window (e.g. an edit control).
1787 virtual wxAccStatus DoDefaultAction(int childId);
1788
1789 // Gets the default action for this object (0) or > 0 (the action for a child).
1790 // Return wxACC_OK even if there is no action. actionName is the action, or the empty
1791 // string if there is no action.
1792 // The retrieved string describes the action that is performed on an object,
1793 // not what the object does as a result. For example, a toolbar button that prints
1794 // a document has a default action of "Press" rather than "Prints the current document."
1795 virtual wxAccStatus GetDefaultAction(int childId, wxString* actionName);
1796
1797 // Returns the description for this object or a child.
1798 virtual wxAccStatus GetDescription(int childId, wxString* description);
1799
1800 // Returns help text for this object or a child, similar to tooltip text.
1801 virtual wxAccStatus GetHelpText(int childId, wxString* helpText);
1802
1803 // Returns the keyboard shortcut for this object or child.
1804 // Return e.g. ALT+K
1805 virtual wxAccStatus GetKeyboardShortcut(int childId, wxString* shortcut);
1806
1807 // Returns a role constant.
1808 virtual wxAccStatus GetRole(int childId, wxAccRole* role);
1809
1810 // Returns a state constant.
1811 virtual wxAccStatus GetState(int childId, long* state);
1812
1813 // Returns a localized string representing the value for the object
1814 // or child.
1815 virtual wxAccStatus GetValue(int childId, wxString* strValue);
1816
1817 // Selects the object or child.
1818 virtual wxAccStatus Select(int childId, wxAccSelectionFlags selectFlags);
1819
1820 // Gets the window with the keyboard focus.
1821 // If childId is 0 and child is NULL, no object in
1822 // this subhierarchy has the focus.
1823 // If this object has the focus, child should be 'this'.
1824 virtual wxAccStatus GetFocus(int* childId, wxAccessible** child);
1825
ca5c6ac3 1826#if wxUSE_VARIANT
45a959a3
JS
1827 // Gets a variant representing the selected children
1828 // of this object.
1829 // Acceptable values:
d4864e97 1830 // - a null variant (IsNull() returns true)
45a959a3
JS
1831 // - a list variant (GetType() == wxT("list")
1832 // - an integer representing the selected child element,
1833 // or 0 if this object is selected (GetType() == wxT("long")
1834 // - a "void*" pointer to a wxAccessible child object
1835 virtual wxAccStatus GetSelections(wxVariant* selections);
ca5c6ac3 1836#endif // wxUSE_VARIANT
45a959a3
JS
1837};
1838
1839#endif // wxUSE_ACCESSIBILITY
1840
1841
faa49bfd 1842#endif // _WX_WINDOW_H_BASE_