]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/window.h
More wxPlotWindow goodies.
[wxWidgets.git] / include / wx / window.h
index 7be5f5413b9543dda55b17a98728a8b0121fcb41..3a1e9362bbf9cfcda1f0ab57729c778169ea072c 100644 (file)
@@ -28,6 +28,9 @@
 #include "wx/font.h"            // so we can't do without them
 #include "wx/colour.h"
 #include "wx/region.h"
+#include "wx/utils.h"
+
+#include "wx/validate.h"        // for wxDefaultValidator (always include it)
 
 #if wxUSE_ACCEL
     #include "wx/accel.h"
@@ -48,7 +51,6 @@ class WXDLLEXPORT wxLayoutConstraints;
 class WXDLLEXPORT wxResourceTable;
 class WXDLLEXPORT wxSizer;
 class WXDLLEXPORT wxToolTip;
-class WXDLLEXPORT wxValidator;
 class WXDLLEXPORT wxWindowBase;
 class WXDLLEXPORT wxWindow;
 
@@ -117,6 +119,7 @@ public:
                     const wxPoint& pos = wxDefaultPosition,
                     const wxSize& size = wxDefaultSize,
                     long style = 0,
+                    const wxValidator& validator = wxDefaultValidator,
                     const wxString& name = wxPanelNameStr);
 
     virtual ~wxWindowBase();
@@ -256,11 +259,31 @@ public:
         return wxSize(w, h);
     }
 
-        // centre with respect to the the parent window
+        // 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;
+    }
+
+        // the generic centre function - centers the window on parent by
+        // default or on screen if it doesn't have parent or
+        // wxCENTER_ON_SCREEN flag is given
     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); }
+
+        // centre on screen (only works for top level windows)
+    void CentreOnScreen(int dir = wxBOTH) { Centre(dir | wxCENTER_ON_SCREEN); }
+    void CenterOnScreen(int dir = wxBOTH) { CentreOnScreen(dir); }
+
+        // centre with respect to the the parent window
+    void CentreOnParent(int dir = wxBOTH) { Centre(dir | wxCENTER_FRAME); }
+    void CenterOnParent(int dir = wxBOTH) { CentreOnParent(dir); }
 
         // set window size to wrap around its children
     virtual void Fit();
@@ -270,6 +293,11 @@ public:
                                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
     // ------------
 
@@ -295,9 +323,12 @@ public:
     long GetWindowStyle() const { return GetWindowStyleFlag(); }
 
     bool HasFlag(int flag) const { return (m_windowStyle & flag) != 0; }
+    virtual bool IsRetained() const { return HasFlag(wxRETAINED); }
 
-    virtual bool IsRetained() const
-        { return (m_windowStyle & wxRETAINED) != 0; }
+        // extra style: the less often used style bits which can't be set with
+        // SetWindowStyleFlag()
+    void SetExtraStyle(long exStyle) { m_exStyle = exStyle; }
+    long GetExtraStyle() const { return m_exStyle; }
 
         // make the window modal (all other windows unresponsive)
     virtual void MakeModal(bool modal = TRUE);
@@ -326,7 +357,7 @@ public:
     inline wxWindow *GetGrandParent() const;
 
         // is this window a top level one?
-    bool IsTopLevel() const;
+    virtual bool IsTopLevel() const;
 
         // it doesn't really change parent, use ReParent() instead
     void SetParent( wxWindowBase *parent ) { m_parent = (wxWindow *)parent; }
@@ -371,18 +402,12 @@ public:
         // 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;
+        // which won't be deleted by the window - but not both of them
+    void SetClientObject( wxClientData *data ) { DoSetClientObject(data); }
+    wxClientData *GetClientObject() const { return DoGetClientObject(); }
 
-        m_clientObject = data;
-    }
-    virtual wxClientData *GetClientObject() const { return m_clientObject; }
-
-    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
     // -------------------------
@@ -603,10 +628,9 @@ public:
     virtual void SetConstraintSizes(bool recurse = TRUE);
     virtual bool LayoutPhase1(int *noChanges);
     virtual bool LayoutPhase2(int *noChanges);
-    virtual bool DoPhase(int);
+    virtual bool DoPhase(int phase);
 
         // 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 ;
@@ -617,12 +641,6 @@ public:
         // 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
@@ -642,6 +660,7 @@ public:
         // event handlers
     void OnSysColourChanged( wxSysColourChangedEvent& event );
     void OnInitDialog( wxInitDialogEvent &event );
+    void OnMiddleClick( wxMouseEvent& event );
 
         // get the haqndle of the window for the underlying window system: this
         // is only used for wxWin itself or for user code which wants to call
@@ -695,9 +714,14 @@ protected:
 
     // 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
@@ -727,7 +751,8 @@ protected:
     bool                 m_isBeingDeleted:1;
 
     // window attributes
-    long                 m_windowStyle;
+    long                 m_windowStyle,
+                         m_exStyle;
     wxString             m_windowName;
 
 protected:
@@ -740,6 +765,26 @@ protected:
     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
     // ---------------------------
 
@@ -761,6 +806,11 @@ protected:
     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
@@ -771,12 +821,33 @@ protected:
     // same as DoSetSize() for the client size
     virtual void DoSetClientSize(int width, int height) = 0;
 
+    // move the window to the specified location and resize it: this is called
+    // from both DoSetSize() and DoSetClientSize() and would usually just
+    // reposition this window except for composite controls which will want to
+    // arrange themselves inside the given rectangle
+    virtual void DoMoveWindow(int x, int y, int width, int height) = 0;
+
 #if 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;
@@ -799,6 +870,8 @@ private:
     #include "wx/qt/window.h"
 #elif defined(__WXMAC__)
     #include "wx/mac/window.h"
+#elif defined(__WXPM__)
+    #include "wx/os2/window.h"
 #endif
 
 // ----------------------------------------------------------------------------
@@ -816,6 +889,8 @@ inline wxWindow *wxWindowBase::GetGrandParent() const
 // ----------------------------------------------------------------------------
 
 WXDLLEXPORT extern wxWindow* wxGetActiveWindow();
+
+// deprecated (doesn't start with 'wx' prefix), use wxWindow::NewControlId()
 inline WXDLLEXPORT int NewControlId() { return wxWindowBase::NewControlId(); }
 
 #endif