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

/////////////////////////////////////////////////////////////////////////////
// Name:        stattool.i
// Purpose:     SWIG definitions for StatusBar and ToolBar classes
//
// Author:      Robin Dunn
//
// Created:     08/24/1998
// RCS-ID:      $Id$
// Copyright:   (c) 1998 by Total Control Software
// Licence:     wxWindows license
/////////////////////////////////////////////////////////////////////////////


%module stattool

%{
#include "helpers.h"
#include <wx/toolbar.h>
#include <wx/tbarsmpl.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"


%{
    static wxString wxPyEmptyStr("");
%}

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

class wxStatusBar : public wxWindow {
public:
    wxStatusBar(wxWindow* parent, wxWindowID id = -1,
                long style = wxST_SIZEGRIP,
                char* name = "statusBar");
    %name(wxPreStatusBar)wxStatusBar();

    bool Create(wxWindow* parent, wxWindowID id,
                long style = wxST_SIZEGRIP,
                char* name = "statusBar");

    %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
    %pragma(python) addtomethod = "wxPreStatusBar:val._setOORInfo(val)"

    %addmethods {
        %new wxRect* GetFieldRect(long item) {
            wxRect* rect= new wxRect;
            self->GetFieldRect(item, *rect);
            return rect;
        }
    }
    int GetFieldsCount(void);
    wxString GetStatusText(int ir = 0);
    int GetBorderX();
    int GetBorderY();

    void SetFieldsCount(int number = 1);
    void SetStatusText(const wxString& text, int i = 0);
    void SetStatusWidths(int LCOUNT, int* choices);
    void SetMinHeight(int height);
};


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

class wxToolBarBase;

enum wxToolBarToolStyle
{
    wxTOOL_STYLE_BUTTON    = 1,
    wxTOOL_STYLE_SEPARATOR = 2,
    wxTOOL_STYLE_CONTROL
};


class wxToolBarToolBase : public wxObject {
public:
//      wxToolBarToolBase(wxToolBarBase *tbar = (wxToolBarBase *)NULL,
//                        int id = wxID_SEPARATOR,
//                        const wxBitmap& bitmap1 = wxNullBitmap,
//                        const wxBitmap& bitmap2 = wxNullBitmap,
//                        bool toggle = FALSE,
//                        wxObject *clientData = (wxObject *) NULL,
//                        const wxString& shortHelpString = wxEmptyString,
//                        const wxString& longHelpString = wxEmptyString);
//      wxToolBarToolBase(wxToolBarBase *tbar, wxControl *control);
//      ~wxToolBarToolBase();

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

    int GetId();
    wxControl *GetControl();
    wxToolBarBase *GetToolBar();
    int IsButton();
    int IsControl();
    int IsSeparator();
    int GetStyle();
    bool IsEnabled();
    bool IsToggled();
    bool CanBeToggled();
    wxBitmap GetBitmap1();
    wxBitmap GetBitmap2();
    wxBitmap GetBitmap();
    wxString GetShortHelp();
    wxString GetLongHelp();
    bool Enable(bool enable);
    bool Toggle(bool toggle);
    bool SetToggle(bool toggle);
    bool SetShortHelp(const wxString& help);
    bool SetLongHelp(const wxString& help);
    void SetBitmap1(const wxBitmap& bmp);
    void SetBitmap2(const wxBitmap& bmp);
    void Detach();
    void Attach(wxToolBarBase *tbar);

    //wxObject *GetClientData();
    %addmethods {
        // convert the ClientData back to a PyObject
        PyObject* GetClientData() {
            wxPyUserData* udata = (wxPyUserData*)self->GetClientData();
            if (udata) {
                Py_INCREF(udata->m_obj);
                return udata->m_obj;
            } else {
                Py_INCREF(Py_None);
                return Py_None;
            }
        }

        void SetClientData(PyObject* clientData) {
            self->SetClientData(new wxPyUserData(clientData));
        }
    }
};


class wxToolBarBase : public wxControl {
public:

    // This is an Abstract Base Class

    %addmethods {
        // wrap ClientData in a class that knows about PyObjects
        wxToolBarToolBase *AddTool(int id,
                                   const wxBitmap& bitmap,
                                   const wxBitmap& pushedBitmap = wxNullBitmap,
                                   int isToggle = FALSE,
                                   PyObject *clientData = NULL,
                                   const wxString& shortHelpString = wxPyEmptyStr,
                                   const wxString& longHelpString = wxPyEmptyStr) {
            wxPyUserData* udata = NULL;
            if (clientData)
                udata = new wxPyUserData(clientData);
            return self->AddTool(id, bitmap, pushedBitmap, (bool)isToggle,
                                 udata, shortHelpString, longHelpString);
        }

        // This one is easier to use...
        wxToolBarToolBase *AddSimpleTool(int id,
                                         const wxBitmap& bitmap,
                                         const wxString& shortHelpString = wxPyEmptyStr,
                                         const wxString& longHelpString = wxPyEmptyStr,
                                         int isToggle = FALSE) {
            return self->AddTool(id, bitmap, wxNullBitmap, isToggle, NULL,
                                 shortHelpString, longHelpString);
        }


        // wrap ClientData in a class that knows about PyObjects
        wxToolBarToolBase *InsertTool(size_t pos,
                                      int id,
                                      const wxBitmap& bitmap,
                                      const wxBitmap& pushedBitmap = wxNullBitmap,
                                      int isToggle = FALSE,
                                      PyObject *clientData = NULL,
                                      const wxString& shortHelpString = wxPyEmptyStr,
                                      const wxString& longHelpString = wxPyEmptyStr) {
            wxPyUserData* udata = NULL;
            if (clientData)
                udata = new wxPyUserData(clientData);
            return self->InsertTool(pos, id, bitmap, pushedBitmap, (bool)isToggle,
                                    udata, shortHelpString, longHelpString);
        }

        // This one is easier to use...
        wxToolBarToolBase *InsertSimpleTool(size_t pos,
                                            int id,
                                            const wxBitmap& bitmap,
                                            const wxString& shortHelpString = wxPyEmptyStr,
                                            const wxString& longHelpString = wxPyEmptyStr,
                                            int isToggle = FALSE) {
            return self->InsertTool(pos, id, bitmap, wxNullBitmap, isToggle, NULL,
                                    shortHelpString, longHelpString);
        }
    }


    wxToolBarToolBase *AddControl(wxControl *control);
    wxToolBarToolBase *InsertControl(size_t pos, wxControl *control);

    wxToolBarToolBase *AddSeparator();
    wxToolBarToolBase *InsertSeparator(size_t pos);

    wxToolBarToolBase *RemoveTool(int id);

    bool DeleteToolByPos(size_t pos);
    bool DeleteTool(int id);
    void ClearTools();
    bool Realize();

    void EnableTool(int id, bool enable);
    void ToggleTool(int id, bool toggle);
    void SetToggle(int id, bool toggle);


    %addmethods {
        // convert the ClientData back to a PyObject
        PyObject* GetToolClientData(int index) {
            wxPyUserData* udata = (wxPyUserData*)self->GetToolClientData(index);
            if (udata) {
                Py_INCREF(udata->m_obj);
                return udata->m_obj;
            } else {
                Py_INCREF(Py_None);
                return Py_None;
            }
        }

        void SetToolClientData(int index, PyObject* clientData) {
            self->SetToolClientData(index, new wxPyUserData(clientData));
        }
    }


    bool GetToolState(int id);
    bool GetToolEnabled(int id);
    void SetToolShortHelp(int id, const wxString& helpString);
    wxString GetToolShortHelp(int id);
    void SetToolLongHelp(int id, const wxString& helpString);
    wxString GetToolLongHelp(int id);

    %name(SetMarginsXY) void SetMargins(int x, int y);
    void SetMargins(const wxSize& size);
    void SetToolPacking(int packing);
    void SetToolSeparation(int separation);
    wxSize GetToolMargins();
    wxSize GetMargins();
    int GetToolPacking();
    int GetToolSeparation();

    void SetRows(int nRows);
    void SetMaxRowsCols(int rows, int cols);
    int GetMaxRows();
    int GetMaxCols();

    void SetToolBitmapSize(const wxSize& size);
    wxSize GetToolBitmapSize();
    wxSize GetToolSize();

};


class wxToolBar : public wxToolBarBase {
public:
    wxToolBar(wxWindow *parent,
              wxWindowID id,
              const wxPoint& pos = wxDefaultPosition,
              const wxSize& size = wxDefaultSize,
              long style = wxNO_BORDER | wxTB_HORIZONTAL,
              const char* name = wxToolBarNameStr);
    %name(wxPreToolBar)wxToolBar();

    bool Create(wxWindow *parent,
              wxWindowID id,
              const wxPoint& pos = wxDefaultPosition,
              const wxSize& size = wxDefaultSize,
              long style = wxNO_BORDER | wxTB_HORIZONTAL,
              const char* name = wxToolBarNameStr);

    %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
    %pragma(python) addtomethod = "wxPreToolBar:val._setOORInfo(val)"

    wxToolBarToolBase *FindToolForPosition(wxCoord x, wxCoord y);
};


class wxToolBarSimple : public wxToolBarBase {
public:
    wxToolBarSimple(wxWindow *parent,
                    wxWindowID id,
                    const wxPoint& pos = wxDefaultPosition,
                    const wxSize& size = wxDefaultSize,
                    long style = wxNO_BORDER | wxTB_HORIZONTAL,
                    const char* name = wxToolBarNameStr);
    %name(wxPreToolBarSimple)wxToolBarSimple();

    bool Create(wxWindow *parent,
                    wxWindowID id,
                    const wxPoint& pos = wxDefaultPosition,
                    const wxSize& size = wxDefaultSize,
                    long style = wxNO_BORDER | wxTB_HORIZONTAL,
                    const char* name = wxToolBarNameStr);

    %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
    %pragma(python) addtomethod = "wxPreToolBarSimple:val._setOORInfo(val)"

    wxToolBarToolBase *FindToolForPosition(wxCoord x, wxCoord y);
};

//---------------------------------------------------------------------------
//---------------------------------------------------------------------------
Commit	Line	Data
9c039d08 RD	1	/////////////////////////////////////////////////////////////////////////////
	2	// Name: stattool.i
	3	// Purpose: SWIG definitions for StatusBar and ToolBar classes
	4	//
	5	// Author: Robin Dunn
	6	//
	7	// Created: 08/24/1998
	8	// RCS-ID: $Id$
	9	// Copyright: (c) 1998 by Total Control Software
	10	// Licence: wxWindows license
	11	/////////////////////////////////////////////////////////////////////////////
	12
	13
	14	%module stattool
	15
	16	%{
	17	#include "helpers.h"
	18	#include <wx/toolbar.h>
	19	#include <wx/tbarsmpl.h>
	20	%}
	21
	22	//----------------------------------------------------------------------
	23
	24	%include typemaps.i
	25	%include my_typemaps.i
	26
	27	// Import some definitions of other classes, etc.
	28	%import _defs.i
	29	%import misc.i
	30	%import windows.i
	31	%import controls.i
	32
b8b8dda7	33	%pragma(python) code = "import wx"
9c039d08	34
b68dc582 RD	35
	36	%{
	37	static wxString wxPyEmptyStr("");
	38	%}
	39
9c039d08 RD	40	//---------------------------------------------------------------------------
	41
	42	class wxStatusBar : public wxWindow {
	43	public:
99f7d340	44	wxStatusBar(wxWindow* parent, wxWindowID id = -1,
9c039d08 RD	45	long style = wxST_SIZEGRIP,
9c039d08 RD	46	char* name = "statusBar");
09f3d4e6 RD	47	%name(wxPreStatusBar)wxStatusBar();
	48
	49	bool Create(wxWindow* parent, wxWindowID id,
	50	long style = wxST_SIZEGRIP,
	51	char* name = "statusBar");
9c039d08	52
0122b7e3	53	%pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
17c0e08c	54	%pragma(python) addtomethod = "wxPreStatusBar:val._setOORInfo(val)"
9c039d08 RD	55
	56	%addmethods {
	57	%new wxRect* GetFieldRect(long item) {
	58	wxRect* rect= new wxRect;
	59	self->GetFieldRect(item, *rect);
	60	return rect;
	61	}
	62	}
	63	int GetFieldsCount(void);
	64	wxString GetStatusText(int ir = 0);
26b9cf27 RD	65	int GetBorderX();
	66	int GetBorderY();
	67
9c039d08 RD	68	void SetFieldsCount(int number = 1);
9c039d08 RD	69	void SetStatusText(const wxString& text, int i = 0);
eec92d76	70	void SetStatusWidths(int LCOUNT, int* choices);
26b9cf27	71	void SetMinHeight(int height);
9c039d08 RD	72	};
	73
	74
	75	//---------------------------------------------------------------------------
	76
9b3d3bc4 RD	77	class wxToolBarBase;
	78
	79	enum wxToolBarToolStyle
	80	{
	81	wxTOOL_STYLE_BUTTON = 1,
	82	wxTOOL_STYLE_SEPARATOR = 2,
	83	wxTOOL_STYLE_CONTROL
	84	};
	85
	86
	87
9416aa89	88	class wxToolBarToolBase : public wxObject {
9b3d3bc4 RD	89	public:
	90	// wxToolBarToolBase(wxToolBarBase tbar = (wxToolBarBase )NULL,
	91	// int id = wxID_SEPARATOR,
	92	// const wxBitmap& bitmap1 = wxNullBitmap,
	93	// const wxBitmap& bitmap2 = wxNullBitmap,
	94	// bool toggle = FALSE,
	95	// wxObject clientData = (wxObject ) NULL,
	96	// const wxString& shortHelpString = wxEmptyString,
	97	// const wxString& longHelpString = wxEmptyString);
	98	// wxToolBarToolBase(wxToolBarBase tbar, wxControl control);
	99	// ~wxToolBarToolBase();
	100
	101	%addmethods { void Destroy() { delete self; } }
	102
	103	int GetId();
	104	wxControl *GetControl();
	105	wxToolBarBase *GetToolBar();
	106	int IsButton();
	107	int IsControl();
	108	int IsSeparator();
	109	int GetStyle();
	110	bool IsEnabled();
	111	bool IsToggled();
	112	bool CanBeToggled();
c5943253 RD	113	wxBitmap GetBitmap1();
	114	wxBitmap GetBitmap2();
	115	wxBitmap GetBitmap();
9b3d3bc4 RD	116	wxString GetShortHelp();
	117	wxString GetLongHelp();
	118	bool Enable(bool enable);
	119	bool Toggle(bool toggle);
	120	bool SetToggle(bool toggle);
	121	bool SetShortHelp(const wxString& help);
	122	bool SetLongHelp(const wxString& help);
	123	void SetBitmap1(const wxBitmap& bmp);
	124	void SetBitmap2(const wxBitmap& bmp);
	125	void Detach();
	126	void Attach(wxToolBarBase *tbar);
	127
	128	//wxObject *GetClientData();
	129	%addmethods {
	130	// convert the ClientData back to a PyObject
	131	PyObject* GetClientData() {
	132	wxPyUserData* udata = (wxPyUserData*)self->GetClientData();
	133	if (udata) {
	134	Py_INCREF(udata->m_obj);
	135	return udata->m_obj;
	136	} else {
	137	Py_INCREF(Py_None);
	138	return Py_None;
	139	}
	140	}
	141
	142	void SetClientData(PyObject* clientData) {
	143	self->SetClientData(new wxPyUserData(clientData));
	144	}
	145	}
	146	};
	147
	148
	149
	150	class wxToolBarBase : public wxControl {
	151	public:
	152
	153	// This is an Abstract Base Class
	154
	155	%addmethods {
	156	// wrap ClientData in a class that knows about PyObjects
	157	wxToolBarToolBase *AddTool(int id,
	158	const wxBitmap& bitmap,
	159	const wxBitmap& pushedBitmap = wxNullBitmap,
c368d904	160	int isToggle = FALSE,
9b3d3bc4 RD	161	PyObject *clientData = NULL,
	162	const wxString& shortHelpString = wxPyEmptyStr,
	163	const wxString& longHelpString = wxPyEmptyStr) {
	164	wxPyUserData* udata = NULL;
	165	if (clientData)
	166	udata = new wxPyUserData(clientData);
c368d904	167	return self->AddTool(id, bitmap, pushedBitmap, (bool)isToggle,
9b3d3bc4 RD	168	udata, shortHelpString, longHelpString);
	169	}
	170
	171	// This one is easier to use...
	172	wxToolBarToolBase *AddSimpleTool(int id,
	173	const wxBitmap& bitmap,
	174	const wxString& shortHelpString = wxPyEmptyStr,
	175	const wxString& longHelpString = wxPyEmptyStr,
c368d904 RD	176	int isToggle = FALSE) {
c368d904 RD	177	return self->AddTool(id, bitmap, wxNullBitmap, isToggle, NULL,
9b3d3bc4 RD	178	shortHelpString, longHelpString);
	179	}
	180
	181
	182	// wrap ClientData in a class that knows about PyObjects
	183	wxToolBarToolBase *InsertTool(size_t pos,
	184	int id,
	185	const wxBitmap& bitmap,
	186	const wxBitmap& pushedBitmap = wxNullBitmap,
c368d904	187	int isToggle = FALSE,
9b3d3bc4 RD	188	PyObject *clientData = NULL,
	189	const wxString& shortHelpString = wxPyEmptyStr,
	190	const wxString& longHelpString = wxPyEmptyStr) {
	191	wxPyUserData* udata = NULL;
	192	if (clientData)
	193	udata = new wxPyUserData(clientData);
c368d904	194	return self->InsertTool(pos, id, bitmap, pushedBitmap, (bool)isToggle,
9b3d3bc4 RD	195	udata, shortHelpString, longHelpString);
	196	}
	197
	198	// This one is easier to use...
	199	wxToolBarToolBase *InsertSimpleTool(size_t pos,
	200	int id,
	201	const wxBitmap& bitmap,
	202	const wxString& shortHelpString = wxPyEmptyStr,
	203	const wxString& longHelpString = wxPyEmptyStr,
c368d904 RD	204	int isToggle = FALSE) {
c368d904 RD	205	return self->InsertTool(pos, id, bitmap, wxNullBitmap, isToggle, NULL,
9b3d3bc4 RD	206	shortHelpString, longHelpString);
	207	}
	208	}
	209
	210
	211	wxToolBarToolBase AddControl(wxControl control);
	212	wxToolBarToolBase InsertControl(size_t pos, wxControl control);
	213
	214	wxToolBarToolBase *AddSeparator();
	215	wxToolBarToolBase *InsertSeparator(size_t pos);
	216
	217	wxToolBarToolBase *RemoveTool(int id);
	218
	219	bool DeleteToolByPos(size_t pos);
	220	bool DeleteTool(int id);
	221	void ClearTools();
	222	bool Realize();
	223
	224	void EnableTool(int id, bool enable);
	225	void ToggleTool(int id, bool toggle);
	226	void SetToggle(int id, bool toggle);
	227
	228
	229	%addmethods {
	230	// convert the ClientData back to a PyObject
	231	PyObject* GetToolClientData(int index) {
	232	wxPyUserData* udata = (wxPyUserData*)self->GetToolClientData(index);
	233	if (udata) {
	234	Py_INCREF(udata->m_obj);
	235	return udata->m_obj;
	236	} else {
	237	Py_INCREF(Py_None);
	238	return Py_None;
	239	}
	240	}
	241
	242	void SetToolClientData(int index, PyObject* clientData) {
	243	self->SetToolClientData(index, new wxPyUserData(clientData));
	244	}
	245	}
	246
	247
	248	bool GetToolState(int id);
	249	bool GetToolEnabled(int id);
	250	void SetToolShortHelp(int id, const wxString& helpString);
	251	wxString GetToolShortHelp(int id);
	252	void SetToolLongHelp(int id, const wxString& helpString);
	253	wxString GetToolLongHelp(int id);
	254
	255	%name(SetMarginsXY) void SetMargins(int x, int y);
	256	void SetMargins(const wxSize& size);
	257	void SetToolPacking(int packing);
	258	void SetToolSeparation(int separation);
	259	wxSize GetToolMargins();
83b18bab	260	wxSize GetMargins();
9b3d3bc4 RD	261	int GetToolPacking();
	262	int GetToolSeparation();
	263
	264	void SetRows(int nRows);
	265	void SetMaxRowsCols(int rows, int cols);
	266	int GetMaxRows();
	267	int GetMaxCols();
	268
	269	void SetToolBitmapSize(const wxSize& size);
	270	wxSize GetToolBitmapSize();
	271	wxSize GetToolSize();
	272
	273	};
	274
	275
	276
	277
	278	class wxToolBar : public wxToolBarBase {
	279	public:
	280	wxToolBar(wxWindow *parent,
	281	wxWindowID id,
b68dc582 RD	282	const wxPoint& pos = wxDefaultPosition,
b68dc582 RD	283	const wxSize& size = wxDefaultSize,
9b3d3bc4	284	long style = wxNO_BORDER \| wxTB_HORIZONTAL,
8e425133	285	const char* name = wxToolBarNameStr);
09f3d4e6 RD	286	%name(wxPreToolBar)wxToolBar();
	287
	288	bool Create(wxWindow *parent,
	289	wxWindowID id,
	290	const wxPoint& pos = wxDefaultPosition,
	291	const wxSize& size = wxDefaultSize,
	292	long style = wxNO_BORDER \| wxTB_HORIZONTAL,
	293	const char* name = wxToolBarNameStr);
9b3d3bc4	294
0122b7e3	295	%pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
17c0e08c	296	%pragma(python) addtomethod = "wxPreToolBar:val._setOORInfo(val)"
9b3d3bc4 RD	297
	298	wxToolBarToolBase *FindToolForPosition(wxCoord x, wxCoord y);
	299	};
	300
	301
	302
	303
	304	class wxToolBarSimple : public wxToolBarBase {
	305	public:
	306	wxToolBarSimple(wxWindow *parent,
	307	wxWindowID id,
b68dc582 RD	308	const wxPoint& pos = wxDefaultPosition,
b68dc582 RD	309	const wxSize& size = wxDefaultSize,
9b3d3bc4	310	long style = wxNO_BORDER \| wxTB_HORIZONTAL,
8e425133	311	const char* name = wxToolBarNameStr);
09f3d4e6 RD	312	%name(wxPreToolBarSimple)wxToolBarSimple();
	313
	314	bool Create(wxWindow *parent,
	315	wxWindowID id,
	316	const wxPoint& pos = wxDefaultPosition,
	317	const wxSize& size = wxDefaultSize,
	318	long style = wxNO_BORDER \| wxTB_HORIZONTAL,
	319	const char* name = wxToolBarNameStr);
9b3d3bc4	320
0122b7e3	321	%pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
17c0e08c	322	%pragma(python) addtomethod = "wxPreToolBarSimple:val._setOORInfo(val)"
9b3d3bc4 RD	323
	324	wxToolBarToolBase *FindToolForPosition(wxCoord x, wxCoord y);
	325	};
	326
	327	//---------------------------------------------------------------------------
9c039d08 RD	328	//---------------------------------------------------------------------------
9c039d08 RD	329