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