Added wxPROPSHEET_TREEBOOK option

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

diff --git a/docs/latex/wx/combobox.tex b/docs/latex/wx/combobox.tex
index 60bb8d54491ca8acacbfae69b4eb843908de8f16..9f87526fde26fd2e27da142cd33658a2dd8f884d 100644 (file)
--- a/docs/latex/wx/combobox.tex
+++ b/docs/latex/wx/combobox.tex
@@ -27,6 +27,10 @@ A combobox permits a single selection only. Combobox items are numbered from zer
 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{wxPROCESS\_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}.
@@ -51,6 +55,7 @@ when <RETURN> is pressed in the combobox.}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
+
 \membersection{wxComboBox::wxComboBox}\label{wxcomboboxctor}
 
 \func{}{wxComboBox}{\void}
@@ -59,7 +64,7 @@ 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
@@ -103,12 +108,14 @@ 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}}\label{wxcomboboxdtor}
 
 \func{}{\destruct{wxComboBox}}{\void}
 
 Destructor, destroying the combobox.
 
+
 \membersection{wxComboBox::Create}\label{wxcomboboxcreate}
 
 \func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp
@@ -125,6 +132,7 @@ Creates the combobox for two-step construction. Derived classes
 should call or replace this function. See \helpref{wxComboBox::wxComboBox}{wxcomboboxctor}\rtfsp
 for further details.
 
+
 \membersection{wxComboBox::CanCopy}\label{wxcomboboxcancopy}
 
 \constfunc{bool}{CanCopy}{\void}
@@ -132,6 +140,7 @@ for further details.
 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}
@@ -139,6 +148,7 @@ Only available on Windows.
 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}
@@ -146,6 +156,7 @@ Only available on Windows.
 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}
@@ -153,6 +164,7 @@ text field. Only available on Windows.
 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}
@@ -160,48 +172,59 @@ Only available on Windows.
 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}
 
 Copies the selected text to the clipboard.
 
+
 \membersection{wxComboBox::Cut}\label{wxcomboboxcut}
 
 \func{void}{Cut}{\void}
 
 Copies the selected text to the clipboard and removes the selection.
 
+
 \membersection{wxComboBox::GetInsertionPoint}\label{wxcomboboxgetinsertionpoint}
 
 \constfunc{long}{GetInsertionPoint}{\void}
 
 Returns the insertion point for the combobox's text field.
 
+\textbf{Note:} Under wxMSW, this function always returns $0$ if the combobox
+doesn't have the focus.
+
+
 \membersection{wxComboBox::GetLastPosition}\label{wxcomboboxgetlastposition}
 
 \constfunc{virtual wxTextPos}{GetLastPosition}{\void}
 
 Returns the last position 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::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}}
@@ -216,6 +239,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}}
@@ -228,6 +252,7 @@ Removes the text between the two positions in the combobox text field.
 
 \docparam{to}{The last position.}
 
+
 \membersection{wxComboBox::SetInsertionPoint}\label{wxcomboboxsetinsertionpoint}
 
 \func{void}{SetInsertionPoint}{\param{long}{ pos}}
@@ -238,12 +263,14 @@ 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{long}{ from}, \param{long}{ to}}
@@ -260,6 +287,7 @@ Selects the text between the two positions, in the combobox text field.
 name is kept for
 \helpref{wxControlWithItems::SetSelection}{wxcontrolwithitemssetselection}.}
 
+
 \membersection{wxComboBox::SetValue}\label{wxcomboboxsetvalue}
 
 \func{void}{SetValue}{\param{const wxString\& }{text}}
@@ -273,6 +301,7 @@ 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}