Some documentation enhancements for wxRichTextCtrl

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

diff --git a/docs/latex/wx/renderer.tex b/docs/latex/wx/renderer.tex
index 2f2a7d6fcd34fbff6f1ea1090afeb29afc188971..d17248a3002e39a745de54a8da4a379471c8ac5a 100644 (file)
--- a/docs/latex/wx/renderer.tex
+++ b/docs/latex/wx/renderer.tex
@@ -52,6 +52,11 @@ the rendering functions should always prepare it.
 combination of the \texttt{wxCONTROL\_XXX} constants below.
 \end{itemize}
 
 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:
 \wxheading{Constants}
 
 The following rendering flags are defined:


@@ -126,9 +131,16 @@ rectangle of a drop down button which arrow matches the size you need.
 
 \membersection{wxRendererNative::DrawHeaderButton}\label{wxrenderernativedrawheaderbutton}
 
 
 \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}
 
 
 \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}.
 
 
 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}}
 \membersection{wxRendererNative::GetSplitterParams}\label{wxrenderernativegetsplitterparams}
 
 \func{wxSplitterRenderParams}{GetSplitterParams}{\param{const wxWindow* }{win}}


@@ -236,3 +256,4 @@ Set the renderer to use, passing {\tt NULL} reverts to using the default
 renderer (the global renderer must always exist).
 
 Return the previous renderer used with Set() or {\tt NULL} if none.
 renderer (the global renderer must always exist).
 
 Return the previous renderer used with Set() or {\tt NULL} if none.

+