A bugfix in the wxTreeCtrl.GetItem wrapper

[wxWidgets.git] / include / wx / window.h

diff --git a/include/wx/window.h b/include/wx/window.h
index 94ea50624ae33e06054e508e25d443e74e32b6f8..f78da2dbfce7aeb8c4dbb035b8806967aecf9559 100644 (file)
--- a/include/wx/window.h
+++ b/include/wx/window.h
@@ -28,7 +28,15 @@
 #include "wx/font.h"            // so we can't do without them
 #include "wx/colour.h"
 #include "wx/region.h"
 #include "wx/font.h"            // so we can't do without them
 #include "wx/colour.h"
 #include "wx/region.h"

-#include "wx/accel.h"
+#include "wx/utils.h"
+
+#if wxUSE_VALIDATORS
+    #include "wx/validate.h"    // defines wxDefaultValidator
+#endif // wxUSE_VALIDATORS
+
+#if wxUSE_ACCEL
+    #include "wx/accel.h"
+#endif // wxUSE_ACCEL

 
 // ----------------------------------------------------------------------------
 // forward declarations
 
 // ----------------------------------------------------------------------------
 // forward declarations


@@ -45,7 +53,6 @@ class WXDLLEXPORT wxLayoutConstraints;
 class WXDLLEXPORT wxResourceTable;
 class WXDLLEXPORT wxSizer;
 class WXDLLEXPORT wxToolTip;
 class WXDLLEXPORT wxResourceTable;
 class WXDLLEXPORT wxSizer;
 class WXDLLEXPORT wxToolTip;

-class WXDLLEXPORT wxValidator;

 class WXDLLEXPORT wxWindowBase;
 class WXDLLEXPORT wxWindow;
 
 class WXDLLEXPORT wxWindowBase;
 class WXDLLEXPORT wxWindow;
 


@@ -114,6 +121,10 @@ public:
                     const wxPoint& pos = wxDefaultPosition,
                     const wxSize& size = wxDefaultSize,
                     long style = 0,
                     const wxPoint& pos = wxDefaultPosition,
                     const wxSize& size = wxDefaultSize,
                     long style = 0,

+
+#if wxUSE_VALIDATORS
+                    const wxValidator& validator = wxDefaultValidator,
+#endif // wxUSE_VALIDATORS

                     const wxString& name = wxPanelNameStr);
 
     virtual ~wxWindowBase();
                     const wxString& name = wxPanelNameStr);
 
     virtual ~wxWindowBase();


@@ -253,9 +264,23 @@ public:
         return wxSize(w, h);
     }
 
         return wxSize(w, h);
     }
 

+        // get the size best suited for the window (in fact, minimal
+        // acceptable size using which it will still look "nice")
+    wxSize GetBestSize() const { return DoGetBestSize(); }
+    void GetBestSize(int *w, int *h) const
+    {
+        wxSize s = DoGetBestSize();
+        if ( w )
+            *w = s.x;
+        if ( h )
+            *h = s.y;
+    }
+

         // centre with respect to the the parent window
         // centre with respect to the the parent window

-    void Centre( int direction = wxHORIZONTAL );
-    void Center( int direction = wxHORIZONTAL ) { Centre(direction); }
+    void Centre( int direction = wxBOTH );
+    void Center( int direction = wxBOTH ) { Centre(direction); }
+    void CentreOnParent( int dir = wxBOTH ) { Centre(dir | wxCENTER_FRAME); }
+    void CenterOnParent( int dir = wxBOTH ) { Centre(dir | wxCENTER_FRAME); }

 
         // set window size to wrap around its children
     virtual void Fit();
 
         // set window size to wrap around its children
     virtual void Fit();


@@ -265,6 +290,11 @@ public:
                                int maxW = -1, int maxH = -1,
                                int incW = -1, int incH = -1 );
 
                                int maxW = -1, int maxH = -1,
                                int incW = -1, int incH = -1 );
 

