document various enumerations defined in defs.h; give a name to the anonymous enum...

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

diff --git a/include/wx/sizer.h b/include/wx/sizer.h
index 40f32e6e19be39dd58fdb93cba0cfcacabc4ff1d..316602ca449ac1928541312b7f56e184e7890494 100644 (file)
--- a/include/wx/sizer.h
+++ b/include/wx/sizer.h
@@ -38,7 +38,7 @@ class WXDLLIMPEXP_FWD_CORE wxSizer;
 // wxSizerFlags: flags used for an item in the sizer
 // ----------------------------------------------------------------------------
 
 // wxSizerFlags: flags used for an item in the sizer
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxSizerFlags
+class WXDLLIMPEXP_CORE wxSizerFlags

 {
 public:
     // construct the flags object initialized with the given proportion (0 by
 {
 public:
     // construct the flags object initialized with the given proportion (0 by


@@ -58,6 +58,15 @@ public:
         return *this;
     }
 
         return *this;
     }
 

+    wxSizerFlags& Expand()
+    {
+        m_flags |= wxEXPAND;
+        return *this;
+    }
+
+    // notice that Align() replaces the current alignment flags, use specific
+    // methods below such as Top(), Left() &c if you want to set just the
+    // vertical or horizontal alignment

     wxSizerFlags& Align(int alignment) // combination of wxAlignment values
     {
         m_flags &= ~wxALIGN_MASK;
     wxSizerFlags& Align(int alignment) // combination of wxAlignment values
     {
         m_flags &= ~wxALIGN_MASK;


@@ -66,27 +75,48 @@ public:
         return *this;
     }
 
         return *this;
     }
 

-    wxSizerFlags& Expand()
+    // some shortcuts for Align()
+    wxSizerFlags& Centre() { return Align(wxALIGN_CENTRE); }
+    wxSizerFlags& Center() { return Centre(); }
+
+    wxSizerFlags& Top()

     {
     {

-        m_flags |= wxEXPAND;
+        m_flags &= ~(wxALIGN_BOTTOM | wxALIGN_CENTRE_VERTICAL);
+        return *this;
+    }
+
+    wxSizerFlags& Left()
+    {
+        m_flags &= ~(wxALIGN_RIGHT | wxALIGN_CENTRE_HORIZONTAL);
+        return *this;
+    }
+
+    wxSizerFlags& Right()
+    {
+        m_flags = (m_flags & ~wxALIGN_CENTRE_HORIZONTAL) | wxALIGN_RIGHT;
+        return *this;
+    }
+
+    wxSizerFlags& Bottom()
+    {
+        m_flags = (m_flags & ~wxALIGN_CENTRE_VERTICAL) | wxALIGN_BOTTOM;

         return *this;
     }
 
         return *this;
     }
 

-    // some shortcuts for Align()
-    wxSizerFlags& Centre() { return Align(wxALIGN_CENTRE); }
-    wxSizerFlags& Center() { return Centre(); }
-    wxSizerFlags& Top() { return Align(wxALIGN_TOP); }
-    wxSizerFlags& Left() { return Align(wxALIGN_LEFT); }
-    wxSizerFlags& Right() { return Align(wxALIGN_RIGHT); }
-    wxSizerFlags& Bottom() { return Align(wxALIGN_BOTTOM); }

 
     // default border size used by Border() below
     static int GetDefaultBorder()
     {
 #if wxUSE_BORDER_BY_DEFAULT
 
     // default border size used by Border() below
     static int GetDefaultBorder()
     {
 #if wxUSE_BORDER_BY_DEFAULT

+    #ifdef __WXGTK20__
+        // GNOME HIG says to use 6px as the base unit:
+        // http://library.gnome.org/devel/hig-book/stable/design-window.html.en
+        return 6;
+    #else

         // FIXME: default border size shouldn't be hardcoded and at the very
         //        least they should depend on the current font size
         return 5;
         // FIXME: default border size shouldn't be hardcoded and at the very
         //        least they should depend on the current font size
         return 5;

+    #endif

 #else
         return 0;
 #endif
 #else
         return 0;
 #endif


@@ -170,6 +200,13 @@ public:
         return *this;
     }
 
         return *this;
     }
 

+    // makes the item ignore window's visibility status
+    wxSizerFlags& ReserveSpaceEvenIfHidden()
+    {
+        m_flags |= wxRESERVE_SPACE_EVEN_IF_HIDDEN;
+        return *this;
+    }
+

     // accessors for wxSizer only
     int GetProportion() const { return m_proportion; }
     int GetFlags() const { return m_flags; }
     // accessors for wxSizer only
     int GetProportion() const { return m_proportion; }
     int GetFlags() const { return m_flags; }


