clear up wxStringBuffer docs a bit

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

diff --git a/include/wx/sizer.h b/include/wx/sizer.h
index d0299b4f39fcaf7070d3d0d8df761aaf79f97c75..374b1559dc2dced184d7fb7492bfdf7cef189805 100644 (file)
--- a/include/wx/sizer.h
+++ b/include/wx/sizer.h
@@ -2,7 +2,7 @@
 // Name:        sizer.h
 // Purpose:     provide wxSizer class for layout
 // Author:      Robert Roebling and Robin Dunn
 // Name:        sizer.h
 // Purpose:     provide wxSizer class for layout
 // Author:      Robert Roebling and Robin Dunn

-// Modified by: Ron Lee
+// Modified by: Ron Lee, Vadim Zeitlin (wxSizerFlags)

 // Created:
 // RCS-ID:      $Id$
 // Copyright:   (c) Robin Dunn, Robert Roebling
 // Created:
 // RCS-ID:      $Id$
 // Copyright:   (c) Robin Dunn, Robert Roebling


@@ -31,6 +31,74 @@ class WXDLLEXPORT wxSizerItem;
 class WXDLLEXPORT wxSizer;
 class WXDLLEXPORT wxBoxSizer;
 
 class WXDLLEXPORT wxSizer;
 class WXDLLEXPORT wxBoxSizer;
 

+
+// ----------------------------------------------------------------------------
+// wxSizerFlags: flags used for an item in the sizer
+// ----------------------------------------------------------------------------
+
+class WXDLLEXPORT wxSizerFlags
+{
+public:
+    // construct the flags object initialized with the given proportion (0 by
+    // default)
+    wxSizerFlags(int proportion = 0) : m_proportion(proportion)
+    {
+        m_flags = 0;
+        m_borderInPixels = 0;
+    }
+
+    // setters for all sizer flags, they all return the object itself so that
+    // calls to them can be chained
+
+    wxSizerFlags& Proportion(int proportion)
+    {
+        m_proportion = proportion;
+        return *this;
+    }
+
+    wxSizerFlags& Align(int alignment) // combination of wxAlignment values
+    {
+        m_flags &= wxALL;
+        m_flags |= alignment;
+
+        return *this;
+    }
+
+    // some shortcuts for Align()
+    wxSizerFlags& Expand() { return Align(wxEXPAND); }
+    wxSizerFlags& Centre() { return Align(wxCENTRE); }
+    wxSizerFlags& Center() { return Centre(); }
+
+
+    wxSizerFlags& Border(int direction, int borderInPixels)
+    {
+        m_flags &= ~wxALL;
+        m_flags |= direction;
+
+        m_borderInPixels = borderInPixels;
+
+        return *this;
+    }
+
+    wxSizerFlags& Border(int direction = wxALL)
+    {
+        // FIXME: default border size shouldn't be hardcoded
+        return Border(direction, 5);
+    }
+
+
+    // accessors for wxSizer only
+    int GetProportion() const { return m_proportion; }
+    int GetFlags() const { return m_flags; }
+    int GetBorderInPixels() const { return m_borderInPixels; }
+
+private:
+    int m_proportion;
+    int m_flags;
+    int m_borderInPixels;
+};
+
+

 //---------------------------------------------------------------------------
 // wxSizerItem
 //---------------------------------------------------------------------------
 //---------------------------------------------------------------------------
 // wxSizerItem
 //---------------------------------------------------------------------------