+    int GetMinWidth() const { return m_minWidth; }
+    int GetMinHeight() const { return m_minHeight; }
+    int GetMaxWidth() const { return m_maxWidth; }
+    int GetMaxHeight() const { return m_maxHeight; }
+

     // window state
     // ------------
 
     // window state
     // ------------
 


@@ -321,7 +351,7 @@ public:
     inline wxWindow *GetGrandParent() const;
 
         // is this window a top level one?
     inline wxWindow *GetGrandParent() const;
 
         // is this window a top level one?

-    bool IsTopLevel() const { return m_parent != 0; }
+    virtual bool IsTopLevel() const;

 
         // it doesn't really change parent, use ReParent() instead
     void SetParent( wxWindowBase *parent ) { m_parent = (wxWindow *)parent; }
 
         // it doesn't really change parent, use ReParent() instead
     void SetParent( wxWindowBase *parent ) { m_parent = (wxWindow *)parent; }


@@ -356,26 +386,22 @@ public:
     // validators and client data
     // --------------------------
 
     // validators and client data
     // --------------------------
 

+#if wxUSE_VALIDATORS

         // a window may have an associated validator which is used to control
         // user input
     virtual void SetValidator( const wxValidator &validator );
     virtual wxValidator *GetValidator() { return m_windowValidator; }
         // a window may have an associated validator which is used to control
         // user input
     virtual void SetValidator( const wxValidator &validator );
     virtual wxValidator *GetValidator() { return m_windowValidator; }

+#endif // wxUSE_VALIDATORS

 
         // each window may have associated client data: either a pointer to
         // wxClientData object in which case it is managed by the window (i.e.
         // it will delete the data when it's destroyed) or an untyped pointer
 
         // each window may have associated client data: either a pointer to
         // wxClientData object in which case it is managed by the window (i.e.
         // it will delete the data when it's destroyed) or an untyped pointer

-        // which won't be deleted by the window
-    virtual void SetClientObject( wxClientData *data )
-    {
-        if ( m_clientObject )
-            delete m_clientObject;
-
-        m_clientObject = data;
-    }
-    virtual wxClientData *GetClientObject() const { return m_clientObject; }
+        // which won't be deleted by the window - but not both of them
+    void SetClientObject( wxClientData *data ) { DoSetClientObject(data); }
+    wxClientData *GetClientObject() const { return DoGetClientObject(); }

 
 

-    virtual void SetClientData( void *data ) { m_clientData = data; }
-    virtual void *GetClientData() const { return m_clientData; }
+    void SetClientData( void *data ) { DoSetClientData(data); }
+    void *GetClientData() const { return DoGetClientData(); }

 
     // dialog oriented functions
     // -------------------------
 
     // dialog oriented functions
     // -------------------------


@@ -389,12 +415,14 @@ public:
 
     virtual void InitDialog();
 
 
     virtual void InitDialog();
 

+#if wxUSE_ACCEL

     // accelerators
     // ------------
     virtual void SetAcceleratorTable( const wxAcceleratorTable& accel )
         { m_acceleratorTable = accel; }
     wxAcceleratorTable *GetAcceleratorTable()
         { return &m_acceleratorTable; }
     // accelerators
     // ------------
     virtual void SetAcceleratorTable( const wxAcceleratorTable& accel )
         { m_acceleratorTable = accel; }
     wxAcceleratorTable *GetAcceleratorTable()
         { return &m_acceleratorTable; }

+#endif // wxUSE_ACCEL

 
     // dialog units translations
     // -------------------------
 
     // dialog units translations
     // -------------------------


@@ -522,7 +550,10 @@ public:
 
     void UpdateWindowUI();
 
 
     void UpdateWindowUI();
 

-    virtual bool PopupMenu( wxMenu *menu, int x, int y ) = 0;
+    bool PopupMenu( wxMenu *menu, const wxPoint& pos )
+        { return DoPopupMenu(menu, pos.x, pos.y); }
+    bool PopupMenu( wxMenu *menu, int x, int y )
+        { return DoPopupMenu(menu, x, y); }

 
     // scrollbars
     // ----------
 
     // scrollbars
     // ----------


