UltimateListEvent

A list event holds information about events associated with UltimateListCtrl objects.

Inheritance Diagram

Inheritance diagram for class UltimateListEvent

Known Superclasses

lib.agw.ultimatelistctrl.CommandListEvent

Methods Summary

__init__	Default class constructor.
Allow	This is the opposite of Veto: it explicitly allows the event to be processed.
GetNotifyEvent	Returns the actual NotifyEvent.
IsAllowed	Returns True if the change is allowed ( Veto hasn’t been called) or
Veto	Prevents the change announced by this event from happening.

Class API

---

class UltimateListEvent(CommandListEvent)

A list event holds information about events associated with UltimateListCtrl objects.

Methods

---

__init__(self, commandTypeOrEvent=None, winid=0)

Default class constructor. For internal use: do not call it in your code!

Parameters:

• commandTypeOrEvent – the event type or another instance of PyCommandEvent;
• winid – the event identifier.

---

Allow(self)

This is the opposite of Veto: it explicitly allows the event to be processed. For most events it is not necessary to call this method as the events are allowed anyhow but some are forbidden by default (this will be mentioned in the corresponding event description).

---

GetNotifyEvent(self)

Returns the actual NotifyEvent.

---

IsAllowed(self)

Returns True if the change is allowed ( Veto hasn’t been called) or False otherwise (if it was).

---

Veto(self)

Prevents the change announced by this event from happening.

Note

It is in general a good idea to notify the user about the reasons for vetoing the change because otherwise the applications behaviour (which just refuses to do what the user wants) might be quite surprising.