]> git.saurik.com Git - wxWidgets.git/blame - include/wx/window.h
fix compile break for unknown FLASHWINFO
[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$
77ffb593 8// Copyright: (c) wxWidgets team
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
51#else // __WXMSW__
52 #define wxUSE_MENUS_NATIVE wxUSE_MENUS
53#endif // __WXUNIVERSAL__/__WXMSW__
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
119WXDLLEXPORT_DATA(extern wxWindowList) wxTopLevelWindows;
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.
320 void InvalidateBestSize() { m_bestSizeCache = wxDefaultSize; }
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
WS
366 int maxW = wxDefaultCoord, int maxH = wxDefaultCoord,
367 int incW = wxDefaultCoord, int incH = wxDefaultCoord );
1ec25e8f
RD
368 void SetSizeHints( const wxSize& minSize,
369 const wxSize& maxSize=wxDefaultSize,
370 const wxSize& incSize=wxDefaultSize)
371 {
372 SetSizeHints(minSize.x, minSize.y,
373 maxSize.x, maxSize.y,
374 incSize.x, incSize.y);
375 }
f03fc89f 376
566d84a7 377 virtual void SetVirtualSizeHints( int minW, int minH,
a0d9c6cb 378 int maxW = wxDefaultCoord, int maxH = wxDefaultCoord );
1ec25e8f
RD
379 void SetVirtualSizeHints( const wxSize& minSize,
380 const wxSize& maxSize=wxDefaultSize)
381 {
382 SetVirtualSizeHints(minSize.x, minSize.y, maxSize.x, maxSize.y);
383 }
566d84a7 384
e7dda1ff
VS
385 virtual int GetMinWidth() const { return m_minWidth; }
386 virtual int GetMinHeight() const { return m_minHeight; }
738f9e5a
RR
387 int GetMaxWidth() const { return m_maxWidth; }
388 int GetMaxHeight() const { return m_maxHeight; }
57c4d796 389
34c3ffca
RL
390 // Override this method to control the values given to Sizers etc.
391 virtual wxSize GetMaxSize() const { return wxSize( m_maxWidth, m_maxHeight ); }
1ec25e8f 392 virtual wxSize GetMinSize() const { return wxSize( m_minWidth, m_minHeight ); }
400a9e41 393
49f1dc5e
RD
394 void SetMinSize(const wxSize& minSize) { SetSizeHints(minSize); }
395 void SetMaxSize(const wxSize& maxSize) { SetSizeHints(GetMinSize(), maxSize); }
a0d9c6cb 396
566d84a7
RL
397 // Methods for accessing the virtual size of a window. For most
398 // windows this is just the client area of the window, but for
399 // some like scrolled windows it is more or less independent of
400 // the screen window size. You may override the DoXXXVirtual
401 // methods below for classes where that is is the case.
402
403 void SetVirtualSize( const wxSize &size ) { DoSetVirtualSize( size.x, size.y ); }
404 void SetVirtualSize( int x, int y ) { DoSetVirtualSize( x, y ); }
405
406 wxSize GetVirtualSize() const { return DoGetVirtualSize(); }
407 void GetVirtualSize( int *x, int *y ) const
408 {
409 wxSize s( DoGetVirtualSize() );
410
411 if( x )
412 *x = s.GetWidth();
413 if( y )
414 *y = s.GetHeight();
415 }
416
417 // Override these methods for windows that have a virtual size
418 // independent of their client size. eg. the virtual area of a
419 // wxScrolledWindow. Default is to alias VirtualSize to ClientSize.
420
421 virtual void DoSetVirtualSize( int x, int y );
422 virtual wxSize DoGetVirtualSize() const; // { return m_virtualSize; }
423
2b5f62a0
VZ
424 // Return the largest of ClientSize and BestSize (as determined
425 // by a sizer, interior children, or other means)
426
427 virtual wxSize GetBestVirtualSize() const
428 {
429 wxSize client( GetClientSize() );
430 wxSize best( GetBestSize() );
431
432 return wxSize( wxMax( client.x, best.x ), wxMax( client.y, best.y ) );
433 }
434
f03fc89f
VZ
435 // window state
436 // ------------
437
d4864e97 438 // returns true if window was shown/hidden, false if the nothing was
f03fc89f 439 // done (window was already shown/hidden)
d4864e97
VZ
440 virtual bool Show( bool show = true );
441 bool Hide() { return Show(false); }
f03fc89f 442
d4864e97
VZ
443 // returns true if window was enabled/disabled, false if nothing done
444 virtual bool Enable( bool enable = true );
445 bool Disable() { return Enable(false); }
f03fc89f
VZ
446
447 bool IsShown() const { return m_isShown; }
448 bool IsEnabled() const { return m_isEnabled; }
449
450 // get/set window style (setting style won't update the window and so
451 // is only useful for internal usage)
452 virtual void SetWindowStyleFlag( long style ) { m_windowStyle = style; }
453 virtual long GetWindowStyleFlag() const { return m_windowStyle; }
454
455 // just some (somewhat shorter) synonims
456 void SetWindowStyle( long style ) { SetWindowStyleFlag(style); }
457 long GetWindowStyle() const { return GetWindowStyleFlag(); }
458
459 bool HasFlag(int flag) const { return (m_windowStyle & flag) != 0; }
d80cd92a 460 virtual bool IsRetained() const { return HasFlag(wxRETAINED); }
f03fc89f 461
d80cd92a
VZ
462 // extra style: the less often used style bits which can't be set with
463 // SetWindowStyleFlag()
b2d5a7ee 464 virtual void SetExtraStyle(long exStyle) { m_exStyle = exStyle; }
d80cd92a 465 long GetExtraStyle() const { return m_exStyle; }
f03fc89f
VZ
466
467 // make the window modal (all other windows unresponsive)
d4864e97 468 virtual void MakeModal(bool modal = true);
f03fc89f 469
b8e7b673
VZ
470
471 // (primitive) theming support
472 // ---------------------------
473
a2d93e73
JS
474 virtual void SetThemeEnabled(bool enableTheme) { m_themeEnabled = enableTheme; }
475 virtual bool GetThemeEnabled() const { return m_themeEnabled; }
476
bd507486
RD
477 // Returns true if this class should have the background colour
478 // changed to match the parent window's theme. For example when a
a0d9c6cb 479 // page is added to a notebook it and its children may need to have
bd507486
RD
480 // the colours adjusted depending on the current theme settings, but
481 // not all windows/controls can do this without looking wrong.
cc0bffac
RD
482 virtual void ApplyParentThemeBackground(const wxColour& WXUNUSED(bg))
483 { /* do nothing */ }
400a9e41 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
VZ
495 // return the window which currently has the focus or NULL
496 static wxWindow *FindFocus() /* = 0: implement in derived classes */;
497
498 // can this window have focus?
499 virtual bool AcceptsFocus() const { return IsShown() && IsEnabled(); }
500
1e6feb95
VZ
501 // can this window be given focus by keyboard navigation? if not, the
502 // only way to give it focus (provided it accepts it at all) is to
503 // click it
504 virtual bool AcceptsFocusFromKeyboard() const { return AcceptsFocus(); }
505
456bc6d9
VZ
506 // NB: these methods really don't belong here but with the current
507 // class hierarchy there is no other place for them :-(
508
509 // get the default child of this parent, i.e. the one which is
510 // activated by pressing <Enter>
511 virtual wxWindow *GetDefaultItem() const { return NULL; }
512
513 // set this child as default, return the old default
514 virtual wxWindow *SetDefaultItem(wxWindow * WXUNUSED(child))
515 { return NULL; }
516
036da5e3
VZ
517 // set this child as temporary default
518 virtual void SetTmpDefaultItem(wxWindow * WXUNUSED(win)) { }
519
a24de76b 520 // navigates in the specified direction by sending a wxNavigationKeyEvent
eedc82f4 521 virtual bool Navigate(int flags = wxNavigationKeyEvent::IsForward);
5f6cfda7 522
a24de76b
VZ
523 // move this window just before/after the specified one in tab order
524 // (the other window must be our sibling!)
525 void MoveBeforeInTabOrder(wxWindow *win)
526 { DoMoveInTabOrder(win, MoveBefore); }
527 void MoveAfterInTabOrder(wxWindow *win)
528 { DoMoveInTabOrder(win, MoveAfter); }
529
530
f03fc89f
VZ
531 // parent/children relations
532 // -------------------------
533
534 // get the list of children
535 const wxWindowList& GetChildren() const { return m_children; }
536 wxWindowList& GetChildren() { return m_children; }
537
1978421a
SC
538 // needed just for extended runtime
539 const wxWindowList& GetWindowChildren() const { return GetChildren() ; }
540
f03fc89f
VZ
541 // get the parent or the parent of the parent
542 wxWindow *GetParent() const { return m_parent; }
543 inline wxWindow *GetGrandParent() const;
544
545 // is this window a top level one?
8487f887 546 virtual bool IsTopLevel() const;
f03fc89f 547
87b6002d 548 // it doesn't really change parent, use Reparent() instead
f03fc89f 549 void SetParent( wxWindowBase *parent ) { m_parent = (wxWindow *)parent; }
d4864e97
VZ
550 // change the real parent of this window, return true if the parent
551 // was changed, false otherwise (error or newParent == oldParent)
f03fc89f
VZ
552 virtual bool Reparent( wxWindowBase *newParent );
553
146ba0fe
VZ
554 // implementation mostly
555 virtual void AddChild( wxWindowBase *child );
556 virtual void RemoveChild( wxWindowBase *child );
557
558 // looking for windows
559 // -------------------
560
f03fc89f
VZ
561 // find window among the descendants of this one either by id or by
562 // name (return NULL if not found)
d9e2e4c2 563 wxWindow *FindWindow( long winid );
f03fc89f
VZ
564 wxWindow *FindWindow( const wxString& name );
565
146ba0fe 566 // Find a window among any window (all return NULL if not found)
d9e2e4c2 567 static wxWindow *FindWindowById( long winid, const wxWindow *parent = NULL );
146ba0fe
VZ
568 static wxWindow *FindWindowByName( const wxString& name,
569 const wxWindow *parent = NULL );
570 static wxWindow *FindWindowByLabel( const wxString& label,
571 const wxWindow *parent = NULL );
f03fc89f
VZ
572
573 // event handler stuff
574 // -------------------
575
576 // get the current event handler
577 wxEvtHandler *GetEventHandler() const { return m_eventHandler; }
578
579 // replace the event handler (allows to completely subclass the
580 // window)
581 void SetEventHandler( wxEvtHandler *handler ) { m_eventHandler = handler; }
582
583 // push/pop event handler: allows to chain a custom event handler to
584 // alreasy existing ones
585 void PushEventHandler( wxEvtHandler *handler );
d4864e97 586 wxEvtHandler *PopEventHandler( bool deleteHandler = false );
f03fc89f 587
2e36d5cf 588 // find the given handler in the event handler chain and remove (but
d4864e97
VZ
589 // not delete) it from the event handler chain, return true if it was
590 // found and false otherwise (this also results in an assert failure so
2e36d5cf
VZ
591 // this function should only be called when the handler is supposed to
592 // be there)
593 bool RemoveEventHandler(wxEvtHandler *handler);
594
1e6feb95
VZ
595 // validators
596 // ----------
f03fc89f 597
88ac883a 598#if wxUSE_VALIDATORS
f03fc89f
VZ
599 // a window may have an associated validator which is used to control
600 // user input
601 virtual void SetValidator( const wxValidator &validator );
602 virtual wxValidator *GetValidator() { return m_windowValidator; }
88ac883a 603#endif // wxUSE_VALIDATORS
f03fc89f 604
f03fc89f
VZ
605
606 // dialog oriented functions
607 // -------------------------
608
d4864e97 609 // validate the correctness of input, return true if ok
f03fc89f
VZ
610 virtual bool Validate();
611
612 // transfer data between internal and GUI representations
613 virtual bool TransferDataToWindow();
614 virtual bool TransferDataFromWindow();
615
616 virtual void InitDialog();
617
88ac883a 618#if wxUSE_ACCEL
f03fc89f
VZ
619 // accelerators
620 // ------------
621 virtual void SetAcceleratorTable( const wxAcceleratorTable& accel )
622 { m_acceleratorTable = accel; }
623 wxAcceleratorTable *GetAcceleratorTable()
624 { return &m_acceleratorTable; }
5048c832 625
540b6b09
VZ
626#endif // wxUSE_ACCEL
627
628#if wxUSE_HOTKEY
629 // hot keys (system wide accelerators)
630 // -----------------------------------
631
632 virtual bool RegisterHotKey(int hotkeyId, int modifiers, int keycode);
5048c832 633 virtual bool UnregisterHotKey(int hotkeyId);
540b6b09 634#endif // wxUSE_HOTKEY
5048c832 635
f03fc89f
VZ
636
637 // dialog units translations
638 // -------------------------
639
640 wxPoint ConvertPixelsToDialog( const wxPoint& pt );
641 wxPoint ConvertDialogToPixels( const wxPoint& pt );
642 wxSize ConvertPixelsToDialog( const wxSize& sz )
643 {
644 wxPoint pt(ConvertPixelsToDialog(wxPoint(sz.x, sz.y)));
645
646 return wxSize(pt.x, pt.y);
647 }
648
649 wxSize ConvertDialogToPixels( const wxSize& sz )
650 {
651 wxPoint pt(ConvertDialogToPixels(wxPoint(sz.x, sz.y)));
652
653 return wxSize(pt.x, pt.y);
654 }
655
656 // mouse functions
657 // ---------------
658
659 // move the mouse to the specified position
660 virtual void WarpPointer(int x, int y) = 0;
661
94633ad9
VZ
662 // start or end mouse capture, these functions maintain the stack of
663 // windows having captured the mouse and after calling ReleaseMouse()
664 // the mouse is not released but returns to the window which had had
665 // captured it previously (if any)
666 void CaptureMouse();
667 void ReleaseMouse();
f03fc89f 668
1e6feb95
VZ
669 // get the window which currently captures the mouse or NULL
670 static wxWindow *GetCapture();
671
672 // does this window have the capture?
673 virtual bool HasCapture() const
674 { return (wxWindow *)this == GetCapture(); }
675
f03fc89f
VZ
676 // painting the window
677 // -------------------
678
679 // mark the specified rectangle (or the whole window) as "dirty" so it
680 // will be repainted
d4864e97 681 virtual void Refresh( bool eraseBackground = true,
f03fc89f 682 const wxRect *rect = (const wxRect *) NULL ) = 0;
1e6feb95
VZ
683
684 // a less awkward wrapper for Refresh
d4864e97 685 void RefreshRect(const wxRect& rect) { Refresh(true, &rect); }
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;
b8e7b673
VZ
749
750 virtual bool SetForegroundColour(const wxColour& colour);
fa47d7a7 751 void SetOwnForegroundColour(const wxColour& colour)
b8e7b673
VZ
752 {
753 if ( SetForegroundColour(colour) )
f8ff87ed 754 m_inheritFgCol = false;
b8e7b673 755 }
1b69c815 756 wxColour GetForegroundColour() const;
f03fc89f 757
50c53860
JS
758 // Set/get the background style.
759 // Pass one of wxBG_STYLE_SYSTEM, wxBG_STYLE_COLOUR, wxBG_STYLE_CUSTOM
760 virtual bool SetBackgroundStyle(wxBackgroundStyle style) { m_backgroundStyle = style; return true; }
761 virtual wxBackgroundStyle GetBackgroundStyle() const { return m_backgroundStyle; }
762
b8e7b673
VZ
763 // set/retrieve the font for the window (SetFont() returns true if the
764 // font really changed)
765 virtual bool SetFont(const wxFont& font) = 0;
fa47d7a7 766 void SetOwnFont(const wxFont& font)
b8e7b673
VZ
767 {
768 if ( SetFont(font) )
f8ff87ed 769 m_inheritFont = false;
b8e7b673 770 }
29094af0 771 wxFont GetFont() const;
b8e7b673 772
d4864e97 773 // set/retrieve the cursor for this window (SetCursor() returns true
f03fc89f
VZ
774 // if the cursor was really changed)
775 virtual bool SetCursor( const wxCursor &cursor );
776 const wxCursor& GetCursor() const { return m_cursor; }
f03fc89f 777
789295bf
VZ
778#if wxUSE_CARET
779 // associate a caret with the window
780 void SetCaret(wxCaret *caret);
781 // get the current caret (may be NULL)
782 wxCaret *GetCaret() const { return m_caret; }
783#endif // wxUSE_CARET
784
f03fc89f
VZ
785 // get the (average) character size for the current font
786 virtual int GetCharHeight() const = 0;
787 virtual int GetCharWidth() const = 0;
788
789 // get the width/height/... of the text using current or specified
790 // font
791 virtual void GetTextExtent(const wxString& string,
792 int *x, int *y,
793 int *descent = (int *) NULL,
794 int *externalLeading = (int *) NULL,
795 const wxFont *theFont = (const wxFont *) NULL)
796 const = 0;
797
1e6feb95
VZ
798 // client <-> screen coords
799 // ------------------------
800
f03fc89f 801 // translate to/from screen/client coordinates (pointers may be NULL)
dabc0cd5
VZ
802 void ClientToScreen( int *x, int *y ) const
803 { DoClientToScreen(x, y); }
804 void ScreenToClient( int *x, int *y ) const
805 { DoScreenToClient(x, y); }
1e6feb95
VZ
806
807 // wxPoint interface to do the same thing
dabc0cd5
VZ
808 wxPoint ClientToScreen(const wxPoint& pt) const
809 {
810 int x = pt.x, y = pt.y;
811 DoClientToScreen(&x, &y);
812
813 return wxPoint(x, y);
814 }
815
816 wxPoint ScreenToClient(const wxPoint& pt) const
817 {
818 int x = pt.x, y = pt.y;
819 DoScreenToClient(&x, &y);
820
821 return wxPoint(x, y);
822 }
f03fc89f 823
1e6feb95
VZ
824 // test where the given (in client coords) point lies
825 wxHitTest HitTest(wxCoord x, wxCoord y) const
826 { return DoHitTest(x, y); }
827
828 wxHitTest HitTest(const wxPoint& pt) const
829 { return DoHitTest(pt.x, pt.y); }
830
f03fc89f
VZ
831 // misc
832 // ----
833
aede4ebb
VZ
834 // get the window border style from the given flags: this is different from
835 // simply doing flags & wxBORDER_MASK because it uses GetDefaultBorder() to
836 // translate wxBORDER_DEFAULT to something reasonable
837 wxBorder GetBorder(long flags) const;
838
839 // get border for the flags of this window
840 wxBorder GetBorder() const { return GetBorder(GetWindowStyleFlag()); }
1e6feb95 841
d4864e97 842 // send wxUpdateUIEvents to this window, and children if recurse is true
e39af974
JS
843 virtual void UpdateWindowUI(long flags = wxUPDATE_UI_NONE);
844
845 // do the window-specific processing after processing the update event
846 virtual void DoUpdateWindowUI(wxUpdateUIEvent& event) ;
f03fc89f 847
1e6feb95 848#if wxUSE_MENUS
45b8a256 849 bool PopupMenu(wxMenu *menu, const wxPoint& pos = wxDefaultPosition)
a1665b22 850 { return DoPopupMenu(menu, pos.x, pos.y); }
971562cb 851 bool PopupMenu(wxMenu *menu, int x, int y)
a1665b22 852 { return DoPopupMenu(menu, x, y); }
1e6feb95 853#endif // wxUSE_MENUS
f03fc89f
VZ
854
855 // scrollbars
856 // ----------
857
1e6feb95
VZ
858 // does the window have the scrollbar for this orientation?
859 bool HasScrollbar(int orient) const
860 {
861 return (m_windowStyle &
862 (orient == wxHORIZONTAL ? wxHSCROLL : wxVSCROLL)) != 0;
863 }
864
f03fc89f
VZ
865 // configure the window scrollbars
866 virtual void SetScrollbar( int orient,
867 int pos,
1e6feb95 868 int thumbvisible,
f03fc89f 869 int range,
d4864e97
VZ
870 bool refresh = true ) = 0;
871 virtual void SetScrollPos( int orient, int pos, bool refresh = true ) = 0;
f03fc89f
VZ
872 virtual int GetScrollPos( int orient ) const = 0;
873 virtual int GetScrollThumb( int orient ) const = 0;
874 virtual int GetScrollRange( int orient ) const = 0;
875
876 // scroll window to the specified position
877 virtual void ScrollWindow( int dx, int dy,
878 const wxRect* rect = (wxRect *) NULL ) = 0;
879
b9b3393e 880 // scrolls window by line/page: note that not all controls support this
9cd6d737 881 //
d4864e97
VZ
882 // return true if the position changed, false otherwise
883 virtual bool ScrollLines(int WXUNUSED(lines)) { return false; }
884 virtual bool ScrollPages(int WXUNUSED(pages)) { return false; }
9cd6d737
VZ
885
886 // convenient wrappers for ScrollLines/Pages
887 bool LineUp() { return ScrollLines(-1); }
888 bool LineDown() { return ScrollLines(1); }
889 bool PageUp() { return ScrollPages(-1); }
890 bool PageDown() { return ScrollPages(1); }
b9b3393e 891
bd83cb56
VZ
892 // context-sensitive help
893 // ----------------------
894
895 // these are the convenience functions wrapping wxHelpProvider methods
896
897#if wxUSE_HELP
898 // associate this help text with this window
899 void SetHelpText(const wxString& text);
900 // associate this help text with all windows with the same id as this
901 // one
902 void SetHelpTextForId(const wxString& text);
903 // get the help string associated with this window (may be empty)
904 wxString GetHelpText() const;
905#endif // wxUSE_HELP
906
f03fc89f
VZ
907 // tooltips
908 // --------
bd83cb56 909
f03fc89f
VZ
910#if wxUSE_TOOLTIPS
911 // the easiest way to set a tooltip for a window is to use this method
912 void SetToolTip( const wxString &tip );
913 // attach a tooltip to the window
914 void SetToolTip( wxToolTip *tip ) { DoSetToolTip(tip); }
915 // get the associated tooltip or NULL if none
916 wxToolTip* GetToolTip() const { return m_tooltip; }
311a173b 917 wxString GetToolTipText() const ;
7649d8fc
JS
918#else
919 // make it much easier to compile apps in an environment
920 // that doesn't support tooltips, such as PocketPC
921 inline void SetToolTip( const wxString & WXUNUSED(tip) ) {}
f03fc89f
VZ
922#endif // wxUSE_TOOLTIPS
923
924 // drag and drop
925 // -------------
926#if wxUSE_DRAG_AND_DROP
927 // set/retrieve the drop target associated with this window (may be
928 // NULL; it's owned by the window and will be deleted by it)
929 virtual void SetDropTarget( wxDropTarget *dropTarget ) = 0;
930 virtual wxDropTarget *GetDropTarget() const { return m_dropTarget; }
931#endif // wxUSE_DRAG_AND_DROP
932
933 // constraints and sizers
934 // ----------------------
935#if wxUSE_CONSTRAINTS
936 // set the constraints for this window or retrieve them (may be NULL)
937 void SetConstraints( wxLayoutConstraints *constraints );
938 wxLayoutConstraints *GetConstraints() const { return m_constraints; }
939
f03fc89f
VZ
940 // implementation only
941 void UnsetConstraints(wxLayoutConstraints *c);
942 wxWindowList *GetConstraintsInvolvedIn() const
943 { return m_constraintsInvolvedIn; }
944 void AddConstraintReference(wxWindowBase *otherWin);
945 void RemoveConstraintReference(wxWindowBase *otherWin);
946 void DeleteRelatedConstraints();
947 void ResetConstraints();
948
949 // these methods may be overriden for special layout algorithms
d4864e97 950 virtual void SetConstraintSizes(bool recurse = true);
f03fc89f
VZ
951 virtual bool LayoutPhase1(int *noChanges);
952 virtual bool LayoutPhase2(int *noChanges);
4b7f2165 953 virtual bool DoPhase(int phase);
f03fc89f
VZ
954
955 // these methods are virtual but normally won't be overridden
f03fc89f
VZ
956 virtual void SetSizeConstraint(int x, int y, int w, int h);
957 virtual void MoveConstraint(int x, int y);
958 virtual void GetSizeConstraint(int *w, int *h) const ;
959 virtual void GetClientSizeConstraint(int *w, int *h) const ;
960 virtual void GetPositionConstraint(int *x, int *y) const ;
961
461e93f9
JS
962#endif // wxUSE_CONSTRAINTS
963
964 // when using constraints or sizers, it makes sense to update
965 // children positions automatically whenever the window is resized
966 // - this is done if autoLayout is on
967 void SetAutoLayout( bool autoLayout ) { m_autoLayout = autoLayout; }
968 bool GetAutoLayout() const { return m_autoLayout; }
969
970 // lay out the window and its children
971 virtual bool Layout();
972
f03fc89f 973 // sizers
d4864e97
VZ
974 void SetSizer(wxSizer *sizer, bool deleteOld = true );
975 void SetSizerAndFit( wxSizer *sizer, bool deleteOld = true );
566d84a7 976
f03fc89f 977 wxSizer *GetSizer() const { return m_windowSizer; }
be90c029
RD
978
979 // Track if this window is a member of a sizer
1ebfafde 980 void SetContainingSizer(wxSizer* sizer);
be90c029
RD
981 wxSizer *GetContainingSizer() const { return m_containingSizer; }
982
45a959a3
JS
983 // accessibility
984 // ----------------------
985#if wxUSE_ACCESSIBILITY
986 // Override to create a specific accessible object.
987 virtual wxAccessible* CreateAccessible();
988
989 // Sets the accessible object.
990 void SetAccessible(wxAccessible* accessible) ;
991
992 // Returns the accessible object.
993 wxAccessible* GetAccessible() { return m_accessible; };
994
995 // Returns the accessible object, creating if necessary.
996 wxAccessible* GetOrCreateAccessible() ;
997#endif
998
f03fc89f
VZ
999 // implementation
1000 // --------------
1001
1002 // event handlers
1003 void OnSysColourChanged( wxSysColourChangedEvent& event );
1004 void OnInitDialog( wxInitDialogEvent &event );
72fc5caf 1005 void OnMiddleClick( wxMouseEvent& event );
bd83cb56
VZ
1006#if wxUSE_HELP
1007 void OnHelp(wxHelpEvent& event);
1008#endif // wxUSE_HELP
f03fc89f 1009
e39af974
JS
1010 // virtual function for implementing internal idle
1011 // behaviour
1012 virtual void OnInternalIdle() {}
1013
1014 // call internal idle recursively
5109ae5d 1015// void ProcessInternalIdle() ;
e39af974
JS
1016
1017 // get the handle of the window for the underlying window system: this
d7c24517
VZ
1018 // is only used for wxWin itself or for user code which wants to call
1019 // platform-specific APIs
d22699b5 1020 virtual WXWidget GetHandle() const = 0;
ed4780ea
VZ
1021 // associate the window with a new native handle
1022 virtual void AssociateHandle(WXWidget WXUNUSED(handle)) { }
1023 // dissociate the current native handle from the window
1024 virtual void DissociateHandle() { }
cc2b7472 1025
574c939e
KB
1026#if wxUSE_PALETTE
1027 // Store the palette used by DCs in wxWindow so that the dcs can share
1028 // a palette. And we can respond to palette messages.
1029 wxPalette GetPalette() const { return m_palette; }
b95edd47 1030
574c939e
KB
1031 // When palette is changed tell the DC to set the system palette to the
1032 // new one.
b95edd47
VZ
1033 void SetPalette(const wxPalette& pal);
1034
1035 // return true if we have a specific palette
1036 bool HasCustomPalette() const { return m_hasCustomPalette; }
1037
1038 // return the first parent window with a custom palette or NULL
1039 wxWindow *GetAncestorWithCustomPalette() const;
574c939e
KB
1040#endif // wxUSE_PALETTE
1041
b8e7b673
VZ
1042 // inherit the parents visual attributes if they had been explicitly set
1043 // by the user (i.e. we don't inherit default attributes) and if we don't
1044 // have our own explicitly set
1045 virtual void InheritAttributes();
1046
1047 // returns false from here if this window doesn't want to inherit the
1048 // parents colours even if InheritAttributes() would normally do it
1049 //
1050 // this just provides a simple way to customize InheritAttributes()
1051 // behaviour in the most common case
1052 virtual bool ShouldInheritColours() const { return false; }
1053
245c5d2e
RD
1054protected:
1055 // event handling specific to wxWindow
1056 virtual bool TryValidator(wxEvent& event);
1057 virtual bool TryParent(wxEvent& event);
1058
a24de76b
VZ
1059 // common part of MoveBefore/AfterInTabOrder()
1060 enum MoveKind
1061 {
1062 MoveBefore, // insert before the given window
1063 MoveAfter // insert after the given window
1064 };
1065 virtual void DoMoveInTabOrder(wxWindow *win, MoveKind move);
4caf847c 1066
ec5bb70d
VZ
1067#if wxUSE_CONSTRAINTS
1068 // satisfy the constraints for the windows but don't set the window sizes
1069 void SatisfyConstraints();
1070#endif // wxUSE_CONSTRAINTS
566d84a7 1071
7de59551
RD
1072 // Send the wxWindowDestroyEvent
1073 void SendDestroyEvent();
1074
7af6f327 1075 // the window id - a number which uniquely identifies a window among
a0d9c6cb 1076 // its siblings unless it is wxID_ANY
f03fc89f 1077 wxWindowID m_windowId;
456bc6d9 1078
f03fc89f
VZ
1079 // the parent window of this window (or NULL) and the list of the children
1080 // of this window
1081 wxWindow *m_parent;
1082 wxWindowList m_children;
1083
1084 // the minimal allowed size for the window (no minimal size if variable(s)
a0d9c6cb 1085 // contain(s) wxDefaultCoord)
ec5bb70d
VZ
1086 int m_minWidth,
1087 m_minHeight,
1088 m_maxWidth,
1089 m_maxHeight;
f03fc89f
VZ
1090
1091 // event handler for this window: usually is just 'this' but may be
1092 // changed with SetEventHandler()
1093 wxEvtHandler *m_eventHandler;
1094
88ac883a 1095#if wxUSE_VALIDATORS
f03fc89f
VZ
1096 // associated validator or NULL if none
1097 wxValidator *m_windowValidator;
88ac883a 1098#endif // wxUSE_VALIDATORS
f03fc89f
VZ
1099
1100#if wxUSE_DRAG_AND_DROP
1101 wxDropTarget *m_dropTarget;
1102#endif // wxUSE_DRAG_AND_DROP
1103
1104 // visual window attributes
1105 wxCursor m_cursor;
1b69c815
VZ
1106 wxFont m_font; // see m_hasFont
1107 wxColour m_backgroundColour, // m_hasBgCol
1108 m_foregroundColour; // m_hasFgCol
f03fc89f 1109
789295bf
VZ
1110#if wxUSE_CARET
1111 wxCaret *m_caret;
1112#endif // wxUSE_CARET
1113
f03fc89f
VZ
1114 // the region which should be repainted in response to paint event
1115 wxRegion m_updateRegion;
1116
88ac883a 1117#if wxUSE_ACCEL
f03fc89f
VZ
1118 // the accelerator table for the window which translates key strokes into
1119 // command events
1120 wxAcceleratorTable m_acceleratorTable;
88ac883a 1121#endif // wxUSE_ACCEL
f03fc89f 1122
f03fc89f
VZ
1123 // the tooltip for this window (may be NULL)
1124#if wxUSE_TOOLTIPS
1125 wxToolTip *m_tooltip;
1126#endif // wxUSE_TOOLTIPS
1127
1128 // constraints and sizers
1129#if wxUSE_CONSTRAINTS
1130 // the constraints for this window or NULL
1131 wxLayoutConstraints *m_constraints;
1132
1133 // constraints this window is involved in
1134 wxWindowList *m_constraintsInvolvedIn;
461e93f9 1135#endif // wxUSE_CONSTRAINTS
f03fc89f 1136
be90c029 1137 // this window's sizer
f03fc89f 1138 wxSizer *m_windowSizer;
be90c029
RD
1139
1140 // The sizer this window is a member of, if any
1141 wxSizer *m_containingSizer;
f03fc89f
VZ
1142
1143 // Layout() window automatically when its size changes?
1144 bool m_autoLayout:1;
f03fc89f
VZ
1145
1146 // window state
1147 bool m_isShown:1;
1148 bool m_isEnabled:1;
1149 bool m_isBeingDeleted:1;
1150
23895080
VZ
1151 // was the window colours/font explicitly changed by user?
1152 bool m_hasBgCol:1;
1153 bool m_hasFgCol:1;
1154 bool m_hasFont:1;
a0d9c6cb 1155
f8ff87ed
VS
1156 // and should it be inherited by children?
1157 bool m_inheritBgCol:1;
1158 bool m_inheritFgCol:1;
1159 bool m_inheritFont:1;
23895080 1160
f03fc89f 1161 // window attributes
d80cd92a
VZ
1162 long m_windowStyle,
1163 m_exStyle;
f03fc89f 1164 wxString m_windowName;
a2d93e73 1165 bool m_themeEnabled;
50c53860 1166 wxBackgroundStyle m_backgroundStyle;
071e5fd9 1167#if wxUSE_PALETTE
574c939e 1168 wxPalette m_palette;
b95edd47
VZ
1169 bool m_hasCustomPalette;
1170#endif // wxUSE_PALETTE
574c939e 1171
45a959a3
JS
1172#if wxUSE_ACCESSIBILITY
1173 wxAccessible* m_accessible;
1174#endif
2654f7e4 1175
566d84a7
RL
1176 // Virtual size (scrolling)
1177 wxSize m_virtualSize;
1178
1179 int m_minVirtualWidth; // VirtualSizeHints
1180 int m_minVirtualHeight;
1181 int m_maxVirtualWidth;
1182 int m_maxVirtualHeight;
400a9e41 1183
69d90995 1184 wxWindowVariant m_windowVariant ;
45e0dc94 1185
1e6feb95
VZ
1186 // override this to change the default (i.e. used when no style is
1187 // specified) border for the window class
1188 virtual wxBorder GetDefaultBorder() const;
1189
5c2be659
RD
1190 // Get the default size for the new window if no explicit size given. TLWs
1191 // have their own default size so this is just for non top-level windows.
a0d9c6cb
WS
1192 static int WidthDefault(int w) { return w == wxDefaultCoord ? 20 : w; }
1193 static int HeightDefault(int h) { return h == wxDefaultCoord ? 20 : h; }
f03fc89f 1194
9f884528
RD
1195
1196 // Used to save the results of DoGetBestSize so it doesn't need to be
1197 // recalculated each time the value is needed.
1198 wxSize m_bestSizeCache;
1199
fe161a26
RD
1200 // keep the old name for compatibility, at least until all the internal
1201 // usages of it are changed to SetBestFittingSize
1202 void SetBestSize(const wxSize& size) { SetBestFittingSize(size); }
a0d9c6cb 1203
d3b5db4b
RD
1204 // set the initial window size if none is given (i.e. at least one of the
1205 // components of the size passed to ctor/Create() is -1)
1206 //
1207 // normally just calls SetBestSize() for controls, but can be overridden
1208 // not to do it for the controls which have to do some additional
1209 // initialization (e.g. add strings to list box) before their best size
1210 // can be accurately calculated
1211 virtual void SetInitialBestSize(const wxSize& WXUNUSED(size)) {}
1212
a0d9c6cb 1213
d3b5db4b 1214
f03fc89f
VZ
1215 // more pure virtual functions
1216 // ---------------------------
1217
1218 // NB: we must have DoSomething() function when Something() is an overloaded
1219 // method: indeed, we can't just have "virtual Something()" in case when
1220 // the function is overloaded because then we'd have to make virtual all
1221 // the variants (otherwise only the virtual function may be called on a
1222 // pointer to derived class according to C++ rules) which is, in
1223 // general, absolutely not needed. So instead we implement all
1224 // overloaded Something()s in terms of DoSomething() which will be the
1225 // only one to be virtual.
1226
dabc0cd5
VZ
1227 // coordinates translation
1228 virtual void DoClientToScreen( int *x, int *y ) const = 0;
1229 virtual void DoScreenToClient( int *x, int *y ) const = 0;
1230
1e6feb95
VZ
1231 virtual wxHitTest DoHitTest(wxCoord x, wxCoord y) const;
1232
94633ad9 1233 // capture/release the mouse, used by Capture/ReleaseMouse()
a83e1475
VZ
1234 virtual void DoCaptureMouse() = 0;
1235 virtual void DoReleaseMouse() = 0;
be90c029 1236
f03fc89f
VZ
1237 // retrieve the position/size of the window
1238 virtual void DoGetPosition( int *x, int *y ) const = 0;
1239 virtual void DoGetSize( int *width, int *height ) const = 0;
1240 virtual void DoGetClientSize( int *width, int *height ) const = 0;
1241
f68586e5
VZ
1242 // get the size which best suits the window: for a control, it would be
1243 // the minimal size which doesn't truncate the control, for a panel - the
1244 // same size as it would have after a call to Fit()
1245 virtual wxSize DoGetBestSize() const;
1246
f03fc89f
VZ
1247 // this is the virtual function to be overriden in any derived class which
1248 // wants to change how SetSize() or Move() works - it is called by all
1249 // versions of these functions in the base class
1250 virtual void DoSetSize(int x, int y,
1251 int width, int height,
1252 int sizeFlags = wxSIZE_AUTO) = 0;
1253
1254 // same as DoSetSize() for the client size
1255 virtual void DoSetClientSize(int width, int height) = 0;
1256
9d9b7755
VZ
1257 // move the window to the specified location and resize it: this is called
1258 // from both DoSetSize() and DoSetClientSize() and would usually just
1259 // reposition this window except for composite controls which will want to
1260 // arrange themselves inside the given rectangle
1261 virtual void DoMoveWindow(int x, int y, int width, int height) = 0;
1262
f03fc89f
VZ
1263#if wxUSE_TOOLTIPS
1264 virtual void DoSetToolTip( wxToolTip *tip );
1265#endif // wxUSE_TOOLTIPS
1266
1e6feb95 1267#if wxUSE_MENUS
971562cb 1268 virtual bool DoPopupMenu(wxMenu *menu, int x, int y) = 0;
1e6feb95 1269#endif // wxUSE_MENUS
a1665b22 1270
716e96df
VZ
1271 // Makes an adjustment to the window position to make it relative to the
1272 // parents client area, e.g. if the parent is a frame with a toolbar, its
1273 // (0, 0) is just below the toolbar
1274 virtual void AdjustForParentClientOrigin(int& x, int& y,
1275 int sizeFlags = 0) const;
8d99be5f 1276
69d90995
SC
1277 // implements the window variants
1278 virtual void DoSetWindowVariant( wxWindowVariant variant ) ;
45e0dc94 1279
f03fc89f
VZ
1280private:
1281 // contains the last id generated by NewControlId
1282 static int ms_lastControlId;
1283
a83e1475
VZ
1284 // the stack of windows which have captured the mouse
1285 static struct WXDLLEXPORT wxWindowNext *ms_winCaptureNext;
1286
1e6feb95
VZ
1287 DECLARE_ABSTRACT_CLASS(wxWindowBase)
1288 DECLARE_NO_COPY_CLASS(wxWindowBase)
f03fc89f
VZ
1289 DECLARE_EVENT_TABLE()
1290};
1291
1292// ----------------------------------------------------------------------------
1293// now include the declaration of wxWindow class
1294// ----------------------------------------------------------------------------
1295
1e6feb95 1296// include the declaration of the platform-specific class
2049ba38 1297#if defined(__WXMSW__)
a5b3669d
VZ
1298 #ifdef __WXUNIVERSAL__
1299 #define wxWindowNative wxWindowMSW
1300 #else // !wxUniv
1e6feb95 1301 #define wxWindowMSW wxWindow
a5b3669d 1302 #endif // wxUniv/!wxUniv
f03fc89f 1303 #include "wx/msw/window.h"
2049ba38 1304#elif defined(__WXMOTIF__)
f03fc89f 1305 #include "wx/motif/window.h"
2049ba38 1306#elif defined(__WXGTK__)
a5b3669d
VZ
1307 #ifdef __WXUNIVERSAL__
1308 #define wxWindowNative wxWindowGTK
1309 #else // !wxUniv
1e6feb95 1310 #define wxWindowGTK wxWindow
1e6feb95 1311 #endif // wxUniv
f03fc89f 1312 #include "wx/gtk/window.h"
83df96d6
JS
1313#elif defined(__WXX11__)
1314 #ifdef __WXUNIVERSAL__
1315 #define wxWindowNative wxWindowX11
1316 #else // !wxUniv
1317 #define wxWindowX11 wxWindow
83df96d6
JS
1318 #endif // wxUniv
1319 #include "wx/x11/window.h"
711c76db 1320#elif defined(__WXMGL__)
386c7058
VS
1321 #ifdef __WXUNIVERSAL__
1322 #define wxWindowNative wxWindowMGL
1323 #else // !wxUniv
1324 #define wxWindowMGL wxWindow
386c7058
VS
1325 #endif // wxUniv
1326 #include "wx/mgl/window.h"
34138703 1327#elif defined(__WXMAC__)
e766c8a9
SC
1328 #ifdef __WXUNIVERSAL__
1329 #define wxWindowNative wxWindowMac
1330 #else // !wxUniv
1331 #define wxWindowMac wxWindow
e766c8a9 1332 #endif // wxUniv
f03fc89f 1333 #include "wx/mac/window.h"
e64df9bc
DE
1334#elif defined(__WXCOCOA__)
1335 #ifdef __WXUNIVERSAL__
1336 #define wxWindowNative wxWindowCocoa
1337 #else // !wxUniv
1338 #define wxWindowCocoa wxWindow
e64df9bc
DE
1339 #endif // wxUniv
1340 #include "wx/cocoa/window.h"
1777b9bb 1341#elif defined(__WXPM__)
210a651b
DW
1342 #ifdef __WXUNIVERSAL__
1343 #define wxWindowNative wxWindowOS2
1344 #else // !wxUniv
1345 #define wxWindowOS2 wxWindow
210a651b 1346 #endif // wxUniv/!wxUniv
1777b9bb 1347 #include "wx/os2/window.h"
c801d85f
KB
1348#endif
1349
1e6feb95
VZ
1350// for wxUniversal, we now derive the real wxWindow from wxWindow<platform>,
1351// for the native ports we already have defined it above
1352#if defined(__WXUNIVERSAL__)
a5b3669d
VZ
1353 #ifndef wxWindowNative
1354 #error "wxWindowNative must be defined above!"
1355 #endif
1356
1e6feb95
VZ
1357 #include "wx/univ/window.h"
1358#endif // wxUniv
1359
f03fc89f
VZ
1360// ----------------------------------------------------------------------------
1361// inline functions which couldn't be declared in the class body because of
1362// forward dependencies
1363// ----------------------------------------------------------------------------
1364
bacd69f9 1365inline wxWindow *wxWindowBase::GetGrandParent() const
f03fc89f
VZ
1366{
1367 return m_parent ? m_parent->GetParent() : (wxWindow *)NULL;
1368}
1369
1370// ----------------------------------------------------------------------------
3723b7b1 1371// global functions
f03fc89f
VZ
1372// ----------------------------------------------------------------------------
1373
3723b7b1
JS
1374// Find the wxWindow at the current mouse position, also returning the mouse
1375// position.
1376WXDLLEXPORT extern wxWindow* wxFindWindowAtPointer(wxPoint& pt);
1377
1378// Get the current mouse position.
1379WXDLLEXPORT extern wxPoint wxGetMousePosition();
1380
1e6feb95
VZ
1381// get the currently active window of this application or NULL
1382WXDLLEXPORT extern wxWindow *wxGetActiveWindow();
1383
33b494d6
VZ
1384// get the (first) top level parent window
1385WXDLLEXPORT wxWindow* wxGetTopLevelParent(wxWindow *win);
1386
f68586e5 1387// deprecated (doesn't start with 'wx' prefix), use wxWindow::NewControlId()
6d56eb5c 1388inline int NewControlId() { return wxWindowBase::NewControlId(); }
f03fc89f 1389
45a959a3
JS
1390#if wxUSE_ACCESSIBILITY
1391// ----------------------------------------------------------------------------
1392// accessible object for windows
1393// ----------------------------------------------------------------------------
1394
1395class WXDLLEXPORT wxWindowAccessible: public wxAccessible
1396{
1397public:
f81387bd 1398 wxWindowAccessible(wxWindow* win): wxAccessible(win) { if (win) win->SetAccessible(this); }
45a959a3
JS
1399 virtual ~wxWindowAccessible() {};
1400
1401// Overridables
1402
1403 // Can return either a child object, or an integer
1404 // representing the child element, starting from 1.
1405 virtual wxAccStatus HitTest(const wxPoint& pt, int* childId, wxAccessible** childObject);
1406
1407 // Returns the rectangle for this object (id = 0) or a child element (id > 0).
1408 virtual wxAccStatus GetLocation(wxRect& rect, int elementId);
1409
1410 // Navigates from fromId to toId/toObject.
1411 virtual wxAccStatus Navigate(wxNavDir navDir, int fromId,
1412 int* toId, wxAccessible** toObject);
1413
1414 // Gets the name of the specified object.
1415 virtual wxAccStatus GetName(int childId, wxString* name);
1416
1417 // Gets the number of children.
a37e4a07 1418 virtual wxAccStatus GetChildCount(int* childCount);
45a959a3
JS
1419
1420 // Gets the specified child (starting from 1).
1421 // If *child is NULL and return value is wxACC_OK,
1422 // this means that the child is a simple element and
1423 // not an accessible object.
1424 virtual wxAccStatus GetChild(int childId, wxAccessible** child);
1425
1426 // Gets the parent, or NULL.
1427 virtual wxAccStatus GetParent(wxAccessible** parent);
1428
1429 // Performs the default action. childId is 0 (the action for this object)
1430 // or > 0 (the action for a child).
1431 // Return wxACC_NOT_SUPPORTED if there is no default action for this
1432 // window (e.g. an edit control).
1433 virtual wxAccStatus DoDefaultAction(int childId);
1434
1435 // Gets the default action for this object (0) or > 0 (the action for a child).
1436 // Return wxACC_OK even if there is no action. actionName is the action, or the empty
1437 // string if there is no action.
1438 // The retrieved string describes the action that is performed on an object,
1439 // not what the object does as a result. For example, a toolbar button that prints
1440 // a document has a default action of "Press" rather than "Prints the current document."
1441 virtual wxAccStatus GetDefaultAction(int childId, wxString* actionName);
1442
1443 // Returns the description for this object or a child.
1444 virtual wxAccStatus GetDescription(int childId, wxString* description);
1445
1446 // Returns help text for this object or a child, similar to tooltip text.
1447 virtual wxAccStatus GetHelpText(int childId, wxString* helpText);
1448
1449 // Returns the keyboard shortcut for this object or child.
1450 // Return e.g. ALT+K
1451 virtual wxAccStatus GetKeyboardShortcut(int childId, wxString* shortcut);
1452
1453 // Returns a role constant.
1454 virtual wxAccStatus GetRole(int childId, wxAccRole* role);
1455
1456 // Returns a state constant.
1457 virtual wxAccStatus GetState(int childId, long* state);
1458
1459 // Returns a localized string representing the value for the object
1460 // or child.
1461 virtual wxAccStatus GetValue(int childId, wxString* strValue);
1462
1463 // Selects the object or child.
1464 virtual wxAccStatus Select(int childId, wxAccSelectionFlags selectFlags);
1465
1466 // Gets the window with the keyboard focus.
1467 // If childId is 0 and child is NULL, no object in
1468 // this subhierarchy has the focus.
1469 // If this object has the focus, child should be 'this'.
1470 virtual wxAccStatus GetFocus(int* childId, wxAccessible** child);
1471
1472 // Gets a variant representing the selected children
1473 // of this object.
1474 // Acceptable values:
d4864e97 1475 // - a null variant (IsNull() returns true)
45a959a3
JS
1476 // - a list variant (GetType() == wxT("list")
1477 // - an integer representing the selected child element,
1478 // or 0 if this object is selected (GetType() == wxT("long")
1479 // - a "void*" pointer to a wxAccessible child object
1480 virtual wxAccStatus GetSelections(wxVariant* selections);
1481};
1482
1483#endif // wxUSE_ACCESSIBILITY
1484
1485
c801d85f 1486#endif
34138703 1487 // _WX_WINDOW_H_BASE_
34c3ffca 1488