A simple class which holds information about UltimateListItem visual attributes for the header/footer items (client rectangles, positions, etc...).
__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. |
A simple class which holds information about UltimateListItem visual attributes for the header/footer items (client rectangles, positions, etc...).
Default class constructor.
Parameters: | item – another instance of UltimateListHeaderData. |
---|
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.
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.
Returns the footer item format.
Returns a Python list with the zero-based indexes of the images associated with the footer item into the image list.
Returns the footer item kind.
See also
SetKind for a list of valid item kinds.
Returns a Python list with the zero-based indexes of the images associated with the header item into the image list.
Returns information about the item.
Parameters: | item – an instance of UltimateListHeaderData. |
---|
Returns a bit field representing the state of the item.
See also
SetState for a list of valid item states.
Returns True if the footer item has at least one image associated with it.
Returns whether the footer item is checked or not.
Returns True if the input position is inside the item client rectangle.
Parameters: |
|
---|
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.
Sets a new font for the header item.
Parameters: | font – an instance of wx.Font. |
---|
Sets a new font for the footer item.
Parameters: | font – an instance of wx.Font. |
---|
Sets the footer item format.
Parameters: | format – the footer item format. |
---|
Sets the footer item kind.
Parameters: | kind – the footer item kind. |
---|
See also
SetKind for a list of valid item kinds.
Sets the header/footer item height, in pixels.
Parameters: | h – an integer value representing the header/footer height. |
---|
Sets information about the header/footer item.
Parameters: | info – an instance of UltimateListHeaderData. |
---|
Sets the header item kind.
Parameters: | kind – may be one of the following integers:
|
---|
Sets the header/footer item position.
Parameters: |
|
---|
Sets the item state flags.
Parameters: | state – any combination of the following bits:
|
---|
Sets the header/footer item text.
Parameters: | text – the new header/footer text. |
---|
Sets the header/footer item tooltip.
Parameters: | tip – the new header/footer tooltip. |
---|