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