utils/wxPython/src/controls.i

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        controls.i
   3 // Purpose:     Control (widget) classes for wxPython
   4 //
   5 // Author:      Robin Dunn
   6 //
   7 // Created:     6/10/98
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c) 1998 by Total Control Software
  10 // Licence:     wxWindows license
  11 /////////////////////////////////////////////////////////////////////////////
  12
  13 %module controls
  14
  15 %{
  16 #include "helpers.h"
  17 #include <wx/slider.h>
  18 #include <wx/spinbutt.h>
  19 #include <wx/dynarray.h>
  20 #include <wx/statline.h>
  21
  22 #ifdef __WXMSW__
  23 #if wxUSE_OWNER_DRAWN
  24 #include <wx/checklst.h>
  25 #endif
  26 #endif
  27
  28 #ifdef __WXGTK__
  29 #include <wx/checklst.h>
  30 #endif
  31
  32 %}
  33
  34 //----------------------------------------------------------------------
  35
  36 %include typemaps.i
  37 %include my_typemaps.i
  38
  39 // Import some definitions of other classes, etc.
  40 %import _defs.i
  41 %import misc.i
  42 %import windows.i
  43 %import gdi.i
  44 %import events.i
  45
  46 %pragma(python) code = "import wx"
  47
  48 //----------------------------------------------------------------------
  49
  50 %{
  51 wxValidator wxPyDefaultValidator;       // Non-const default because of SWIG
  52 %}
  53
  54 %readonly
  55 wxValidator wxDefaultValidator;
  56 %readwrite
  57
  58 //----------------------------------------------------------------------
  59
  60 class wxControl : public wxWindow {
  61 public:
  62 #ifdef __WXMSW__
  63     void Command(wxCommandEvent& event);
  64 #endif
  65     wxString GetLabel();
  66     void SetLabel(const wxString& label);
  67 };
  68
  69 //----------------------------------------------------------------------
  70
  71 class wxButton : public wxControl {
  72 public:
  73     wxButton(wxWindow* parent, wxWindowID id, const wxString& label,
  74              const wxPoint& pos = wxPyDefaultPosition,
  75              const wxSize& size = wxPyDefaultSize,
  76              long style = 0,
  77              const wxValidator& validator = wxPyDefaultValidator,
  78              char* name = "button");
  79
  80     %pragma(python) addtomethod = "__init__:wx._StdWindowCallbacks(self)"
  81
  82     void SetDefault();
  83 };
  84
  85 //----------------------------------------------------------------------
  86
  87 class wxBitmapButton : public wxButton {
  88 public:
  89     wxBitmapButton(wxWindow* parent, wxWindowID id, const wxBitmap& bitmap,
  90                    const wxPoint& pos = wxPyDefaultPosition,
  91                    const wxSize& size = wxPyDefaultSize,
  92                    long style = wxBU_AUTODRAW,
  93                    const wxValidator& validator = wxPyDefaultValidator,
  94                    char* name = "button");
  95
  96     %pragma(python) addtomethod = "__init__:wx._StdWindowCallbacks(self)"
  97
  98     wxBitmap& GetBitmapLabel();
  99     wxBitmap& GetBitmapDisabled();
 100     wxBitmap& GetBitmapFocus();
 101     wxBitmap& GetBitmapSelected();
 102     void SetBitmapDisabled(const wxBitmap& bitmap);
 103     void SetBitmapFocus(const wxBitmap& bitmap);
 104     void SetBitmapSelected(const wxBitmap& bitmap);
 105     void SetBitmapLabel(const wxBitmap& bitmap);
 106
 107 };
 108
 109 //----------------------------------------------------------------------
 110
 111 class wxCheckBox : public wxControl {
 112 public:
 113     wxCheckBox(wxWindow* parent, wxWindowID id, const wxString& label,
 114                const wxPoint& pos = wxPyDefaultPosition,
 115                const wxSize& size = wxPyDefaultSize,
 116                long style = 0,
 117                const wxValidator& val = wxPyDefaultValidator,
 118                char* name = "checkBox");
 119
 120     %pragma(python) addtomethod = "__init__:wx._StdWindowCallbacks(self)"
 121
 122     bool GetValue();
 123     void SetValue(const bool state);
 124 };
 125
 126 //----------------------------------------------------------------------
 127
 128 class wxChoice : public wxControl {
 129 public:
 130     wxChoice(wxWindow *parent, wxWindowID id,
 131              const wxPoint& pos = wxPyDefaultPosition,
 132              const wxSize& size = wxPyDefaultSize,
 133              int LCOUNT=0, wxString* LIST=NULL,
 134              long style = 0,
 135              const wxValidator& validator = wxPyDefaultValidator,
 136              char* name = "choice");
 137
 138     %pragma(python) addtomethod = "__init__:wx._StdWindowCallbacks(self)"
 139
 140     void Append(const wxString& item);
 141     void Clear();
 142     int FindString(const wxString& string);
 143     int GetColumns();
 144     int GetSelection();
 145     wxString GetString(const int n);
 146     wxString GetStringSelection();
 147     int Number();
 148     void SetColumns(const int n = 1);
 149     void SetSelection(const int n);
 150     void SetStringSelection(const wxString& string);
 151 };
 152
 153 //----------------------------------------------------------------------
 154
 155 class wxComboBox : public wxChoice {
 156 public:
 157     wxComboBox(wxWindow* parent, wxWindowID id, char* value = "",
 158                const wxPoint& pos = wxPyDefaultPosition,
 159                const wxSize& size = wxPyDefaultSize,
 160                int LCOUNT=0, wxString* LIST=NULL,
 161                long style = 0,
 162                const wxValidator& validator = wxPyDefaultValidator,
 163                char* name = "comboBox");
 164
 165     %pragma(python) addtomethod = "__init__:wx._StdWindowCallbacks(self)"
 166
 167     void Append(const wxString& item);
 168     // TODO: void Append(const wxString& item, char* clientData);
 169     void Clear();
 170     void Copy();
 171     void Cut();
 172     void Delete(int n);
 173     // NotMember??:    void Deselect(int n);
 174     int FindString(const wxString& string);
 175     // TODO: char* GetClientData(const int n);
 176     long GetInsertionPoint();
 177     long GetLastPosition();
 178     int GetSelection();
 179     wxString GetString(int n);
 180     wxString GetStringSelection();
 181     wxString GetValue();
 182     int Number();
 183     void Paste();
 184     void Replace(long from, long to, const wxString& text);
 185     void Remove(long from, long to);
 186     // TODO:    void SetClientData(const int n, char* data);
 187     void SetInsertionPoint(long pos);
 188     void SetInsertionPointEnd();
 189     void SetSelection(int n);
 190     %name(SetMark)void SetSelection(long from, long to);
 191     void SetValue(const wxString& text);
 192 };
 193
 194 //----------------------------------------------------------------------
 195
 196 class wxGauge : public wxControl {
 197 public:
 198     wxGauge(wxWindow* parent, wxWindowID id, int range,
 199             const wxPoint& pos = wxPyDefaultPosition,
 200             const wxSize& size = wxPyDefaultSize,
 201             long style = wxGA_HORIZONTAL,
 202             const wxValidator& validator = wxPyDefaultValidator,
 203             char* name = "gauge");
 204
 205     %pragma(python) addtomethod = "__init__:wx._StdWindowCallbacks(self)"
 206
 207     int GetBezelFace();
 208     int GetRange();
 209     int GetShadowWidth();
 210     int GetValue();
 211     void SetBezelFace(int width);
 212     void SetRange(int range);
 213     void SetShadowWidth(int width);
 214     void SetValue(int pos);
 215 };
 216
 217 //----------------------------------------------------------------------
 218
 219 class wxStaticBox : public wxControl {
 220 public:
 221     wxStaticBox(wxWindow* parent, wxWindowID id, const wxString& label,
 222                 const wxPoint& pos = wxPyDefaultPosition,
 223                 const wxSize& size = wxPyDefaultSize,
 224                 long style = 0,
 225                 char* name = "staticBox");
 226 };
 227
 228
 229 //----------------------------------------------------------------------
 230
 231
 232 class wxStaticLine : public wxControl {
 233 public:
 234     wxStaticLine( wxWindow *parent, wxWindowID id,
 235                   const wxPoint &pos = wxPyDefaultPosition,
 236                   const wxSize &size = wxPyDefaultSize,
 237                   long style = wxLI_HORIZONTAL,
 238                   const char* name = "staticLine" );
 239 };
 240
 241
 242 //----------------------------------------------------------------------
 243
 244 class wxStaticText : public wxControl {
 245 public:
 246     wxStaticText(wxWindow* parent, wxWindowID id, const wxString& label,
 247                  const wxPoint& pos = wxPyDefaultPosition,
 248                  const wxSize& size = wxPyDefaultSize,
 249                  long style = 0,
 250                  char* name = "staticText");
 251
 252     %pragma(python) addtomethod = "__init__:wx._StdWindowCallbacks(self)"
 253
 254     wxString GetLabel();
 255     void SetLabel(const wxString& label);
 256 };
 257
 258 //----------------------------------------------------------------------
 259
 260 class wxListBox : public wxControl {
 261 public:
 262     wxListBox(wxWindow* parent, wxWindowID id,
 263               const wxPoint& pos = wxPyDefaultPosition,
 264               const wxSize& size = wxPyDefaultSize,
 265               int LCOUNT, wxString* LIST = NULL,
 266               long style = 0,
 267               const wxValidator& validator = wxPyDefaultValidator,
 268               char* name = "listBox");
 269
 270     %pragma(python) addtomethod = "__init__:wx._StdWindowCallbacks(self)"
 271
 272     void Append(const wxString& item);
 273     // TODO:    void Append(const wxString& item, char* clientData);
 274     void Clear();
 275     void Delete(int n);
 276     void Deselect(int n);
 277     int FindString(const wxString& string);
 278     // TODO:    char* GetClientData(const int n);
 279     int GetSelection();
 280
 281     // int GetSelections(int **selections);
 282     %addmethods {
 283       PyObject* GetSelections() {
 284           wxArrayInt lst;
 285           self->GetSelections(lst);
 286           PyObject *tup = PyTuple_New(lst.GetCount());
 287           for(int i=0; i<lst.GetCount(); i++) {
 288               PyTuple_SetItem(tup, i, PyInt_FromLong(lst[i]));
 289           }
 290           return tup;
 291       }
 292     }
 293
 294     void InsertItems(int LCOUNT, wxString* LIST, int pos);
 295
 296     wxString GetString(int n);
 297     wxString GetStringSelection();
 298     int Number();
 299     bool Selected(const int n);
 300     void Set(int LCOUNT, wxString* LIST);
 301     // TODO:    void SetClientData(const int n, char* data);
 302     void SetFirstItem(int n);
 303     %name(SetFirstItemStr)void SetFirstItem(const wxString& string);
 304     void SetSelection(int n, bool select = TRUE);
 305     void SetString(int n, const wxString& string);
 306     void SetStringSelection(const wxString& string, bool select = TRUE);
 307 };
 308
 309
 310 //----------------------------------------------------------------------
 311
 312 class wxCheckListBox : public wxListBox {
 313 public:
 314     wxCheckListBox(wxWindow *parent, wxWindowID id,
 315                    const wxPoint& pos = wxPyDefaultPosition,
 316                    const wxSize& size = wxPyDefaultSize,
 317                    int LCOUNT = 0,
 318                    wxString* LIST = NULL,
 319                    long style = 0,
 320                    const wxValidator& validator = wxPyDefaultValidator,
 321                    char* name = "listBox");
 322
 323     %pragma(python) addtomethod = "__init__:wx._StdWindowCallbacks(self)"
 324
 325     bool  IsChecked(int uiIndex);
 326     void  Check(int uiIndex, bool bCheck = TRUE);
 327
 328     int GetItemHeight();
 329 };
 330
 331 //----------------------------------------------------------------------
 332
 333 class wxTextCtrl : public wxControl {
 334 public:
 335     wxTextCtrl(wxWindow* parent, wxWindowID id, char* value = "",
 336                const wxPoint& pos = wxPyDefaultPosition,
 337                const wxSize& size = wxPyDefaultSize,
 338                long style = 0,
 339                const wxValidator& validator = wxPyDefaultValidator,
 340                char* name = "text");
 341
 342     %pragma(python) addtomethod = "__init__:wx._StdWindowCallbacks(self)"
 343
 344     void Clear();
 345     void Copy();
 346     void Cut();
 347     void DiscardEdits();
 348     long GetInsertionPoint();
 349     long GetLastPosition();
 350     int GetLineLength(long lineNo);
 351     wxString GetLineText(long lineNo);
 352     int GetNumberOfLines();
 353     wxString GetValue();
 354     bool IsModified();
 355     bool LoadFile(const wxString& filename);
 356     void Paste();
 357     void PositionToXY(long pos, long *OUTPUT, long *OUTPUT);
 358     void Remove(long from, long to);
 359     void Replace(long from, long to, const wxString& value);
 360     bool SaveFile(const wxString& filename);
 361     void SetEditable(bool editable);
 362     void SetInsertionPoint(long pos);
 363     void SetInsertionPointEnd();
 364     void SetSelection(long from, long to);
 365     void SetValue(const wxString& value);
 366     void ShowPosition(long pos);
 367     void WriteText(const wxString& text);
 368     void AppendText(const wxString& text);
 369     long XYToPosition(long x, long y);
 370
 371     bool CanCopy();
 372     bool CanCut();
 373     bool CanPaste();
 374     bool CanRedo();
 375     bool CanUndo();
 376     void GetSelection(long* OUTPUT, long* OUTPUT);
 377     bool IsEditable();
 378     void Undo();
 379     void Redo();
 380
 381     %addmethods {
 382         void write(const wxString& text) {
 383             self->AppendText(text + '\n');
 384         }
 385     }
 386 };
 387
 388 //----------------------------------------------------------------------
 389
 390 class wxScrollBar : public wxControl {
 391 public:
 392     wxScrollBar(wxWindow* parent, wxWindowID id = -1,
 393                 const wxPoint& pos = wxPyDefaultPosition,
 394                 const wxSize& size = wxPyDefaultSize,
 395                 long style = wxSB_HORIZONTAL,
 396                 const wxValidator& validator = wxPyDefaultValidator,
 397                 char* name = "scrollBar");
 398
 399     %pragma(python) addtomethod = "__init__:wx._StdWindowCallbacks(self)"
 400
 401     int GetRange();
 402     int GetPageSize();
 403     int GetThumbPosition();
 404     int GetThumbSize();
 405     void SetThumbPosition(int viewStart);
 406     void SetScrollbar(int position, int thumbSize,
 407                       int range,    int pageSize,
 408                       bool refresh = TRUE);
 409 };
 410
 411 //----------------------------------------------------------------------
 412
 413 class wxSpinButton : public wxControl {
 414 public:
 415     wxSpinButton(wxWindow* parent, wxWindowID id = -1,
 416                  const wxPoint& pos = wxPyDefaultPosition,
 417                  const wxSize& size = wxPyDefaultSize,
 418                  long style = wxSP_HORIZONTAL,
 419                  char* name = "spinButton");
 420
 421     int GetMax();
 422     int GetMin();
 423     int GetValue();
 424     void SetRange(int min, int max);
 425     void SetValue(int value);
 426 };
 427
 428 //----------------------------------------------------------------------
 429
 430 class wxStaticBitmap : public wxControl {
 431 public:
 432     wxStaticBitmap(wxWindow* parent, wxWindowID id,
 433                    const wxBitmap& bitmap,
 434                    const wxPoint& pos = wxPyDefaultPosition,
 435                    const wxSize& size = wxPyDefaultSize,
 436                    long style = 0,
 437                    char* name = "staticBitmap");
 438
 439     %pragma(python) addtomethod = "__init__:wx._StdWindowCallbacks(self)"
 440
 441     const wxBitmap& GetBitmap();
 442     void SetBitmap(const wxBitmap& bitmap);
 443     void SetIcon(const wxIcon& icon);
 444 };
 445
 446 //----------------------------------------------------------------------
 447
 448 class wxRadioBox : public wxControl {
 449 public:
 450     wxRadioBox(wxWindow* parent, wxWindowID id,
 451                const wxString& label,
 452                const wxPoint& point = wxPyDefaultPosition,
 453                const wxSize& size = wxPyDefaultSize,
 454                int LCOUNT = 0, wxString* LIST = NULL,
 455                int majorDimension = 0,
 456                long style = wxRA_HORIZONTAL,
 457                const wxValidator& validator = wxPyDefaultValidator,
 458                char* name = "radioBox");
 459
 460     %pragma(python) addtomethod = "__init__:wx._StdWindowCallbacks(self)"
 461
 462     void Enable(bool enable);
 463     %name(EnableItem)void Enable(int n, bool enable);
 464     int FindString(const wxString& string);
 465
 466 //***    wxString GetLabel();
 467 //***    void SetLabel(const wxString& label);
 468
 469     %name(GetItemLabel)wxString GetLabel(int n);
 470     int GetSelection();
 471     wxString GetString(int n);
 472     wxString GetStringSelection();
 473     int Number();
 474     %name(SetItemLabel)void SetLabel(int n, const wxString& label);
 475     void SetSelection(int n);
 476     void SetStringSelection(const wxString& string);
 477     void Show(bool show);
 478     %name(ShowItem)void Show(int item, bool show);
 479 };
 480
 481 //----------------------------------------------------------------------
 482
 483 class wxRadioButton : public wxControl {
 484 public:
 485     wxRadioButton(wxWindow* parent, wxWindowID id,
 486                   const wxString& label,
 487                   const wxPoint& pos = wxPyDefaultPosition,
 488                   const wxSize& size = wxPyDefaultSize,
 489                   long style = 0,
 490                   const wxValidator& validator = wxPyDefaultValidator,
 491                   char* name = "radioButton");
 492
 493     %pragma(python) addtomethod = "__init__:wx._StdWindowCallbacks(self)"
 494
 495     bool GetValue();
 496     void SetValue(bool value);
 497 };
 498
 499 //----------------------------------------------------------------------
 500
 501 class wxSlider : public wxControl {
 502 public:
 503     wxSlider(wxWindow* parent, wxWindowID id,
 504              int value, int minValue, int maxValue,
 505              const wxPoint& point = wxPyDefaultPosition,
 506              const wxSize& size = wxPyDefaultSize,
 507              long style = wxSL_HORIZONTAL,
 508              const wxValidator& validator = wxPyDefaultValidator,
 509              char* name = "slider");
 510
 511     %pragma(python) addtomethod = "__init__:wx._StdWindowCallbacks(self)"
 512
 513     void ClearSel();
 514     void ClearTicks();
 515     int GetLineSize();
 516     int GetMax();
 517     int GetMin();
 518     int GetPageSize();
 519     int GetSelEnd();
 520     int GetSelStart();
 521     int GetThumbLength();
 522     int GetTickFreq();
 523     int GetValue();
 524     void SetRange(int minValue, int maxValue);
 525     void SetTickFreq(int n, int pos);
 526     void SetLineSize(int lineSize);
 527     void SetPageSize(int pageSize);
 528     void SetSelection(int startPos, int endPos);
 529     void SetThumbLength(int len);
 530     void SetTick(int tickPos);
 531     void SetValue(int value);
 532 };
 533
 534
 535 //----------------------------------------------------------------------
 536