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