wx.lib.agw.ultimatelistctrl.UltimateListItemAttr

Represents the attributes (colour, font, …) of a UltimateListCtrl UltimateListItem.

Class Hierarchy

Inheritance diagram for class UltimateListItemAttr:

Methods Summary

__init__	Default class constructor.
Enable	Enables or disables the item.
GetBackgroundColour	Returns the currently set background colour.
GetFont	Returns the currently set item font.
GetFooterBackgroundColour	Returns the currently set background colour for a footer item.
GetFooterFont	Returns the currently set font for a footer item.
GetFooterTextColour	Returns the currently set text colour for a footer item.
GetTextColour	Returns the currently set text colour.
HasBackgroundColour	Returns True if the currently set background colour is valid.
HasFont	Returns True if the currently set font is valid.
HasFooterBackgroundColour	Returns True if the currently set background colour for the footer item
HasFooterFont	Returns True if the currently set font for the footer item
HasFooterTextColour	Returns True if the currently set text colour for the footer item
HasTextColour	Returns True if the currently set text colour is valid.
IsEnabled	Returns True if the item is enabled.
SetBackgroundColour	Sets a new background colour.
SetFont	Sets a new font for the item.
SetFooterBackgroundColour	Sets a new footer item background colour.
SetFooterFont	Sets a new font for the footer item.
SetFooterTextColour	Sets a new footer item text colour.
SetTextColour	Sets a new text colour.

Class API

class UltimateListItemAttr(object)

Represents the attributes (colour, font, …) of a UltimateListCtrl UltimateListItem.

Methods

__init__(self, colText=wx.NullColour, colBack=wx.NullColour, font=wx.NullFont, enabled=True, footerColText=wx.NullColour, footerColBack=wx.NullColour, footerFont=wx.NullFont)

Default class constructor.

Parameters:

• colText – the item text colour;

• colBack – the item background colour;

• font – the item font;

• enabled – True if the item should be enabled, False if it is disabled;

• footerColText – for footer items, the item text colour;

• footerColBack – for footer items, the item background colour;

• footerFont – for footer items, the item font.

---

Enable(self, enable=True)

Enables or disables the item.

Parameters:

enable – True to enable the item, False to disable it.

---

GetBackgroundColour(self)

Returns the currently set background colour.

---

GetFont(self)

Returns the currently set item font.

---

GetFooterBackgroundColour(self)

Returns the currently set background colour for a footer item.

---

GetFooterFont(self)

Returns the currently set font for a footer item.

---

GetFooterTextColour(self)

Returns the currently set text colour for a footer item.

---

GetTextColour(self)

Returns the currently set text colour.

---

HasBackgroundColour(self)

Returns True if the currently set background colour is valid.

---

HasFont(self)

Returns True if the currently set font is valid.

---

HasFooterBackgroundColour(self)

Returns True if the currently set background colour for the footer item is valid.

---

HasFooterFont(self)

Returns True if the currently set font for the footer item is valid.

---

HasFooterTextColour(self)

Returns True if the currently set text colour for the footer item is valid.

---

HasTextColour(self)

Returns True if the currently set text colour is valid.

---

IsEnabled(self)

Returns True if the item is enabled.

---

SetBackgroundColour(self, colBack)

Sets a new background colour.

Parameters:

colBack – an instance of wx.Colour.

---

SetFont(self, font)

Sets a new font for the item.

Parameters:

font – an instance of wx.Font.

---

SetFooterBackgroundColour(self, colBack)

Sets a new footer item background colour.

Parameters:

colBack – an instance of wx.Colour.

---

SetFooterFont(self, font)

Sets a new font for the footer item.

Parameters:

font – an instance of wx.Font.

---

SetFooterTextColour(self, colText)

Sets a new footer item text colour.

Parameters:

colText – an instance of wx.Colour.

---

SetTextColour(self, colText)

Sets a new text colour.

Parameters:

colText – an instance of wx.Colour.