wx.lib.agw.ultimatelistctrl.UltimateListHeaderData

A simple class which holds information about UltimateListItem visual attributes for the header/footer items (client rectangles, positions, etc...).

Class Hierarchy

Inheritance diagram for class UltimateListHeaderData:

Methods Summary

__init__	Default class constructor.
Check	Checks/unchecks a header item.
CheckFooter	Checks/unchecks a footer item.
GetCustomRenderer	Returns the custom renderer associated with this item (if any).
GetFont	Returns the header/footer item font.
GetFooterFormat	Returns the footer item format.
GetFooterImage	Returns a Python list with the zero-based indexes of the images associated
GetFooterKind	Returns the footer item kind.
GetFormat	Returns the header item format.
GetImage	Returns a Python list with the zero-based indexes of the images associated
GetItem	Returns information about the item.
GetKind	Returns the header item kind.
GetState	Returns a bit field representing the state of the item.
GetText	Returns the header/footer item text.
GetToolTip	Returns the header/footer item tooltip.
GetWidth	Returns the header/footer item width, in pixels.
HasFooterImage	Returns True if the footer item has at least one image associated
HasImage	Returns True if the header item has at least one image associated
HasText	Returns True if the currently set text colour is valid.
Init	Initializes the header/footer item.
IsChecked	Returns whether the header item is checked or not.
IsFooterChecked	Returns whether the footer item is checked or not.
IsHit	Returns True if the input position is inside the item client rectangle.
SetCustomRenderer	Associate a custom renderer to this item.
SetFont	Sets a new font for the header item.
SetFooterFont	Sets a new font for the footer item.
SetFooterFormat	Sets the footer item format.
SetFooterKind	Sets the footer item kind.
SetFormat	Sets the header item format.
SetHeight	Sets the header/footer item height, in pixels.
SetItem	Sets information about the header/footer item.
SetKind	Sets the header item kind.
SetPosition	Sets the header/footer item position.
SetState	Sets the item state flags.
SetText	Sets the header/footer item text.
SetToolTip	Sets the header/footer item tooltip.
SetWidth	Sets the header/footer item width, in pixels.

Class API

---

class UltimateListHeaderData(object)

A simple class which holds information about UltimateListItem visual attributes for the header/footer items (client rectangles, positions, etc...).

Methods

---

__init__(self, item=None)

Default class constructor.

Parameters:item – another instance of UltimateListHeaderData.

---

Check(self, checked=True)

Checks/unchecks a header item.

Parameters:checked – True to check an item, False to uncheck it.

Note

This method is meaningful only for check and radio header items.

---

CheckFooter(self, check=True)

Checks/unchecks a footer item.

Parameters:checked – True to check an item, False to uncheck it.

Note

This method is meaningful only for check and radio footer items.

---

GetCustomRenderer(self)

Returns the custom renderer associated with this item (if any).

---

GetFont(self)

Returns the header/footer item font.

---

GetFooterFormat(self)

Returns the footer item format.

---

GetFooterImage(self)

Returns a Python list with the zero-based indexes of the images associated with the footer item into the image list.

---

GetFooterKind(self)

Returns the footer item kind.

See also

SetKind for a list of valid item kinds.

---

GetFormat(self)

Returns the header item format.

---

GetImage(self)

Returns a Python list with the zero-based indexes of the images associated with the header item into the image list.

---

GetItem(self, item)

Returns information about the item.

Parameters:item – an instance of UltimateListHeaderData.

---

GetKind(self)

Returns the header item kind.

See also

SetKind for a list of valid item kinds.

---

GetState(self)

Returns a bit field representing the state of the item.

See also

SetState for a list of valid item states.

---

GetText(self)

Returns the header/footer item text.

---

GetToolTip(self)

Returns the header/footer item tooltip.

---

GetWidth(self)

Returns the header/footer item width, in pixels.

---

HasFooterImage(self)

Returns True if the footer item has at least one image associated with it.

---

HasImage(self)

Returns True if the header item has at least one image associated with it.

---

HasText(self)

Returns True if the currently set text colour is valid.

---

Init(self)

Initializes the header/footer item.

---

IsChecked(self)

Returns whether the header item is checked or not.

---

IsFooterChecked(self)

Returns whether the footer item is checked or not.

---

IsHit(self, x, y)

Returns True if the input position is inside the item client rectangle.

Parameters:

• x – the x mouse position;
• y – the y mouse position.

---

SetCustomRenderer(self, renderer)

Associate a custom renderer to this item.

Parameters:renderer – a class able to correctly render the item.

Note

the renderer class must implement the methods DrawHeaderButton and GetForegroundColor.

---

SetFont(self, font)

Sets a new font for the header item.

Parameters:font – an instance of wx.Font.

---

SetFooterFont(self, font)

Sets a new font for the footer item.

Parameters:font – an instance of wx.Font.

---

SetFooterFormat(self, format)

Sets the footer item format.

Parameters:format – the footer item format.

---

SetFooterKind(self, kind)

Sets the footer item kind.

Parameters:kind – the footer item kind.

See also

SetKind for a list of valid item kinds.

---

SetFormat(self, format)

Sets the header item format.

Parameters:format – the header item format.

---

SetHeight(self, h)

Sets the header/footer item height, in pixels.

Parameters:h – an integer value representing the header/footer height.

---

SetItem(self, item)

Sets information about the header/footer item.

Parameters:info – an instance of UltimateListHeaderData.

---

SetKind(self, kind)

Sets the header item kind.

Parameters:kind – may be one of the following integers:

Item Kind	Description
0	A normal item
1	A checkbox-like item
2	A radiobutton-type item

---

SetPosition(self, x, y)

Sets the header/footer item position.

Parameters:

• x – the item x position;
• y – the item y position.

---

SetState(self, flag)

Sets the item state flags.

Parameters:state – any combination of the following bits:

State Bits	Hex Value	Description
ULC_STATE_DONTCARE	0x0	Don’t care what the state is
ULC_STATE_DROPHILITED	0x1	The item is highlighted to receive a drop event
ULC_STATE_FOCUSED	0x2	The item has the focus
ULC_STATE_SELECTED	0x4	The item is selected
ULC_STATE_CUT	0x8	The item is in the cut state
ULC_STATE_DISABLED	0x10	The item is disabled
ULC_STATE_FILTERED	0x20	The item has been filtered
ULC_STATE_INUSE	0x40	The item is in use
ULC_STATE_PICKED	0x80	The item has been picked
ULC_STATE_SOURCE	0x100	The item is a drag and drop source

---

SetText(self, text)

Sets the header/footer item text.

Parameters:text – the new header/footer text.

---

SetToolTip(self, tip)

Sets the header/footer item tooltip.

Parameters:tip – the new header/footer tooltip.

---

SetWidth(self, w)

Sets the header/footer item width, in pixels.

Parameters:w – an integer value representing the header/footer width.