wxPython/src/_choice.i

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        _choice.i
   3 // Purpose:     SWIG interface defs for wxChoice
   4 //
   5 // Author:      Robin Dunn
   6 //
   7 // Created:     10-June-1998
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c) 2003 by Total Control Software
  10 // Licence:     wxWindows license
  11 /////////////////////////////////////////////////////////////////////////////
  12
  13 // Not a %module
  14
  15
  16 //---------------------------------------------------------------------------
  17
  18 MAKE_CONST_WXSTRING(ChoiceNameStr);
  19
  20 //---------------------------------------------------------------------------
  21 %newgroup;
  22
  23
  24 DocStr(wxChoice,
  25 "A Choice control is used to select one of a list of strings.
  26 Unlike a `wx.ListBox`, only the selection is visible until the
  27 user pulls down the menu of choices.", "
  28
  29 Events
  30 ------
  31     ================    ==========================================
  32     EVT_CHOICE          Sent when an item in the list is selected.
  33     ================    ==========================================
  34 ");
  35
  36
  37 class wxChoice : public wxControlWithItems
  38 {
  39 public:
  40     %pythonAppend wxChoice         "self._setOORInfo(self)"
  41     %pythonAppend wxChoice()       ""
  42
  43     DocCtorAStr(
  44         wxChoice(wxWindow *parent, wxWindowID id=-1,
  45                  const wxPoint& pos = wxDefaultPosition,
  46                  const wxSize& size = wxDefaultSize,
  47                  const wxArrayString& choices = wxPyEmptyStringArray,
  48                  long style = 0,
  49                  const wxValidator& validator = wxDefaultValidator,
  50                  const wxString& name = wxPyChoiceNameStr),
  51         "__init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
  52     List choices=[], long style=0, Validator validator=DefaultValidator,
  53     String name=ChoiceNameStr) -> Choice",
  54         "Create and show a Choice control", "");
  55
  56     DocCtorStrName(
  57         wxChoice(),
  58         "Precreate a Choice control for 2-phase creation.", "",
  59         PreChoice);
  60
  61
  62     DocDeclAStr(
  63         bool, Create(wxWindow *parent, wxWindowID id=-1,
  64                      const wxPoint& pos = wxDefaultPosition,
  65                      const wxSize& size = wxDefaultSize,
  66                      const wxArrayString& choices = wxPyEmptyStringArray,
  67                      long style = 0,
  68                      const wxValidator& validator = wxDefaultValidator,
  69                      const wxString& name = wxPyChoiceNameStr),
  70         "Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
  71     List choices=[], long style=0, Validator validator=DefaultValidator,
  72     String name=ChoiceNameStr) -> bool",
  73         "Actually create the GUI Choice control for 2-phase creation", "");
  74
  75
  76 //     // These are only meaningful on wxMotif...
  77 //     int GetColumns();
  78 //     void SetColumns(const int n = 1);
  79
  80
  81     DocDeclStr(
  82         void , SetSelection(const int n),
  83         "Select the n'th item (zero based) in the list.", "");
  84
  85     DocDeclStr(
  86         bool , SetStringSelection(const wxString& string),
  87         "Select the item with the specifed string", "");
  88
  89     DocDeclStr(
  90         void , SetString(int n, const wxString& string),
  91         "Set the label for the n'th item (zero based) in the list.", "");
  92
  93
  94     %pythoncode { Select = SetSelection }
  95
  96     static wxVisualAttributes
  97     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
  98 };
  99
 100 //---------------------------------------------------------------------------