@@ -594,7 +625,6 @@ public:
     virtual bool DoPhase(int);
 
         // these methods are virtual but normally won't be overridden
     virtual bool DoPhase(int);
 
         // these methods are virtual but normally won't be overridden

-    virtual void TransformSizerToActual(int *x, int *y) const ;

     virtual void SetSizeConstraint(int x, int y, int w, int h);
     virtual void MoveConstraint(int x, int y);
     virtual void GetSizeConstraint(int *w, int *h) const ;
     virtual void SetSizeConstraint(int x, int y, int w, int h);
     virtual void MoveConstraint(int x, int y);
     virtual void GetSizeConstraint(int *w, int *h) const ;


@@ -605,12 +635,6 @@ public:
         // TODO: what are they and how do they work??
     void SetSizer( wxSizer *sizer );
     wxSizer *GetSizer() const { return m_windowSizer; }
         // TODO: what are they and how do they work??
     void SetSizer( wxSizer *sizer );
     wxSizer *GetSizer() const { return m_windowSizer; }

-
-    void SetSizerParent( wxWindowBase *win ) { m_sizerParent = win; }
-    wxWindowBase *GetSizerParent() const { return m_sizerParent; }
-
-    virtual void SizerSetSize(int x, int y, int w, int h);
-    virtual void SizerMove(int x, int y);

 #endif // wxUSE_CONSTRAINTS
 
     // backward compatibility
 #endif // wxUSE_CONSTRAINTS
 
     // backward compatibility


@@ -654,8 +678,10 @@ protected:
     // changed with SetEventHandler()
     wxEvtHandler        *m_eventHandler;
 
     // changed with SetEventHandler()
     wxEvtHandler        *m_eventHandler;
 

+#if wxUSE_VALIDATORS

     // associated validator or NULL if none
     wxValidator         *m_windowValidator;
     // associated validator or NULL if none
     wxValidator         *m_windowValidator;

+#endif // wxUSE_VALIDATORS

 
 #if wxUSE_DRAG_AND_DROP
     wxDropTarget        *m_dropTarget;
 
 #if wxUSE_DRAG_AND_DROP
     wxDropTarget        *m_dropTarget;


@@ -673,15 +699,22 @@ protected:
     // the region which should be repainted in response to paint event
     wxRegion             m_updateRegion;
 
     // the region which should be repainted in response to paint event
     wxRegion             m_updateRegion;
 

+#if wxUSE_ACCEL

     // the accelerator table for the window which translates key strokes into
     // command events
     wxAcceleratorTable   m_acceleratorTable;
     // the accelerator table for the window which translates key strokes into
     // command events
     wxAcceleratorTable   m_acceleratorTable;

+#endif // wxUSE_ACCEL

 
     // user data associated with the window: either an object which will be
     // deleted by the window when it's deleted or some raw pointer which we do
 
     // user data associated with the window: either an object which will be
     // deleted by the window when it's deleted or some raw pointer which we do

-    // nothing with
-    wxClientData        *m_clientObject;
-    void                *m_clientData;
+    // nothing with - only one type of data can be used with the given window
+    // (i.e. you cannot set the void data and then associate the window with
+    // wxClientData or vice versa)
+    union
+    {
+        wxClientData *m_clientObject;
+        void         *m_clientData;
+    };

 
     // the tooltip for this window (may be NULL)
 #if wxUSE_TOOLTIPS
 
     // the tooltip for this window (may be NULL)
 #if wxUSE_TOOLTIPS


@@ -724,6 +757,26 @@ protected:
     static int WidthDefault(int w) { return w == -1 ? 20 : w; }
     static int HeightDefault(int h) { return h == -1 ? 20 : h; }
 
     static int WidthDefault(int w) { return w == -1 ? 20 : w; }
     static int HeightDefault(int h) { return h == -1 ? 20 : h; }
 

