Document wxBitmapToggleButton, add update UI event in Base class for all toggle buttons

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

diff --git a/docs/latex/wx/comboctrl.tex b/docs/latex/wx/comboctrl.tex
index 1dc9e049ce7c2927eb07caa74eccdd5f99c5d6a3..1798986e0e974b53c7d3a460cc38eed08cf4b4ef 100644 (file)
--- a/docs/latex/wx/comboctrl.tex
+++ b/docs/latex/wx/comboctrl.tex
@@ -36,6 +36,10 @@ Here's a minimal sample of \helpref{wxListView}{wxlistview} popup:
 
 #include <wx/combo.h>
 #include <wx/listctrl.h>
 
 #include <wx/combo.h>
 #include <wx/listctrl.h>

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

 
 class wxListViewComboPopup : public wxListView,
                              public wxComboPopup
 
 class wxListViewComboPopup : public wxListView,
                              public wxComboPopup


@@ -130,7 +134,7 @@ Here's how you would create and populate it in a dialog constructor:
 
 \wxheading{Include files}
 
 
 \wxheading{Include files}
 

-<combo.h>
+<wx/combo.h>

 
 \wxheading{Window styles}
 
 
 \wxheading{Window styles}
 


@@ -213,6 +217,25 @@ appropriately.}
 Destructor, destroying the combo control.
 
 
 Destructor, destroying the combo control.
 
 

+\membersection{wxComboCtrl::AnimateShow}\label{wxcomboctrlanimateshow}
+
+\func{virtual bool}{AnimateShow}{\param{const wxRect\& }{rect}, \param{int }{flags}}
+
+This member function is not normally called in application code.
+Instead, it can be implemented in a derived class to create a
+custom popup animation.
+
+\wxheading{Parameters}
+
+Same as in \helpref{DoShowPopup}{wxcomboctrldoshowpopup}.
+
+\wxheading{Return value}
+
+\true if animation finishes before the function returns.
+\false otherwise. In the latter case you need to manually call DoShowPopup
+after the animation ends.
+
+

 \membersection{wxComboCtrl::Create}\label{wxcomboctrlcreate}
 
 \func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp
 \membersection{wxComboCtrl::Create}\label{wxcomboctrlcreate}
 
 \func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp


@@ -251,6 +274,39 @@ something else than show the popup, then DoSetPopupControl
 must always return NULL.
 
 
 must always return NULL.
 
 

+\membersection{wxComboCtrl::DoShowPopup}\label{wxcomboctrldoshowpopup}
+
+\func{virtual void}{DoShowPopup}{\param{const wxRect\& }{rect}, \param{int }{flags}}
+
+This member function is not normally called in application code.
+Instead, it must be called in a derived class to make sure popup
+is properly shown after a popup animation has finished (but only
+if \helpref{AnimateShow}{wxcomboctrlanimateshow} did not finish
+the animation within it's function scope).
+
+\wxheading{Parameters}
+
+\docparam{rect}{Position to show the popup window at, in screen coordinates.}
+
+\docparam{flags}{Combination of any of the following:}
+\twocolwidtha{8cm}%
+\begin{twocollist}\itemsep=0pt
+\twocolitem{{\tt wxComboCtrl::ShowAbove}}{Popup is shown above the control instead
+of below.}
+\twocolitem{{\tt wxComboCtrl::CanDeferShow}}{Showing the popup can be deferred
+to happen sometime after \helpref{ShowPopup}{wxcomboctrlshowpopup} has finished.
+In this case, \helpref{AnimateShow}{wxcomboctrlanimateshow} must return \false.}
+\end{twocollist}
+
+
+\membersection{wxComboCtrl::EnablePopupAnimation}\label{wxcomboctrlenablepopupanimation}
+
+\func{void}{EnablePopupAnimation}{\param{bool }{enable = true}}
+
+Enables or disables popup animation, if any, depending on the value of
+the argument.
+
+

 \membersection{wxComboCtrl::GetBitmapDisabled}\label{wxcomboctrlgetbitmapdisabled}
 
 \constfunc{const wxBitmap\&}{GetBitmapDisabled}{\void}
 \membersection{wxComboCtrl::GetBitmapDisabled}\label{wxcomboctrlgetbitmapdisabled}
 
 \constfunc{const wxBitmap\&}{GetBitmapDisabled}{\void}


@@ -344,8 +400,7 @@ itself can be custom painted.}
 \twocolitem{{\tt wxComboCtrlFeatures::PaintWritable}}{A variable-
 width area in front of writable combo control's textctrl can
 be custom painted.}
 \twocolitem{{\tt wxComboCtrlFeatures::PaintWritable}}{A variable-
 width area in front of writable combo control's textctrl can
 be custom painted.}

-\twocolitem{{\tt wxComboCtrlFeatures::Borderless}}{wxNO\_BORDER
-window style works.}
+\twocolitem{{\tt wxComboCtrlFeatures::Borderless}}{wxBORDER\_NONE window style works.}

 \twocolitem{{\tt wxComboCtrlFeatures::All}}{All of the
 above.}
 \end{twocollist}
 \twocolitem{{\tt wxComboCtrlFeatures::All}}{All of the
 above.}
 \end{twocollist}


@@ -361,6 +416,22 @@ Returns the insertion point for the combo control's text field.
 doesn't have the focus.
 
 
 doesn't have the focus.
 
 

+\membersection{wxComboCtrl::IsPopupWindowState}\label{wxcomboctrlispopupwindowstate}
+
+\constfunc{bool}{IsPopupWindowState}{\param{int }{state}}
+
+Returns \true if the popup window is in the given state.
+Possible values are:
+\twocolwidtha{8cm}%
+\begin{twocollist}\itemsep=0pt
+\twocolitem{{\tt wxComboCtrl::Hidden}}{Popup window is hidden.}
+\twocolitem{{\tt wxComboCtrl::Animating}}{Popup window is being shown, but the
+popup animation has not yet finished.}
+\twocolitem{{\tt wxComboCtrl::Visible}}{Popup window is fully visible.}
+\end{twocollist}
+
+
+

 \membersection{wxComboCtrl::GetLastPosition}\label{wxcomboctrlgetlastposition}
 
 \constfunc{long}{GetLastPosition}{\void}
 \membersection{wxComboCtrl::GetLastPosition}\label{wxcomboctrlgetlastposition}
 
 \constfunc{long}{GetLastPosition}{\void}


@@ -664,3 +735,15 @@ Show the popup.
 
 Undoes the last edit in the text field. Windows only.
 
 
 Undoes the last edit in the text field. Windows only.
 

+
+\membersection{wxComboCtrl::UseAltPopupWindow}\label{wxcomboctrlusealtpopupwindow}
+
+\func{void}{UseAltPopupWindow}{\param{bool }{enable = true}}
+
+Enable or disable usage of an alternative popup window, which guarantees
+ability to focus the popup control, and allows common native controls to
+function normally. This alternative popup window is usually a wxDialog,
+and as such, when it is shown, its parent top-level window will appear
+as if the focus has been lost from it.
+
+