]> git.saurik.com Git - wxWidgets.git/commitdiff
[ 1564113 ] wxComboCtrl and wxODComboBox documentation update
authorRobert Roebling <robert@roebling.de>
Sat, 23 Sep 2006 16:16:08 +0000 (16:16 +0000)
committerRobert Roebling <robert@roebling.de>
Sat, 23 Sep 2006 16:16:08 +0000 (16:16 +0000)
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@41389 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

docs/latex/wx/comboctrl.tex
docs/latex/wx/odcbox.tex

index b7689955dc3d04fefa35ee9af2e964be0b8230a3..f25de03a1701b973b37cceb93792a24bf608915e 100644 (file)
@@ -238,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}
@@ -383,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}
@@ -414,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}
 
@@ -617,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}
index 460966abc65092568880db5322dcb207390aa9a6..4d9ac667300a16065fae26f20b0351192bbeb32c 100644 (file)
@@ -140,6 +140,20 @@ should call or replace this function. See
 for further details.
 
 
+\membersection{wxOwnerDrawnComboBox::GetWidestItem}\label{wxownerdrawncomboboxgetwidestitem}
+
+\constfunc{int}{GetWidestItem}{\void}
+
+Returns index to the widest item in the list.
+
+
+\membersection{wxOwnerDrawnComboBox::GetWidestItemWidth}\label{wxownerdrawncomboboxgetwidestitemwidth}
+
+\constfunc{int}{GetWidestItemWidth}{\void}
+
+Returns width of the widest item in the list.
+
+
 \membersection{wxOwnerDrawnComboBox::OnDrawBackground}\label{wxownerdrawncomboboxondrawbackground}
 
 \constfunc{void}{OnDrawBackground}{\param{wxDC\& }{dc}, \param{const wxRect\& }{rect}, \param{int }{item}, \param{int }{flags}}
@@ -179,6 +193,8 @@ region is set to this rectangle before calling this function)}
 \twocolitem{{\tt wxODCB\_PAINTING\_CONTROL}}{Combo control is being
 painted, instead of a list item. Argument item may be wxNOT\_FOUND in this
 case.}
+\twocolitem{{\tt wxODCB\_PAINTING\_SELECTED}}{An item with selection
+background is being painted. DC text colour should already be correct.}
 \end{twocollist}