we don't need to override MSWTranslateMessage(), it was a wrong workaround for the...

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

diff --git a/include/wx/sizer.h b/include/wx/sizer.h
index 820c32502808832868c71f2840489b5ea13c9751..62b49e681561fff90ff23de195ea30772c4540a7 100644 (file)
--- a/include/wx/sizer.h
+++ b/include/wx/sizer.h
@@ -12,16 +12,12 @@
 #ifndef __WXSIZER_H__
 #define __WXSIZER_H__
 
 #ifndef __WXSIZER_H__
 #define __WXSIZER_H__
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-#pragma interface "sizer.h"
-#endif
-

 #include "wx/defs.h"
 
 #include "wx/defs.h"
 

+#include "wx/button.h"

 #include "wx/window.h"
 #include "wx/frame.h"
 #include "wx/dialog.h"
 #include "wx/window.h"
 #include "wx/frame.h"
 #include "wx/dialog.h"

-#include "wx/bookctrl.h"

 
 //---------------------------------------------------------------------------
 // classes
 
 //---------------------------------------------------------------------------
 // classes


@@ -58,16 +54,23 @@ public:
 
     wxSizerFlags& Align(int alignment) // combination of wxAlignment values
     {
 
     wxSizerFlags& Align(int alignment) // combination of wxAlignment values
     {

-        m_flags &= wxALL;
+        m_flags &= ~wxALIGN_MASK;

         m_flags |= alignment;
 
         return *this;
     }
 
         m_flags |= alignment;
 
         return *this;
     }
 

+    wxSizerFlags& Expand()
+    {
+        m_flags |= wxEXPAND;
+        return *this;
+    }
+

     // some shortcuts for Align()
     // some shortcuts for Align()

-    wxSizerFlags& Expand() { return Align(wxEXPAND); }

     wxSizerFlags& Centre() { return Align(wxCENTRE); }
     wxSizerFlags& Center() { return Centre(); }
     wxSizerFlags& Centre() { return Align(wxCENTRE); }
     wxSizerFlags& Center() { return Centre(); }

+    wxSizerFlags& Left() { return Align(wxALIGN_LEFT); }
+    wxSizerFlags& Right() { return Align(wxALIGN_RIGHT); }

 
 
     wxSizerFlags& Border(int direction, int borderInPixels)
 
 
     wxSizerFlags& Border(int direction, int borderInPixels)


@@ -83,7 +86,14 @@ public:
     wxSizerFlags& Border(int direction = wxALL)
     {
         // FIXME: default border size shouldn't be hardcoded
     wxSizerFlags& Border(int direction = wxALL)
     {
         // FIXME: default border size shouldn't be hardcoded

+#ifdef __SMARTPHONE__
+        // no borders by default on limited size screen
+        wxUnusedVar(direction);
+
+        return *this;
+#else

         return Border(direction, 5);
         return Border(direction, 5);

+#endif

     }
 
 
     }
 
 


@@ -99,29 +109,36 @@ private:
 };
 
 
 };
 
 

-//---------------------------------------------------------------------------
-// wxSizerItem
-//---------------------------------------------------------------------------
+// ----------------------------------------------------------------------------
+// wxSizerSpacer: used by wxSizerItem to represent a spacer
+// ----------------------------------------------------------------------------

 
 

