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