X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/5b6aa0ff15be125c6f5f641e586002ec0c0330a2..c8499e53d820ed68ad6a1e9b25d963107641af14:/docs/latex/wx/combobox.tex diff --git a/docs/latex/wx/combobox.tex b/docs/latex/wx/combobox.tex index b503434fd5..7b780e526c 100644 --- a/docs/latex/wx/combobox.tex +++ b/docs/latex/wx/combobox.tex @@ -14,13 +14,18 @@ A combobox permits a single selection only. Combobox items are numbered from zer \helpref{wxEvtHandler}{wxevthandler}\\ \helpref{wxObject}{wxobject} +\wxheading{Include files} + + + \wxheading{Window styles} \begin{twocollist}\itemsep=0pt -\twocolitem{\windowstyle{wxCB\_SIMPLE}}{Creates a combobox with a permanently displayed list.} +\twocolitem{\windowstyle{wxCB\_SIMPLE}}{Creates a combobox with a permanently displayed list. Windows only. } \twocolitem{\windowstyle{wxCB\_DROPDOWN}}{Creates a combobox with a drop-down list.} -\twocolitem{\windowstyle{wxCB\_READONLY}}{Creates a combo box consisting of a drop-down list and static text item -displaying the current selection.} +\twocolitem{\windowstyle{wxCB\_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.} \twocolitem{\windowstyle{wxCB\_SORT}}{Sorts the entries in the list alphabetically.} \end{twocollist} @@ -81,6 +86,13 @@ appropriately.} \helpref{wxComboBox::Create}{wxcomboboxcreate}, \helpref{wxValidator}{wxvalidator} +\pythonnote{The wxComboBox constructor in wxPython reduces the {\tt n} +and {\tt choices} arguments are to a single argument, which is +a list of strings.} + +\perlnote{In wxPerl there is just an array reference in place of {\tt n} +and {\tt choices}.} + \membersection{wxComboBox::\destruct{wxComboBox}} \func{}{\destruct{wxComboBox}}{\void} @@ -93,7 +105,7 @@ Destructor, destroying the combobox. Adds the item to the end of the combobox. -\func{void}{Append}{\param{const wxString\& }{ item}, \param{char* }{clientData}} +\func{void}{Append}{\param{const wxString\& }{ item}, \param{void* }{clientData}} Adds the item to the end of the combobox, associating the given data with the item. @@ -159,7 +171,7 @@ The position if found, or -1 if not found. \membersection{wxComboBox::GetClientData}\label{wxcomboboxgetclientdata} -\constfunc{char*}{GetClientData}{\param{int}{ n}} +\constfunc{void*}{GetClientData}{\param{int}{ n}} Returns a pointer to the client data associated with the given item (if any). @@ -256,7 +268,7 @@ Removes the text between the two positions in the combobox text field. \membersection{wxComboBox::SetClientData}\label{wxcomboboxsetclientdata} -\func{void}{SetClientData}{\param{int}{ n}, \param{char* }{data}} +\func{void}{SetClientData}{\param{int}{ n}, \param{void* }{data}} Associates the given client data pointer with the given item. @@ -286,7 +298,8 @@ Sets the insertion point at the end of the combobox text field. \func{void}{SetSelection}{\param{int}{ n}} -Selects the given item in the combobox list. +Selects the given item in the combobox list. This does not cause a +wxEVT\_COMMAND\_COMBOBOX\_SELECTED event to get emitted. \func{void}{SetSelection}{\param{long}{ from}, \param{long}{ to}} @@ -300,12 +313,18 @@ Selects the text between the two positions, in the combobox text field. \docparam{to}{The second position.} +\pythonnote{The second form of this method is called {\tt SetMark} in +wxPython.} + \membersection{wxComboBox::SetValue}\label{wxcomboboxsetvalue} \func{void}{SetValue}{\param{const wxString\& }{text}} Sets the text for the combobox text field. +{\bf NB:} For a combobox with {\tt wxCB\_READONLY} style the string must be in +the combobox choices list, otherwise the call to SetValue() is ignored. + \wxheading{Parameters} \docparam{text}{The text to set.}