X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/eaaa6a06a25774c18d10bb8182cc1934ed0ed9aa..e06b95691f1cc89509100700985101c34da7759e:/docs/latex/wx/combobox.tex?ds=sidebyside diff --git a/docs/latex/wx/combobox.tex b/docs/latex/wx/combobox.tex index 4d79cda441..c09c0060a5 100644 --- a/docs/latex/wx/combobox.tex +++ b/docs/latex/wx/combobox.tex @@ -14,10 +14,14 @@ 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.} @@ -26,9 +30,20 @@ displaying the current selection.} See also \helpref{window styles overview}{windowstyles}. +\wxheading{Event handling} + +\twocolwidtha{7cm} +\begin{twocollist}\itemsep=0pt +\twocolitem{{\bf EVT\_COMBOBOX(id, func)}}{Process a wxEVT\_COMMAND\_COMBOBOX\_SELECTED event, +when an item on the list is selected.} +\twocolitem{{\bf EVT\_TEXT(id, func)}}{Process a wxEVT\_COMMAND\_TEXT\_UPDATED event, +when the combobox text changes.} +\end{twocollist} + \wxheading{See also} -\helpref{wxListBox}{wxlistbox}, \helpref{wxTextCtrl}{wxtextctrl}, \helpref{wxChoice}{wxchoice} +\helpref{wxListBox}{wxlistbox}, \helpref{wxTextCtrl}{wxtextctrl}, \helpref{wxChoice}{wxchoice}, +\rtfsp\helpref{wxCommandEvent}{wxcommandevent} \latexignore{\rtfignore{\wxheading{Members}}} @@ -70,6 +85,11 @@ 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.} + + \membersection{wxComboBox::\destruct{wxComboBox}} \func{}{\destruct{wxComboBox}}{\void} @@ -82,7 +102,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. @@ -148,7 +168,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). @@ -209,8 +229,7 @@ Returns the current value in the combobox text field. \constfunc{int}{Number}{\void} Returns the number of items in the combobox list. - -TODO: make this GetNumber or GetCount? +%TODO: make this GetNumber or GetCount? \membersection{wxComboBox::Paste}\label{wxcomboboxpaste} @@ -246,7 +265,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. @@ -276,7 +295,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}} @@ -290,6 +310,9 @@ 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}}