[wxWidgets.git] / wxPython / src / sizers.i

/////////////////////////////////////////////////////////////////////////////
// Name:        sizers.i
// Purpose:     SWIG definitions of the wxSizer family of classes
//
// Author:      Robin Dunn
//
// Created:     18-Sept-1999
// RCS-ID:      $Id$
// Copyright:   (c) 1999 by Total Control Software
// Licence:     wxWindows license
/////////////////////////////////////////////////////////////////////////////

%module sizers

%{
#include "helpers.h"

#include <wx/notebook.h>
%}

//----------------------------------------------------------------------

%include typemaps.i
%include my_typemaps.i

// Import some definitions of other classes, etc.
%import _defs.i
%import misc.i
%import windows.i
%import controls.i

%pragma(python) code = "import wx"
%pragma(python) code = "import string"

//---------------------------------------------------------------------------


class wxSizerItem : public wxObject {
public:
    // No need to ever create one directly in Python...

    //wxSizerItem( int width, int height, int option, int flag, int border, wxObject* userData);
    //wxSizerItem( wxWindow *window, int option, int flag, int border, wxObject* userData );
    //wxSizerItem( wxSizer *sizer, int option, int flag, int border, wxObject* userData );

    wxPoint GetPosition();
    wxSize GetSize();
    wxSize CalcMin();
    void SetDimension( wxPoint pos, wxSize size );
    %name(SetRatioWH) void SetRatio( int width, int height );
    %name(SetRatioSize) void SetRatio( wxSize size );
    void SetRatio( float ratio );
    float GetRatio();

    bool IsWindow();
    bool IsSizer();
    bool IsSpacer();

    wxWindow *GetWindow();
    void SetWindow( wxWindow *window );
    wxSizer *GetSizer();
    void SetSizer( wxSizer *sizer );
    int GetOption();
    int GetFlag();
    int GetBorder();

    void SetInitSize( int x, int y );
    void SetOption( int option );
    void SetFlag( int flag );
    void SetBorder( int border );

    // wxObject* GetUserData();
    %addmethods {
        // Assume that the user data is a wxPyUserData object and return the contents
        PyObject* GetUserData() {
            wxPyUserData* data = (wxPyUserData*)self->GetUserData();
            if (data) {
                Py_INCREF(data->m_obj);
                return data->m_obj;
            } else {
                Py_INCREF(Py_None);
                return Py_None;
            }
        }
    }
};


//---------------------------------------------------------------------------

class wxSizer : public wxObject {
public:
    // wxSizer();      ****  abstract, can't instantiate
    // ~wxSizer();

    %addmethods {
        void Destroy() { delete self; }

        void AddWindow(wxWindow *window, int option=0, int flag=0, int border=0,
                       PyObject* userData=NULL) {
            wxPyUserData* data = NULL;
            if (userData) data = new wxPyUserData(userData);
            self->Add(window, option, flag, border, data);
        }
        void AddSizer(wxSizer *sizer, int option=0, int flag=0, int border=0,
                      PyObject* userData=NULL) {
            wxPyUserData* data = NULL;
            if (userData) data = new wxPyUserData(userData);
            self->Add(sizer, option, flag, border, data);
        }
        void AddSpacer(int width, int height, int option=0, int flag=0,
                       int border=0, PyObject* userData=NULL) {
            wxPyUserData* data = NULL;
            if (userData) data = new wxPyUserData(userData);
            self->Add(width, height, option, flag, border, data);
        }


        void InsertWindow(int before, wxWindow *window, int option=0, int flag=0,
                          int border=0, PyObject* userData=NULL) {
            wxPyUserData* data = NULL;
            if (userData) data = new wxPyUserData(userData);
            self->Insert(before, window, option, flag, border, data);
        }
        void InsertSizer(int before, wxSizer *sizer, int option=0, int flag=0,
                         int border=0, PyObject* userData=NULL) {
            wxPyUserData* data = NULL;
            if (userData) data = new wxPyUserData(userData);
            self->Insert(before, sizer, option, flag, border, data);
        }
        void InsertSpacer(int before, int width, int height, int option=0, int flag=0,
                          int border=0, PyObject* userData=NULL) {
            wxPyUserData* data = NULL;
            if (userData) data = new wxPyUserData(userData);
            self->Insert(before, width, height, option, flag, border, data);
        }


        void PrependWindow(wxWindow *window, int option=0, int flag=0, int border=0,
                           PyObject* userData=NULL) {
            wxPyUserData* data = NULL;
            if (userData) data = new wxPyUserData(userData);
            self->Prepend(window, option, flag, border, data);
        }
        void PrependSizer(wxSizer *sizer, int option=0, int flag=0, int border=0,
                          PyObject* userData=NULL) {
            wxPyUserData* data = NULL;
            if (userData) data = new wxPyUserData(userData);
            self->Prepend(sizer, option, flag, border, data);
        }
        void PrependSpacer(int width, int height, int option=0, int flag=0,
                           int border=0, PyObject* userData=NULL) {
            wxPyUserData* data = NULL;
            if (userData) data = new wxPyUserData(userData);
            self->Prepend(width, height, option, flag, border, data);
        }
    }

