wxPython/src/stattool.i

   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
  33 %pragma(python) code = "import wx"
  34
  35
  36 %{
  37     static wxString wxPyEmptyStr("");
  38 %}
  39
  40 //---------------------------------------------------------------------------
  41
  42 class wxStatusBar : public wxWindow {
  43 public:
  44     wxStatusBar(wxWindow* parent, wxWindowID id = -1,
  45                 long style = wxST_SIZEGRIP,
  46                 char* name = "statusBar");
  47     %name(wxPreStatusBar)wxStatusBar();
  48
  49     bool Create(wxWindow* parent, wxWindowID id,
  50                 long style = wxST_SIZEGRIP,
  51                 char* name = "statusBar");
  52
  53     %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
  54     %pragma(python) addtomethod = "wxPreStatusBar:val._setOORInfo(val)"
  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);
  65     int GetBorderX();
  66     int GetBorderY();
  67
  68     void SetFieldsCount(int number = 1);
  69     void SetStatusText(const wxString& text, int i = 0);
  70     void SetStatusWidths(int LCOUNT, int* choices);
  71     void SetMinHeight(int height);
  72 };
  73
  74
  75 //---------------------------------------------------------------------------
  76
  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
  88 class wxToolBarToolBase : public wxObject {
  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();
 113     const wxBitmap& GetBitmap1();
 114     const wxBitmap& GetBitmap2();
 115     const wxBitmap& GetBitmap();
 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,
 160                                    int isToggle = FALSE,
 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);
 167             return self->AddTool(id, bitmap, pushedBitmap, (bool)isToggle,
 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,
 176                                          int isToggle = FALSE) {
 177             return self->AddTool(id, bitmap, wxNullBitmap, isToggle, NULL,
 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,
 187                                       int isToggle = FALSE,
 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);
 194             return self->InsertTool(pos, id, bitmap, pushedBitmap, (bool)isToggle,
 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,
 204                                             int isToggle = FALSE) {
 205             return self->InsertTool(pos, id, bitmap, wxNullBitmap, isToggle, NULL,
 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();
 260     wxSize GetMargins();
 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,
 282               const wxPoint& pos = wxDefaultPosition,
 283               const wxSize& size = wxDefaultSize,
 284               long style = wxNO_BORDER | wxTB_HORIZONTAL,
 285               const char* name = wxToolBarNameStr);
 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);
 294
 295     %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
 296     %pragma(python) addtomethod = "wxPreToolBar:val._setOORInfo(val)"
 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,
 308                     const wxPoint& pos = wxDefaultPosition,
 309                     const wxSize& size = wxDefaultSize,
 310                     long style = wxNO_BORDER | wxTB_HORIZONTAL,
 311                     const char* name = wxToolBarNameStr);
 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);
 320
 321     %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
 322     %pragma(python) addtomethod = "wxPreToolBarSimple:val._setOORInfo(val)"
 323
 324     wxToolBarToolBase *FindToolForPosition(wxCoord x, wxCoord y);
 325 };
 326
 327 //---------------------------------------------------------------------------
 328 //---------------------------------------------------------------------------
 329