Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

wxGridCellRenderer (3erl)

Name

wxGridCellRenderer - Functions for wxGridCellRenderer class

Synopsis

Please see following description for synopsis

Description

wxGridCellRenderer(3)      Erlang Module Definition      wxGridCellRenderer(3)



NAME
       wxGridCellRenderer - Functions for wxGridCellRenderer class

DESCRIPTION
       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/2 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.

       See:  wxGridCellAutoWrapStringRenderer (not implemented in wx), wxGrid-
       CellBoolRenderer, wxGridCellDateTimeRenderer (not implemented  in  wx),
       wxGridCellEnumRenderer  (not  implemented  in  wx), wxGridCellFloatRen-
       derer, wxGridCellNumberRenderer, wxGridCellStringRenderer

       wxWidgets docs: wxGridCellRenderer

DATA TYPES
       wxGridCellRenderer() = wx:wx_object()

EXPORTS
       draw(This, Grid, Attr, Dc, Rect, Row, Col, IsSelected) -> ok

              Types:

                 This = wxGridCellRenderer()
                 Grid = wxGrid:wxGrid()
                 Attr = wxGridCellAttr:wxGridCellAttr()
                 Dc = wxDC:wxDC()
                 Rect =
                     {X :: integer(),
                      Y :: integer(),
                      W :: integer(),
                      H :: integer()}
                 Row = Col = integer()
                 IsSelected = boolean()

              Draw the given cell on the provided DC inside the given  rectan-
              gle  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.

       getBestSize(This, Grid, Attr, Dc, Row, Col) ->
                      {W :: integer(), H :: integer()}

              Types:

                 This = wxGridCellRenderer()
                 Grid = wxGrid:wxGrid()
                 Attr = wxGridCellAttr:wxGridCellAttr()
                 Dc = wxDC:wxDC()
                 Row = Col = integer()

              Get the preferred size of the cell for its contents.

              This  method must be overridden in the derived classes to return
              the minimal fitting size for displaying the content of the given
              grid cell.

              See:  GetBestHeight()  (not  implemented  in wx), GetBestWidth()
              (not implemented in wx)



wxWidgets team.                    wx 2.1.1              wxGridCellRenderer(3)