wxGridCellAttr(3)

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

DESCRIPTION

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

DATA TYPES

wxGridCellAttr() :: wx:wx_object().

FUNCTIONS

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) -> wx:wx_colour4() when This :: wxGridCellAttr().

    Returns the background colour.
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) -> wxFont:wxFont() when This :: wxGridCellAttr().

    Returns the font.
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) -> wx:wx_colour4() when This :: wxGridCellAttr().

    Returns the text colour.
hasAlignment(This) -> boolean() when This :: wxGridCellAttr().

    Returns true if this attribute has a valid alignment set.
hasBackgroundColour(This) -> boolean() when This :: wxGridCellAttr().

    Returns true if this attribute has a valid background colour set.
hasEditor(This) -> boolean() when This :: wxGridCellAttr().

    Returns true if this attribute has a valid cell editor set.
hasFont(This) -> boolean() when This :: wxGridCellAttr().

    Returns true if this attribute has a valid font set.
hasRenderer(This) -> boolean() when This :: wxGridCellAttr().

    Returns true if this attribute has a valid cell renderer set.
hasTextColour(This) -> boolean() when This :: wxGridCellAttr().

    Returns true if this attribute has a valid text colour set.
isReadOnly(This) -> boolean() when This :: wxGridCellAttr().

    Returns true if this cell is set as read-only.
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) -> ok when This :: wxGridCellAttr(), ColBack :: wx:wx_colour().

    Sets the background colour.
setDefAttr(This, DefAttr) -> ok when This :: wxGridCellAttr(), DefAttr :: wxGridCellAttr().
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) -> ok when This :: wxGridCellAttr(), Font :: wxFont:wxFont().

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

    Sets the cell as read-only.
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) -> ok when This :: wxGridCellAttr(), ColText :: wx:wx_colour().

    Sets the text colour.