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