documented wxDateSpan

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

diff --git a/docs/latex/wx/combobox.tex b/docs/latex/wx/combobox.tex
index 1615069a704e43efa81b5b5c07746918fa3a64c7..1678b06ebcaf166ece431c3e91dbe8691b5f8349 100644 (file)
--- a/docs/latex/wx/combobox.tex
+++ b/docs/latex/wx/combobox.tex
@@ -8,6 +8,7 @@ A combobox permits a single selection only. Combobox items are numbered from zer
 
 \wxheading{Derived from}
 
 
 \wxheading{Derived from}
 

+\helpref{wxControlWithItems}{wxcontrolwithitems}\\

 \helpref{wxChoice}{wxchoice}\\
 \helpref{wxControl}{wxcontrol}\\
 \helpref{wxWindow}{wxwindow}\\
 \helpref{wxChoice}{wxchoice}\\
 \helpref{wxControl}{wxcontrol}\\
 \helpref{wxWindow}{wxwindow}\\


@@ -23,8 +24,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}
 


@@ -66,6 +68,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,6 +93,8 @@ 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}}
 


@@ -96,29 +102,6 @@ a list of strings.}
 
 Destructor, destroying the combobox.
 
 
 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


@@ -142,44 +125,6 @@ Copies the selected text to the clipboard.
 
 Copies the selected text to the clipboard and removes the selection.
 
 
 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{void*}{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}
 \membersection{wxComboBox::GetInsertionPoint}\label{wxcomboboxgetinsertionpoint}
 
 \constfunc{long}{GetInsertionPoint}{\void}


@@ -192,45 +137,12 @@ 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}
 \membersection{wxComboBox::Paste}\label{wxcomboboxpaste}
 
 \func{void}{Paste}{\void}


@@ -263,18 +175,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 +193,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,6 +213,9 @@ 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.}