-class WXDLLEXPORT wxSizerItem: public wxObject
+class WXDLLEXPORT wxSizerSpacer

 {
 public:
 {
 public:

-    // window with flags
-    wxSizerItem(wxWindow *window, const wxSizerFlags& flags)
-    {
-        Init(flags);
+    wxSizerSpacer(const wxSize& size) : m_size(size), m_isShown(true) { }

 
 

-        m_window = window;
-    }
+    void SetSize(const wxSize& size) { m_size = size; }
+    const wxSize& GetSize() const { return m_size; }

 
 

-    // sizer with flags
-    wxSizerItem(wxSizer *sizer, const wxSizerFlags& flags)
-    {
-        Init(flags);
+    void Show(bool show) { m_isShown = show; }
+    bool IsShown() const { return m_isShown; }

 
 

-        m_sizer = sizer;
-    }
+private:
+    // the size, in pixel
+    wxSize m_size;
+
+    // is the spacer currently shown?
+    bool m_isShown;
+};
+
+// ----------------------------------------------------------------------------
+// wxSizerItem
+// ----------------------------------------------------------------------------

 
 

+class WXDLLEXPORT wxSizerItem : public wxObject
+{
+public:

     // window
     wxSizerItem( wxWindow *window,
                  int proportion,
     // window
     wxSizerItem( wxWindow *window,
                  int proportion,


@@ -129,6 +146,14 @@ public:
                  int border,
                  wxObject* userData );
 
                  int border,
                  wxObject* userData );
 

+    // window with flags
+    wxSizerItem(wxWindow *window, const wxSizerFlags& flags)
+    {
+        Init(flags);
+
+        SetWindow(window);
+    }
+

     // subsizer
     wxSizerItem( wxSizer *sizer,
                  int proportion,
     // subsizer
     wxSizerItem( wxSizer *sizer,
                  int proportion,


@@ -136,6 +161,14 @@ public:
                  int border,
                  wxObject* userData );
 
                  int border,
                  wxObject* userData );
 

+    // sizer with flags
+    wxSizerItem(wxSizer *sizer, const wxSizerFlags& flags)
+    {
+        Init(flags);
+
+        SetSizer(sizer);
+    }
+

     // spacer
     wxSizerItem( int width,
                  int height,
     // spacer
     wxSizerItem( int width,
                  int height,


@@ -144,53 +177,63 @@ public:
                  int border,
                  wxObject* userData);
 
                  int border,
                  wxObject* userData);
 

+    // spacer with flags
+    wxSizerItem(int width, int height, const wxSizerFlags& flags)
+    {
+        Init(flags);
+
+        SetSpacer(width, height);
+    }
+

     wxSizerItem();
     virtual ~wxSizerItem();
 
     virtual void DeleteWindows();
 
     // Enable deleting the SizerItem without destroying the contained sizer.
     wxSizerItem();
     virtual ~wxSizerItem();
 
     virtual void DeleteWindows();
 
     // Enable deleting the SizerItem without destroying the contained sizer.

-    void DetachSizer()
-        { m_sizer = 0; }
+    void DetachSizer() { m_sizer = NULL; }

 
     virtual wxSize GetSize() const;
     virtual wxSize CalcMin();
 
     virtual wxSize GetSize() const;
     virtual wxSize CalcMin();

-    virtual void SetDimension( wxPoint pos, wxSize size );
+    virtual void SetDimension( const wxPoint& pos, const wxSize& size );

 
     wxSize GetMinSize() const
         { return m_minSize; }
     wxSize GetMinSizeWithBorder() const;
 
     void SetMinSize(const wxSize& size)
 
     wxSize GetMinSize() const
         { return m_minSize; }
     wxSize GetMinSizeWithBorder() const;
 
     void SetMinSize(const wxSize& size)

-        {
-            if (IsWindow()) m_window->SetMinSize(size);
-            m_minSize = size;
-        }
+    {
+        if ( IsWindow() )
+            m_window->SetMinSize(size);
+        m_minSize = size;
+    }

     void SetMinSize( int x, int y )
         { SetMinSize(wxSize(x, y)); }
     void SetInitSize( int x, int y )
         { SetMinSize(wxSize(x, y)); }
 
     void SetMinSize( int x, int y )
         { SetMinSize(wxSize(x, y)); }
     void SetInitSize( int x, int y )
         { SetMinSize(wxSize(x, y)); }
 

-    void SetRatio( int width, int height )
-        // if either of dimensions is zero, ratio is assumed to be 1
-        // to avoid "divide by zero" errors
+    // if either of dimensions is zero, ratio is assumed to be 1
+    // to avoid "divide by zero" errors
+    void SetRatio(int width, int height)

         { m_ratio = (width && height) ? ((float) width / (float) height) : 1; }
         { m_ratio = (width && height) ? ((float) width / (float) height) : 1; }

-    void SetRatio( wxSize size )
-        { m_ratio = (size.x && size.y) ? ((float) size.x / (float) size.y) : 1; }
-    void SetRatio( float ratio )
+    void SetRatio(const wxSize& size)
+        { SetRatio(size.x, size.y); }
+    void SetRatio(float ratio)

         { m_ratio = ratio; }
     float GetRatio() const
         { return m_ratio; }
 
         { m_ratio = ratio; }
     float GetRatio() const
         { return m_ratio; }
 

-    virtual wxRect GetRect() { return m_zoneRect; }
+    virtual wxRect GetRect() { return m_rect; }

 
 

-    bool IsWindow() const;
-    bool IsSizer() const;
-    bool IsSpacer() const;
+    bool IsWindow() const { return m_kind == Item_Window; }
+    bool IsSizer() const { return m_kind == Item_Sizer; }
+    bool IsSpacer() const { return m_kind == Item_Spacer; }

 
 

+#if WXWIN_COMPATIBILITY_2_6

     // Deprecated in 2.6, use {G,S}etProportion instead.
     wxDEPRECATED( void SetOption( int option ) );
     wxDEPRECATED( int GetOption() const );
     // Deprecated in 2.6, use {G,S}etProportion instead.
     wxDEPRECATED( void SetOption( int option ) );
     wxDEPRECATED( int GetOption() const );

+#endif // WXWIN_COMPATIBILITY_2_6

 
     void SetProportion( int proportion )
         { m_proportion = proportion; }
 
     void SetProportion( int proportion )
         { m_proportion = proportion; }


@@ -206,48 +249,63 @@ public:
         { return m_border; }
 
     wxWindow *GetWindow() const
         { return m_border; }
 
     wxWindow *GetWindow() const

-        { return m_window; }
-    void SetWindow( wxWindow *window )
-        { m_window = window; m_minSize = window->GetSize(); }
+        { return m_kind == Item_Window ? m_window : NULL; }

     wxSizer *GetSizer() const
     wxSizer *GetSizer() const

-        { return m_sizer; }
-    void SetSizer( wxSizer *sizer )
-        { m_sizer = sizer; }
-    const wxSize &GetSpacer() const
-        { return m_size; }
-    void SetSpacer( const wxSize &size )
-        { m_size = size; m_minSize = size; }
+        { return m_kind == Item_Sizer ? m_sizer : NULL; }
+    wxSize GetSpacer() const;

 
 

-    void Show ( bool show );
-    bool IsShown() const
-        { return m_show; }
+    // this function behaves obviously for the windows and spacers but for the
+    // sizers it returns true if any sizer element is shown and only returns
+    // false if all of them are hidden
+    bool IsShown() const;
+    void Show(bool show);

 
 

+    void SetUserData(wxObject* userData)
+        { delete m_userData; m_userData = userData; }

     wxObject* GetUserData() const
         { return m_userData; }
     wxPoint GetPosition() const
         { return m_pos; }
 
     wxObject* GetUserData() const
         { return m_userData; }
     wxPoint GetPosition() const
         { return m_pos; }
 

+
+    // these functions do not free old sizer/spacer
+    void SetWindow(wxWindow *window);
+    void SetSizer(wxSizer *sizer);
+    void SetSpacer(const wxSize& size);
+    void SetSpacer(int width, int height) { SetSpacer(wxSize(width, height)); }
+

 protected:
     // common part of several ctors
 protected:
     // common part of several ctors

-    void Init();
+    void Init() { m_userData = NULL; }

 
     // common part of ctors taking wxSizerFlags
     void Init(const wxSizerFlags& flags);
 
 
 
     // common part of ctors taking wxSizerFlags
     void Init(const wxSizerFlags& flags);
 
 

-    wxWindow    *m_window;
-    wxSizer     *m_sizer;
-    wxSize       m_size;
+    // discriminated union: depending on m_kind one of the fields is valid
+    enum
+    {
+        Item_None,
+        Item_Window,
+        Item_Sizer,
+        Item_Spacer,
+        Item_Max
+    } m_kind;
+    union
+    {
+        wxWindow      *m_window;
+        wxSizer       *m_sizer;
+        wxSizerSpacer *m_spacer;
+    };
+

     wxPoint      m_pos;
     wxSize       m_minSize;
     int          m_proportion;
     int          m_border;
     int          m_flag;
     wxPoint      m_pos;
     wxSize       m_minSize;
     int          m_proportion;
     int          m_border;
     int          m_flag;

-    wxRect       m_zoneRect; // Rectangle for window or item (not including borders)

 
 

-    // If true, then this item is considered in the layout
-    // calculation.  Otherwise, it is skipped over.
-    bool         m_show;
+    // on screen rectangle of this item (not including borders)
+    wxRect       m_rect;

 
     // Aspect ratio can always be calculated from m_size,
     // but this would cause precision loss when the window
 
     // Aspect ratio can always be calculated from m_size,
     // but this would cause precision loss when the window


@@ -271,7 +329,7 @@ WX_DECLARE_EXPORTED_LIST( wxSizerItem, wxSizerItemList );
 class WXDLLEXPORT wxSizer: public wxObject, public wxClientDataContainer
 {
 public:
 class WXDLLEXPORT wxSizer: public wxObject, public wxClientDataContainer
 {
 public:

-    wxSizer();
+    wxSizer() { }

     ~wxSizer();
 
     // methods for adding elements to the sizer: there are Add/Insert/Prepend
     ~wxSizer();
 
     // methods for adding elements to the sizer: there are Add/Insert/Prepend


@@ -353,9 +411,12 @@ public:
     inline wxSizerItem* PrependStretchSpacer(int prop = 1);
 
 
     inline wxSizerItem* PrependStretchSpacer(int prop = 1);
 
 

+#if WXWIN_COMPATIBILITY_2_6

     // Deprecated in 2.6 since historically it does not delete the window,
     // use Detach instead.
     wxDEPRECATED( virtual bool Remove( wxWindow *window ) );
     // Deprecated in 2.6 since historically it does not delete the window,
     // use Detach instead.
     wxDEPRECATED( virtual bool Remove( wxWindow *window ) );

+#endif // WXWIN_COMPATIBILITY_2_6
+

     virtual bool Remove( wxSizer *sizer );
     virtual bool Remove( int index );
 
     virtual bool Remove( wxSizer *sizer );
     virtual bool Remove( int index );
 


@@ -368,24 +429,24 @@ public:
 
     void SetMinSize( int width, int height )
         { DoSetMinSize( width, height ); }
 
     void SetMinSize( int width, int height )
         { DoSetMinSize( width, height ); }

-    void SetMinSize( wxSize size )
+    void SetMinSize( const wxSize& size )

         { DoSetMinSize( size.x, size.y ); }
 
         { DoSetMinSize( size.x, size.y ); }
 

-    /* Searches recursively */
+    // Searches recursively

     bool SetItemMinSize( wxWindow *window, int width, int height )
         { return DoSetItemMinSize( window, width, height ); }
     bool SetItemMinSize( wxWindow *window, int width, int height )
         { return DoSetItemMinSize( window, width, height ); }

-    bool SetItemMinSize( wxWindow *window, wxSize size )
+    bool SetItemMinSize( wxWindow *window, const wxSize& size )

         { return DoSetItemMinSize( window, size.x, size.y ); }
 
         { return DoSetItemMinSize( window, size.x, size.y ); }
 

-    /* Searches recursively */
+    // Searches recursively

     bool SetItemMinSize( wxSizer *sizer, int width, int height )
         { return DoSetItemMinSize( sizer, width, height ); }
     bool SetItemMinSize( wxSizer *sizer, int width, int height )
         { return DoSetItemMinSize( sizer, width, height ); }

-    bool SetItemMinSize( wxSizer *sizer, wxSize size )
+    bool SetItemMinSize( wxSizer *sizer, const wxSize& size )

         { return DoSetItemMinSize( sizer, size.x, size.y ); }
 
     bool SetItemMinSize( size_t index, int width, int height )
         { return DoSetItemMinSize( index, width, height ); }
         { return DoSetItemMinSize( sizer, size.x, size.y ); }
 
     bool SetItemMinSize( size_t index, int width, int height )
         { return DoSetItemMinSize( index, width, height ); }

-    bool SetItemMinSize( size_t index, wxSize size )
+    bool SetItemMinSize( size_t index, const wxSize& size )

         { return DoSetItemMinSize( index, size.x, size.y ); }
 
     wxSize GetSize() const
         { return DoSetItemMinSize( index, size.x, size.y ); }
 
     wxSize GetSize() const


@@ -393,7 +454,7 @@ public:
     wxPoint GetPosition() const
         { return m_position; }
 
     wxPoint GetPosition() const
         { return m_position; }
 

-    /* Calculate the minimal size or return m_minSize if bigger. */
+    // Calculate the minimal size or return m_minSize if bigger.

     wxSize GetMinSize();
 
     virtual void RecalcSizes() = 0;
     wxSize GetMinSize();
 
     virtual void RecalcSizes() = 0;


@@ -435,6 +496,8 @@ public:
     // Recursively call wxWindow::Show () on all sizer items.
     virtual void ShowItems (bool show);
 
     // Recursively call wxWindow::Show () on all sizer items.
     virtual void ShowItems (bool show);
 

+    void Show(bool show) { ShowItems(show); }
+

 protected:
     wxSize              m_size;
     wxSize              m_minSize;
 protected:
     wxSize              m_size;
     wxSize              m_minSize;


@@ -620,7 +683,9 @@ class WXDLLEXPORT wxStaticBox;
 class WXDLLEXPORT wxStaticBoxSizer: public wxBoxSizer
 {
 public:
 class WXDLLEXPORT wxStaticBoxSizer: public wxBoxSizer
 {
 public:

-    wxStaticBoxSizer( wxStaticBox *box, int orient );
+    wxStaticBoxSizer(wxStaticBox *box, int orient);
+    wxStaticBoxSizer(int orient, wxWindow *win, const wxString& label = wxEmptyString);
+    virtual ~wxStaticBoxSizer();

 
     void RecalcSizes();
     wxSize CalcMin();
 
     void RecalcSizes();
     wxSize CalcMin();


@@ -631,6 +696,10 @@ public:
     // override to hide/show the static box as well
     virtual void ShowItems (bool show);
 
     // override to hide/show the static box as well
     virtual void ShowItems (bool show);
 

+    virtual bool Detach( wxWindow *window );
+    virtual bool Detach( wxSizer *sizer ) { return wxBoxSizer::Detach(sizer); }
+    virtual bool Detach( int index ) { return wxBoxSizer::Detach(index); }
+

 protected:
     wxStaticBox   *m_staticBox;
 
 protected:
     wxStaticBox   *m_staticBox;
 


@@ -641,10 +710,57 @@ private:
 
 #endif // wxUSE_STATBOX
 
 
 #endif // wxUSE_STATBOX
 

+#if wxUSE_BUTTON
+
+class WXDLLEXPORT wxStdDialogButtonSizer: public wxBoxSizer
+{
+public:
+    // Constructor just creates a new wxBoxSizer, not much else.
+    // Box sizer orientation is automatically determined here:
+    // vertical for PDAs, horizontal for everything else?
+    wxStdDialogButtonSizer();
+
+    // Checks button ID against system IDs and sets one of the pointers below
+    // to this button. Does not do any sizer-related things here.
+    void AddButton(wxButton *button);
+
+    // Use these if no standard ID can/should be used
+    void SetAffirmativeButton( wxButton *button );
+    void SetNegativeButton( wxButton *button );
+    void SetCancelButton( wxButton *button );
+
+    // All platform-specific code here, checks which buttons exist and add
+    // them to the sizer accordingly.
+    // Note - one potential hack on Mac we could use here,
+    // if m_buttonAffirmative is wxID_SAVE then ensure wxID_SAVE
+    // is set to _("Save") and m_buttonNegative is set to _("Don't Save")
+    // I wouldn't add any other hacks like that into here,
+    // but this one I can see being useful.
+    void Realize();
+
+    wxButton *GetAffirmativeButton() const { return m_buttonAffirmative; }
+    wxButton *GetApplyButton() const { return m_buttonApply; }
+    wxButton *GetNegativeButton() const { return m_buttonNegative; }
+    wxButton *GetCancelButton() const { return m_buttonCancel; }
+    wxButton *GetHelpButton() const { return m_buttonHelp; }
+
+protected:
+    wxButton *m_buttonAffirmative;  // wxID_OK, wxID_YES, wxID_SAVE go here
+    wxButton *m_buttonApply;
+    wxButton *m_buttonNegative;     // wxID_NO
+    wxButton *m_buttonCancel;
+    wxButton *m_buttonHelp;
+
+private:
+    DECLARE_CLASS(wxStdDialogButtonSizer)
+    DECLARE_NO_COPY_CLASS(wxStdDialogButtonSizer)
+};
+
+#endif // wxUSE_BUTTON

 
 #if WXWIN_COMPATIBILITY_2_4
 // NB: wxBookCtrlSizer and wxNotebookSizer are deprecated, they
 
 #if WXWIN_COMPATIBILITY_2_4
 // NB: wxBookCtrlSizer and wxNotebookSizer are deprecated, they

-//     don't do anything. wxBookCtrl::DoGetBestSize does the job now.
+//     don't do anything. wxBookCtrlBase::DoGetBestSize does the job now.

 
 // ----------------------------------------------------------------------------
 // wxBookCtrlSizer
 
 // ----------------------------------------------------------------------------
 // wxBookCtrlSizer


@@ -654,14 +770,16 @@ private:
 
 // this sizer works with wxNotebook/wxListbook/... and sizes the control to
 // fit its pages
 
 // this sizer works with wxNotebook/wxListbook/... and sizes the control to
 // fit its pages

-class WXDLLEXPORT wxBookCtrl;
+class WXDLLEXPORT wxBookCtrlBase;

 
 class WXDLLEXPORT wxBookCtrlSizer : public wxSizer
 {
 public:
 
 class WXDLLEXPORT wxBookCtrlSizer : public wxSizer
 {
 public:

-    wxDEPRECATED( wxBookCtrlSizer(wxBookCtrl *bookctrl) );
+#if WXWIN_COMPATIBILITY_2_6
+    wxDEPRECATED( wxBookCtrlSizer(wxBookCtrlBase *bookctrl) );
+#endif // WXWIN_COMPATIBILITY_2_6

 
 

-    wxBookCtrl *GetControl() const { return m_bookctrl; }
+    wxBookCtrlBase *GetControl() const { return m_bookctrl; }

 
     virtual void RecalcSizes();
     virtual wxSize CalcMin();
 
     virtual void RecalcSizes();
     virtual wxSize CalcMin();


@@ -671,7 +789,7 @@ protected:
     // and still have warning-free build of the library itself:
     wxBookCtrlSizer() {}
 
     // and still have warning-free build of the library itself:
     wxBookCtrlSizer() {}
 

-    wxBookCtrl *m_bookctrl;
+    wxBookCtrlBase *m_bookctrl;

 
 private:
     DECLARE_CLASS(wxBookCtrlSizer)
 
 private:
     DECLARE_CLASS(wxBookCtrlSizer)


@@ -681,14 +799,16 @@ private:
 
 #if wxUSE_NOTEBOOK
 
 
 #if wxUSE_NOTEBOOK
 

-// before wxBookCtrl we only had wxNotebookSizer, keep it for backwards
+// before wxBookCtrlBase we only had wxNotebookSizer, keep it for backwards

 // compatibility
 class WXDLLEXPORT wxNotebook;
 
 class WXDLLEXPORT wxNotebookSizer : public wxBookCtrlSizer
 {
 public:
 // compatibility
 class WXDLLEXPORT wxNotebook;
 
 class WXDLLEXPORT wxNotebookSizer : public wxBookCtrlSizer
 {
 public:

+#if WXWIN_COMPATIBILITY_2_6

     wxDEPRECATED( wxNotebookSizer(wxNotebook *nb) );
     wxDEPRECATED( wxNotebookSizer(wxNotebook *nb) );

+#endif // WXWIN_COMPATIBILITY_2_6

 
     wxNotebook *GetNotebook() const { return (wxNotebook *)m_bookctrl; }
 
 
     wxNotebook *GetNotebook() const { return (wxNotebook *)m_bookctrl; }