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