    %name(RemoveWindow)bool Remove( wxWindow *window );
    %name(RemoveSizer)bool Remove( wxSizer *sizer );
    %name(RemovePos)bool Remove( int pos );


    %pragma(python) addtoclass = "
    def Add(self, *args, **kw):
        if type(args[0]) == type(1):
            apply(self.AddSpacer, args, kw)
        elif string.find(args[0].this, 'Sizer') != -1:
            apply(self.AddSizer, args, kw)
        else:
            apply(self.AddWindow, args, kw)

    def Insert(self, *args, **kw):
        if type(args[1]) == type(1):
            apply(self.InsertSpacer, args, kw)
        elif string.find(args[1].this, 'Sizer') != -1:
            apply(self.InsertSizer, args, kw)
        else:
            apply(self.InsertWindow, args, kw)

    def Prepend(self, *args, **kw):
        if type(args[0]) == type(1):
            apply(self.PrependSpacer, args, kw)
        elif string.find(args[0].this, 'Sizer') != -1:
            apply(self.PrependSizer, args, kw)
        else:
            apply(self.PrependWindow, args, kw)

    def Remove(self, *args, **kw):
        if type(args[0]) == type(1):
            apply(self.RemovePos, args, kw)
        elif string.find(args[0].this, 'Sizer') != -1:
            apply(self.RemoveSizer, args, kw)
        else:
            apply(self.RemoveWindow, args, kw)

    def AddMany(self, widgets):
        for childinfo in widgets:
            if type(childinfo) != type(()):
                childinfo = (childinfo, )
            apply(self.Add, childinfo)
"


    void SetDimension( int x, int y, int width, int height );
    void SetMinSize(wxSize size);

    %name(SetItemMinSizeWindow) void SetItemMinSize(wxWindow* window, int width, int height);
    %name(SetItemMinSizeSizer) void SetItemMinSize(wxSizer* sizer, int width, int height);
    %name(SetItemMinSizePos) void SetItemMinSize(int pos, int width, int height);

    %pragma(python) addtoclass = "
    def SetItemMinSize(self, *args):
        if type(args[0]) == type(1):
            apply(self.SetItemMinSizePos, args)
        elif string.find(args[0].this, 'Sizer') != -1:
            apply(self.SetItemMinSizeSizer, args)
        else:
            apply(self.SetItemMinSizeWindow, args)
     "

    wxSize GetSize();
    wxPoint GetPosition();
    wxSize GetMinSize();

    // void RecalcSizes() = 0;
    // wxSize CalcMin() = 0;

    void Layout();

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

    // wxList& GetChildren();
    %addmethods {
        PyObject* GetChildren() {
            wxList& list = self->GetChildren();
            return wxPy_ConvertList(&list, "wxSizerItem");
        }
    }
};


