X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a660d684eda27638bca0384b2058911a31c8e845..2e25e7b7629b9c362d1fc689b536032a35441b8c:/docs/latex/wx/combobox.tex diff --git a/docs/latex/wx/combobox.tex b/docs/latex/wx/combobox.tex index 14a6978125..1d2b124cda 100644 --- a/docs/latex/wx/combobox.tex +++ b/docs/latex/wx/combobox.tex @@ -14,21 +14,37 @@ 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} 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}}} @@ -38,10 +54,10 @@ See also \helpref{window styles overview}{windowstyles}. Default constructor. -\func{}{wxComboBox}{\param{wxWindow*}{ parent}, \param{const wxWindowID}{ id},\rtfsp +\func{}{wxComboBox}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp \param{const wxString\& }{value = ``"}, \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp -\param{const int}{ n}, \param{const wxString }{choices[]},\rtfsp -\param{const long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``comboBox"}} +\param{int}{ n}, \param{const wxString }{choices[]},\rtfsp +\param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``comboBox"}} Constructor, creating and showing a combobox. @@ -70,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} @@ -82,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. @@ -101,10 +124,10 @@ Clears all strings from the combobox. \membersection{wxComboBox::Create}\label{wxcomboboxcreate} -\func{bool}{Create}{\param{wxWindow*}{ parent}, \param{const wxWindowID}{ id},\rtfsp +\func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp \param{const wxString\& }{value = ``"}, \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp -\param{const int}{ n}, \param{const wxString }{choices[]},\rtfsp -\param{const long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``comboBox"}} +\param{int}{ n}, \param{const wxString }{choices[]},\rtfsp +\param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``comboBox"}} Creates the combobox for two-step construction. Derived classes should call or replace this function. See \helpref{wxComboBox::wxComboBox}{wxcomboboxconstr}\rtfsp @@ -124,7 +147,7 @@ Copies the selected text to the clipboard and removes the selection. \membersection{wxComboBox::Delete}\label{wxcomboboxdelete} -\func{void}{Delete}{\param{const int}{ n}} +\func{void}{Delete}{\param{int}{ n}} Deletes an item from the combobox. @@ -132,16 +155,6 @@ Deletes an item from the combobox. \docparam{n}{The item to delete, starting from zero.} -\membersection{wxComboBox::Deselect}\label{wxcomboboxdeselect} - -\func{void}{Deselect}{\param{const int}{ n}} - -Deselects an item in the combobox. - -\wxheading{Parameters} - -\docparam{n}{The item to deselect, starting from zero.} - \membersection{wxComboBox::FindString}\label{wxcomboboxfindstring} \func{int}{FindString}{\param{const wxString\& }{string}} @@ -158,7 +171,7 @@ The position if found, or -1 if not found. \membersection{wxComboBox::GetClientData}\label{wxcomboboxgetclientdata} -\constfunc{char*}{GetClientData}{\param{const int}{ n}} +\constfunc{void*}{GetClientData}{\param{int}{ n}} Returns a pointer to the client data associated with the given item (if any). @@ -170,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} @@ -218,9 +237,13 @@ Returns the current value in the combobox text field. \constfunc{int}{Number}{\void} -Returns the number of items in the combobox list. +{\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. -TODO: make this GetNumber or GetCount? +Returns the number of items in the combobox list. \membersection{wxComboBox::Paste}\label{wxcomboboxpaste} @@ -230,7 +253,7 @@ Pastes text from the clipboard to the text field. \membersection{wxComboBox::Replace}\label{wxcomboboxreplace} -\func{void}{Replace}{\param{const long}{ from}, \param{const long}{ to}, \param{const wxString\& }{text}} +\func{void}{Replace}{\param{long}{ from}, \param{long}{ to}, \param{const wxString\& }{text}} Replaces the text between two positions with the given text, in the combobox text field. @@ -244,7 +267,7 @@ Replaces the text between two positions with the given text, in the combobox tex \membersection{wxComboBox::Remove}\label{wxcomboboxremove} -\func{void}{Remove}{\param{const long}{ from}, \param{const long}{ to}} +\func{void}{Remove}{\param{long}{ from}, \param{long}{ to}} Removes the text between the two positions in the combobox text field. @@ -256,7 +279,7 @@ Removes the text between the two positions in the combobox text field. \membersection{wxComboBox::SetClientData}\label{wxcomboboxsetclientdata} -\func{void}{SetClientData}{\param{const int}{ n}, \param{char* }{data}} +\func{void}{SetClientData}{\param{int}{ n}, \param{void* }{data}} Associates the given client data pointer with the given item. @@ -268,7 +291,7 @@ Associates the given client data pointer with the given item. \membersection{wxComboBox::SetInsertionPoint}\label{wxcomboboxsetinsertionpoint} -\func{void}{SetInsertionPoint}{\param{const long}{ pos}} +\func{void}{SetInsertionPoint}{\param{long}{ pos}} Sets the insertion point in the combobox text field. @@ -284,11 +307,12 @@ Sets the insertion point at the end of the combobox text field. \membersection{wxComboBox::SetSelection}\label{wxcomboboxsetselection} -\func{void}{SetSelection}{\param{const int}{ n}} +\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{const long}{ from}, \param{const long}{ to}} +\func{void}{SetSelection}{\param{long}{ from}, \param{long}{ to}} Selects the text between the two positions, in the combobox text field. @@ -300,12 +324,32 @@ 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::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.}