Some docstring additions, reformats and epydoc markup.
Removed RefDoc macros, instead made all the normal Docstring macros take an extra parameter to be used for the optional details postion of the docstring. The intent is that the docstrings put in the generated .py files checked in to CVS and delivered in releases will be only a paragraph or two, but when used for generating the epydoc reference docs they can optionally contain a lot more details. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@27216 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Robin Dunn
@@ -22,28 +22,36 @@ MAKE_CONST_WXSTRING(ComboBoxNameStr);
|
||||
|
||||
|
||||
DocStr(wxComboBox,
|
||||
"A combobox is like a combination of an edit control and a listbox. It can be
|
||||
displayed as static list with editable or read-only text field; or a drop-down
|
||||
list with text field.");
|
||||
"A combobox is like a combination of an edit control and a
|
||||
listbox. It can be displayed as static list with editable or
|
||||
read-only text field; or a drop-down list with text field.
|
||||
|
||||
RefDoc(wxComboBox, "
|
||||
Styles
|
||||
wx.CB_SIMPLE: Creates a combobox with a permanently displayed list.
|
||||
Windows only.
|
||||
A combobox permits a single selection only. Combobox items are
|
||||
numbered from zero.", "
|
||||
|
||||
wx.CB_DROPDOWN: Creates a combobox with a drop-down list.
|
||||
Styles
|
||||
------
|
||||
================ ===============================================
|
||||
wx.CB_SIMPLE Creates a combobox with a permanently
|
||||
displayed list. Windows only.
|
||||
|
||||
wx.CB_READONLY: Same as wxCB_DROPDOWN but only the strings specified as
|
||||
the combobox choices can be selected, it is impossible
|
||||
to select (even from a program) a string which is not in
|
||||
the choices list.
|
||||
wx.CB_DROPDOWN Creates a combobox with a drop-down list.
|
||||
|
||||
wx.CB_SORT: Sorts the entries in the list alphabetically.
|
||||
wx.CB_READONLY Same as wxCB_DROPDOWN but only the strings
|
||||
specified as the combobox choices can be
|
||||
selected, it is impossible to select
|
||||
(even from a program) a string which is
|
||||
not in the choices list.
|
||||
|
||||
Events
|
||||
wx.CB_SORT Sorts the entries in the list alphabetically.
|
||||
================ ===============================================
|
||||
|
||||
EVT_COMBOBOX: Sent when an item on the list is selected.
|
||||
EVT_TEXT: Sent when the combobox text changes.
|
||||
Events
|
||||
-------
|
||||
================ ===============================================
|
||||
EVT_COMBOBOX Sent when an item on the list is selected.
|
||||
EVT_TEXT Sent when the combobox text changes.
|
||||
================ ===============================================
|
||||
");
|
||||
|
||||
|
||||
@@ -58,8 +66,6 @@ public:
|
||||
%pythonAppend wxComboBox "self._setOORInfo(self)"
|
||||
%pythonAppend wxComboBox() ""
|
||||
|
||||
RefDoc(wxComboBox, ""); // turn it off for the ctors
|
||||
|
||||
DocCtorAStr(
|
||||
wxComboBox(wxWindow* parent, wxWindowID id=-1,
|
||||
const wxString& value = wxPyEmptyString,
|
||||
@@ -69,15 +75,15 @@ public:
|
||||
long style = 0,
|
||||
const wxValidator& validator = wxDefaultValidator,
|
||||
const wxString& name = wxPyComboBoxNameStr),
|
||||
"__init__(Window parent, int id, String value=EmptyString,\n"
|
||||
" Point pos=DefaultPosition, Size size=DefaultSize,\n"
|
||||
" List choices=[], long style=0, Validator validator=DefaultValidator,\n"
|
||||
" String name=ComboBoxNameStr) -> ComboBox",
|
||||
"Constructor, creates and shows a ComboBox control.");
|
||||
"__init__(Window parent, int id, String value=EmptyString,
|
||||
Point pos=DefaultPosition, Size size=DefaultSize,
|
||||
List choices=[], long style=0, Validator validator=DefaultValidator,
|
||||
String name=ComboBoxNameStr) -> ComboBox",
|
||||
"Constructor, creates and shows a ComboBox control.", "");
|
||||
|
||||
DocCtorStrName(
|
||||
wxComboBox(),
|
||||
"Precreate a ComboBox control for 2-phase creation.",
|
||||
"Precreate a ComboBox control for 2-phase creation.", "",
|
||||
PreComboBox);
|
||||
|
||||
|
||||
@@ -90,81 +96,81 @@ public:
|
||||
long style = 0,
|
||||
const wxValidator& validator = wxDefaultValidator,
|
||||
const wxString& name = wxPyChoiceNameStr),
|
||||
"Create(Window parent, int id, String value=EmptyString,\n"
|
||||
" Point pos=DefaultPosition, Size size=DefaultSize,\n"
|
||||
" List choices=[], long style=0, Validator validator=DefaultValidator,\n"
|
||||
" String name=ChoiceNameStr) -> bool",
|
||||
"Actually create the GUI wxComboBox control for 2-phase creation");
|
||||
"Create(Window parent, int id, String value=EmptyString,
|
||||
Point pos=DefaultPosition, Size size=DefaultSize,
|
||||
List choices=[], long style=0, Validator validator=DefaultValidator,
|
||||
String name=ChoiceNameStr) -> bool",
|
||||
"Actually create the GUI wxComboBox control for 2-phase creation", "");
|
||||
|
||||
|
||||
DocDeclStr(
|
||||
virtual wxString , GetValue() const,
|
||||
"Returns the current value in the combobox text field.");
|
||||
"Returns the current value in the combobox text field.", "");
|
||||
|
||||
DocDeclStr(
|
||||
virtual void , SetValue(const wxString& value),
|
||||
"");
|
||||
"", "");
|
||||
|
||||
|
||||
DocDeclStr(
|
||||
virtual void , Copy(),
|
||||
"Copies the selected text to the clipboard.");
|
||||
"Copies the selected text to the clipboard.", "");
|
||||
|
||||
DocDeclStr(
|
||||
virtual void , Cut(),
|
||||
"Copies the selected text to the clipboard and removes the selection.");
|
||||
"Copies the selected text to the clipboard and removes the selection.", "");
|
||||
|
||||
DocDeclStr(
|
||||
virtual void , Paste(),
|
||||
"Pastes text from the clipboard to the text field.");
|
||||
"Pastes text from the clipboard to the text field.", "");
|
||||
|
||||
|
||||
DocDeclStr(
|
||||
virtual void , SetInsertionPoint(long pos),
|
||||
"Sets the insertion point in the combobox text field.");
|
||||
"Sets the insertion point in the combobox text field.", "");
|
||||
|
||||
DocDeclStr(
|
||||
virtual long , GetInsertionPoint() const,
|
||||
"Returns the insertion point for the combobox's text field.");
|
||||
"Returns the insertion point for the combobox's text field.", "");
|
||||
|
||||
DocDeclStr(
|
||||
virtual long , GetLastPosition() const,
|
||||
"Returns the last position in the combobox text field.");
|
||||
"Returns the last position in the combobox text field.", "");
|
||||
|
||||
DocDeclStr(
|
||||
virtual void , Replace(long from, long to, const wxString& value),
|
||||
"Replaces the text between two positions with the given text, in the\n"
|
||||
"combobox text field.");
|
||||
"Replaces the text between two positions with the given text, in the
|
||||
combobox text field.", "");
|
||||
|
||||
DocDeclStr(
|
||||
void , SetSelection(int n),
|
||||
"Sets the item at index 'n' to be the selected item.");
|
||||
"Sets the item at index 'n' to be the selected item.", "");
|
||||
|
||||
DocDeclStrName(
|
||||
virtual void , SetSelection(long from, long to),
|
||||
"Selects the text between the two positions in the combobox text field.",
|
||||
"Selects the text between the two positions in the combobox text field.", "",
|
||||
SetMark);
|
||||
|
||||
DocDeclStr(
|
||||
bool , SetStringSelection(const wxString& string),
|
||||
"Select the item with the specifed 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.");
|
||||
"Set the label for the n'th item (zero based) in the list.", "");
|
||||
|
||||
DocDeclStr(
|
||||
virtual void , SetEditable(bool editable),
|
||||
"");
|
||||
"", "");
|
||||
|
||||
|
||||
DocDeclStr(
|
||||
virtual void , SetInsertionPointEnd(),
|
||||
"Sets the insertion point at the end of the combobox text field.");
|
||||
"Sets the insertion point at the end of the combobox text field.", "");
|
||||
|
||||
DocDeclStr(
|
||||
virtual void , Remove(long from, long to),
|
||||
"Removes the text between the two positions in the combobox text field.");
|
||||
"Removes the text between the two positions in the combobox text field.", "");
|
||||
|
||||
static wxVisualAttributes
|
||||
GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
|
||||
|
||||
Reference in New Issue
Block a user