Bug 1099143 and more occurences of the same set vs. get mistakes.

[wxWidgets.git] / docs / latex / wx / combobox.tex

diff --git a/docs/latex/wx/combobox.tex b/docs/latex/wx/combobox.tex
index 1615069a704e43efa81b5b5c07746918fa3a64c7..917a541edb4dd6d08cdb33dab635a21295062dec 100644 (file)
--- 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}
 
 
 \wxheading{Derived from}
 

-\helpref{wxChoice}{wxchoice}\\
+\helpref{wxControlWithItems}{wxcontrolwithitems}\\

 \helpref{wxControl}{wxcontrol}\\
 \helpref{wxWindow}{wxwindow}\\
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxControl}{wxcontrol}\\
 \helpref{wxWindow}{wxwindow}\\
 \helpref{wxEvtHandler}{wxevthandler}\\


@@ -23,8 +23,9 @@ A combobox permits a single selection only. Combobox items are numbered from zer
 \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.}
 \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.}
 \end{twocollist}
 
 \twocolitem{\windowstyle{wxCB\_SORT}}{Sorts the entries in the list alphabetically.}
 \end{twocollist}
 


@@ -35,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,
 \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(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 <RETURN> is pressed in the combobox.}

 \end{twocollist}
 
 \wxheading{See also}
 \end{twocollist}
 
 \wxheading{See also}


@@ -47,7 +51,7 @@ when the combobox text changes.}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxComboBox::wxComboBox}\label{wxcomboboxconstr}
+\membersection{wxComboBox::wxComboBox}\label{wxcomboboxctor}

 
 \func{}{wxComboBox}{\void}
 
 
 \func{}{wxComboBox}{\void}
 


@@ -58,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"}}
 
 \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}
 Constructor, creating and showing a combobox.
 
 \wxheading{Parameters}


@@ -66,6 +75,8 @@ Constructor, creating and showing a combobox.
 
 \docparam{id}{Window identifier. A value of -1 indicates a default value.}
 
 
 \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
 \docparam{pos}{Window position.}
 
 \docparam{size}{Window size. If the default size (-1, -1) is specified then the window is sized


@@ -89,36 +100,15 @@ appropriately.}
 and {\tt choices} arguments are to a single argument, which is
 a list of strings.}
 
 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.
 
 
 \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}
 
 \func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp
 \membersection{wxComboBox::Create}\label{wxcomboboxcreate}
 
 \func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp


@@ -126,59 +116,61 @@ 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"}}
 
 \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
 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.
 
 for further details.
 

-\membersection{wxComboBox::Copy}\label{wxcomboboxcopy}
-
-\func{void}{Copy}{\void}
-
-Copies the selected text to the clipboard.
-
-\membersection{wxComboBox::Cut}\label{wxcomboboxcut}
-
-\func{void}{Cut}{\void}
+\membersection{wxComboBox::CanCopy}\label{wxcomboboxcancopy}

 
 

-Copies the selected text to the clipboard and removes the selection.
-
-\membersection{wxComboBox::Delete}\label{wxcomboboxdelete}
+\constfunc{bool}{CanCopy}{\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.
+\membersection{wxComboBox::CanCut}\label{wxcomboboxcancut}

 
 

-\wxheading{Parameters}
+\constfunc{bool}{CanCut}{\void}

 
 

-\docparam{n}{The item to delete, starting from zero.}
+Returns true if the combobox is editable and there is a text selection to copy to the clipboard.
+Only available on Windows.

 
 

-\membersection{wxComboBox::FindString}\label{wxcomboboxfindstring}
+\membersection{wxComboBox::CanPaste}\label{wxcomboboxcanpaste}

 
 

-\func{int}{FindString}{\param{const wxString\& }{string}}
+\constfunc{bool}{CanPaste}{\void}

 
 

-Finds a choice matching the given string.
-
-\wxheading{Parameters}
+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.

 
 

-\docparam{string}{The item to find.}
+\membersection{wxComboBox::CanRedo}\label{wxcomboboxcanredo}

 
 

-\wxheading{Return value}
+\constfunc{bool}{CanRedo}{\void}

 
 

-The position if found, or -1 if not found.
+Returns true if the combobox is editable and the last undo can be redone.
+Only available on Windows.
+ 
+\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.
+ 
+\membersection{wxComboBox::Copy}\label{wxcomboboxcopy}

 
 

-Returns a pointer to the client data associated with the given item (if any).
+\func{void}{Copy}{\void}

 
 

-\wxheading{Parameters}
+Copies the selected text to the clipboard.

 
 

-\docparam{n}{An item, starting from zero.}
+\membersection{wxComboBox::Cut}\label{wxcomboboxcut}

 
 

-\wxheading{Return value}
+\func{void}{Cut}{\void}

 
 

-A pointer to the client data, or NULL if the item was not found.
+Copies the selected text to the clipboard and removes the selection.

 
 \membersection{wxComboBox::GetInsertionPoint}\label{wxcomboboxgetinsertionpoint}
 
 
 \membersection{wxComboBox::GetInsertionPoint}\label{wxcomboboxgetinsertionpoint}
 


@@ -192,51 +184,24 @@ Returns the insertion point for the combobox's text field.
 
 Returns the last position in the combobox 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::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}
 
 Pastes text from the clipboard to the text field.
 
 \membersection{wxComboBox::Paste}\label{wxcomboboxpaste}
 
 \func{void}{Paste}{\void}
 
 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}}
 \membersection{wxComboBox::Replace}\label{wxcomboboxreplace}
 
 \func{void}{Replace}{\param{long}{ from}, \param{long}{ to}, \param{const wxString\& }{text}}


@@ -263,18 +228,6 @@ Removes the text between the two positions in the combobox text field.
 
 \docparam{to}{The last position.}
 
 
 \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}
 
 \func{void}{SetInsertionPoint}{\param{long}{ pos}}
 \membersection{wxComboBox::SetInsertionPoint}\label{wxcomboboxsetinsertionpoint}
 
 \func{void}{SetInsertionPoint}{\param{long}{ pos}}


@@ -293,25 +246,19 @@ Sets the insertion point at the end of the combobox text field.
 
 \membersection{wxComboBox::SetSelection}\label{wxcomboboxsetselection}
 
 
 \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.
-

 \func{void}{SetSelection}{\param{long}{ from}, \param{long}{ to}}
 
 Selects the text between the two positions, in the combobox text field.
 
 \wxheading{Parameters}
 
 \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.}
 
 \docparam{from}{The first position.}
 
 \docparam{to}{The second position.}
 

-\pythonnote{The second form of this method is called {\tt SetMark} in
-wxPython.}
+\pythonnote{This method is called {\tt SetMark} in wxPython, {\tt SetSelection}
+name is kept for 
+\helpref{wxControlWithItems::SetSelection}{wxcontrolwithitemssetselection}.}

 
 \membersection{wxComboBox::SetValue}\label{wxcomboboxsetvalue}
 
 
 \membersection{wxComboBox::SetValue}\label{wxcomboboxsetvalue}
 


@@ -319,8 +266,16 @@ wxPython.}
 
 Sets the text for the combobox text field.
 
 
 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.}
 
 \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.