sorting support for generic version (patch 1765087 from Bo)

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

\section{\class{wxGridCellBoolRenderer}}\label{wxgridcellboolrenderer}

This class may be used to format boolean data in a cell.
for string cells.

\wxheading{Derived from}

\helpref{wxGridCellRenderer}{wxgridcellrenderer}

\wxheading{See also}

\helpref{wxGridCellRenderer}{wxgridcellrenderer},\rtfsp
\helpref{wxGridCellStringRenderer}{wxgridcellstringrenderer},\rtfsp
\helpref{wxGridCellFloatRenderer}{wxgridcellfloatrenderer},\rtfsp
\helpref{wxGridCellNumberRenderer}{wxgridcellnumberrenderer}

\wxheading{Include files}

<wx/grid.h>

\wxheading{Library}

\helpref{wxAdv}{librarieslist}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxGridCellBoolRenderer::wxGridCellBoolRenderer}\label{wxgridcellboolrendererconstr}

\func{}{wxGridCellBoolRenderer}{}

Default constructor



\section{\class{wxGridCellFloatRenderer}}\label{wxgridcellfloatrenderer}

This class may be used to format floating point data in a cell.

\wxheading{Derived from}

\helpref{wxGridCellStringRenderer}{wxgridcellstringrenderer}\\
\helpref{wxGridCellRenderer}{wxgridcellrenderer}

\wxheading{See also}

\helpref{wxGridCellRenderer}{wxgridcellrenderer},\rtfsp
\helpref{wxGridCellNumberRenderer}{wxgridcellnumberrenderer},\rtfsp
\helpref{wxGridCellStringRenderer}{wxgridcellstringrenderer},\rtfsp
\helpref{wxGridCellBoolRenderer}{wxgridcellboolrenderer}

\wxheading{Include files}

<wx/grid.h>

\wxheading{Library}

\helpref{wxAdv}{librarieslist}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxGridCellFloatRenderer::wxGridCellFloatRenderer}\label{wxgridcellfloatrendererconstr}

\func{}{wxGridCellFloatRenderer}{\param{int }{width = -1}, \param{int }{precision = -1}}

\docparam{width}{Minimum number of characters to be shown.}
\docparam{precision}{Number of digits after the decimal dot.}

\membersection{wxGridCellFloatRenderer::GetPrecision}\label{wxgridcellfloatrenderergetprecision}

\constfunc{int}{GetPrecision}{\void}

Returns the precision ( see \helpref{wxGridCellFloatRenderer}{wxgridcellfloatrendererconstr} ).

\membersection{wxGridCellFloatRenderer::GetWidth}\label{wxgridcellfloatrenderergetwidth}

\constfunc{int}{GetWidth}{\void}

Returns the width ( see \helpref{wxGridCellFloatRenderer}{wxgridcellfloatrendererconstr} ).

\membersection{wxGridCellFloatRenderer::SetParameters}\label{wxgridcellfloatrenderersetparameters}

\func{void}{SetParameters}{\param{const wxString\& }{params}}

Parameters string format is "width[,precision]".

\membersection{wxGridCellFloatRenderer::SetPrecision}\label{wxgridcellfloatrenderersetprecision}

\func{void}{SetPrecision}{\param{int }{precision}}

Sets the precision ( see \helpref{wxGridCellFloatRenderer}{wxgridcellfloatrendererconstr} ).

\membersection{wxGridCellFloatRenderer::SetWidth}\label{wxgridcellfloatrenderersetwidth}

\func{void}{SetWidth}{\param{int }{width}}

Sets the width ( see \helpref{wxGridCellFloatRenderer}{wxgridcellfloatrendererconstr} )



\section{\class{wxGridCellNumberRenderer}}\label{wxgridcellnumberrenderer}

This class may be used to format integer data in a cell.

\wxheading{Derived from}

