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