wxGridCellAttr Class Reference
[Grid Related Classes]

#include <wx/grid.h>


Detailed Description

This class can be used to alter the cells' appearance in the grid by changing their attributes from the defaults.

An object of this class may be returned by wxGridTableBase::GetAttr().

Library:  wxAdvanced

Category:  Grid Related Classes

Public Member Functions

 wxGridCellAttr (wxGridCellAttr *attrDefault=NULL)
 Default constructor.
 wxGridCellAttr (const wxColour &colText, const wxColour &colBack, const wxFont &font, int hAlign, int vAlign)
 Constructor specifying some of the often used attributes.
wxGridCellAttrClone () const
 Creates a new copy of this object.
void DecRef ()
 This class is reference counted: it is created with ref count of 1, so calling DecRef() once will delete it.
void GetAlignment (int *hAlign, int *vAlign) const
 See SetAlignment() for the returned values.
const wxColourGetBackgroundColour () const
 Returns the background colour.
wxGridCellEditorGetEditor (const wxGrid *grid, int row, int col) const
 Returns the cell editor.
const wxFontGetFont () const
 Returns the font.
wxGridCellRendererGetRenderer (const wxGrid *grid, int row, int col) const
 Returns the cell renderer.
const wxColourGetTextColour () const
 Returns the text colour.
bool HasAlignment () const
 Returns true if this attribute has a valid alignment set.
bool HasBackgroundColour () const
 Returns true if this attribute has a valid background colour set.
bool HasEditor () const
 Returns true if this attribute has a valid cell editor set.
bool HasFont () const
 Returns true if this attribute has a valid font set.
bool HasRenderer () const
 Returns true if this attribute has a valid cell renderer set.
bool HasTextColour () const
 Returns true if this attribute has a valid text colour set.
void IncRef ()
 This class is reference counted: it is created with ref count of 1, so calling DecRef() once will delete it.
bool IsReadOnly () const
 Returns true if this cell is set as read-only.
void SetAlignment (int hAlign, int vAlign)
 Sets the alignment.
void SetBackgroundColour (const wxColour &colBack)
 Sets the background colour.
void SetDefAttr (wxGridCellAttr *defAttr)
void SetEditor (wxGridCellEditor *editor)
 Sets the editor to be used with the cells with this attribute.
void SetFont (const wxFont &font)
 Sets the font.
void SetReadOnly (bool isReadOnly=true)
 Sets the cell as read-only.
void SetRenderer (wxGridCellRenderer *renderer)
 Sets the renderer to be used for cells with this attribute.
void SetTextColour (const wxColour &colText)
 Sets the text colour.

List of all members.


Constructor & Destructor Documentation

wxGridCellAttr::wxGridCellAttr ( wxGridCellAttr attrDefault = NULL  ) 

Default constructor.

wxGridCellAttr::wxGridCellAttr ( const wxColour colText,
const wxColour colBack,
const wxFont font,
int  hAlign,
int  vAlign 
)

Constructor specifying some of the often used attributes.


Member Function Documentation

wxGridCellAttr* wxGridCellAttr::Clone (  )  const

Creates a new copy of this object.

void wxGridCellAttr::DecRef (  ) 

This class is reference counted: it is created with ref count of 1, so calling DecRef() once will delete it.

Calling IncRef() allows to lock it until the matching DecRef() is called.

void wxGridCellAttr::GetAlignment ( int *  hAlign,
int *  vAlign 
) const

See SetAlignment() for the returned values.

const wxColour& wxGridCellAttr::GetBackgroundColour (  )  const

Returns the background colour.

wxGridCellEditor* wxGridCellAttr::GetEditor ( const wxGrid grid,
int  row,
int  col 
) const

Returns the cell editor.

const wxFont& wxGridCellAttr::GetFont (  )  const

Returns the font.

wxGridCellRenderer* wxGridCellAttr::GetRenderer ( const wxGrid grid,
int  row,
int  col 
) const

Returns the cell renderer.

const wxColour& wxGridCellAttr::GetTextColour (  )  const

Returns the text colour.

bool wxGridCellAttr::HasAlignment (  )  const

Returns true if this attribute has a valid alignment set.

bool wxGridCellAttr::HasBackgroundColour (  )  const

Returns true if this attribute has a valid background colour set.

bool wxGridCellAttr::HasEditor (  )  const

Returns true if this attribute has a valid cell editor set.

bool wxGridCellAttr::HasFont (  )  const

Returns true if this attribute has a valid font set.

bool wxGridCellAttr::HasRenderer (  )  const

Returns true if this attribute has a valid cell renderer set.

bool wxGridCellAttr::HasTextColour (  )  const

Returns true if this attribute has a valid text colour set.

void wxGridCellAttr::IncRef (  ) 

This class is reference counted: it is created with ref count of 1, so calling DecRef() once will delete it.

Calling IncRef() allows to lock it until the matching DecRef() is called.

bool wxGridCellAttr::IsReadOnly (  )  const

Returns true if this cell is set as read-only.

void wxGridCellAttr::SetAlignment ( int  hAlign,
int  vAlign 
)

Sets the alignment.

hAlign can be one of wxALIGN_LEFT, wxALIGN_CENTRE or wxALIGN_RIGHT and vAlign can be one of wxALIGN_TOP, wxALIGN_CENTRE or wxALIGN_BOTTOM.

void wxGridCellAttr::SetBackgroundColour ( const wxColour colBack  ) 

Sets the background colour.

void wxGridCellAttr::SetDefAttr ( wxGridCellAttr defAttr  ) 

Todo:
Needs documentation.

void wxGridCellAttr::SetEditor ( wxGridCellEditor editor  ) 

Sets the editor to be used with the cells with this attribute.

void wxGridCellAttr::SetFont ( const wxFont font  ) 

Sets the font.

void wxGridCellAttr::SetReadOnly ( bool  isReadOnly = true  ) 

Sets the cell as read-only.

void wxGridCellAttr::SetRenderer ( wxGridCellRenderer renderer  ) 

Sets the renderer to be used for cells with this attribute.

Takes ownership of the pointer.

void wxGridCellAttr::SetTextColour ( const wxColour colText  ) 

Sets the text colour.



wxWidgets logo

[ top ]