cleanup (mainly wrapping lines to be < 80 chars); added IsExpanded()

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

diff --git a/docs/latex/wx/renderer.tex b/docs/latex/wx/renderer.tex
index 9678cb65ae6deaaaa1c69d343d1baf6dc4e9d24d..1c1277d32613322d5116e3264166ffcc9b44fa58 100644 (file)
--- a/docs/latex/wx/renderer.tex
+++ b/docs/latex/wx/renderer.tex
@@ -19,7 +19,7 @@ However not all controls exist under all (or even any) platforms and in this
 case wxWidgets provides a default, generic, implementation of them written in
 wxWidgets itself.
 
-These controls don't have the native appearance if only the standard
+These controls don't have the native appearance if only the tandard
 line drawing and other graphics primitives are used, because the native
 appearance is different under different platforms while the lines are always
 drawn in the same way.
@@ -52,6 +52,11 @@ the rendering functions should always prepare it.
 combination of the \texttt{wxCONTROL\_XXX} constants below.
 \end{itemize}
 
+Note that each drawing function restores the \helpref{wxDC}{wxdc} attributes if
+it changes them, so it is safe to assume that the same pen, brush and colours
+that were active before the call to this function are still in effect after it.
+
+
 \wxheading{Constants}
 
 The following rendering flags are defined:
@@ -92,9 +97,9 @@ No base class
 Virtual destructor as for any base class.
 
 
-\membersection{wxRendererNative::DrawCheckButton}\label{wxrenderernativedrawcheckbutton}
+\membersection{wxRendererNative::DrawCheckBox}\label{wxrenderernativedrawcheckbox}
 
-\func{void}{DrawCheckButton}{\param{wxWindow *}{win}, \param{wxDC\& }{dc}, \param{const wxRect\& }{rect}, \param{int }{flags}}
+\func{void}{DrawCheckBox}{\param{wxWindow *}{win}, \param{wxDC\& }{dc}, \param{const wxRect\& }{rect}, \param{int }{flags}}
 
 Draw a check box (used by wxDataViewCtrl).
 
@@ -126,9 +131,16 @@ rectangle of a drop down button which arrow matches the size you need.
 
 \membersection{wxRendererNative::DrawHeaderButton}\label{wxrenderernativedrawheaderbutton}
 
-\func{void}{DrawHeaderButton}{\param{wxWindow* }{win}, \param{wxDC\& }{dc}, \param{const wxRect\& }{rect}, \param{int }{flags = 0}}
+\func{void}{DrawHeaderButton}{\param{wxWindow* }{win}, \param{wxDC\& }{dc}, \param{const wxRect\& }{rect}, \param{int }{flags = 0}, \param{wxHeaderSortIconType }{sortArrow = wxHDR\_SORT\_ICON\_NONE}, \param{wxHeaderButtonParams* }{params = NULL}}
 
-Draw the header control button (used by \helpref{wxListCtrl}{wxlistctrl}).
+Draw the header control button (used, for example, by
+\helpref{wxListCtrl}{wxlistctrl}).  Depending on platforms the
+\arg{flags} parameter may support the \texttt{wxCONTROL\_SELECTED}
+\texttt{wxCONTROL\_DISABLED} and \texttt{wxCONTROL\_CURRENT} bits.
+The \arg{sortArrow} parameter can be one of
+\texttt{wxHDR\_SORT\_ICON\_NONE}, \texttt{wxHDR\_SORT\_ICON\_UP}, or 
+\texttt{wxHDR\_SORT\_ICON\_DOWN}.  Additional values controlling the
+drawing of a text or bitmap label can be passed in \arg{params}.
 
 
 \membersection{wxRendererNative::DrawPushButton}\label{wxrenderernativedrawpushbutton}
@@ -192,6 +204,14 @@ is the default renderer implementation, others have platform-specific default
 renderer which can be retrieved by calling \helpref{GetDefault}{wxrenderernativegetdefault}.
 
 
+\membersection{wxRendererNative::GetHeaderButtonHeight}\label{wxrenderernativegetheaderbuttonheight}
+
+\func{int}{GetHeaderButtonHeight}{\param{const wxWindow* }{win}}
+
+Returns the height of a header button, either a fixed platform height if available, or a 
+generic height based on the window's font.
+
+
 \membersection{wxRendererNative::GetSplitterParams}\label{wxrenderernativegetsplitterparams}
 
 \func{wxSplitterRenderParams}{GetSplitterParams}{\param{const wxWindow* }{win}}