X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/0dfff6740755754c36e47e5961e9e5fbd1cd4d4e..7b4b24bca94555afc29762acfc5b100009bb29ff:/docs/latex/wx/comboctrl.tex diff --git a/docs/latex/wx/comboctrl.tex b/docs/latex/wx/comboctrl.tex index f7b7921cfb..f25de03a17 100644 --- a/docs/latex/wx/comboctrl.tex +++ b/docs/latex/wx/comboctrl.tex @@ -137,7 +137,7 @@ Here's how you would create and populate it in a dialog constructor: \begin{twocollist}\itemsep=0pt \twocolitem{\windowstyle{wxCB\_READONLY}}{Text will not be editable.} \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.} @@ -145,9 +145,6 @@ dialog controls). Windows only.} to popup's OnComboDoubleClick. Actual behaviour is defined by a derived class. For instance, wxOwnerDrawnComboBox will cycle an item. This style only applies if wxCB\_READONLY is used as well.} -\twocolitem{\windowstyle{wxCC\_ALT\_KEYS}}{Use keyboard behaviour alternate -to platform default: up and down keys will show popup (instead of cycling value, -for instance, on wxMSW).} \twocolitem{\windowstyle{wxCC\_STD\_BUTTON}}{Drop button will behave more like a standard push button.} \end{twocollist} @@ -241,6 +238,19 @@ Copies the selected text to the clipboard. Copies the selected text to the clipboard and removes the selection. +\membersection{wxComboCtrl::DoSetPopupControl}\label{wxcomboctrldosetpopupcontrol} + +\func{void}{DoSetPopupControl}{\param{wxComboPopup* }{popup}} + +This member function is not normally called in application code. +Instead, it can be implemented in a derived class to return +default wxComboPopup, incase {\tt popup} is NULL. + +\textbf{Note:} If you have implemented OnButtonClick to do +something else than show the popup, then DoSetPopupControl +must always return NULL. + + \membersection{wxComboCtrl::GetBitmapDisabled}\label{wxcomboctrlgetbitmapdisabled} \constfunc{const wxBitmap\&}{GetBitmapDisabled}{\void} @@ -289,6 +299,13 @@ Returns depressed button bitmap that has been set with A reference to the depressed state bitmap. +\membersection{wxComboCtrl::GetButtonSize}\label{wxcomboctrlgetbuttonsize} + +\func{wxSize}{GetButtonSize}{\void} + +Returns current size of the dropdown button. + + \membersection{wxComboCtrl::GetCustomPaintWidth}\label{wxcomboctrlgetcustompaintwidth} \constfunc{int}{GetCustomPaintWidth}{\void} @@ -379,6 +396,14 @@ Get the text control which is part of the combo control. Returns actual indentation in pixels. +\membersection{wxComboCtrl::GetTextRect}\label{wxcomboctrlgettextrect} + +\constfunc{const wxRect\&}{GetTextRect}{\void} + +Returns area covered by the text field (includes everything except +borders and the dropdown button). + + \membersection{wxComboCtrl::GetValue}\label{wxcomboctrlgetvalue} \constfunc{wxString}{GetValue}{\void} @@ -410,6 +435,11 @@ dropdown button click. Default action is to show the popup. +\textbf{Note:} If you implement this to do something else than +show the popup, you must then also implement +\helpref{DoSetPopupControl}{wxcomboctrldosetpopupcontrol} to always +return NULL. + \membersection{wxComboCtrl::Paste}\label{wxcomboctrlpaste} @@ -466,15 +496,14 @@ different kind of button on mouse hover.} \membersection{wxComboCtrl::SetButtonPosition}\label{wxcomboctrlsetbuttonposition} -\func{void}{SetButtonPosition}{\param{int }{width = 0}, \param{int }{height = 0}, \param{int }{side = wxRIGHT}, \param{int }{spacingX = 0}} +\func{void}{SetButtonPosition}{\param{int }{width = -1}, \param{int }{height = -1}, \param{int }{side = wxRIGHT}, \param{int }{spacingX = 0}} Sets size and position of dropdown button. \wxheading{Parameters} -\docparam{width}{If > $0$, defines specific button width. $0$ means platform default, -while negative numbers allow adjusting smaller than default.} -\docparam{height}{Same as width.} +\docparam{width}{Button width. Value <= $0$ specifies default.} +\docparam{height}{Button height. Value <= $0$ specifies default.} \docparam{side}{Indicates which side the button will be placed. Value can be {\tt wxLEFT} or {\tt wxRIGHT}.} \docparam{spacingX}{Horizontal spacing around the button. Default is $0$.} @@ -614,6 +643,14 @@ string must be accepted by the popup (for instance, exist in the dropdown list), otherwise the call to SetValue() is ignored +\membersection{wxComboCtrl::SetValueWithEvent}\label{wxcomboctrlsetvaluewithevent} + +\func{void}{SetValueWithEvent}{\param{const wxString\& }{value}, \param{bool }{withEvent = true}} + +Same as SetValue, but also sends wxCommandEvent of type wxEVT\_COMMAND\_TEXT\_UPDATED +if {\tt withEvent} is \true. + + \membersection{wxComboCtrl::ShowPopup}\label{wxcomboctrlshowpopup} \func{void}{ShowPopup}{\void}