@@ -38,13 +106,21 @@ class WXDLLEXPORT wxBoxSizer;
 class WXDLLEXPORT wxSizerItem: public wxObject
 {
 public:
 class WXDLLEXPORT wxSizerItem: public wxObject
 {
 public:

-    // spacer
-    wxSizerItem( int width,
-                 int height,
-                 int proportion,
-                 int flag,
-                 int border,
-                 wxObject* userData);
+    // window with flags
+    wxSizerItem(wxWindow *window, const wxSizerFlags& flags)
+    {
+        Init(flags);
+
+        m_window = window;
+    }
+
+    // sizer with flags
+    wxSizerItem(wxSizer *sizer, const wxSizerFlags& flags)
+    {
+        Init(flags);
+
+        m_sizer = sizer;
+    }

 
     // window
     wxSizerItem( wxWindow *window,
 
     // window
     wxSizerItem( wxWindow *window,


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

+    // spacer
+    wxSizerItem( int width,
+                 int height,
+                 int proportion,
+                 int flag,
+                 int border,
+                 wxObject* userData);
+

     wxSizerItem();
     virtual ~wxSizerItem();
 
     wxSizerItem();
     virtual ~wxSizerItem();
 


@@ -142,6 +226,13 @@ public:
         { return m_pos; }
 
 protected:
         { return m_pos; }
 
 protected:

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

     wxWindow    *m_window;
     wxSizer     *m_sizer;
     wxSize       m_size;
     wxWindow    *m_window;
     wxSizer     *m_sizer;
     wxSize       m_size;


@@ -182,71 +273,82 @@ public:
 
     // methods for adding elements to the sizer: there are Add/Insert/Prepend
     // overloads for each of window/sizer/spacer/wxSizerItem
 
     // methods for adding elements to the sizer: there are Add/Insert/Prepend
     // overloads for each of window/sizer/spacer/wxSizerItem

-    void Add( wxWindow *window,
-              int proportion = 0,
-              int flag = 0,
-              int border = 0,
-              wxObject* userData = NULL );
-    void Add( wxSizer *sizer,
-              int proportion = 0,
-              int flag = 0,
-              int border = 0,
-              wxObject* userData = NULL );
-    void Add( int width,
-              int height,
-              int proportion = 0,
-              int flag = 0,
-              int border = 0,
-              wxObject* userData = NULL );
-    void Add( wxSizerItem *item );
-
-    void AddSpacer(int size);
-    void AddStretchSpacer(int prop = 1);
-
-    void Insert( size_t index,
-                 wxWindow *window,
-                 int proportion = 0,
-                 int flag = 0,
-                 int border = 0,
-                 wxObject* userData = NULL );
-    void Insert( size_t index,
-                 wxSizer *sizer,
-                 int proportion = 0,
-                 int flag = 0,
-                 int border = 0,
-                 wxObject* userData = NULL );
-    void Insert( size_t index,
-                 int width,
-                 int height,
-                 int proportion = 0,
-                 int flag = 0,
-                 int border = 0,
-                 wxObject* userData = NULL );
+    inline void Add( wxWindow *window,
+                     int proportion = 0,
+                     int flag = 0,
+                     int border = 0,
+                     wxObject* userData = NULL );
+    inline void Add( wxSizer *sizer,
+                     int proportion = 0,
+                     int flag = 0,
+                     int border = 0,
+                     wxObject* userData = NULL );
+    inline void Add( int width,
+                     int height,
+                     int proportion = 0,
+                     int flag = 0,
+                     int border = 0,
+                     wxObject* userData = NULL );
+    inline void Add( wxWindow *window, const wxSizerFlags& flags );
+    inline void Add( wxSizer *sizer, const wxSizerFlags& flags );
+    inline void Add( wxSizerItem *item );
+
+    inline void AddSpacer(int size);
+    inline void AddStretchSpacer(int prop = 1);
+
+    inline void Insert( size_t index,
+                        wxWindow *window,
+                        int proportion = 0,
+                        int flag = 0,
+                        int border = 0,
+                        wxObject* userData = NULL );
+    inline void Insert( size_t index,
+                        wxSizer *sizer,
+                        int proportion = 0,
+                        int flag = 0,
+                        int border = 0,
+                        wxObject* userData = NULL );
+    inline void Insert( size_t index,
+                        int width,
+                        int height,
+                        int proportion = 0,
+                        int flag = 0,
+                        int border = 0,
+                        wxObject* userData = NULL );
+    inline void Insert( size_t index,
+                        wxWindow *window,
+                        const wxSizerFlags& flags );
+    inline void Insert( size_t index,
+                        wxSizer *sizer,
+                        const wxSizerFlags& flags );

     virtual void Insert( size_t index, wxSizerItem *item );
 
     virtual void Insert( size_t index, wxSizerItem *item );
 

-    void InsertSpacer(size_t index, int size);
-    void InsertStretchSpacer(size_t index, int prop = 1);
-
-    void Prepend( wxWindow *window,
-                  int proportion = 0,
-                  int flag = 0,
-                  int border = 0,
-                  wxObject* userData = NULL );
-    void Prepend( wxSizer *sizer,
-                  int proportion = 0,
-                  int flag = 0,
-                  int border = 0,
-                  wxObject* userData = NULL );
-    void Prepend( int width,
-                  int height,
-                  int proportion = 0,
-                  int flag = 0,
-                  int border = 0,
-                  wxObject* userData = NULL );
-    void Prepend( wxSizerItem *item );
-
-    void PrependSpacer(int size);
-    void PrependStretchSpacer(int prop = 1);
+    inline void InsertSpacer(size_t index, int size);
+    inline void InsertStretchSpacer(size_t index, int prop = 1);
+
+    inline void Prepend( wxWindow *window,
+                         int proportion = 0,
+                         int flag = 0,
+                         int border = 0,
+                         wxObject* userData = NULL );
+    inline void Prepend( wxSizer *sizer,
+                         int proportion = 0,
+                         int flag = 0,
+                         int border = 0,
+                         wxObject* userData = NULL );
+    inline void Prepend( int width,
+                         int height,
+                         int proportion = 0,
+                         int flag = 0,
+                         int border = 0,
+                         wxObject* userData = NULL );
+    inline void Prepend( wxWindow *window, const wxSizerFlags& flags );
+    inline void Prepend( wxSizer *sizer, const wxSizerFlags& flags );
+    inline void Prepend( wxSizerItem *item );
+
+    inline void PrependSpacer(int size);
+    inline void PrependStretchSpacer(int prop = 1);
+

 
     // Deprecated in 2.6 since historically it does not delete the window,
     // use Detach instead.
 
     // Deprecated in 2.6 since historically it does not delete the window,
     // use Detach instead.


@@ -306,6 +408,10 @@ public:
 
     void SetDimension( int x, int y, int width, int height );
 
 
     void SetDimension( int x, int y, int width, int height );
 

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

     // Manage whether individual scene items are considered
     // in the layout calculations or not.
     bool Show( wxWindow *window, bool show = true, bool recursive = false );
     // Manage whether individual scene items are considered
     // in the layout calculations or not.
     bool Show( wxWindow *window, bool show = true, bool recursive = false );


@@ -543,7 +649,7 @@ private:
 
 #if wxUSE_BOOKCTRL
 
 
 #if wxUSE_BOOKCTRL
 

-// this sizer works with wxNotebook/wxListbook/wxChoicebook... and sizes the control to
+// this sizer works with wxNotebook/wxListbook/... and sizes the control to

 // fit its pages
 class WXDLLEXPORT wxBookCtrl;
 
 // fit its pages
 class WXDLLEXPORT wxBookCtrl;
 


@@ -594,6 +700,164 @@ private:
 
 #endif // WXWIN_COMPATIBILITY_2_4
 
 
 #endif // WXWIN_COMPATIBILITY_2_4
 

+// ----------------------------------------------------------------------------
+// inline functions implementation
+// ----------------------------------------------------------------------------
+
+inline void
+wxSizer::Add( wxWindow *window, int proportion, int flag, int border, wxObject* userData )
+{
+    Add( new wxSizerItem( window, proportion, flag, border, userData ) );
+}
+
+inline void
+wxSizer::Add( wxSizer *sizer, int proportion, int flag, int border, wxObject* userData )
+{
+    Add( new wxSizerItem( sizer, proportion, flag, border, userData ) );
+}
+
+inline void
+wxSizer::Add( int width, int height, int proportion, int flag, int border, wxObject* userData )
+{
+    Add( new wxSizerItem( width, height, proportion, flag, border, userData ) );
+}
+
+inline void
+wxSizer::Add( wxWindow *window, const wxSizerFlags& flags )
+{
+    Add( new wxSizerItem(window, flags) );
+}
+
+inline void
+wxSizer::Add( wxSizer *sizer, const wxSizerFlags& flags )
+{
+    Add( new wxSizerItem(sizer, flags) );
+}
+
+inline void
+wxSizer::Add( wxSizerItem *item )
+{
+    Insert( m_children.GetCount(), item );
+}
+
+inline void
+wxSizer::AddSpacer(int size)
+{
+    Add(size, size);
+}
+
+inline void
+wxSizer::AddStretchSpacer(int prop)
+{
+    Add(0, 0, prop);
+}
+
+inline void
+wxSizer::Prepend( wxWindow *window, int proportion, int flag, int border, wxObject* userData )
+{
+    Prepend( new wxSizerItem( window, proportion, flag, border, userData ) );
+}
+
+inline void
+wxSizer::Prepend( wxSizer *sizer, int proportion, int flag, int border, wxObject* userData )
+{
+    Prepend( new wxSizerItem( sizer, proportion, flag, border, userData ) );
+}
+
+inline void
+wxSizer::Prepend( int width, int height, int proportion, int flag, int border, wxObject* userData )
+{
+    Prepend( new wxSizerItem( width, height, proportion, flag, border, userData ) );
+}
+
+inline void
+wxSizer::Prepend( wxSizerItem *item )
+{
+    Insert( 0, item );
+}
+
+inline void
+wxSizer::PrependSpacer(int size)
+{
+    Prepend(size, size);
+}
+
+inline void
+wxSizer::PrependStretchSpacer(int prop)
+{
+    Prepend(0, 0, prop);
+}
+
+inline void
+wxSizer::Prepend( wxWindow *window, const wxSizerFlags& flags )
+{
+    Prepend( new wxSizerItem(window, flags) );
+}
+
+inline void
+wxSizer::Prepend( wxSizer *sizer, const wxSizerFlags& flags )
+{
+    Prepend( new wxSizerItem(sizer, flags) );
+}
+
+inline void
+wxSizer::Insert( size_t index,
+                 wxWindow *window,
+                 int proportion,
+                 int flag,
+                 int border,
+                 wxObject* userData )
+{
+    Insert( index, new wxSizerItem( window, proportion, flag, border, userData ) );
+}
+
+inline void
+wxSizer::Insert( size_t index,
+                 wxSizer *sizer,
+                 int proportion,
+                 int flag,
+                 int border,
+                 wxObject* userData )
+{
+    Insert( index, new wxSizerItem( sizer, proportion, flag, border, userData ) );
+}
+
+inline void
+wxSizer::Insert( size_t index,
+                 int width,
+                 int height,
+                 int proportion,
+                 int flag,
+                 int border,
+                 wxObject* userData )
+{
+    Insert( index, new wxSizerItem( width, height, proportion, flag, border, userData ) );
+}
+
+inline void
+wxSizer::Insert( size_t index, wxWindow *window, const wxSizerFlags& flags )
+{
+    Insert( index, new wxSizerItem(window, flags) );
+}
+
+inline void
+wxSizer::Insert( size_t index, wxSizer *sizer, const wxSizerFlags& flags )
+{
+    Insert( index, new wxSizerItem(sizer, flags) );
+}
+
+inline void
+wxSizer::InsertSpacer(size_t index, int size)
+{
+    Insert(index, size, size);
+}
+
+inline void
+wxSizer::InsertStretchSpacer(size_t index, int prop)
+{
+    Insert(index, 0, 0, prop);
+}
+

 
 #endif // __WXSIZER_H__
 
 
 #endif // __WXSIZER_H__