wxHTML classes description is now in alphabetical order

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

diff --git a/include/wx/sizer.h b/include/wx/sizer.h
index 140b6cb5b402cb39820e104935ecc537e852d580..c94ebfee7187fa6e9e546391f7eb3a9be447ced5 100644 (file)
--- a/include/wx/sizer.h
+++ b/include/wx/sizer.h
@@ -1,9 +1,9 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        sizer.h
-// Purpose:     provide wxNewSizer class for layounting
+// Purpose:     provide wxSizer class for layouting
 // Author:      Robert Roebling and Robin Dunn
 // Modified by:
-// Created:     
+// Created:
 // RCS-ID:      $Id$
 // Copyright:   (c) Robin Dunn, Dirk Holtwick and Robert Roebling
 // Licence:     wxWindows licence
@@ -26,38 +26,43 @@
 // classes
 //---------------------------------------------------------------------------
 
-class wxNewSizerItem;
-class wxNewSizer;
-class wxBorderNewSizer;
-class wxBoxNewSizer;
+class wxStaticBox;
+
+class wxSizerItem;
+class wxSizer;
+class wxBoxSizer;
+class wxStaticBoxSizer;
 
 //---------------------------------------------------------------------------
-// wxNewSizerItem
+// wxSizerItem
 //---------------------------------------------------------------------------
 
-class WXDLLEXPORT wxNewSizerItem: public wxObject
+class WXDLLEXPORT wxSizerItem: public wxObject
 {
+    DECLARE_CLASS(wxSizerItem);
 public:
   // spacer
-  wxNewSizerItem( int width, int height, int option, int flag, int border );
+  wxSizerItem( int width, int height, int option, int flag, int border, wxObject* userData);
 
   // window
-  wxNewSizerItem( wxWindow *window, int option, int flag, int border );
+  wxSizerItem( wxWindow *window, int option, int flag, int border, wxObject* userData );
 
   // subsizer
-  wxNewSizerItem( wxNewSizer *sizer, int option, int flag, int border );
+  wxSizerItem( wxSizer *sizer, int option, int flag, int border, wxObject* userData );
+
+  ~wxSizerItem();
 
   virtual wxSize GetSize();
   virtual wxSize CalcMin();
   virtual void SetDimension( wxPoint pos, wxSize size );
-  
+
   bool IsWindow();
-  bool IsNewSizer();
+  bool IsSizer();
   bool IsSpacer();
-  
-  wxWindow *GetWindow() const  
+
+  wxWindow *GetWindow() const
     { return m_window; }
-  wxNewSizer *GetNewSizer() const    
+  wxSizer *GetSizer() const
     { return m_sizer; }
   int GetOption() const
     { return m_option; }
@@ -65,33 +70,45 @@ public:
     { return m_flag; }
   int GetBorder() const
     { return m_border; }
-  
+  wxObject* GetUserData()
+    { return m_userData; }
+
 protected:
   wxWindow    *m_window;
-  wxNewSizer     *m_sizer;
+  wxSizer     *m_sizer;
   wxSize       m_size;
   wxSize       m_minSize;
   int          m_option;
   int          m_border;
   int          m_flag;
+  wxObject    *m_userData;
 };
 
 //---------------------------------------------------------------------------
-// wxNewSizer
+// wxSizer
 //---------------------------------------------------------------------------
 
-class WXDLLEXPORT wxNewSizer: public wxObject
+class WXDLLEXPORT wxSizer: public wxObject
 {
+    DECLARE_CLASS(wxSizer);
 public:
-   wxNewSizer();
-   ~wxNewSizer();
-   
-   virtual void Add( wxWindow *window, int option = 0, int flag = 0, int border = 0 );
-   virtual void Add( wxNewSizer *sizer, int option = 0, int flag = 0, int border = 0 );
-   virtual void Add( int width, int height, int option = 0, int flag = 0, int border = 0  );
-  
+   wxSizer();
+   ~wxSizer();
+
+   virtual void Add( wxWindow *window, int option = 0, int flag = 0, int border = 0, wxObject* userData = NULL );
+   virtual void Add( wxSizer *sizer, int option = 0, int flag = 0, int border = 0, wxObject* userData = NULL );
+   virtual void Add( int width, int height, int option = 0, int flag = 0, int border = 0, wxObject* userData = NULL );
+
+   virtual void Prepend( wxWindow *window, int option = 0, int flag = 0, int border = 0, wxObject* userData = NULL );
+   virtual void Prepend( wxSizer *sizer, int option = 0, int flag = 0, int border = 0, wxObject* userData = NULL );
+   virtual void Prepend( int width, int height, int option = 0, int flag = 0, int border = 0, wxObject* userData = NULL );
+
+   virtual bool Remove( wxWindow *window );
+   virtual bool Remove( wxSizer *sizer );
+   virtual bool Remove( int pos );
+
    void SetDimension( int x, int y, int width, int height );
-  
+
    wxSize GetSize()
      { return m_size; }
    wxPoint GetPosition()
@@ -101,35 +118,39 @@ public:
 
    virtual void RecalcSizes() = 0;
    virtual wxSize CalcMin() = 0;
-   
+
    virtual void Layout();
 
    void Fit( wxWindow *window );
    void SetSizeHints( wxWindow *window );
-   
+
+  wxList& GetChildren()
+    { return m_children; }
+
 protected:
    wxSize  m_size;
    wxPoint m_position;
    wxList  m_children;
-   
+
    wxSize GetMinWindowSize( wxWindow *window );
 };
 
 //---------------------------------------------------------------------------
-// wxBox
+// wxBoxSizer
 //---------------------------------------------------------------------------
 
-class WXDLLEXPORT wxBox: public wxNewSizer
+class WXDLLEXPORT wxBoxSizer: public wxSizer
 {
+    DECLARE_CLASS(wxBoxSizer);
 public:
-   wxBox( int orient );
-   
+   wxBoxSizer( int orient );
+
    void RecalcSizes();
    wxSize CalcMin();
-   
+
    int GetOrientation()
      { return m_orient; }
-   
+
 protected:
     int m_orient;
     int m_stretchable;
@@ -138,6 +159,26 @@ protected:
     int m_fixedWidth;
     int m_fixedHeight;
 };
-  
+
+//---------------------------------------------------------------------------
+// wxStaticBoxSizer
+//---------------------------------------------------------------------------
+
+class WXDLLEXPORT wxStaticBoxSizer: public wxBoxSizer
+{
+    DECLARE_CLASS(wxStaticBoxSizer);
+public:
+   wxStaticBoxSizer( wxStaticBox *box, int orient );
+
+   void RecalcSizes();
+   wxSize CalcMin();
+
+   wxStaticBox *GetStaticBox()
+     { return m_staticBox; }
+
+protected:
+   wxStaticBox   *m_staticBox;
+};
+
 #endif
   // __WXSIZER_H__