[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"


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

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