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