Applied patch [ 1747059 ] wxAUIDefaultTabArt wxAUI_NB_BOTTOM

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

diff --git a/docs/latex/wx/combobox.tex b/docs/latex/wx/combobox.tex
index 15f8e7647abbd670af7ae3da26a9e7cce507b5c2..413bed234cada9a236e5326487cdd696ae8cd5d7 100644 (file)
--- a/docs/latex/wx/combobox.tex
+++ b/docs/latex/wx/combobox.tex
@@ -6,6 +6,10 @@ text field; or a drop-down list without a text field.
 
 A combobox permits a single selection only. Combobox items are numbered from zero.
 
 
 A combobox permits a single selection only. Combobox items are numbered from zero.
 

+If you need a customized combobox, have a look at \helpref{wxComboCtrl}{wxcomboctrl},
+\helpref{wxOwnerDrawnComboBox}{wxownerdrawncombobox}, \helpref{wxComboPopup}{wxcombopopup}
+and the ready-to-use \helpref{wxBitmapComboBox}{wxbitmapcombobox}.
+

 \wxheading{Derived from}
 
 \helpref{wxControlWithItems}{wxcontrolwithitems}\\
 \wxheading{Derived from}
 
 \helpref{wxControlWithItems}{wxcontrolwithitems}\\


@@ -18,6 +22,10 @@ A combobox permits a single selection only. Combobox items are numbered from zer
 
 <wx/combobox.h>
 
 
 <wx/combobox.h>
 

+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+

 \wxheading{Window styles}
 
 \begin{twocollist}\itemsep=0pt
 \wxheading{Window styles}
 
 \begin{twocollist}\itemsep=0pt


@@ -27,7 +35,7 @@ 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.}
 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
+\twocolitem{\windowstyle{wxTE\_PROCESS\_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.}
 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.}


@@ -55,6 +63,7 @@ when <RETURN> is pressed in the combobox.}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

+

 \membersection{wxComboBox::wxComboBox}\label{wxcomboboxctor}
 
 \func{}{wxComboBox}{\void}
 \membersection{wxComboBox::wxComboBox}\label{wxcomboboxctor}
 
 \func{}{wxComboBox}{\void}


@@ -63,7 +72,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
 
 \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
 \param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``comboBox"}}
 
 \func{}{wxComboBox}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp


@@ -107,12 +116,14 @@ a list of strings.}
 \perlnote{In wxPerl there is just an array reference in place of {\tt n}
 and {\tt choices}.}
 
 \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::\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
 \membersection{wxComboBox::Create}\label{wxcomboboxcreate}
 
 \func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp


@@ -129,6 +140,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.
 
 should call or replace this function. See \helpref{wxComboBox::wxComboBox}{wxcomboboxctor}\rtfsp
 for further details.
 

+

 \membersection{wxComboBox::CanCopy}\label{wxcomboboxcancopy}
 
 \constfunc{bool}{CanCopy}{\void}
 \membersection{wxComboBox::CanCopy}\label{wxcomboboxcancopy}
 
 \constfunc{bool}{CanCopy}{\void}


@@ -136,6 +148,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.
 
 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}
 \membersection{wxComboBox::CanCut}\label{wxcomboboxcancut}
 
 \constfunc{bool}{CanCut}{\void}


@@ -143,6 +156,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.
 
 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}
 \membersection{wxComboBox::CanPaste}\label{wxcomboboxcanpaste}
 
 \constfunc{bool}{CanPaste}{\void}


@@ -150,6 +164,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.
 
 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}
 \membersection{wxComboBox::CanRedo}\label{wxcomboboxcanredo}
 
 \constfunc{bool}{CanRedo}{\void}


@@ -157,6 +172,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.
 
 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}
 \membersection{wxComboBox::CanUndo}\label{wxcomboboxcanundo}
 
 \constfunc{bool}{CanUndo}{\void}


@@ -164,48 +180,80 @@ Only available on Windows.
 Returns true if the combobox is editable and the last edit can be undone.
 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::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::Cut}\label{wxcomboboxcut}
 
 \func{void}{Cut}{\void}
 
 Copies the selected text to the clipboard and removes the selection.
 

