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