//---------------------------------------------------------------------------
// Use this one for deriving Python classes from
%{
class wxPySizer : public wxSizer {
    DECLARE_DYNAMIC_CLASS(wxPySizer);
public:
    wxPySizer() : wxSizer() {};

    DEC_PYCALLBACK___pure(RecalcSizes);
    DEC_PYCALLBACK_wxSize__pure(CalcMin);
    PYPRIVATE;
};


IMP_PYCALLBACK___pure(wxPySizer, wxSizer, RecalcSizes);
IMP_PYCALLBACK_wxSize__pure(wxPySizer, wxSizer, CalcMin);

IMPLEMENT_DYNAMIC_CLASS(wxPySizer, wxSizer);
%}


class wxPySizer : public wxSizer {
public:
    wxPySizer();
    void _setSelf(PyObject* self, PyObject* _class);
    %pragma(python) addtomethod = "__init__:self._setSelf(self, wxPySizer)"
};


//---------------------------------------------------------------------------

class  wxBoxSizer : public wxSizer {
public:
    wxBoxSizer(int orient = wxHORIZONTAL);
    int GetOrientation();
    void RecalcSizes();
    wxSize CalcMin();
};

//---------------------------------------------------------------------------

class  wxStaticBoxSizer : public wxBoxSizer {
public:
    wxStaticBoxSizer(wxStaticBox *box, int orient = wxHORIZONTAL);
    wxStaticBox *GetStaticBox();
    void RecalcSizes();
    wxSize CalcMin();
};

//---------------------------------------------------------------------------

class wxNotebookSizer: public wxSizer {
public:
    wxNotebookSizer( wxNotebook *nb );

    void RecalcSizes();
    wxSize CalcMin();

    wxNotebook *GetNotebook();
};

//---------------------------------------------------------------------------

class wxGridSizer: public wxSizer
{
public:
    wxGridSizer( int rows=1, int cols=0, int vgap=0, int hgap=0 );

    void RecalcSizes();
    wxSize CalcMin();

    void SetCols( int cols );
    void SetRows( int rows );
    void SetVGap( int gap );
    void SetHGap( int gap );
    int GetCols();
    int GetRows();
    int GetVGap();
    int GetHGap();
};

//---------------------------------------------------------------------------

class wxFlexGridSizer: public wxGridSizer
{
public:
    wxFlexGridSizer( int rows=1, int cols=0, int vgap=0, int hgap=0 );

    void RecalcSizes();
    wxSize CalcMin();

    void AddGrowableRow( size_t idx );
    void RemoveGrowableRow( size_t idx );
    void AddGrowableCol( size_t idx );
    void RemoveGrowableCol( size_t idx );

};

//---------------------------------------------------------------------------
Commit	Line	Data
2f90df85 RD	1	/////////////////////////////////////////////////////////////////////////////
	2	// Name: sizers.i
	3	// Purpose: SWIG definitions of the wxSizer family of classes
	4	//
	5	// Author: Robin Dunn
	6	//
	7	// Created: 18-Sept-1999
	8	// RCS-ID: $Id$
f0261a72	9	// Copyright: (c) 1999 by Total Control Software
2f90df85 RD	10	// Licence: wxWindows license
	11	/////////////////////////////////////////////////////////////////////////////
	12
	13	%module sizers
	14
	15	%{
	16	#include "helpers.h"
9416aa89 RD	17
9416aa89 RD	18	#include <wx/notebook.h>
2f90df85 RD	19	%}
	20
	21	//----------------------------------------------------------------------
	22
	23	%include typemaps.i
	24	%include my_typemaps.i
	25
	26	// Import some definitions of other classes, etc.
	27	%import _defs.i
	28	%import misc.i
	29	%import windows.i
	30	%import controls.i
	31
	32	%pragma(python) code = "import wx"
	33	%pragma(python) code = "import string"
	34
	35	//---------------------------------------------------------------------------
	36
