X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/06d20283afba5439c8a2c1b3b7cd3390541da52d..07b87e8d9b49b46bbe71d414feb35db2be278586:/docs/latex/wx/combobox.tex?ds=sidebyside diff --git a/docs/latex/wx/combobox.tex b/docs/latex/wx/combobox.tex index 52d509551a..de4a644391 100644 --- a/docs/latex/wx/combobox.tex +++ b/docs/latex/wx/combobox.tex @@ -8,7 +8,7 @@ A combobox permits a single selection only. Combobox items are numbered from zer \wxheading{Derived from} -\helpref{wxChoice}{wxchoice}\\ +\helpref{wxControlWithItems}{wxcontrolwithitems}\\ \helpref{wxControl}{wxcontrol}\\ \helpref{wxWindow}{wxwindow}\\ \helpref{wxEvtHandler}{wxevthandler}\\ @@ -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.} +\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} @@ -58,6 +59,11 @@ Default constructor. \param{int}{ n}, \param{const wxString }{choices[]},\rtfsp \param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``comboBox"}} +\func{}{wxComboBox}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp +\param{const wxString\& }{value}, \param{const wxPoint\&}{ pos}, \param{const wxSize\&}{ size},\rtfsp +\param{const wxArrayString\& }{choices},\rtfsp +\param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``comboBox"}} + Constructor, creating and showing a combobox. \wxheading{Parameters} @@ -66,6 +72,8 @@ Constructor, creating and showing a combobox. \docparam{id}{Window identifier. A value of -1 indicates a default value.} +\docparam{value}{Initial selection string. An empty string indicates no selection.} + \docparam{pos}{Window position.} \docparam{size}{Window size. If the default size (-1, -1) is specified then the window is sized @@ -85,10 +93,12 @@ 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 +\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}} @@ -96,29 +106,6 @@ a list of strings.} Destructor, destroying the combobox. -\membersection{wxComboBox::Append}\label{wxcomboboxappend} - -\func{void}{Append}{\param{const wxString\& }{item}} - -Adds the item to the end of the combobox. - -\func{void}{Append}{\param{const wxString\& }{ item}, \param{char* }{clientData}} - -Adds the item to the end of the combobox, associating the given data -with the item. - -\wxheading{Parameters} - -\docparam{item}{The string to add.} - -\docparam{clientData}{Client data to associate with the item.} - -\membersection{wxComboBox::Clear}\label{wxcomboboxclear} - -\func{void}{Clear}{\void} - -Clears all strings from the combobox. - \membersection{wxComboBox::Create}\label{wxcomboboxcreate} \func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp @@ -126,6 +113,11 @@ Clears all strings from the combobox. \param{int}{ n}, \param{const wxString }{choices[]},\rtfsp \param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``comboBox"}} +\func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp +\param{const wxString\& }{value}, \param{const wxPoint\&}{ pos}, \param{const wxSize\&}{ size},\rtfsp +\param{const wxArrayString\& }{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 for further details. @@ -142,44 +134,6 @@ Copies the selected text to the clipboard. Copies the selected text to the clipboard and removes the selection. -\membersection{wxComboBox::Delete}\label{wxcomboboxdelete} - -\func{void}{Delete}{\param{int}{ n}} - -Deletes an item from the combobox. - -\wxheading{Parameters} - -\docparam{n}{The item to delete, starting from zero.} - -\membersection{wxComboBox::FindString}\label{wxcomboboxfindstring} - -\func{int}{FindString}{\param{const wxString\& }{string}} - -Finds a choice matching the given string. - -\wxheading{Parameters} - -\docparam{string}{The item to find.} - -\wxheading{Return value} - -The position if found, or -1 if not found. - -\membersection{wxComboBox::GetClientData}\label{wxcomboboxgetclientdata} - -\constfunc{char*}{GetClientData}{\param{int}{ n}} - -Returns a pointer to the client data associated with the given item (if any). - -\wxheading{Parameters} - -\docparam{n}{An item, starting from zero.} - -\wxheading{Return value} - -A pointer to the client data, or NULL if the item was not found. - \membersection{wxComboBox::GetInsertionPoint}\label{wxcomboboxgetinsertionpoint} \constfunc{long}{GetInsertionPoint}{\void} @@ -192,45 +146,12 @@ Returns the insertion point for the combobox's text field. Returns the last position in the combobox text field. -\membersection{wxComboBox::GetSelection}\label{wxcomboboxgetselection} - -\constfunc{int}{GetSelection}{\void} - -Gets the position of the selected string, or -1 if there is no selection. - -\membersection{wxComboBox::GetString}\label{wxcomboboxgetstring} - -\constfunc{wxString}{GetString}{\param{int}{ n}} - -Returns the string at position {\it n}. - -\wxheading{Parameters} - -\docparam{n}{The item position, starting from zero.} - -\wxheading{Return value} - -The string if the item is found, otherwise the empty string. - -\membersection{wxComboBox::GetStringSelection}\label{wxcomboboxgetstringselection} - -\constfunc{wxString}{GetStringSelection}{\void} - -Gets the selected string. - \membersection{wxComboBox::GetValue}\label{wxcomboboxgetvalue} \constfunc{wxString}{GetValue}{\void} Returns the current value in the combobox text field. -\membersection{wxComboBox::Number}\label{wxcomboboxnumber} - -\constfunc{int}{Number}{\void} - -Returns the number of items in the combobox list. -%TODO: make this GetNumber or GetCount? - \membersection{wxComboBox::Paste}\label{wxcomboboxpaste} \func{void}{Paste}{\void} @@ -263,18 +184,6 @@ Removes the text between the two positions in the combobox text field. \docparam{to}{The last position.} -\membersection{wxComboBox::SetClientData}\label{wxcomboboxsetclientdata} - -\func{void}{SetClientData}{\param{int}{ n}, \param{char* }{data}} - -Associates the given client data pointer with the given item. - -\wxheading{Parameters} - -\docparam{n}{The zero-based item.} - -\docparam{data}{The client data.} - \membersection{wxComboBox::SetInsertionPoint}\label{wxcomboboxsetinsertionpoint} \func{void}{SetInsertionPoint}{\param{long}{ pos}} @@ -293,28 +202,29 @@ Sets the insertion point at the end of the combobox text field. \membersection{wxComboBox::SetSelection}\label{wxcomboboxsetselection} -\func{void}{SetSelection}{\param{int}{ n}} - -Selects the given item in the combobox list. - \func{void}{SetSelection}{\param{long}{ from}, \param{long}{ to}} Selects the text between the two positions, in the combobox text field. \wxheading{Parameters} -\docparam{n}{The zero-based item to select.} - \docparam{from}{The first position.} \docparam{to}{The second position.} +\pythonnote{This method is called {\tt SetMark} in wxPython, {\tt SetSelection} +name is kept for +\helpref{wxControlWithItems::SetSelection}{wxcontrolwithitemssetselection}.} + \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.}