include/wx/window.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        window.h
   3 // Purpose:     wxWindowBase class - the interface of wxWindow
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     01/02/97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) wxWindows team
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_WINDOW_H_BASE_
  13 #define _WX_WINDOW_H_BASE_
  14
  15 #ifdef __GNUG__
  16     #pragma interface "windowbase.h"
  17 #endif
  18
  19 // ----------------------------------------------------------------------------
  20 // headers which we must include here
  21 // ----------------------------------------------------------------------------
  22
  23 #include "wx/event.h"           // the base class
  24
  25 #include "wx/list.h"            // defines wxWindowList
  26
  27 #include "wx/cursor.h"          // we have member variables of these classes
  28 #include "wx/font.h"            // so we can't do without them
  29 #include "wx/colour.h"
  30 #include "wx/region.h"
  31 #include "wx/utils.h"
  32
  33 #include "wx/validate.h"        // for wxDefaultValidator (always include it)
  34
  35 #if wxUSE_ACCEL
  36     #include "wx/accel.h"
  37 #endif // wxUSE_ACCEL
  38
  39 // ----------------------------------------------------------------------------
  40 // forward declarations
  41 // ----------------------------------------------------------------------------
  42
  43 class WXDLLEXPORT wxCaret;
  44 class WXDLLEXPORT wxClientData;
  45 class WXDLLEXPORT wxControl;
  46 class WXDLLEXPORT wxCursor;
  47 class WXDLLEXPORT wxDC;
  48 class WXDLLEXPORT wxDropTarget;
  49 class WXDLLEXPORT wxItemResource;
  50 class WXDLLEXPORT wxLayoutConstraints;
  51 class WXDLLEXPORT wxResourceTable;
  52 class WXDLLEXPORT wxSizer;
  53 class WXDLLEXPORT wxToolTip;
  54 class WXDLLEXPORT wxWindowBase;
  55 class WXDLLEXPORT wxWindow;
  56
  57 // ----------------------------------------------------------------------------
  58 // (pseudo)template list classes
  59 // ----------------------------------------------------------------------------
  60
  61 WX_DECLARE_LIST_3(wxWindow, wxWindowBase, wxWindowList, wxWindowListNode);
  62
  63 // ----------------------------------------------------------------------------
  64 // global variables
  65 // ----------------------------------------------------------------------------
  66
  67 WXDLLEXPORT_DATA(extern wxWindowList) wxTopLevelWindows;
  68
  69 // ----------------------------------------------------------------------------
  70 // helper classes used by [SG]etClientObject/Data
  71 //
  72 // TODO move into a separate header?
  73 // ----------------------------------------------------------------------------
  74
  75 class wxClientData
  76 {
  77 public:
  78     wxClientData() { }
  79     virtual ~wxClientData() { }
  80 };
  81
  82 class wxStringClientData : public wxClientData
  83 {
  84 public:
  85     wxStringClientData() { }
  86     wxStringClientData( const wxString &data ) : m_data(data) { }
  87     void SetData( const wxString &data ) { m_data = data; }
  88     const wxString& GetData() const { return m_data; }
  89
  90 private:
  91     wxString  m_data;
  92 };
  93
  94 // ----------------------------------------------------------------------------
  95 // wxWindowBase is the base class for all GUI controls/widgets, this is the public
  96 // interface of this class.
  97 //
  98 // Event handler: windows have themselves as their event handlers by default,
  99 // but their event handlers could be set to another object entirely. This
 100 // separation can reduce the amount of derivation required, and allow
 101 // alteration of a window's functionality (e.g. by a resource editor that
 102 // temporarily switches event handlers).
 103 // ----------------------------------------------------------------------------
 104
 105 class WXDLLEXPORT wxWindowBase : public wxEvtHandler
 106 {
 107     DECLARE_ABSTRACT_CLASS(wxWindowBase);
 108
 109 public:
 110     // creating the window
 111     // -------------------
 112
 113         // default ctor
 114     wxWindowBase() { InitBase(); }
 115
 116         // pseudo ctor (can't be virtual, called from ctor)
 117     bool CreateBase(wxWindowBase *parent,
 118                     wxWindowID id,
 119                     const wxPoint& pos = wxDefaultPosition,
 120                     const wxSize& size = wxDefaultSize,
 121                     long style = 0,
 122                     const wxValidator& validator = wxDefaultValidator,
 123                     const wxString& name = wxPanelNameStr);
 124
 125     virtual ~wxWindowBase();
 126
 127 #if wxUSE_WX_RESOURCES
 128     // these functions are implemented in resource.cpp and resourc2.cpp
 129     virtual bool LoadFromResource(wxWindow *parent,
 130                                   const wxString& resourceName,
 131                                   const wxResourceTable *table = (const wxResourceTable *) NULL);
 132     virtual wxControl *CreateItem(const wxItemResource* childResource,
 133                                   const wxItemResource* parentResource,
 134                                   const wxResourceTable *table = (const wxResourceTable *) NULL);
 135 #endif // wxUSE_WX_RESOURCES
 136
 137     // deleting the window
 138     // -------------------
 139
 140         // ask the window to close itself, return TRUE if the event handler
 141         // honoured our request
 142     bool Close( bool force = FALSE );
 143
 144         // the following functions delete the C++ objects (the window itself
 145         // or its children) as well as the GUI windows and normally should
 146         // never be used directly
 147
 148         // delete window unconditionally (dangerous!), returns TRUE if ok
 149     virtual bool Destroy();
 150         // delete all children of this window, returns TRUE if ok
 151     bool DestroyChildren();
 152
 153         // is the window being deleted?
 154     bool IsBeingDeleted() const { return m_isBeingDeleted; }
 155
 156     // window attributes
 157     // -----------------
 158
 159         // the title (or label, see below) of the window: the text which the
 160         // window shows
 161     virtual void SetTitle( const wxString & WXUNUSED(title) ) { }
 162     virtual wxString GetTitle() const { return ""; }
 163
 164         // label is just the same as the title (but for, e.g., buttons it
 165         // makes more sense to speak about labels)
 166     virtual void SetLabel(const wxString& label) { SetTitle(label); }
 167     virtual wxString GetLabel() const { return GetTitle(); }
 168
 169         // the window name is used for ressource setting in X, it is not the
 170         // same as the window title/label
 171     virtual void SetName( const wxString &name ) { m_windowName = name; }
 172     virtual wxString GetName() const { return m_windowName; }
 173
 174         // window id uniquely identifies the window among its siblings unless
 175         // it is -1 which means "don't care"
 176     void SetId( wxWindowID id ) { m_windowId = id; }
 177     wxWindowID GetId() const { return m_windowId; }
 178
 179         // generate a control id for the controls which were not given one by
 180         // user
 181     static int NewControlId() { return --ms_lastControlId; }
 182         // get the id of the control following the one with the given
 183         // (autogenerated) id
 184     static int NextControlId(int id) { return id - 1; }
 185         // get the id of the control preceding the one with the given
 186         // (autogenerated) id
 187     static int PrevControlId(int id) { return id + 1; }
 188
 189     // moving/resizing
 190     // ---------------
 191
 192         // set the window size and/or position
 193     void SetSize( int x, int y, int width, int height,
 194                   int sizeFlags = wxSIZE_AUTO )
 195         {  DoSetSize(x, y, width, height, sizeFlags); }
 196
 197     void SetSize( int width, int height )
 198         { DoSetSize( -1, -1, width, height, wxSIZE_USE_EXISTING ); }
 199
 200     void SetSize( const wxSize& size )
 201         { SetSize( size.x, size.y); }
 202
 203     void SetSize(const wxRect& rect, int sizeFlags = wxSIZE_AUTO)
 204         { DoSetSize(rect.x, rect.y, rect.width, rect.height, sizeFlags); }
 205
 206     void Move( int x, int y )
 207         { DoSetSize( x, y, -1, -1, wxSIZE_USE_EXISTING ); }
 208
 209     void Move(const wxPoint& pt)
 210         { Move(pt.x, pt.y); }
 211
 212         // Z-order
 213     virtual void Raise() = 0;
 214     virtual void Lower() = 0;
 215
 216         // client size is the size of area available for subwindows
 217     void SetClientSize( int width, int height )
 218         { DoSetClientSize(width, height); }
 219
 220     void SetClientSize( const wxSize& size )
 221         { DoSetClientSize(size.x, size.y); }
 222
 223     void SetClientSize(const wxRect& rect)
 224         { SetClientSize( rect.width, rect.height ); }
 225
 226         // get the window position and/or size (pointers may be NULL)
 227     void GetPosition( int *x, int *y ) const { DoGetPosition(x, y); }
 228     wxPoint GetPosition() const
 229     {
 230         int w, h;
 231         DoGetPosition(&w, &h);
 232
 233         return wxPoint(w, h);
 234     }
 235
 236     void GetSize( int *w, int *h ) const { DoGetSize(w, h); }
 237     wxSize GetSize() const
 238     {
 239         int w, h;
 240         DoGetSize(& w, & h);
 241         return wxSize(w, h);
 242     }
 243
 244     wxRect GetRect() const
 245     {
 246         int x, y, w, h;
 247         GetPosition(& x, & y);
 248         GetSize(& w, & h);
 249
 250         return wxRect(x, y, w, h);
 251     }
 252
 253     void GetClientSize( int *w, int *h ) const { DoGetClientSize(w, h); }
 254     wxSize GetClientSize() const
 255     {
 256         int w, h;
 257         DoGetClientSize(& w, & h);
 258
 259         return wxSize(w, h);
 260     }
 261
 262         // get the size best suited for the window (in fact, minimal
 263         // acceptable size using which it will still look "nice")
 264     wxSize GetBestSize() const { return DoGetBestSize(); }
 265     void GetBestSize(int *w, int *h) const
 266     {
 267         wxSize s = DoGetBestSize();
 268         if ( w )
 269             *w = s.x;
 270         if ( h )
 271             *h = s.y;
 272     }
 273
 274         // centre with respect to the the parent window
 275     void Centre( int direction = wxBOTH );
 276     void Center( int direction = wxBOTH ) { Centre(direction); }
 277     void CentreOnParent( int dir = wxBOTH ) { Centre(dir | wxCENTER_FRAME); }
 278     void CenterOnParent( int dir = wxBOTH ) { Centre(dir | wxCENTER_FRAME); }
 279
 280         // set window size to wrap around its children
 281     virtual void Fit();
 282
 283         // set min/max size of the window
 284     virtual void SetSizeHints( int minW, int minH,
 285                                int maxW = -1, int maxH = -1,
 286                                int incW = -1, int incH = -1 );
 287
 288     int GetMinWidth() const { return m_minWidth; }
 289     int GetMinHeight() const { return m_minHeight; }
 290     int GetMaxWidth() const { return m_maxWidth; }
 291     int GetMaxHeight() const { return m_maxHeight; }
 292
 293     // window state
 294     // ------------
 295
 296         // returns TRUE if window was shown/hidden, FALSE if the nothing was
 297         // done (window was already shown/hidden)
 298     virtual bool Show( bool show = TRUE );
 299     bool Hide() { return Show(FALSE); }
 300
 301         // returns TRUE if window was enabled/disabled, FALSE if nothing done
 302     virtual bool Enable( bool enable = TRUE );
 303     bool Disable() { return Enable(FALSE); }
 304
 305     bool IsShown() const { return m_isShown; }
 306     bool IsEnabled() const { return m_isEnabled; }
 307
 308         // get/set window style (setting style won't update the window and so
 309         // is only useful for internal usage)
 310     virtual void SetWindowStyleFlag( long style ) { m_windowStyle = style; }
 311     virtual long GetWindowStyleFlag() const { return m_windowStyle; }
 312
 313         // just some (somewhat shorter) synonims
 314     void SetWindowStyle( long style ) { SetWindowStyleFlag(style); }
 315     long GetWindowStyle() const { return GetWindowStyleFlag(); }
 316
 317     bool HasFlag(int flag) const { return (m_windowStyle & flag) != 0; }
 318     virtual bool IsRetained() const { return HasFlag(wxRETAINED); }
 319
 320         // extra style: the less often used style bits which can't be set with
 321         // SetWindowStyleFlag()
 322     void SetExtraStyle(long exStyle) { m_exStyle = exStyle; }
 323     long GetExtraStyle() const { return m_exStyle; }
 324
 325         // make the window modal (all other windows unresponsive)
 326     virtual void MakeModal(bool modal = TRUE);
 327
 328     // focus handling
 329     // --------------
 330
 331         // set focus to this window
 332     virtual void SetFocus() = 0;
 333
 334         // return the window which currently has the focus or NULL
 335     static wxWindow *FindFocus() /* = 0: implement in derived classes */;
 336
 337         // can this window have focus?
 338     virtual bool AcceptsFocus() const { return IsShown() && IsEnabled(); }
 339
 340     // parent/children relations
 341     // -------------------------
 342
 343         // get the list of children
 344     const wxWindowList& GetChildren() const { return m_children; }
 345     wxWindowList& GetChildren() { return m_children; }
 346
 347         // get the parent or the parent of the parent
 348     wxWindow *GetParent() const { return m_parent; }
 349     inline wxWindow *GetGrandParent() const;
 350
 351         // is this window a top level one?
 352     virtual bool IsTopLevel() const;
 353
 354         // it doesn't really change parent, use ReParent() instead
 355     void SetParent( wxWindowBase *parent ) { m_parent = (wxWindow *)parent; }
 356         // change the real parent of this window, return TRUE if the parent
 357         // was changed, FALSE otherwise (error or newParent == oldParent)
 358     virtual bool Reparent( wxWindowBase *newParent );
 359
 360         // find window among the descendants of this one either by id or by
 361         // name (return NULL if not found)
 362     wxWindow *FindWindow( long id );
 363     wxWindow *FindWindow( const wxString& name );
 364
 365         // implementation mostly
 366     virtual void AddChild( wxWindowBase *child );
 367     virtual void RemoveChild( wxWindowBase *child );
 368
 369     // event handler stuff
 370     // -------------------
 371
 372         // get the current event handler
 373     wxEvtHandler *GetEventHandler() const { return m_eventHandler; }
 374
 375         // replace the event handler (allows to completely subclass the
 376         // window)
 377     void SetEventHandler( wxEvtHandler *handler ) { m_eventHandler = handler; }
 378
 379         // push/pop event handler: allows to chain a custom event handler to
 380         // alreasy existing ones
 381     void PushEventHandler( wxEvtHandler *handler );
 382     wxEvtHandler *PopEventHandler( bool deleteHandler = FALSE );
 383
 384     // validators and client data
 385     // --------------------------
 386
 387 #if wxUSE_VALIDATORS
 388         // a window may have an associated validator which is used to control
 389         // user input
 390     virtual void SetValidator( const wxValidator &validator );
 391     virtual wxValidator *GetValidator() { return m_windowValidator; }
 392 #endif // wxUSE_VALIDATORS
 393
 394         // each window may have associated client data: either a pointer to
 395         // wxClientData object in which case it is managed by the window (i.e.
 396         // it will delete the data when it's destroyed) or an untyped pointer
 397         // which won't be deleted by the window - but not both of them
 398     void SetClientObject( wxClientData *data ) { DoSetClientObject(data); }
 399     wxClientData *GetClientObject() const { return DoGetClientObject(); }
 400
 401     void SetClientData( void *data ) { DoSetClientData(data); }
 402     void *GetClientData() const { return DoGetClientData(); }
 403
 404     // dialog oriented functions
 405     // -------------------------
 406
 407         // validate the correctness of input, return TRUE if ok
 408     virtual bool Validate();
 409
 410         // transfer data between internal and GUI representations
 411     virtual bool TransferDataToWindow();
 412     virtual bool TransferDataFromWindow();
 413
 414     virtual void InitDialog();
 415
 416 #if wxUSE_ACCEL
 417     // accelerators
 418     // ------------
 419     virtual void SetAcceleratorTable( const wxAcceleratorTable& accel )
 420         { m_acceleratorTable = accel; }
 421     wxAcceleratorTable *GetAcceleratorTable()
 422         { return &m_acceleratorTable; }
 423 #endif // wxUSE_ACCEL
 424
 425     // dialog units translations
 426     // -------------------------
 427
 428     wxPoint ConvertPixelsToDialog( const wxPoint& pt );
 429     wxPoint ConvertDialogToPixels( const wxPoint& pt );
 430     wxSize ConvertPixelsToDialog( const wxSize& sz )
 431     {
 432         wxPoint pt(ConvertPixelsToDialog(wxPoint(sz.x, sz.y)));
 433
 434         return wxSize(pt.x, pt.y);
 435     }
 436
 437     wxSize ConvertDialogToPixels( const wxSize& sz )
 438     {
 439         wxPoint pt(ConvertDialogToPixels(wxPoint(sz.x, sz.y)));
 440
 441         return wxSize(pt.x, pt.y);
 442     }
 443
 444     // mouse functions
 445     // ---------------
 446
 447         // move the mouse to the specified position
 448     virtual void WarpPointer(int x, int y) = 0;
 449
 450         // start or end mouse capture
 451     virtual void CaptureMouse() = 0;
 452     virtual void ReleaseMouse() = 0;
 453
 454     // painting the window
 455     // -------------------
 456
 457         // mark the specified rectangle (or the whole window) as "dirty" so it
 458         // will be repainted
 459     virtual void Refresh( bool eraseBackground = TRUE,
 460                           const wxRect *rect = (const wxRect *) NULL ) = 0;
 461         // clear the window entirely
 462     virtual void Clear() = 0;
 463
 464         // adjust DC for drawing on this window
 465     virtual void PrepareDC( wxDC & WXUNUSED(dc) ) { }
 466
 467         // the update region of the window contains the areas which must be
 468         // repainted by the program
 469     const wxRegion& GetUpdateRegion() const { return m_updateRegion; }
 470     wxRegion& GetUpdateRegion() { return m_updateRegion; }
 471
 472         // these functions verify whether the given point/rectangle belongs to
 473         // (or at least intersects with) the update region
 474     bool IsExposed( int x, int y ) const;
 475     bool IsExposed( int x, int y, int w, int h ) const;
 476
 477     bool IsExposed( const wxPoint& pt ) const
 478         { return IsExposed(pt.x, pt.y); }
 479     bool IsExposed( const wxRect& rect ) const
 480         { return IsExposed(rect.x, rect.y, rect.width, rect.height); }
 481
 482     // colours, fonts and cursors
 483     // --------------------------
 484
 485         // set/retrieve the window colours (system defaults are used by
 486         // default): Set functions return TRUE if colour was changed
 487     virtual bool SetBackgroundColour( const wxColour &colour );
 488     virtual bool SetForegroundColour( const wxColour &colour );
 489
 490     wxColour GetBackgroundColour() const { return m_backgroundColour; }
 491     wxColour GetForegroundColour() const { return m_foregroundColour; }
 492
 493         // set/retrieve the cursor for this window (SetCursor() returns TRUE
 494         // if the cursor was really changed)
 495     virtual bool SetCursor( const wxCursor &cursor );
 496     const wxCursor& GetCursor() const { return m_cursor; }
 497     wxCursor& GetCursor() { return m_cursor; }
 498
 499         // set/retrieve the font for the window (SetFont() returns TRUE if the
 500         // font really changed)
 501     virtual bool SetFont( const wxFont &font ) = 0;
 502     const wxFont& GetFont() const { return m_font; }
 503     wxFont& GetFont() { return m_font; }
 504
 505 #if wxUSE_CARET
 506         // associate a caret with the window
 507     void SetCaret(wxCaret *caret);
 508         // get the current caret (may be NULL)
 509     wxCaret *GetCaret() const { return m_caret; }
 510 #endif // wxUSE_CARET
 511
 512         // get the (average) character size for the current font
 513     virtual int GetCharHeight() const = 0;
 514     virtual int GetCharWidth() const = 0;
 515
 516         // get the width/height/... of the text using current or specified
 517         // font
 518     virtual void GetTextExtent(const wxString& string,
 519                                int *x, int *y,
 520                                int *descent = (int *) NULL,
 521                                int *externalLeading = (int *) NULL,
 522                                const wxFont *theFont = (const wxFont *) NULL)
 523                                const = 0;
 524
 525         // translate to/from screen/client coordinates (pointers may be NULL)
 526     void ClientToScreen( int *x, int *y ) const
 527         { DoClientToScreen(x, y); }
 528     void ScreenToClient( int *x, int *y ) const
 529         { DoScreenToClient(x, y); }
 530     wxPoint ClientToScreen(const wxPoint& pt) const
 531     {
 532         int x = pt.x, y = pt.y;
 533         DoClientToScreen(&x, &y);
 534
 535         return wxPoint(x, y);
 536     }
 537
 538     wxPoint ScreenToClient(const wxPoint& pt) const
 539     {
 540         int x = pt.x, y = pt.y;
 541         DoScreenToClient(&x, &y);
 542
 543         return wxPoint(x, y);
 544     }
 545
 546     // misc
 547     // ----
 548
 549     void UpdateWindowUI();
 550
 551     bool PopupMenu( wxMenu *menu, const wxPoint& pos )
 552         { return DoPopupMenu(menu, pos.x, pos.y); }
 553     bool PopupMenu( wxMenu *menu, int x, int y )
 554         { return DoPopupMenu(menu, x, y); }
 555
 556     // scrollbars
 557     // ----------
 558
 559         // configure the window scrollbars
 560     virtual void SetScrollbar( int orient,
 561                                int pos,
 562                                int thumbVisible,
 563                                int range,
 564                                bool refresh = TRUE ) = 0;
 565     virtual void SetScrollPos( int orient, int pos, bool refresh = TRUE ) = 0;
 566     virtual int GetScrollPos( int orient ) const = 0;
 567     virtual int GetScrollThumb( int orient ) const = 0;
 568     virtual int GetScrollRange( int orient ) const = 0;
 569
 570         // scroll window to the specified position
 571     virtual void ScrollWindow( int dx, int dy,
 572                                const wxRect* rect = (wxRect *) NULL ) = 0;
 573
 574     // tooltips
 575     // --------
 576 #if wxUSE_TOOLTIPS
 577         // the easiest way to set a tooltip for a window is to use this method
 578     void SetToolTip( const wxString &tip );
 579         // attach a tooltip to the window
 580     void SetToolTip( wxToolTip *tip ) { DoSetToolTip(tip); }
 581         // get the associated tooltip or NULL if none
 582     wxToolTip* GetToolTip() const { return m_tooltip; }
 583 #endif // wxUSE_TOOLTIPS
 584
 585     // drag and drop
 586     // -------------
 587 #if wxUSE_DRAG_AND_DROP
 588         // set/retrieve the drop target associated with this window (may be
 589         // NULL; it's owned by the window and will be deleted by it)
 590     virtual void SetDropTarget( wxDropTarget *dropTarget ) = 0;
 591     virtual wxDropTarget *GetDropTarget() const { return m_dropTarget; }
 592 #endif // wxUSE_DRAG_AND_DROP
 593
 594     // constraints and sizers
 595     // ----------------------
 596 #if wxUSE_CONSTRAINTS
 597         // set the constraints for this window or retrieve them (may be NULL)
 598     void SetConstraints( wxLayoutConstraints *constraints );
 599     wxLayoutConstraints *GetConstraints() const { return m_constraints; }
 600
 601         // when using constraints, it makes sense to update children positions
 602         // automatically whenever the window is resized - this is done if
 603         // autoLayout is on
 604     void SetAutoLayout( bool autoLayout ) { m_autoLayout = autoLayout; }
 605     bool GetAutoLayout() const { return m_autoLayout; }
 606
 607         // do layout the window and its children
 608     virtual bool Layout();
 609
 610         // implementation only
 611     void UnsetConstraints(wxLayoutConstraints *c);
 612     wxWindowList *GetConstraintsInvolvedIn() const
 613         { return m_constraintsInvolvedIn; }
 614     void AddConstraintReference(wxWindowBase *otherWin);
 615     void RemoveConstraintReference(wxWindowBase *otherWin);
 616     void DeleteRelatedConstraints();
 617     void ResetConstraints();
 618
 619         // these methods may be overriden for special layout algorithms
 620     virtual void SetConstraintSizes(bool recurse = TRUE);
 621     virtual bool LayoutPhase1(int *noChanges);
 622     virtual bool LayoutPhase2(int *noChanges);
 623     virtual bool DoPhase(int phase);
 624
 625         // these methods are virtual but normally won't be overridden
 626     virtual void SetSizeConstraint(int x, int y, int w, int h);
 627     virtual void MoveConstraint(int x, int y);
 628     virtual void GetSizeConstraint(int *w, int *h) const ;
 629     virtual void GetClientSizeConstraint(int *w, int *h) const ;
 630     virtual void GetPositionConstraint(int *x, int *y) const ;
 631
 632         // sizers
 633         // TODO: what are they and how do they work??
 634     void SetSizer( wxSizer *sizer );
 635     wxSizer *GetSizer() const { return m_windowSizer; }
 636 #endif // wxUSE_CONSTRAINTS
 637
 638     // backward compatibility
 639     // ----------------------
 640 #if WXWIN_COMPATIBILITY
 641     bool Enabled() const { return IsEnabled(); }
 642
 643     void SetButtonFont(const wxFont& font) { SetFont(font); }
 644     void SetLabelFont(const wxFont& font) { SetFont(font); }
 645     wxFont& GetLabelFont() { return GetFont(); };
 646     wxFont& GetButtonFont() { return GetFont(); };
 647 #endif // WXWIN_COMPATIBILITY
 648
 649     // implementation
 650     // --------------
 651
 652         // event handlers
 653     void OnSysColourChanged( wxSysColourChangedEvent& event );
 654     void OnInitDialog( wxInitDialogEvent &event );
 655
 656         // get the haqndle of the window for the underlying window system: this
 657         // is only used for wxWin itself or for user code which wants to call
 658         // platform-specific APIs
 659     virtual WXWidget GetHandle() const = 0;
 660
 661 protected:
 662     // the window id - a number which uniquely identifies a window among
 663     // its siblings unless it is -1
 664     wxWindowID           m_windowId;
 665
 666     // the parent window of this window (or NULL) and the list of the children
 667     // of this window
 668     wxWindow            *m_parent;
 669     wxWindowList         m_children;
 670
 671     // the minimal allowed size for the window (no minimal size if variable(s)
 672     // contain(s) -1)
 673     int                  m_minWidth, m_minHeight, m_maxWidth, m_maxHeight;
 674
 675     // event handler for this window: usually is just 'this' but may be
 676     // changed with SetEventHandler()
 677     wxEvtHandler        *m_eventHandler;
 678
 679 #if wxUSE_VALIDATORS
 680     // associated validator or NULL if none
 681     wxValidator         *m_windowValidator;
 682 #endif // wxUSE_VALIDATORS
 683
 684 #if wxUSE_DRAG_AND_DROP
 685     wxDropTarget        *m_dropTarget;
 686 #endif // wxUSE_DRAG_AND_DROP
 687
 688     // visual window attributes
 689     wxCursor             m_cursor;
 690     wxFont               m_font;
 691     wxColour             m_backgroundColour, m_foregroundColour;
 692
 693 #if wxUSE_CARET
 694     wxCaret             *m_caret;
 695 #endif // wxUSE_CARET
 696
 697     // the region which should be repainted in response to paint event
 698     wxRegion             m_updateRegion;
 699
 700 #if wxUSE_ACCEL
 701     // the accelerator table for the window which translates key strokes into
 702     // command events
 703     wxAcceleratorTable   m_acceleratorTable;
 704 #endif // wxUSE_ACCEL
 705
 706     // user data associated with the window: either an object which will be
 707     // deleted by the window when it's deleted or some raw pointer which we do
 708     // nothing with - only one type of data can be used with the given window
 709     // (i.e. you cannot set the void data and then associate the window with
 710     // wxClientData or vice versa)
 711     union
 712     {
 713         wxClientData *m_clientObject;
 714         void         *m_clientData;
 715     };
 716
 717     // the tooltip for this window (may be NULL)
 718 #if wxUSE_TOOLTIPS
 719     wxToolTip           *m_tooltip;
 720 #endif // wxUSE_TOOLTIPS
 721
 722     // constraints and sizers
 723 #if wxUSE_CONSTRAINTS
 724     // the constraints for this window or NULL
 725     wxLayoutConstraints *m_constraints;
 726
 727     // constraints this window is involved in
 728     wxWindowList        *m_constraintsInvolvedIn;
 729
 730     // top level and the parent sizers
 731     // TODO what's this and how does it work?)
 732     wxSizer             *m_windowSizer;
 733     wxWindowBase        *m_sizerParent;
 734
 735     // Layout() window automatically when its size changes?
 736     bool                 m_autoLayout:1;
 737 #endif // wxUSE_CONSTRAINTS
 738
 739     // window state
 740     bool                 m_isShown:1;
 741     bool                 m_isEnabled:1;
 742     bool                 m_isBeingDeleted:1;
 743
 744     // window attributes
 745     long                 m_windowStyle,
 746                          m_exStyle;
 747     wxString             m_windowName;
 748
 749 protected:
 750     // common part of all ctors: it is not virtual because it is called from
 751     // ctor
 752     void InitBase();
 753
 754     // get the default size for the new window if no explicit size given
 755     // FIXME why 20 and not 30, 10 or ...?
 756     static int WidthDefault(int w) { return w == -1 ? 20 : w; }
 757     static int HeightDefault(int h) { return h == -1 ? 20 : h; }
 758
 759     // sets the size to be size but take width and/or height from
 760     // DoGetBestSize() if width/height of size is -1
 761     //
 762     // NB: when calling this function from the ctor, the DoGetBestSize() of
 763     //     the class with the same name as the ctor, not the real (most
 764     //     derived) one - but this is what we usually want
 765     void SetSizeOrDefault(const wxSize& size = wxDefaultSize)
 766     {
 767         if ( size.x == -1 || size.y == -1 )
 768         {
 769             wxSize sizeDef = GetBestSize();
 770             SetSize( size.x == -1 ? sizeDef.x : size.x,
 771                      size.y == -1 ? sizeDef.y : size.y);
 772         }
 773         else
 774         {
 775             SetSize(size);
 776         }
 777     }
 778
 779     // more pure virtual functions
 780     // ---------------------------
 781
 782     // NB: we must have DoSomething() function when Something() is an overloaded
 783     //     method: indeed, we can't just have "virtual Something()" in case when
 784     //     the function is overloaded because then we'd have to make virtual all
 785     //     the variants (otherwise only the virtual function may be called on a
 786     //     pointer to derived class according to C++ rules) which is, in
 787     //     general, absolutely not needed. So instead we implement all
 788     //     overloaded Something()s in terms of DoSomething() which will be the
 789     //     only one to be virtual.
 790
 791     // coordinates translation
 792     virtual void DoClientToScreen( int *x, int *y ) const = 0;
 793     virtual void DoScreenToClient( int *x, int *y ) const = 0;
 794
 795     // retrieve the position/size of the window
 796     virtual void DoGetPosition( int *x, int *y ) const = 0;
 797     virtual void DoGetSize( int *width, int *height ) const = 0;
 798     virtual void DoGetClientSize( int *width, int *height ) const = 0;
 799
 800     // get the size which best suits the window: for a control, it would be
 801     // the minimal size which doesn't truncate the control, for a panel - the
 802     // same size as it would have after a call to Fit()
 803     virtual wxSize DoGetBestSize() const;
 804
 805     // this is the virtual function to be overriden in any derived class which
 806     // wants to change how SetSize() or Move() works - it is called by all
 807     // versions of these functions in the base class
 808     virtual void DoSetSize(int x, int y,
 809                            int width, int height,
 810                            int sizeFlags = wxSIZE_AUTO) = 0;
 811
 812     // same as DoSetSize() for the client size
 813     virtual void DoSetClientSize(int width, int height) = 0;
 814
 815     // move the window to the specified location and resize it: this is called
 816     // from both DoSetSize() and DoSetClientSize() and would usually just
 817     // reposition this window except for composite controls which will want to
 818     // arrange themselves inside the given rectangle
 819     virtual void DoMoveWindow(int x, int y, int width, int height) = 0;
 820
 821 #if wxUSE_TOOLTIPS
 822     virtual void DoSetToolTip( wxToolTip *tip );
 823 #endif // wxUSE_TOOLTIPS
 824
 825     virtual bool DoPopupMenu( wxMenu *menu, int x, int y ) = 0;
 826
 827     // client data accessors
 828     virtual void DoSetClientObject( wxClientData *data );
 829     virtual wxClientData *DoGetClientObject() const;
 830
 831     virtual void DoSetClientData( void *data );
 832     virtual void *DoGetClientData() const;
 833
 834     // what kind of data do we have?
 835     enum wxClientDataType
 836     {
 837         ClientData_None,    // we don't know yet because we don't have it at all
 838         ClientData_Object,  // our client data is typed and we own it
 839         ClientData_Void     // client data is untyped and we don't own it
 840     } m_clientDataType;
 841
 842 private:
 843     // contains the last id generated by NewControlId
 844     static int ms_lastControlId;
 845
 846     DECLARE_NO_COPY_CLASS(wxWindowBase);
 847     DECLARE_EVENT_TABLE()
 848 };
 849
 850 // ----------------------------------------------------------------------------
 851 // now include the declaration of wxWindow class
 852 // ----------------------------------------------------------------------------
 853
 854 #if defined(__WXMSW__)
 855     #include "wx/msw/window.h"
 856 #elif defined(__WXMOTIF__)
 857     #include "wx/motif/window.h"
 858 #elif defined(__WXGTK__)
 859     #include "wx/gtk/window.h"
 860 #elif defined(__WXQT__)
 861     #include "wx/qt/window.h"
 862 #elif defined(__WXMAC__)
 863     #include "wx/mac/window.h"
 864 #elif defined(__WXPM__)
 865     #include "wx/os2/window.h"
 866 #endif
 867
 868 // ----------------------------------------------------------------------------
 869 // inline functions which couldn't be declared in the class body because of
 870 // forward dependencies
 871 // ----------------------------------------------------------------------------
 872
 873 inline wxWindow *wxWindowBase::GetGrandParent() const
 874 {
 875     return m_parent ? m_parent->GetParent() : (wxWindow *)NULL;
 876 }
 877
 878 // ----------------------------------------------------------------------------
 879 // global function
 880 // ----------------------------------------------------------------------------
 881
 882 WXDLLEXPORT extern wxWindow* wxGetActiveWindow();
 883
 884 // deprecated (doesn't start with 'wx' prefix), use wxWindow::NewControlId()
 885 inline WXDLLEXPORT int NewControlId() { return wxWindowBase::NewControlId(); }
 886
 887 #endif
 888     // _WX_WINDOW_H_BASE_