2f90df85	37
9416aa89	38	class wxSizerItem : public wxObject {
2f90df85 RD	39	public:
	40	// No need to ever create one directly in Python...
	41
	42	//wxSizerItem( int width, int height, int option, int flag, int border, wxObject* userData);
	43	//wxSizerItem( wxWindow window, int option, int flag, int border, wxObject userData );
	44	//wxSizerItem( wxSizer sizer, int option, int flag, int border, wxObject userData );
	45
09f3d4e6	46	wxPoint GetPosition();
2f90df85 RD	47	wxSize GetSize();
	48	wxSize CalcMin();
	49	void SetDimension( wxPoint pos, wxSize size );
f6bcfd97 BP	50	%name(SetRatioWH) void SetRatio( int width, int height );
	51	%name(SetRatioSize) void SetRatio( wxSize size );
	52	void SetRatio( float ratio );
	53	float GetRatio();
2f90df85 RD	54
	55	bool IsWindow();
	56	bool IsSizer();
	57	bool IsSpacer();
	58
	59	wxWindow *GetWindow();
f6bcfd97	60	void SetWindow( wxWindow *window );
2f90df85	61	wxSizer *GetSizer();
f6bcfd97	62	void SetSizer( wxSizer *sizer );
2f90df85 RD	63	int GetOption();
	64	int GetFlag();
	65	int GetBorder();
	66
9b3d3bc4 RD	67	void SetInitSize( int x, int y );
	68	void SetOption( int option );
	69	void SetFlag( int flag );
	70	void SetBorder( int border );
	71
2f90df85 RD	72	// wxObject* GetUserData();
	73	%addmethods {
	74	// Assume that the user data is a wxPyUserData object and return the contents
	75	PyObject* GetUserData() {
	76	wxPyUserData* data = (wxPyUserData*)self->GetUserData();
	77	if (data) {
	78	Py_INCREF(data->m_obj);
	79	return data->m_obj;
	80	} else {
	81	Py_INCREF(Py_None);
	82	return Py_None;
	83	}
	84	}
	85	}
	86	};
	87
	88
	89	//---------------------------------------------------------------------------
	90
