AGW Logo

agw_title UltimateListEvent

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

hierarchy Inheritance Diagram

Inheritance diagram for: UltimateListEvent

Inheritance diagram of UltimateListEvent


method_summary Methods Summary

__init__Default class constructor.
AllowThis is the opposite of Veto: it explicitly allows the event to be processed.
GetNotifyEventReturns the actual wx.NotifyEvent.
IsAllowedReturns True if the change is allowed (Veto hasn’t been called) or
VetoPrevents the change announced by this event from happening.

API Class API

class UltimateListEvent(CommandListEvent)[source]

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



__init__(commandTypeOrEvent=None, winid=0)[source]

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

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


Allow()[source]

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()[source]

Returns the actual wx.NotifyEvent.



IsAllowed()[source]

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



Veto()[source]

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.

Tree

Table Of Contents

Previous topic

UltimateListCtrl

Next topic

UltimateListHeaderData