.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. currentmodule:: wx.lib.agw.ultimatelistctrl
.. highlight:: python
.. _wx.lib.agw.ultimatelistctrl.UltimateListEvent:
==========================================================================================================================================
|phoenix_title| **wx.lib.agw.ultimatelistctrl.UltimateListEvent**
==========================================================================================================================================
A list event holds information about events associated with :class:`UltimateListCtrl`
objects.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
UltimateListEvent:
|
|super_classes| Known Superclasses
==================================
:class:`wx.lib.agw.ultimatelistctrl.CommandListEvent`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListEvent.__init__` Default class constructor.
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListEvent.Allow` This is the opposite of :meth:`~UltimateListEvent.Veto`: it explicitly allows the event to be processed.
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListEvent.GetNotifyEvent` Returns the actual :class:`NotifyEvent`.
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListEvent.IsAllowed` Returns ``True`` if the change is allowed ( :meth:`~UltimateListEvent.Veto` hasn't been called) or
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListEvent.Veto` Prevents the change announced by this event from happening.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: UltimateListEvent(CommandListEvent)
A list event holds information about events associated with :class:`UltimateListCtrl`
objects.
.. method:: __init__(self, commandTypeOrEvent=None, winid=0)
Default class constructor.
For internal use: do not call it in your code!
:param `commandTypeOrEvent`: the event type or another instance of
:class:`PyCommandEvent`;
:param `winid`: the event identifier.
.. method:: Allow(self)
This is the opposite of :meth:`~UltimateListEvent.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).
.. method:: GetNotifyEvent(self)
Returns the actual :class:`NotifyEvent`.
.. method:: IsAllowed(self)
Returns ``True`` if the change is allowed ( :meth:`~UltimateListEvent.Veto` hasn't been called) or
``False`` otherwise (if it was).
.. method:: 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.