@@ -186,7 +223,7 @@ private:
 // wxSizerSpacer: used by wxSizerItem to represent a spacer
 // ----------------------------------------------------------------------------
 
 // wxSizerSpacer: used by wxSizerItem to represent a spacer
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxSizerSpacer
+class WXDLLIMPEXP_CORE wxSizerSpacer

 {
 public:
     wxSizerSpacer(const wxSize& size) : m_size(size), m_isShown(true) { }
 {
 public:
     wxSizerSpacer(const wxSize& size) : m_size(size), m_isShown(true) { }


@@ -209,7 +246,7 @@ private:
 // wxSizerItem
 // ----------------------------------------------------------------------------
 
 // wxSizerItem
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxSizerItem : public wxObject
+class WXDLLIMPEXP_CORE wxSizerItem : public wxObject

 {
 public:
     // window
 {
 public:
     // window


@@ -298,6 +335,11 @@ public:
 
     virtual wxRect GetRect() { return m_rect; }
 
 
     virtual wxRect GetRect() { return m_rect; }
 

+    // set a sizer item id (different from a window id, all sizer items,
+    // including spacers, can have an associated id)
+    void SetId(int id) { m_id = id; }
+    int GetId() const { return m_id; }
+

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


@@ -327,10 +369,12 @@ public:
         { return m_kind == Item_Sizer ? m_sizer : NULL; }
     wxSize GetSpacer() const;
 
         { return m_kind == Item_Sizer ? m_sizer : NULL; }
     wxSize GetSpacer() const;
 

-    // this function behaves obviously for the windows and spacers but for the
+    // 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
     // sizers it returns true if any sizer element is shown and only returns

-    // false if all of them are hidden
+    // false if all of them are hidden. Also, it always returns true if
+    // wxRESERVE_SPACE_EVEN_IF_HIDDEN flag was used.

     bool IsShown() const;
     bool IsShown() const;

+

     void Show(bool show);
 
     void SetUserData(wxObject* userData)
     void Show(bool show);
 
     void SetUserData(wxObject* userData)


@@ -340,6 +384,12 @@ public:
     wxPoint GetPosition() const
         { return m_pos; }
 
     wxPoint GetPosition() const
         { return m_pos; }
 

+    // Called once the first component of an item has been decided. This is
+    // used in algorithms that depend on knowing the size in one direction
+    // before the min size in the other direction can be known.
+    // Returns true if it made use of the information (and min size was changed).
+    bool InformFirstDirection( int direction, int size, int availableOtherDir=-1 );
+

     // these functions delete the current contents of the item if it's a sizer
     // or a spacer but not if it is a window
     void AssignWindow(wxWindow *window)
     // these functions delete the current contents of the item if it's a sizer
     // or a spacer but not if it is a window
     void AssignWindow(wxWindow *window)


@@ -407,6 +457,7 @@ protected:
     int          m_proportion;
     int          m_border;
     int          m_flag;
     int          m_proportion;
     int          m_border;
     int          m_flag;

+    int          m_id;

 
     // on screen rectangle of this item (not including borders)
     wxRect       m_rect;
 
     // on screen rectangle of this item (not including borders)
     wxRect       m_rect;


@@ -430,7 +481,7 @@ WX_DECLARE_EXPORTED_LIST( wxSizerItem, wxSizerItemList );
 // wxSizer
 //---------------------------------------------------------------------------
 
 // wxSizer
 //---------------------------------------------------------------------------
 

-class WXDLLEXPORT wxSizer: public wxObject, public wxClientDataContainer
+class WXDLLIMPEXP_CORE wxSizer: public wxObject, public wxClientDataContainer

 {
 public:
     wxSizer() { m_containingWindow = NULL; }
 {
 public:
     wxSizer() { m_containingWindow = NULL; }


@@ -456,6 +507,7 @@ public:
                      wxObject* userData = NULL);
     wxSizerItem* Add( wxWindow *window, const wxSizerFlags& flags);
     wxSizerItem* Add( wxSizer *sizer, const wxSizerFlags& flags);
                      wxObject* userData = NULL);
     wxSizerItem* Add( wxWindow *window, const wxSizerFlags& flags);
     wxSizerItem* Add( wxSizer *sizer, const wxSizerFlags& flags);

+    wxSizerItem* Add( int width, int height, const wxSizerFlags& flags);

     wxSizerItem* Add( wxSizerItem *item);
 
     wxSizerItem* AddSpacer(int size);
     wxSizerItem* Add( wxSizerItem *item);
 
     wxSizerItem* AddSpacer(int size);


@@ -486,6 +538,10 @@ public:
     wxSizerItem* Insert(size_t index,
                         wxSizer *sizer,
                         const wxSizerFlags& flags);
     wxSizerItem* Insert(size_t index,
                         wxSizer *sizer,
                         const wxSizerFlags& flags);

+    wxSizerItem* Insert(size_t index,
+                        int width,
+                        int height,
+                        const wxSizerFlags& flags);

     virtual wxSizerItem* Insert( size_t index, wxSizerItem *item);
 
     wxSizerItem* InsertSpacer(size_t index, int size);
     virtual wxSizerItem* Insert( size_t index, wxSizerItem *item);
 
     wxSizerItem* InsertSpacer(size_t index, int size);


@@ -509,6 +565,7 @@ public:
                          wxObject* userData = NULL);
     wxSizerItem* Prepend(wxWindow *window, const wxSizerFlags& flags);
     wxSizerItem* Prepend(wxSizer *sizer, const wxSizerFlags& flags);
                          wxObject* userData = NULL);
     wxSizerItem* Prepend(wxWindow *window, const wxSizerFlags& flags);
     wxSizerItem* Prepend(wxSizer *sizer, const wxSizerFlags& flags);

+    wxSizerItem* Prepend(int width, int height, const wxSizerFlags& flags);

     wxSizerItem* Prepend(wxSizerItem *item);
 
     wxSizerItem* PrependSpacer(int size);
     wxSizerItem* Prepend(wxSizerItem *item);
 
     wxSizerItem* PrependSpacer(int size);


@@ -539,6 +596,11 @@ public:
     virtual void Clear( bool delete_windows = false );
     virtual void DeleteWindows();
 
     virtual void Clear( bool delete_windows = false );
     virtual void DeleteWindows();
 

+    // Inform sizer about the first direction that has been decided (by parent item)
+    // Returns true if it made use of the informtion (and recalculated min size)
+    virtual bool InformFirstDirection( int WXUNUSED(direction), int WXUNUSED(size), int WXUNUSED(availableOtherDir) )
+        { return false; }
+

     void SetMinSize( int width, int height )
         { DoSetMinSize( width, height ); }
     void SetMinSize( const wxSize& size )
     void SetMinSize( int width, int height )
         { DoSetMinSize( width, height ); }
     void SetMinSize( const wxSize& size )


@@ -578,21 +640,38 @@ public:
 
     virtual void Layout();
 
 
     virtual void Layout();
 

+    wxSize ComputeFittingClientSize(wxWindow *window);
+    wxSize ComputeFittingWindowSize(wxWindow *window);
+

     wxSize Fit( wxWindow *window );
     void FitInside( wxWindow *window );
     void SetSizeHints( wxWindow *window );
     wxSize Fit( wxWindow *window );
     void FitInside( wxWindow *window );
     void SetSizeHints( wxWindow *window );

-    void SetVirtualSizeHints( wxWindow *window );
+#if WXWIN_COMPATIBILITY_2_8
+    // This only calls FitInside() since 2.9
+    wxDEPRECATED( void SetVirtualSizeHints( wxWindow *window ) );
+#endif

 
     wxSizerItemList& GetChildren()
         { return m_children; }
     const wxSizerItemList& GetChildren() const
         { return m_children; }
 
 
     wxSizerItemList& GetChildren()
         { return m_children; }
     const wxSizerItemList& GetChildren() const
         { return m_children; }
 

-    void SetDimension( int x, int y, int width, int height );
+    void SetDimension(const wxPoint& pos, const wxSize& size)
+    {
+        m_position = pos;
+        m_size = size;
+        Layout();
+    }
+    void SetDimension(int x, int y, int width, int height)
+        { SetDimension(wxPoint(x, y), wxSize(width, height)); }
+
+    size_t GetItemCount() const { return m_children.GetCount(); }
+    bool IsEmpty() const { return m_children.IsEmpty(); }

 
     wxSizerItem* GetItem( wxWindow *window, bool recursive = false );
     wxSizerItem* GetItem( wxSizer *sizer, bool recursive = false );
     wxSizerItem* GetItem( size_t index );
 
     wxSizerItem* GetItem( wxWindow *window, bool recursive = false );
     wxSizerItem* GetItem( wxSizer *sizer, bool recursive = false );
     wxSizerItem* GetItem( size_t index );

+    wxSizerItem* GetItemById( int id, bool recursive = false );

 
     // Manage whether individual scene items are considered
     // in the layout calculations or not.
 
     // Manage whether individual scene items are considered
     // in the layout calculations or not.


@@ -625,8 +704,6 @@ protected:
     // the window this sizer is used in, can be NULL
     wxWindow *m_containingWindow;
 
     // the window this sizer is used in, can be NULL
     wxWindow *m_containingWindow;
 

-    wxSize GetMaxWindowSize( wxWindow *window ) const;
-    wxSize GetMinWindowSize( wxWindow *window );

     wxSize GetMaxClientSize( wxWindow *window ) const;
     wxSize GetMinClientSize( wxWindow *window );
     wxSize VirtualFitSize( wxWindow *window );
     wxSize GetMaxClientSize( wxWindow *window ) const;
     wxSize GetMinClientSize( wxWindow *window );
     wxSize VirtualFitSize( wxWindow *window );


@@ -644,7 +721,7 @@ private:
 // wxGridSizer
 //---------------------------------------------------------------------------
 
 // wxGridSizer
 //---------------------------------------------------------------------------
 

-class WXDLLEXPORT wxGridSizer: public wxSizer
+class WXDLLIMPEXP_CORE wxGridSizer: public wxSizer

 {
 public:
     wxGridSizer( int rows, int cols, int vgap, int hgap );
 {
 public:
     wxGridSizer( int rows, int cols, int vgap, int hgap );


@@ -695,7 +772,7 @@ enum wxFlexSizerGrowMode
     wxFLEX_GROWMODE_ALL
 };
 
     wxFLEX_GROWMODE_ALL
 };
 

-class WXDLLEXPORT wxFlexGridSizer: public wxGridSizer
+class WXDLLIMPEXP_CORE wxFlexGridSizer: public wxGridSizer

 {
 public:
     // ctors/dtor
 {
 public:
     // ctors/dtor


@@ -711,6 +788,8 @@ public:
     void AddGrowableCol( size_t idx, int proportion = 0 );
     void RemoveGrowableCol( size_t idx );
 
     void AddGrowableCol( size_t idx, int proportion = 0 );
     void RemoveGrowableCol( size_t idx );
 

+    bool IsRowGrowable( size_t idx );
+    bool IsColGrowable( size_t idx );

 
     // the sizer cells may grow in both directions, not grow at all or only
     // grow in one direction but not the other
 
     // the sizer cells may grow in both directions, not grow at all or only
     // grow in one direction but not the other


@@ -735,6 +814,7 @@ public:
 protected:
     void AdjustForFlexDirection();
     void AdjustForGrowables(const wxSize& sz);
 protected:
     void AdjustForFlexDirection();
     void AdjustForGrowables(const wxSize& sz);

+    void FindWidthsAndHeights(int nrows, int ncols);

 
     // the heights/widths of all rows/columns
     wxArrayInt  m_rowHeights,
 
     // the heights/widths of all rows/columns
     wxArrayInt  m_rowHeights,


@@ -765,12 +845,13 @@ private:
 // wxBoxSizer
 //---------------------------------------------------------------------------
 
 // wxBoxSizer
 //---------------------------------------------------------------------------
 

-class WXDLLEXPORT wxBoxSizer: public wxSizer
+class WXDLLIMPEXP_CORE wxBoxSizer: public wxSizer

 {
 public:
     wxBoxSizer(int orient)
     {
         m_orient = orient;
 {
 public:
     wxBoxSizer(int orient)
     {
         m_orient = orient;

+        m_totalProportion = 0;

 
         wxASSERT_MSG( m_orient == wxHORIZONTAL || m_orient == wxVERTICAL,
                       _T("invalid value for wxBoxSizer orientation") );
 
         wxASSERT_MSG( m_orient == wxHORIZONTAL || m_orient == wxVERTICAL,
                       _T("invalid value for wxBoxSizer orientation") );


@@ -789,7 +870,7 @@ public:
 protected:
     // helpers for our code: this returns the component of the given wxSize in
     // the direction of the sizer and in the other direction, respectively
 protected:
     // helpers for our code: this returns the component of the given wxSize in
     // the direction of the sizer and in the other direction, respectively

-    int SizeInMajorDir(const wxSize& sz) const
+    int GetSizeInMajorDir(const wxSize& sz) const

     {
         return m_orient == wxHORIZONTAL ? sz.x : sz.y;
     }
     {
         return m_orient == wxHORIZONTAL ? sz.x : sz.y;
     }


@@ -804,7 +885,7 @@ protected:
         return m_orient == wxHORIZONTAL ? pt.x : pt.y;
     }
 
         return m_orient == wxHORIZONTAL ? pt.x : pt.y;
     }
 

-    int SizeInMinorDir(const wxSize& sz) const
+    int GetSizeInMinorDir(const wxSize& sz) const

     {
         return m_orient == wxHORIZONTAL ? sz.y : sz.x;
     }
     {
         return m_orient == wxHORIZONTAL ? sz.y : sz.x;
     }


@@ -855,7 +936,7 @@ private:
 
 class WXDLLIMPEXP_FWD_CORE wxStaticBox;
 
 
 class WXDLLIMPEXP_FWD_CORE wxStaticBox;
 

-class WXDLLEXPORT wxStaticBoxSizer: public wxBoxSizer
+class WXDLLIMPEXP_CORE wxStaticBoxSizer: public wxBoxSizer

 {
 public:
     wxStaticBoxSizer(wxStaticBox *box, int orient);
 {
 public:
     wxStaticBoxSizer(wxStaticBox *box, int orient);


@@ -887,7 +968,7 @@ private:
 
 #if wxUSE_BUTTON
 
 
 #if wxUSE_BUTTON
 

-class WXDLLEXPORT wxStdDialogButtonSizer: public wxBoxSizer
+class WXDLLIMPEXP_CORE wxStdDialogButtonSizer: public wxBoxSizer

 {
 public:
     // Constructor just creates a new wxBoxSizer, not much else.
 {
 public:
     // Constructor just creates a new wxBoxSizer, not much else.


@@ -956,9 +1037,9 @@ inline void wxSizerItem::SetSpacer(const wxSize& size)
 }
 
 inline void wxSizerItem::SetSpacer(int width, int height)
 }
 
 inline void wxSizerItem::SetSpacer(int width, int height)

-{ 
-    DoSetSpacer(wxSize(width, height)); 
-} 
+{
+    DoSetSpacer(wxSize(width, height));
+}

 
 #endif // WXWIN_COMPATIBILITY_2_8
 
 
 #endif // WXWIN_COMPATIBILITY_2_8
 


@@ -999,6 +1080,12 @@ wxSizer::Add( wxSizer *sizer, const wxSizerFlags& flags )
     return Add( new wxSizerItem(sizer, flags) );
 }
 
     return Add( new wxSizerItem(sizer, flags) );
 }
 

+inline wxSizerItem*
+wxSizer::Add( int width, int height, const wxSizerFlags& flags )
+{
+    return Add( new wxSizerItem(width, height, flags) );
+}
+

 inline wxSizerItem*
 wxSizer::AddSpacer(int size)
 {
 inline wxSizerItem*
 wxSizer::AddSpacer(int size)
 {


@@ -1059,6 +1146,12 @@ wxSizer::Prepend( wxSizer *sizer, const wxSizerFlags& flags )
     return Prepend( new wxSizerItem(sizer, flags) );
 }
 
     return Prepend( new wxSizerItem(sizer, flags) );
 }
 

+inline wxSizerItem*
+wxSizer::Prepend( int width, int height, const wxSizerFlags& flags )
+{
+    return Prepend( new wxSizerItem(width, height, flags) );
+}
+

 inline wxSizerItem*
 wxSizer::Insert( size_t index,
                  wxWindow *window,
 inline wxSizerItem*
 wxSizer::Insert( size_t index,
                  wxWindow *window,


@@ -1105,6 +1198,12 @@ wxSizer::Insert( size_t index, wxSizer *sizer, const wxSizerFlags& flags )
     return Insert( index, new wxSizerItem(sizer, flags) );
 }
 
     return Insert( index, new wxSizerItem(sizer, flags) );
 }
 

+inline wxSizerItem*
+wxSizer::Insert( size_t index, int width, int height, const wxSizerFlags& flags )
+{
+    return Insert( index, new wxSizerItem(width, height, flags) );
+}
+

 inline wxSizerItem*
 wxSizer::InsertSpacer(size_t index, int size)
 {
 inline wxSizerItem*
 wxSizer::InsertSpacer(size_t index, int size)
 {