X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/c91108763b1621be54af24e24b2fab590db87325..c112e10026f5ad27704c1447be81b51664a0e070:/docs/latex/wx/combobox.tex diff --git a/docs/latex/wx/combobox.tex b/docs/latex/wx/combobox.tex index c09c0060a5..1d2b124cda 100644 --- a/docs/latex/wx/combobox.tex +++ b/docs/latex/wx/combobox.tex @@ -16,15 +16,16 @@ A combobox permits a single selection only. Combobox items are numbered from zer \wxheading{Include files} - + \wxheading{Window styles} \begin{twocollist}\itemsep=0pt \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} @@ -89,6 +90,8 @@ appropriately.} 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}} @@ -180,6 +183,12 @@ Returns a pointer to the client data associated with the given item (if any). A pointer to the client data, or NULL if the item was not found. +\membersection{wxComboBox::GetCount}\label{wxcomboboxgetcount} + +\constfunc{int}{GetCount}{\void} + +Returns the number of items in the combobox. + \membersection{wxComboBox::GetInsertionPoint}\label{wxcomboboxgetinsertionpoint} \constfunc{long}{GetInsertionPoint}{\void} @@ -228,8 +237,13 @@ Returns the current value in the combobox text field. \constfunc{int}{Number}{\void} +{\bf Obsolescence note:} This method is obsolete and was replaced with +\helpref{GetCount}{wxcomboboxgetcount}, please use the new method in the new +code. This method is only available if wxWindows was compiled with +{\tt WXWIN\_COMPATIBILITY\_2\_2} defined and will disappear completely in +future versions. + Returns the number of items in the combobox list. -%TODO: make this GetNumber or GetCount? \membersection{wxComboBox::Paste}\label{wxcomboboxpaste} @@ -313,12 +327,29 @@ Selects the text between the two positions, in the combobox text field. \pythonnote{The second form of this method is called {\tt SetMark} in wxPython.} +\membersection{wxComboBox::SetString}\label{wxcomboboxsetstring} + +\func{void}{SetString}{\param{int }{n}, \param{const wxString\& }{text}} + +Replaces the specified string in the control with another one. + +\wxheading{Parameters} + +\docparam{n}{The zero-based index of the string to replace} + +\docparam{text}{The new value for this item} + +{\bf NB:} This method is currently not implemented in wxGTK. + \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.}