Added some more docstrings, and also a few little tweaks along the way.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@25848 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Robin Dunn
2004-02-18 02:12:12 +00:00
parent d1b3039b9f
commit fcafa8a99e
10 changed files with 786 additions and 318 deletions

View File

@@ -20,42 +20,75 @@ MAKE_CONST_WXSTRING(ChoiceNameStr);
//---------------------------------------------------------------------------
%newgroup;
DocStr(wxChoice,
"A Choice control is used to select one of a list of strings. Unlike a ListBox,
only the selection is visible until the user pulls down the menu of choices.");
RefDoc(wxChoice, "
Events
EVT_CHOICE: Sent when an item in the list is selected.
");
class wxChoice : public wxControlWithItems
{
public:
%pythonAppend wxChoice "self._setOORInfo(self)"
%pythonAppend wxChoice() ""
wxChoice(wxWindow *parent, wxWindowID id,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
//int choices=0, wxString* choices_array=NULL,
const wxArrayString& choices = wxPyEmptyStringArray,
long style = 0,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = wxPyChoiceNameStr);
%name(PreChoice)wxChoice();
DocCtorAStr(
wxChoice(wxWindow *parent, wxWindowID id,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
const wxArrayString& choices = wxPyEmptyStringArray,
long style = 0,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = wxPyChoiceNameStr),
"__init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,\n"
" List choices=[], long style=0, Validator validator=DefaultValidator,\n"
" String name=ChoiceNameStr) -> Choice",
"Create and show a Choice control");
bool Create(wxWindow *parent, wxWindowID id,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
//int choices=0, wxString* choices_array=NULL,
const wxArrayString& choices = wxPyEmptyStringArray,
long style = 0,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = wxPyChoiceNameStr);
DocCtorStrName(
wxChoice(),
"Precreate a Choice control for 2-phase creation.",
PreChoice);
#ifndef __WXX11__
int GetColumns();
void SetColumns(const int n = 1);
#endif
void SetSelection(const int n);
void SetStringSelection(const wxString& string);
void SetString(int n, const wxString& s);
DocDeclAStr(
bool, Create(wxWindow *parent, wxWindowID id,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
const wxArrayString& choices = wxPyEmptyStringArray,
long style = 0,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = wxPyChoiceNameStr),
"Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,\n"
" List choices=[], long style=0, Validator validator=DefaultValidator,\n"
" String name=ChoiceNameStr) -> bool",
"Actually create the GUI Choice control for 2-phase creation");
%pragma(python) addtoclass = "
Select = SetSelection
"
// // These are only meaningful on wxMotif...
// int GetColumns();
// void SetColumns(const int n = 1);
DocDeclStr(
void , SetSelection(const int n),
"Select the n'th item (zero based) in the list.");
DocDeclStr(
void , SetStringSelection(const wxString& string),
"Select the item with the specifed string");
DocDeclStr(
void , SetString(int n, const wxString& string),
"Set the label for the n'th item (zero based) in the list.");
%pythoncode { Select = SetSelection }
};
//---------------------------------------------------------------------------