wxGridCellAttr — wx v2.4.3.1

Search documentation of wx

# wxGridCellAttr (wx v2.4.3.1)

View Source

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()` (not implemented in wx).

Note that objects of this class are reference-counted and it's recommended to use wxGridCellAttrPtr smart pointer class when working with them to avoid memory leaks.

wxWidgets docs: wxGridCellAttr

# Summary

## Types

wxGridCellAttr()

## Functions

getAlignment(This)

Get the alignment to use for the cell with the given attribute.

getBackgroundColour(This)

Returns the background colour.

getEditor(This, Grid, Row, Col)

Returns the cell editor.

getFont(This)

Returns the font.

getRenderer(This, Grid, Row, Col)

Returns the cell renderer.

getTextColour(This)

Returns the text colour.

hasAlignment(This)

Returns true if this attribute has a valid alignment set.

hasBackgroundColour(This)

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

hasEditor(This)

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

hasFont(This)

Returns true if this attribute has a valid font set.

hasRenderer(This)

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

hasTextColour(This)

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

isReadOnly(This)

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

setAlignment(This, HAlign, VAlign)

Sets the alignment.

setBackgroundColour(This, ColBack)

Sets the background colour.

setDefAttr(This, DefAttr)
setEditor(This, Editor)

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

setFont(This, Font)

Sets the font.

setReadOnly(This)

Equivalent to `setReadOnly(This, [])`.

setReadOnly/2

Sets the cell as read-only.

setRenderer(This, Renderer)

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

setTextColour(This, ColText)

Sets the text colour.

# Types

# wxGridCellAttr()

    -type wxGridCellAttr() :: wx:wx_object().

# Functions

# getAlignment(This)

    -spec getAlignment(This) -> {HAlign :: integer(), VAlign :: integer()} when This :: wxGridCellAttr().

Get the alignment to use for the cell with the given attribute.

If this attribute doesn't specify any alignment, the default attribute alignment is used (which can be changed using `wxGrid:setDefaultCellAlignment/3` but is left and top by default).

Notice that `hAlign` and `vAlign` values are always overwritten by this function, use `GetNonDefaultAlignment()` (not implemented in wx) if this is not desirable.

# getBackgroundColour(This)

    -spec getBackgroundColour(This) -> wx:wx_colour4() when This :: wxGridCellAttr().

Returns the background colour.

# getEditor(This, Grid, Row, Col)

    -spec getEditor(This, Grid, Row, Col) -> wxGridCellEditor:wxGridCellEditor()
                       when
                           This :: wxGridCellAttr(),
                           Grid :: wxGrid:wxGrid(),
                           Row :: integer(),
                           Col :: integer().

Returns the cell editor.

The caller is responsible for calling `DecRef()` (not implemented in wx) on the returned pointer, use `GetEditorPtr()` (not implemented in wx) to do it automatically.

# getFont(This)

    -spec getFont(This) -> wxFont:wxFont() when This :: wxGridCellAttr().

Returns the font.

# getRenderer(This, Grid, Row, Col)

    -spec getRenderer(This, Grid, Row, Col) -> wxGridCellRenderer:wxGridCellRenderer()
                         when
                             This :: wxGridCellAttr(),
                             Grid :: wxGrid:wxGrid(),
                             Row :: integer(),
                             Col :: integer().

Returns the cell renderer.

The caller is responsible for calling `DecRef()` (not implemented in wx) on the returned pointer, use `GetRendererPtr()` (not implemented in wx) to do it automatically.

# getTextColour(This)

    -spec getTextColour(This) -> wx:wx_colour4() when This :: wxGridCellAttr().

Returns the text colour.

# hasAlignment(This)

    -spec hasAlignment(This) -> boolean() when This :: wxGridCellAttr().

Returns true if this attribute has a valid alignment set.

# hasBackgroundColour(This)

    -spec hasBackgroundColour(This) -> boolean() when This :: wxGridCellAttr().

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

# hasEditor(This)

    -spec hasEditor(This) -> boolean() when This :: wxGridCellAttr().

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

# hasFont(This)

    -spec hasFont(This) -> boolean() when This :: wxGridCellAttr().

Returns true if this attribute has a valid font set.

# hasRenderer(This)

    -spec hasRenderer(This) -> boolean() when This :: wxGridCellAttr().

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

# hasTextColour(This)

    -spec hasTextColour(This) -> boolean() when This :: wxGridCellAttr().

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

# isReadOnly(This)

    -spec isReadOnly(This) -> boolean() when This :: wxGridCellAttr().

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

# setAlignment(This, HAlign, VAlign)

    -spec setAlignment(This, HAlign, VAlign) -> ok
                          when This :: wxGridCellAttr(), HAlign :: integer(), VAlign :: integer().

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`.

# setBackgroundColour(This, ColBack)

    -spec setBackgroundColour(This, ColBack) -> ok when This :: wxGridCellAttr(), ColBack :: wx:wx_colour().

Sets the background colour.

# setDefAttr(This, DefAttr)

    -spec setDefAttr(This, DefAttr) -> ok when This :: wxGridCellAttr(), DefAttr :: wxGridCellAttr().

# setEditor(This, Editor)

    -spec setEditor(This, Editor) -> ok
                       when This :: wxGridCellAttr(), Editor :: wxGridCellEditor:wxGridCellEditor().

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

# setFont(This, Font)

    -spec setFont(This, Font) -> ok when This :: wxGridCellAttr(), Font :: wxFont:wxFont().

Sets the font.

# setReadOnly(This)

    -spec setReadOnly(This) -> ok when This :: wxGridCellAttr().

Equivalent to `setReadOnly(This, [])`.

# setReadOnly/2

    -spec setReadOnly(This, [Option]) -> ok when This :: wxGridCellAttr(), Option :: {isReadOnly, boolean()}.

Sets the cell as read-only.

# setRenderer(This, Renderer)

    -spec setRenderer(This, Renderer) -> ok
                         when This :: wxGridCellAttr(), Renderer :: wxGridCellRenderer:wxGridCellRenderer().

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

Takes ownership of the pointer.

# setTextColour(This, ColText)

    -spec setTextColour(This, ColText) -> ok when This :: wxGridCellAttr(), ColText :: wx:wx_colour().

Sets the text colour.