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