X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9c8849722a71ee7139e035bca5fdb2ae7b0af570..2706e543a6923d8e743c6ec21fcfe898a52aec88:/docs/latex/wx/combobox.tex diff --git a/docs/latex/wx/combobox.tex b/docs/latex/wx/combobox.tex index 2c6fabcb20..413bed234c 100644 --- a/docs/latex/wx/combobox.tex +++ b/docs/latex/wx/combobox.tex @@ -6,9 +6,13 @@ text field; or a drop-down list without a text field. A combobox permits a single selection only. Combobox items are numbered from zero. +If you need a customized combobox, have a look at \helpref{wxComboCtrl}{wxcomboctrl}, +\helpref{wxOwnerDrawnComboBox}{wxownerdrawncombobox}, \helpref{wxComboPopup}{wxcombopopup} +and the ready-to-use \helpref{wxBitmapComboBox}{wxbitmapcombobox}. + \wxheading{Derived from} -\helpref{wxChoice}{wxchoice}\\ +\helpref{wxControlWithItems}{wxcontrolwithitems}\\ \helpref{wxControl}{wxcontrol}\\ \helpref{wxWindow}{wxwindow}\\ \helpref{wxEvtHandler}{wxevthandler}\\ @@ -16,16 +20,25 @@ A combobox permits a single selection only. Combobox items are numbered from zer \wxheading{Include files} - + + +\wxheading{Library} + +\helpref{wxCore}{librarieslist} \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.} +\twocolitem{\windowstyle{wxTE\_PROCESS\_ENTER}}{The control will generate +the event wxEVT\_COMMAND\_TEXT\_ENTER (otherwise pressing Enter key +is either processed internally by the control or used for navigation between +dialog controls). Windows only.} \end{twocollist} See also \helpref{window styles overview}{windowstyles}. @@ -35,9 +48,12 @@ See also \helpref{window styles overview}{windowstyles}. \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.} +when an item on the list is selected. Note that calling +\helpref{GetValue}{wxcomboboxgetvalue} returns the new value of selection.} \twocolitem{{\bf EVT\_TEXT(id, func)}}{Process a wxEVT\_COMMAND\_TEXT\_UPDATED event, when the combobox text changes.} +\twocolitem{{\bf EVT\_TEXT\_ENTER(id, func)}}{Process a wxEVT\_COMMAND\_TEXT\_ENTER event, +when is pressed in the combobox.} \end{twocollist} \wxheading{See also} @@ -47,7 +63,8 @@ when the combobox text changes.} \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxComboBox::wxComboBox}\label{wxcomboboxconstr} + +\membersection{wxComboBox::wxComboBox}\label{wxcomboboxctor} \func{}{wxComboBox}{\void} @@ -55,7 +72,12 @@ Default constructor. \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{int}{ n}, \param{const wxString }{choices[]},\rtfsp +\param{int}{ n = 0}, \param{const wxString }{choices[] = NULL},\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. @@ -66,6 +88,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,39 +109,20 @@ 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}} +\membersection{wxComboBox::\destruct{wxComboBox}}\label{wxcomboboxdtor} \func{}{\destruct{wxComboBox}}{\void} 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{void* }{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} @@ -126,97 +131,107 @@ 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 +should call or replace this function. See \helpref{wxComboBox::wxComboBox}{wxcomboboxctor}\rtfsp for further details. -\membersection{wxComboBox::Copy}\label{wxcomboboxcopy} -\func{void}{Copy}{\void} +\membersection{wxComboBox::CanCopy}\label{wxcomboboxcancopy} -Copies the selected text to the clipboard. +\constfunc{bool}{CanCopy}{\void} -\membersection{wxComboBox::Cut}\label{wxcomboboxcut} +Returns true if the combobox is editable and there is a text selection to copy to the clipboard. +Only available on Windows. -\func{void}{Cut}{\void} -Copies the selected text to the clipboard and removes the selection. +\membersection{wxComboBox::CanCut}\label{wxcomboboxcancut} -\membersection{wxComboBox::Delete}\label{wxcomboboxdelete} +\constfunc{bool}{CanCut}{\void} -\func{void}{Delete}{\param{int}{ n}} +Returns true if the combobox is editable and there is a text selection to copy to the clipboard. +Only available on Windows. -Deletes an item from the combobox. -\wxheading{Parameters} +\membersection{wxComboBox::CanPaste}\label{wxcomboboxcanpaste} -\docparam{n}{The item to delete, starting from zero.} +\constfunc{bool}{CanPaste}{\void} -\membersection{wxComboBox::FindString}\label{wxcomboboxfindstring} +Returns true if the combobox is editable and there is text on the clipboard that can be pasted into the +text field. Only available on Windows. -\func{int}{FindString}{\param{const wxString\& }{string}} -Finds a choice matching the given string. +\membersection{wxComboBox::CanRedo}\label{wxcomboboxcanredo} -\wxheading{Parameters} +\constfunc{bool}{CanRedo}{\void} -\docparam{string}{The item to find.} +Returns true if the combobox is editable and the last undo can be redone. +Only available on Windows. -\wxheading{Return value} -The position if found, or -1 if not found. +\membersection{wxComboBox::CanUndo}\label{wxcomboboxcanundo} -\membersection{wxComboBox::GetClientData}\label{wxcomboboxgetclientdata} +\constfunc{bool}{CanUndo}{\void} -\constfunc{void*}{GetClientData}{\param{int}{ n}} +Returns true if the combobox is editable and the last edit can be undone. +Only available on Windows. -Returns a pointer to the client data associated with the given item (if any). -\wxheading{Parameters} +\membersection{wxComboBox::Copy}\label{wxcomboboxcopy} -\docparam{n}{An item, starting from zero.} +\func{void}{Copy}{\void} -\wxheading{Return value} +Copies the selected text to the clipboard. -A pointer to the client data, or NULL if the item was not found. -\membersection{wxComboBox::GetInsertionPoint}\label{wxcomboboxgetinsertionpoint} +\membersection{wxComboBox::Cut}\label{wxcomboboxcut} -\constfunc{long}{GetInsertionPoint}{\void} +\func{void}{Cut}{\void} -Returns the insertion point for the combobox's text field. +Copies the selected text to the clipboard and removes the selection. -\membersection{wxComboBox::GetLastPosition}\label{wxcomboboxgetlastposition} -\constfunc{long}{GetLastPosition}{\void} +\membersection{wxComboBox::GetCurrentSelection}\label{wxcomboboxgetcurrentselection} -Returns the last position in the combobox text field. +\constfunc{int}{GetCurrentSelection}{\void} -\membersection{wxComboBox::GetSelection}\label{wxcomboboxgetselection} +This function does the same things as +\helpref{wxChoice::GetCurrentSelection}{wxchoicegetcurrentselection} and +returns the item currently selected in the dropdown list if it's open or the +same thing as \helpref{GetSelection}{wxcontrolwithitemsgetselection} otherwise. -\constfunc{int}{GetSelection}{\void} -Gets the position of the selected string, or -1 if there is no selection. +\membersection{wxComboBox::GetInsertionPoint}\label{wxcomboboxgetinsertionpoint} -\membersection{wxComboBox::GetString}\label{wxcomboboxgetstring} +\constfunc{long}{GetInsertionPoint}{\void} -\constfunc{wxString}{GetString}{\param{int}{ n}} +Returns the insertion point for the combobox's text field. -Returns the string at position {\it n}. +\textbf{Note:} Under wxMSW, this function always returns $0$ if the combobox +doesn't have the focus. -\wxheading{Parameters} -\docparam{n}{The item position, starting from zero.} +\membersection{wxComboBox::GetLastPosition}\label{wxcomboboxgetlastposition} + +\constfunc{virtual wxTextPos}{GetLastPosition}{\void} + +Returns the last position in the combobox text field. -\wxheading{Return value} -The string if the item is found, otherwise the empty string. +\membersection{wxComboBox::GetSelection}\label{wxcomboboxgetselection} + +\constfunc{void}{GetSelection}{\param{long *}{from}, \param{long *}{to}} -\membersection{wxComboBox::GetStringSelection}\label{wxcomboboxgetstringselection} +This is the same as \helpref{wxTextCtrl::GetSelection}{wxtextctrlgetselection} +for the text control which is part of the combobox. Notice that this is a +different method from \helpref{wxControlWithItems::GetSelection}{wxcontrolwithitemsgetselection}. -\constfunc{wxString}{GetStringSelection}{\void} +Currently this method is only implemented in wxMSW and wxGTK. -Gets the selected string. \membersection{wxComboBox::GetValue}\label{wxcomboboxgetvalue} @@ -224,12 +239,6 @@ Gets the selected string. 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} @@ -237,6 +246,14 @@ Returns the number of items in the combobox list. Pastes text from the clipboard to the text field. + +\membersection{wxComboBox::Redo}\label{wxcomboboxredo} + +\func{void}{Redo}{\void} + +Redoes the last undo in the text field. Windows only. + + \membersection{wxComboBox::Replace}\label{wxcomboboxreplace} \func{void}{Replace}{\param{long}{ from}, \param{long}{ to}, \param{const wxString\& }{text}} @@ -251,6 +268,7 @@ Replaces the text between two positions with the given text, in the combobox tex \docparam{text}{The text to insert.} + \membersection{wxComboBox::Remove}\label{wxcomboboxremove} \func{void}{Remove}{\param{long}{ from}, \param{long}{ to}} @@ -263,17 +281,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{void* }{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} @@ -285,18 +292,15 @@ Sets the insertion point in the combobox text field. \docparam{pos}{The new insertion point.} + \membersection{wxComboBox::SetInsertionPointEnd}\label{wxcomboboxsetinsertionpointend} \func{void}{SetInsertionPointEnd}{\void} 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. This does not cause a -wxEVT\_COMMAND\_COMBOBOX\_SELECTED event to get emitted. +\membersection{wxComboBox::SetSelection}\label{wxcomboboxsetselection} \func{void}{SetSelection}{\param{long}{ from}, \param{long}{ to}} @@ -304,20 +308,32 @@ 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.} +\membersection{wxComboBox::Undo}\label{wxcomboboxundo} + +\func{void}{Undo}{\void} + +Undoes the last edit in the text field. Windows only. +