A simple class which holds information about UltimateListItem visual attributes (client rectangles, positions, etc...).
__init__ | Default class constructor |
Check | Checks/unchecks an item. |
DeleteWindow | Deletes the window associated to the item (if any). |
Enable | Enables or disables the item. |
GetAttr | Returns the item attributes. |
GetBackgroundColour | Returns the currently set background colour. |
GetColour | Returns the currently set text colour. |
GetCustomRenderer | Returns the custom renderer associated with this item (if any). |
GetFont | Returns the currently set font. |
GetHeight | Returns the item height, in pixels. |
GetImage | Returns a Python list with the zero-based indexes of the images associated |
GetItem | Returns information about the item. |
GetKind | Returns the item kind. |
GetOverFlow | Returns if the item is in the overflow state. |
GetText | Returns the item text. |
GetTextForMeasuring | Returns the item text or a simple string if the item text is the |
GetToolTip | Returns the item tooltip. |
GetVisited | Returns whether an hypertext item was visited or not. |
GetWidth | Returns the item width, in pixels. |
GetWindow | Returns the window associated to the item. |
GetWindowEnabled | Returns whether the associated window is enabled or not. |
GetWindowSize | Returns the associated window size. |
GetX | Returns the item x position. |
GetY | Returns the item y position. |
HasBackgroundColour | Returns True if the currently set background colour is valid. |
HasColour | Returns True if the currently set text colour is valid. |
HasFont | Returns True if the currently set font is valid. |
HasImage | Returns True if the item has at least one image associated with it. |
HasText | Returns True if the item text is not the empty string. |
Init | Initializes the item data structure. |
IsChecked | Returns whether the item is checked or not. |
IsEnabled | Returns True if the item is enabled, False if it is disabled. |
IsHit | Returns True if the input position is inside the item client rectangle. |
IsHyperText | Returns whether the item is hypetext or not. |
SetAttr | Sets the item attributes. |
SetBackgroundColour | Sets the background colour for the item. |
SetColour | Sets the text colour for the item. |
SetCustomRenderer | Associate a custom renderer to this item. |
SetData | Sets client data for the item. |
SetFont | Sets the text font for the item. |
SetHyperText | Sets whether the item is hypertext or not. |
SetImage | Sets the zero-based indexes of the images associated with the item into the image list. |
SetItem | Sets information about the item. |
SetKind | Sets the item kind. |
SetOverFlow | Sets the item in the overflow/non overflow state. |
SetPosition | Sets the item position. |
SetSize | Sets the item size. |
SetText | Sets the text label for the item. |
SetToolTip | Sets the tooltip for the item |
SetVisited | Sets whether an hypertext item was visited or not. |
SetWindow | Sets the window associated to the item. |
SetWindowEnabled | Sets whether the associated window is enabled or not. |
A simple class which holds information about UltimateListItem visual attributes (client rectangles, positions, etc...).
Default class constructor
Parameters: | owner – an instance of UltimateListCtrl. |
---|
Checks/unchecks an item.
Parameters: | checked – True to check an item, False to uncheck it. |
---|
Note
This method is meaningful only for check and radio items.
Enables or disables the item.
Parameters: | enable – True to enable the item, False to disable it. |
---|
Returns a Python list with the zero-based indexes of the images associated with the item into the image list.
Returns information about the item.
Parameters: | info – an instance of UltimateListItemData. |
---|
Returns if the item is in the overflow state.
An item/subitem may overwrite neighboring items/subitems if its text would not normally fit in the space allotted to it.
Returns the item text or a simple string if the item text is the empty string.
Returns True if the input position is inside the item client rectangle.
Parameters: |
|
---|
Sets the item attributes.
Parameters: | attr – an instance of UltimateListItemAttr. |
---|
Sets the background colour for the item.
Parameters: | colour – an instance of wx.Colour. |
---|
Sets the text colour for the item.
Parameters: | colour – an instance of wx.Colour. |
---|
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 DrawSubItem, GetLineHeight and GetSubItemWidth.
Sets client data for the item.
Parameters: | data – the client data associated to the item. |
---|
Note
Please note that client data is associated with the item and not with subitems.
Sets whether the item is hypertext or not.
Parameters: | hyper – True to set hypertext behaviour, False otherwise. |
---|
Sets the zero-based indexes of the images associated with the item into the image list.
Parameters: | image – a Python list with the zero-based indexes of the images associated with the item into the image list. |
---|
Sets information about the item.
Parameters: | info – an instance of UltimateListItemData. |
---|
Sets the item kind.
Parameters: | kind – may be one of the following integers:
|
---|
Sets the item in the overflow/non overflow state.
An item/subitem may overwrite neighboring items/subitems if its text would not normally fit in the space allotted to it.
Parameters: | over – True to set the item in a overflow state, False otherwise. |
---|
Sets the item position.
Parameters: |
|
---|
Sets the item size.
Parameters: |
|
---|
Sets the text label for the item.
Parameters: | text – the text label for the item. |
---|
Sets whether an hypertext item was visited or not.
Parameters: | visited – True to set a hypertext item as visited, False otherwise. |
---|
Sets the window associated to the item.
Parameters: |
|
---|