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