CommandListEvent¶A list event holds information about events associated with UltimateListCtrl objects.
Methods Summary¶| __init__ | Default class constructor. |
| GetCacheFrom | Returns the first item which the list control advises us to cache. |
| GetCacheTo | Returns the last item (inclusive) which the list control advises us to cache. |
| GetColumn | Returns the column position: it is only used with COL events. |
| GetData | Returns the item data. |
| GetImage | Returns the item image. |
| GetIndex | Returns the item index. |
| GetItem | Returns the item itself. |
| GetKeyCode | Returns the key code if the event is a keypress event. |
| GetLabel | Returns the (new) item label for EVT_LIST_END_LABEL_EDIT event. |
| GetMask | Returns the item mask. |
| GetPoint | Returns the position of the mouse pointer if the event is a drag event. |
| GetText | Returns the item text. |
| IsEditCancelled | Returns True if it the label editing has been cancelled by the user |
| SetEditCanceled | Sets the item editing as cancelled/not cancelled. |
Class API¶A list event holds information about events associated with UltimateListCtrl objects.
Default class constructor. For internal use: do not call it in your code!
| Parameters: |
|
|---|
Returns the first item which the list control advises us to cache.
Note
This method is meaningful for EVT_LIST_CACHE_HINT event only.
Returns the last item (inclusive) which the list control advises us to cache.
Note
This method is meaningful for EVT_LIST_CACHE_HINT event only.
Returns the column position: it is only used with COL events.
For the column dragging events, it is the column to the left of the divider being dragged, for the column click events it may be -1 if the user clicked in the list control header outside any column.
Returns True if it the label editing has been cancelled by the user (GetLabel returns an empty string in this case but it doesn’t allow the application to distinguish between really cancelling the edit and the admittedly rare case when the user wants to rename it to an empty string).
Note
This method only makes sense for EVT_LIST_END_LABEL_EDIT messages.
Inheritance Diagram
Known Subclasses