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