\helpref{wxGridCellStringRenderer}{wxgridcellstringrenderer}\\
\helpref{wxGridCellRenderer}{wxgridcellrenderer}

\wxheading{See also}

\helpref{wxGridCellRenderer}{wxgridcellrenderer},\rtfsp
\helpref{wxGridCellStringRenderer}{wxgridcellstringrenderer},\rtfsp
\helpref{wxGridCellFloatRenderer}{wxgridcellfloatrenderer},\rtfsp
\helpref{wxGridCellBoolRenderer}{wxgridcellboolrenderer}

\wxheading{Include files}

<wx/grid.h>

\wxheading{Library}

\helpref{wxAdv}{librarieslist}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxGridCellNumberRenderer::wxGridCellNumberRenderer}\label{wxgridcellnumberrendererconstr}

\func{}{wxGridCellNumberRenderer}{}

Default constructor

\section{\class{wxGridCellRenderer}}\label{wxgridcellrenderer}

This class is responsible for actually drawing the cell
in the grid. You may pass it to the wxGridCellAttr (below) to change the
format of one given cell or to wxGrid::SetDefaultRenderer() to change the
view of all cells. This is an abstract class, and you will normally use one of the
predefined derived classes or derive your own class from it.

\wxheading{Derived from}

wxGridCellWorker

\wxheading{See also}

\helpref{wxGridCellStringRenderer}{wxgridcellstringrenderer},\rtfsp
\helpref{wxGridCellNumberRenderer}{wxgridcellnumberrenderer},\rtfsp
\helpref{wxGridCellFloatRenderer}{wxgridcellfloatrenderer},\rtfsp
\helpref{wxGridCellBoolRenderer}{wxgridcellboolrenderer}

\wxheading{Include files}

<wx/grid.h>

\wxheading{Library}

\helpref{wxAdv}{librarieslist}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxGridCellRenderer::Draw}\label{wxgridcellrendererdraw}

\func{void}{Draw}{\param{wxGrid\& }{grid}, \param{wxGridCellAttr\& }{attr}, \param{wxDC\& }{dc}, \param{const wxRect\& }{rect}, \param{int }{row}, \param{int }{col}, \param{bool }{isSelected}}

Draw the given cell on the provided DC inside the given rectangle
using the style specified by the attribute and the default or selected
state corresponding to the isSelected value.

This pure virtual function has a default implementation which will
prepare the DC using the given attribute: it will draw the rectangle
with the background colour from attr and set the text colour and font.

\membersection{wxGridCellRenderer::GetBestSize}\label{wxgridcellrenderergetbestsize}

\func{wxSize}{GetBestSize}{\param{wxGrid\& }{grid}, \param{wxGridCellAttr\& }{attr}, \param{wxDC\& }{dc}, \param{int }{row}, \param{int }{col}}

Get the preferred size of the cell for its contents.

\membersection{wxGridCellRenderer::Clone}\label{wxgridcellrendererclone}

\constfunc{wxGridCellRenderer*}{Clone}{\void}

\section{\class{wxGridCellStringRenderer}}\label{wxgridcellstringrenderer}

This class may be used to format string data in a cell; it is the default
for string cells.

\wxheading{Derived from}

\helpref{wxGridCellRenderer}{wxgridcellrenderer}

\wxheading{See also}

\helpref{wxGridCellRenderer}{wxgridcellrenderer},\rtfsp
\helpref{wxGridCellNumberRenderer}{wxgridcellnumberrenderer},\rtfsp
\helpref{wxGridCellFloatRenderer}{wxgridcellfloatrenderer},\rtfsp
\helpref{wxGridCellBoolRenderer}{wxgridcellboolrenderer}

\wxheading{Include files}

<wx/grid.h>

\wxheading{Library}

\helpref{wxAdv}{librarieslist}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxGridCellStringRenderer::wxGridCellStringRenderer}\label{wxgridcellstringrendererconstr}

\func{}{wxGridCellStringRenderer}{}

Default constructor