+    // sets the size to be size but take width and/or height from
+    // DoGetBestSize() if width/height of size is -1
+    //
+    // NB: when calling this function from the ctor, the DoGetBestSize() of
+    //     the class with the same name as the ctor, not the real (most
+    //     derived) one - but this is what we usually want
+    void SetSizeOrDefault(const wxSize& size = wxDefaultSize)
+    {
+        if ( size.x == -1 || size.y == -1 )
+        {
+            wxSize sizeDef = GetBestSize();
+            SetSize( size.x == -1 ? sizeDef.x : size.x,
+                     size.y == -1 ? sizeDef.y : size.y);
+        }
+        else
+        {
+            SetSize(size);
+        }
+    }
+

     // more pure virtual functions
     // ---------------------------
 
     // more pure virtual functions
     // ---------------------------
 


@@ -745,6 +798,11 @@ protected:
     virtual void DoGetSize( int *width, int *height ) const = 0;
     virtual void DoGetClientSize( int *width, int *height ) const = 0;
 
     virtual void DoGetSize( int *width, int *height ) const = 0;
     virtual void DoGetClientSize( int *width, int *height ) const = 0;
 

+    // get the size which best suits the window: for a control, it would be
+    // the minimal size which doesn't truncate the control, for a panel - the
+    // same size as it would have after a call to Fit()
+    virtual wxSize DoGetBestSize() const;
+

     // this is the virtual function to be overriden in any derived class which
     // wants to change how SetSize() or Move() works - it is called by all
     // versions of these functions in the base class
     // this is the virtual function to be overriden in any derived class which
     // wants to change how SetSize() or Move() works - it is called by all
     // versions of these functions in the base class


@@ -759,6 +817,23 @@ protected:
     virtual void DoSetToolTip( wxToolTip *tip );
 #endif // wxUSE_TOOLTIPS
 
     virtual void DoSetToolTip( wxToolTip *tip );
 #endif // wxUSE_TOOLTIPS
 

+    virtual bool DoPopupMenu( wxMenu *menu, int x, int y ) = 0;
+
+    // client data accessors
+    virtual void DoSetClientObject( wxClientData *data );
+    virtual wxClientData *DoGetClientObject() const;
+
+    virtual void DoSetClientData( void *data );
+    virtual void *DoGetClientData() const;
+
+    // what kind of data do we have?
+    enum wxClientDataType
+    {
+        ClientData_None,    // we don't know yet because we don't have it at all
+        ClientData_Object,  // our client data is typed and we own it
+        ClientData_Void     // client data is untyped and we don't own it
+    } m_clientDataType;
+

 private:
     // contains the last id generated by NewControlId
     static int ms_lastControlId;
 private:
     // contains the last id generated by NewControlId
     static int ms_lastControlId;


@@ -781,6 +856,8 @@ private:
     #include "wx/qt/window.h"
 #elif defined(__WXMAC__)
     #include "wx/mac/window.h"
     #include "wx/qt/window.h"
 #elif defined(__WXMAC__)
     #include "wx/mac/window.h"

+#elif defined(__WXPM__)
+    #include "wx/os2/window.h"

 #endif
 
 // ----------------------------------------------------------------------------
 #endif
 
 // ----------------------------------------------------------------------------


@@ -798,6 +875,8 @@ inline wxWindow *wxWindowBase::GetGrandParent() const
 // ----------------------------------------------------------------------------
 
 WXDLLEXPORT extern wxWindow* wxGetActiveWindow();
 // ----------------------------------------------------------------------------
 
 WXDLLEXPORT extern wxWindow* wxGetActiveWindow();

+
+// deprecated (doesn't start with 'wx' prefix), use wxWindow::NewControlId()

 inline WXDLLEXPORT int NewControlId() { return wxWindowBase::NewControlId(); }
 
 #endif
 inline WXDLLEXPORT int NewControlId() { return wxWindowBase::NewControlId(); }
 
 #endif