AGW Logo

agw_title UltimateListItemAttr

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

hierarchy Inheritance Diagram

Inheritance diagram for: UltimateListItemAttr

Inheritance diagram of UltimateListItemAttr


method_summary Methods Summary

__init__Default class constructor.
EnableEnables or disables the item.
GetBackgroundColourReturns the currently set background colour.
GetFontReturns the currently set item font.
GetFooterBackgroundColourReturns the currently set background colour for a footer item.
GetFooterFontReturns the currently set font for a footer item.
GetFooterTextColourReturns the currently set text colour for a footer item.
GetTextColourReturns the currently set text colour.
HasBackgroundColourReturns True if the currently set background colour is valid.
HasFontReturns True if the currently set font is valid.
HasFooterBackgroundColourReturns True if the currently set background colour for the footer item
HasFooterFontReturns True if the currently set font for the footer item
HasFooterTextColourReturns True if the currently set text colour for the footer item
HasTextColourReturns True if the currently set text colour is valid.
IsEnabledReturns True if the item is enabled.
SetBackgroundColourSets a new background colour.
SetFontSets a new font for the item.
SetFooterBackgroundColourSets a new footer item background colour.
SetFooterFontSets a new font for the footer item.
SetFooterTextColourSets a new footer item text colour.
SetTextColourSets a new text colour.

API Class API

class UltimateListItemAttr(object)[source]

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



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

Default class constructor.

Parameters:
  • colText – the item text colour;
  • colBack – the item background colour;
  • font – the item font;
  • enabledTrue 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(enable=True)[source]

Enables or disables the item.

Parameters:enableTrue to enable the item, False to disable it.


GetBackgroundColour()[source]

Returns the currently set background colour.



GetFont()[source]

Returns the currently set item font.



GetFooterBackgroundColour()[source]

Returns the currently set background colour for a footer item.



GetFooterFont()[source]

Returns the currently set font for a footer item.



GetFooterTextColour()[source]

Returns the currently set text colour for a footer item.



GetTextColour()[source]

Returns the currently set text colour.



HasBackgroundColour()[source]

Returns True if the currently set background colour is valid.



HasFont()[source]

Returns True if the currently set font is valid.



HasFooterBackgroundColour()[source]

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



HasFooterFont()[source]

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



HasFooterTextColour()[source]

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



HasTextColour()[source]

Returns True if the currently set text colour is valid.



IsEnabled()[source]

Returns True if the item is enabled.



SetBackgroundColour(colBack)[source]

Sets a new background colour.

Parameters:colBack – an instance of wx.Colour.


SetFont(font)[source]

Sets a new font for the item.

Parameters:font – an instance of wx.Font.


SetFooterBackgroundColour(colBack)[source]

Sets a new footer item background colour.

Parameters:colBack – an instance of wx.Colour.



SetFooterFont(font)[source]

Sets a new font for the footer item.

Parameters:font – an instance of wx.Font.



SetFooterTextColour(colText)[source]

Sets a new footer item text colour.

Parameters:colText – an instance of wx.Colour.



SetTextColour(colText)[source]

Sets a new text colour.

Parameters:colText – an instance of wx.Colour.

Tree

Table Of Contents

Previous topic

UltimateListItem

Next topic

UltimateListItemData