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