compilation fix after TRUE/FALSE change

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

diff --git a/docs/latex/wx/combobox.tex b/docs/latex/wx/combobox.tex
index b503434fd58a73d73fff805759e2722e6af3a637..1d2b124cda8a382fdeb2a7e246f05886c0a32ab0 100644 (file)
--- a/docs/latex/wx/combobox.tex
+++ b/docs/latex/wx/combobox.tex
@@ -14,13 +14,18 @@ A combobox permits a single selection only. Combobox items are numbered from zer
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 

+\wxheading{Include files}
+
+<wx/combobox.h>
+

 \wxheading{Window styles}
 
 \begin{twocollist}\itemsep=0pt
 \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\_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}
 


@@ -81,6 +86,13 @@ appropriately.}
 
 \helpref{wxComboBox::Create}{wxcomboboxcreate}, \helpref{wxValidator}{wxvalidator}
 
 
 \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}
 \membersection{wxComboBox::\destruct{wxComboBox}}
 
 \func{}{\destruct{wxComboBox}}{\void}


@@ -93,7 +105,7 @@ Destructor, destroying the combobox.
 
 Adds the item to the end of 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.
 
 Adds the item to the end of the combobox, associating the given data
 with the item.


@@ -159,7 +171,7 @@ The position if found, or -1 if not found.
 
 \membersection{wxComboBox::GetClientData}\label{wxcomboboxgetclientdata}
 
 
 \membersection{wxComboBox::GetClientData}\label{wxcomboboxgetclientdata}
 

-\constfunc{char*}{GetClientData}{\param{int}{ n}}
+\constfunc{void*}{GetClientData}{\param{int}{ n}}

 
 Returns a pointer to the client data associated with the given item (if any).
 
 
 Returns a pointer to the client data associated with the given item (if any).
 


@@ -171,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.
 
 
 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}
 \membersection{wxComboBox::GetInsertionPoint}\label{wxcomboboxgetinsertionpoint}
 
 \constfunc{long}{GetInsertionPoint}{\void}


@@ -219,8 +237,13 @@ Returns the current value in the combobox text field.
 
 \constfunc{int}{Number}{\void}
 
 
 \constfunc{int}{Number}{\void}
 

+{\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.
+

 Returns the number of items in the combobox list.
 Returns the number of items in the combobox list.

-%TODO: make this GetNumber or GetCount?

 
 \membersection{wxComboBox::Paste}\label{wxcomboboxpaste}
 
 
 \membersection{wxComboBox::Paste}\label{wxcomboboxpaste}
 


@@ -256,7 +279,7 @@ Removes the text between the two positions in the combobox text field.
 
 \membersection{wxComboBox::SetClientData}\label{wxcomboboxsetclientdata}
 
 
 \membersection{wxComboBox::SetClientData}\label{wxcomboboxsetclientdata}
 

-\func{void}{SetClientData}{\param{int}{ n}, \param{char* }{data}}
+\func{void}{SetClientData}{\param{int}{ n}, \param{void* }{data}}

 
 Associates the given client data pointer with the given item.
 
 
 Associates the given client data pointer with the given item.
 


@@ -286,7 +309,8 @@ Sets the insertion point at the end of the combobox text field.
 
 \func{void}{SetSelection}{\param{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{long}{ from}, \param{long}{ to}}
 
 
 \func{void}{SetSelection}{\param{long}{ from}, \param{long}{ to}}
 


@@ -300,12 +324,32 @@ Selects the text between the two positions, in the combobox text field.
 
 \docparam{to}{The second position.}
 
 
 \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.
 
 \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.}
 \wxheading{Parameters}
 
 \docparam{text}{The text to set.}