9416aa89	91	class wxSizer : public wxObject {
2f90df85 RD	92	public:
	93	// wxSizer(); **** abstract, can't instantiate
	94	// ~wxSizer();
	95
	96	%addmethods {
	97	void Destroy() { delete self; }
	98
	99	void AddWindow(wxWindow *window, int option=0, int flag=0, int border=0,
	100	PyObject* userData=NULL) {
	101	wxPyUserData* data = NULL;
	102	if (userData) data = new wxPyUserData(userData);
	103	self->Add(window, option, flag, border, data);
	104	}
2f90df85 RD	105	void AddSizer(wxSizer *sizer, int option=0, int flag=0, int border=0,
	106	PyObject* userData=NULL) {
	107	wxPyUserData* data = NULL;
	108	if (userData) data = new wxPyUserData(userData);
	109	self->Add(sizer, option, flag, border, data);
	110	}
2f90df85 RD	111	void AddSpacer(int width, int height, int option=0, int flag=0,
	112	int border=0, PyObject* userData=NULL) {
	113	wxPyUserData* data = NULL;
	114	if (userData) data = new wxPyUserData(userData);
	115	self->Add(width, height, option, flag, border, data);
	116	}
	117
	118
f6bcfd97 BP	119	void InsertWindow(int before, wxWindow *window, int option=0, int flag=0,
	120	int border=0, PyObject* userData=NULL) {
	121	wxPyUserData* data = NULL;
	122	if (userData) data = new wxPyUserData(userData);
	123	self->Insert(before, window, option, flag, border, data);
	124	}
	125	void InsertSizer(int before, wxSizer *sizer, int option=0, int flag=0,
	126	int border=0, PyObject* userData=NULL) {
	127	wxPyUserData* data = NULL;
	128	if (userData) data = new wxPyUserData(userData);
	129	self->Insert(before, sizer, option, flag, border, data);
	130	}
	131	void InsertSpacer(int before, int width, int height, int option=0, int flag=0,
	132	int border=0, PyObject* userData=NULL) {
	133	wxPyUserData* data = NULL;
	134	if (userData) data = new wxPyUserData(userData);
	135	self->Insert(before, width, height, option, flag, border, data);
	136	}
	137
	138
2f90df85 RD	139	void PrependWindow(wxWindow *window, int option=0, int flag=0, int border=0,
	140	PyObject* userData=NULL) {
	141	wxPyUserData* data = NULL;
	142	if (userData) data = new wxPyUserData(userData);
	143	self->Prepend(window, option, flag, border, data);
	144	}
2f90df85 RD	145	void PrependSizer(wxSizer *sizer, int option=0, int flag=0, int border=0,
	146	PyObject* userData=NULL) {
	147	wxPyUserData* data = NULL;
	148	if (userData) data = new wxPyUserData(userData);
	149	self->Prepend(sizer, option, flag, border, data);
	150	}
2f90df85 RD	151	void PrependSpacer(int width, int height, int option=0, int flag=0,
	152	int border=0, PyObject* userData=NULL) {
	153	wxPyUserData* data = NULL;
	154	if (userData) data = new wxPyUserData(userData);
	155	self->Prepend(width, height, option, flag, border, data);
	156	}
	157	}
	158
	159	%name(RemoveWindow)bool Remove( wxWindow *window );
	160	%name(RemoveSizer)bool Remove( wxSizer *sizer );
	161	%name(RemovePos)bool Remove( int pos );
	162
	163
	164	%pragma(python) addtoclass = "
d1679124	165	def Add(self, args, *kw):
2f90df85	166	if type(args[0]) == type(1):
d1679124	167	apply(self.AddSpacer, args, kw)
2f90df85	168	elif string.find(args[0].this, 'Sizer') != -1:
d1679124	169	apply(self.AddSizer, args, kw)
2f90df85	170	else:
d1679124	171	apply(self.AddWindow, args, kw)
2f90df85	172
d1679124	173	def Insert(self, args, *kw):
c368d904	174	if type(args[1]) == type(1):
d1679124	175	apply(self.InsertSpacer, args, kw)
c368d904	176	elif string.find(args[1].this, 'Sizer') != -1:
d1679124	177	apply(self.InsertSizer, args, kw)
f6bcfd97	178	else:
d1679124	179	apply(self.InsertWindow, args, kw)
f6bcfd97	180
d1679124	181	def Prepend(self, args, *kw):
2f90df85	182	if type(args[0]) == type(1):
d1679124	183	apply(self.PrependSpacer, args, kw)
2f90df85	184	elif string.find(args[0].this, 'Sizer') != -1:
d1679124	185	apply(self.PrependSizer, args, kw)
2f90df85	186	else:
d1679124	187	apply(self.PrependWindow, args, kw)
2f90df85	188
d1679124	189	def Remove(self, args, *kw):
2f90df85	190	if type(args[0]) == type(1):
d1679124	191	apply(self.RemovePos, args, kw)
2f90df85	192	elif string.find(args[0].this, 'Sizer') != -1:
d1679124	193	apply(self.RemoveSizer, args, kw)
2f90df85	194	else:
d1679124	195	apply(self.RemoveWindow, args, kw)
2f90df85 RD	196
	197	def AddMany(self, widgets):
	198	for childinfo in widgets:
	199	if type(childinfo) != type(()):
	200	childinfo = (childinfo, )
	201	apply(self.Add, childinfo)
	202	"
	203
	204
	205	void SetDimension( int x, int y, int width, int height );
f6bcfd97 BP	206	void SetMinSize(wxSize size);
	207
	208	%name(SetItemMinSizeWindow) void SetItemMinSize(wxWindow* window, int width, int height);
	209	%name(SetItemMinSizeSizer) void SetItemMinSize(wxSizer* sizer, int width, int height);
	210	%name(SetItemMinSizePos) void SetItemMinSize(int pos, int width, int height);
	211
	212	%pragma(python) addtoclass = "
	213	def SetItemMinSize(self, *args):
	214	if type(args[0]) == type(1):
	215	apply(self.SetItemMinSizePos, args)
	216	elif string.find(args[0].this, 'Sizer') != -1:
	217	apply(self.SetItemMinSizeSizer, args)
	218	else:
	219	apply(self.SetItemMinSizeWindow, args)
	220	"
2f90df85 RD	221
	222	wxSize GetSize();
	223	wxPoint GetPosition();
	224	wxSize GetMinSize();
	225
	226	// void RecalcSizes() = 0;
	227	// wxSize CalcMin() = 0;
	228
	229	void Layout();
	230
	231	void Fit( wxWindow *window );
	232	void SetSizeHints( wxWindow *window );
	233
	234	// wxList& GetChildren();
	235	%addmethods {
	236	PyObject* GetChildren() {
	237	wxList& list = self->GetChildren();
	238	return wxPy_ConvertList(&list, "wxSizerItem");
	239	}
	240	}
	241	};
	242
	243
	244	//---------------------------------------------------------------------------
	245	// Use this one for deriving Python classes from
	246	%{
	247	class wxPySizer : public wxSizer {
	248	DECLARE_DYNAMIC_CLASS(wxPySizer);
	249	public:
	250	wxPySizer() : wxSizer() {};
	251
	252	DEC_PYCALLBACK___pure(RecalcSizes);
	253	DEC_PYCALLBACK_wxSize__pure(CalcMin);
	254	PYPRIVATE;
	255	};
	256
	257
	258	IMP_PYCALLBACK___pure(wxPySizer, wxSizer, RecalcSizes);
	259	IMP_PYCALLBACK_wxSize__pure(wxPySizer, wxSizer, CalcMin);
	260
	261	IMPLEMENT_DYNAMIC_CLASS(wxPySizer, wxSizer);
	262	%}
	263
	264
	265
	266	class wxPySizer : public wxSizer {
	267	public:
	268	wxPySizer();
f6bcfd97 BP	269	void _setSelf(PyObject* self, PyObject* _class);
f6bcfd97 BP	270	%pragma(python) addtomethod = "__init__:self._setSelf(self, wxPySizer)"
2f90df85 RD	271	};
	272
	273
	274	//---------------------------------------------------------------------------
	275
	276	class wxBoxSizer : public wxSizer {
	277	public:
	278	wxBoxSizer(int orient = wxHORIZONTAL);
	279	int GetOrientation();
f6bcfd97 BP	280	void RecalcSizes();
f6bcfd97 BP	281	wxSize CalcMin();
2f90df85 RD	282	};
	283
	284	//---------------------------------------------------------------------------
	285
	286	class wxStaticBoxSizer : public wxBoxSizer {
	287	public:
	288	wxStaticBoxSizer(wxStaticBox *box, int orient = wxHORIZONTAL);
	289	wxStaticBox *GetStaticBox();
f6bcfd97 BP	290	void RecalcSizes();
	291	wxSize CalcMin();
	292	};
	293
	294	//---------------------------------------------------------------------------
	295
	296	class wxNotebookSizer: public wxSizer {
	297	public:
	298	wxNotebookSizer( wxNotebook *nb );
	299
	300	void RecalcSizes();
	301	wxSize CalcMin();
	302
	303	wxNotebook *GetNotebook();
	304	};
	305
	306	//---------------------------------------------------------------------------
	307
	308	class wxGridSizer: public wxSizer
	309	{
	310	public:
	311	wxGridSizer( int rows=1, int cols=0, int vgap=0, int hgap=0 );
	312
	313	void RecalcSizes();
	314	wxSize CalcMin();
	315
	316	void SetCols( int cols );
	317	void SetRows( int rows );
	318	void SetVGap( int gap );
	319	void SetHGap( int gap );
	320	int GetCols();
	321	int GetRows();
	322	int GetVGap();
	323	int GetHGap();
	324	};
	325
	326	//---------------------------------------------------------------------------
	327
	328	class wxFlexGridSizer: public wxGridSizer
	329	{
	330	public:
	331	wxFlexGridSizer( int rows=1, int cols=0, int vgap=0, int hgap=0 );
	332
	333	void RecalcSizes();
	334	wxSize CalcMin();
	335
	336	void AddGrowableRow( size_t idx );
	337	void RemoveGrowableRow( size_t idx );
	338	void AddGrowableCol( size_t idx );
	339	void RemoveGrowableCol( size_t idx );
	340
2f90df85 RD	341	};
	342
	343	//---------------------------------------------------------------------------