+
+\membersection{wxComboBox::GetCurrentSelection}\label{wxcomboboxgetcurrentselection}
+
+\constfunc{int}{GetCurrentSelection}{\void}
+
+This function does the same things as 
+\helpref{wxChoice::GetCurrentSelection}{wxchoicegetcurrentselection} and
+returns the item currently selected in the dropdown list if it's open or the
+same thing as \helpref{GetSelection}{wxcontrolwithitemsgetselection} otherwise.
+
+

 \membersection{wxComboBox::GetInsertionPoint}\label{wxcomboboxgetinsertionpoint}
 
 \constfunc{long}{GetInsertionPoint}{\void}
 
 Returns the insertion point for the combobox's text field.
 
 \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::GetLastPosition}\label{wxcomboboxgetlastposition}
 
 \constfunc{virtual wxTextPos}{GetLastPosition}{\void}
 
 Returns the last position in the combobox text field.
 

+
+\membersection{wxComboBox::GetSelection}\label{wxcomboboxgetselection}
+
+\constfunc{void}{GetSelection}{\param{long *}{from}, \param{long *}{to}}
+
+This is the same as \helpref{wxTextCtrl::GetSelection}{wxtextctrlgetselection} 
+for the text control which is part of the combobox. Notice that this is a
+different method from \helpref{wxControlWithItems::GetSelection}{wxcontrolwithitemsgetselection}.
+
+Currently this method is only implemented in wxMSW and wxGTK.
+
+

 \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::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::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}}


@@ -220,6 +268,7 @@ Replaces the text between two positions with the given text, in the combobox tex
 
 \docparam{text}{The text to insert.}
 
 
 \docparam{text}{The text to insert.}
 

+

 \membersection{wxComboBox::Remove}\label{wxcomboboxremove}
 
 \func{void}{Remove}{\param{long}{ from}, \param{long}{ to}}
 \membersection{wxComboBox::Remove}\label{wxcomboboxremove}
 
 \func{void}{Remove}{\param{long}{ from}, \param{long}{ to}}


@@ -232,6 +281,7 @@ Removes the text between the two positions in the combobox text field.
 
 \docparam{to}{The last position.}
 
 
 \docparam{to}{The last position.}
 

+

 \membersection{wxComboBox::SetInsertionPoint}\label{wxcomboboxsetinsertionpoint}
 
 \func{void}{SetInsertionPoint}{\param{long}{ pos}}
 \membersection{wxComboBox::SetInsertionPoint}\label{wxcomboboxsetinsertionpoint}
 
 \func{void}{SetInsertionPoint}{\param{long}{ pos}}


@@ -242,12 +292,14 @@ Sets the insertion point in the combobox text field.
 
 \docparam{pos}{The new insertion point.}
 
 
 \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::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}}
 \membersection{wxComboBox::SetSelection}\label{wxcomboboxsetselection}
 
 \func{void}{SetSelection}{\param{long}{ from}, \param{long}{ to}}


@@ -264,6 +316,7 @@ Selects the text between the two positions, in the combobox text field.
 name is kept for
 \helpref{wxControlWithItems::SetSelection}{wxcontrolwithitemssetselection}.}
 
 name is kept for
 \helpref{wxControlWithItems::SetSelection}{wxcontrolwithitemssetselection}.}
 

+

 \membersection{wxComboBox::SetValue}\label{wxcomboboxsetvalue}
 
 \func{void}{SetValue}{\param{const wxString\& }{text}}
 \membersection{wxComboBox::SetValue}\label{wxcomboboxsetvalue}
 
 \func{void}{SetValue}{\param{const wxString\& }{text}}


@@ -277,6 +330,7 @@ the combobox choices list, otherwise the call to SetValue() is ignored.
 
 \docparam{text}{The text to set.}
 
 
 \docparam{text}{The text to set.}
 

+

 \membersection{wxComboBox::Undo}\label{wxcomboboxundo}
 
 \func{void}{Undo}{\void}
 \membersection{wxComboBox::Undo}\label{wxcomboboxundo}
 
 \func{void}{Undo}{\void}