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