X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/bed5584e2a93de909120d3eed5710f48d590a2a8..65baafba0e8cd74f2264b7e2f7625ff5bea84864:/docs/latex/wx/combobox.tex diff --git a/docs/latex/wx/combobox.tex b/docs/latex/wx/combobox.tex index 1678b06ebc..60bb8d5449 100644 --- a/docs/latex/wx/combobox.tex +++ b/docs/latex/wx/combobox.tex @@ -9,7 +9,6 @@ A combobox permits a single selection only. Combobox items are numbered from zer \wxheading{Derived from} \helpref{wxControlWithItems}{wxcontrolwithitems}\\ -\helpref{wxChoice}{wxchoice}\\ \helpref{wxControl}{wxcontrol}\\ \helpref{wxWindow}{wxwindow}\\ \helpref{wxEvtHandler}{wxevthandler}\\ @@ -37,9 +36,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} @@ -49,7 +51,7 @@ when the combobox text changes.} \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxComboBox::wxComboBox}\label{wxcomboboxconstr} +\membersection{wxComboBox::wxComboBox}\label{wxcomboboxctor} \func{}{wxComboBox}{\void} @@ -60,6 +62,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} @@ -96,7 +103,7 @@ 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} @@ -109,10 +116,50 @@ Destructor, destroying 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::CanCopy}\label{wxcomboboxcancopy} + +\constfunc{bool}{CanCopy}{\void} + +Returns true if the combobox is editable and there is a text selection to copy to the clipboard. +Only available on Windows. + +\membersection{wxComboBox::CanCut}\label{wxcomboboxcancut} + +\constfunc{bool}{CanCut}{\void} + +Returns true if the combobox is editable and there is a text selection to copy to the clipboard. +Only available on Windows. + +\membersection{wxComboBox::CanPaste}\label{wxcomboboxcanpaste} + +\constfunc{bool}{CanPaste}{\void} + +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. + +\membersection{wxComboBox::CanRedo}\label{wxcomboboxcanredo} + +\constfunc{bool}{CanRedo}{\void} + +Returns true if the combobox is editable and the last undo can be redone. +Only available on Windows. + +\membersection{wxComboBox::CanUndo}\label{wxcomboboxcanundo} + +\constfunc{bool}{CanUndo}{\void} + +Returns true if the combobox is editable and the last edit can be undone. +Only available on Windows. + \membersection{wxComboBox::Copy}\label{wxcomboboxcopy} \func{void}{Copy}{\void} @@ -133,7 +180,7 @@ Returns the insertion point for the combobox's text field. \membersection{wxComboBox::GetLastPosition}\label{wxcomboboxgetlastposition} -\constfunc{long}{GetLastPosition}{\void} +\constfunc{virtual wxTextPos}{GetLastPosition}{\void} Returns the last position in the combobox text field. @@ -149,6 +196,12 @@ Returns the current value in the combobox text field. 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}} @@ -204,7 +257,7 @@ Selects the text between the two positions, in the combobox text field. \docparam{to}{The second position.} \pythonnote{This method is called {\tt SetMark} in wxPython, {\tt SetSelection} -name is kept for +name is kept for \helpref{wxControlWithItems::SetSelection}{wxcontrolwithitemssetselection}.} \membersection{wxComboBox::SetValue}\label{wxcomboboxsetvalue} @@ -220,4 +273,9 @@ the combobox choices list, otherwise the call to SetValue() is ignored. \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.