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