.. 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
.. _wx.dataview.DataViewModelNotifier:
==========================================================================================================================================
|phoenix_title| **wx.dataview.DataViewModelNotifier**
==========================================================================================================================================
A :ref:`wx.dataview.DataViewModelNotifier` instance is owned by a :ref:`wx.dataview.DataViewModel` and mirrors its notification interface.
See the documentation of that class for further information.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
DataViewModelNotifier:
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.dataview.DataViewModelNotifier.__init__` Constructor.
:meth:`~wx.dataview.DataViewModelNotifier.Cleared` Called by owning model.
:meth:`~wx.dataview.DataViewModelNotifier.GetOwner` Get owning :ref:`wx.dataview.DataViewModel`.
:meth:`~wx.dataview.DataViewModelNotifier.ItemAdded` Called by owning model.
:meth:`~wx.dataview.DataViewModelNotifier.ItemChanged` Called by owning model.
:meth:`~wx.dataview.DataViewModelNotifier.ItemDeleted` Called by owning model.
:meth:`~wx.dataview.DataViewModelNotifier.ItemsAdded` Called by owning model.
:meth:`~wx.dataview.DataViewModelNotifier.ItemsChanged` Called by owning model.
:meth:`~wx.dataview.DataViewModelNotifier.ItemsDeleted` Called by owning model.
:meth:`~wx.dataview.DataViewModelNotifier.Resort` Called by owning model.
:meth:`~wx.dataview.DataViewModelNotifier.SetOwner` Set owner of this notifier.
:meth:`~wx.dataview.DataViewModelNotifier.ValueChanged` Called by owning model.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.dataview.DataViewModelNotifier.Owner` See :meth:`~wx.dataview.DataViewModelNotifier.GetOwner` and :meth:`~wx.dataview.DataViewModelNotifier.SetOwner`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.dataview.DataViewModelNotifier(object)
**Possible constructors**::
DataViewModelNotifier() -> None
A DataViewModelNotifier instance is owned by a DataViewModel and
mirrors its notification interface.
.. method:: __init__(self)
Constructor.
:rtype: `None`
.. method:: Cleared(self)
Called by owning model.
:rtype: `bool`
.. method:: GetOwner(self)
Get owning :ref:`wx.dataview.DataViewModel`.
:rtype: :ref:`wx.dataview.DataViewModel`
.. method:: ItemAdded(self, parent : DataViewItem, item : DataViewItem)
Called by owning model.
:param `parent`:
:type `parent`: wx.dataview.DataViewItem
:param `item`:
:type `item`: wx.dataview.DataViewItem
:rtype: `bool`
:returns:
Always return ``True`` from this function in derived classes.
.. method:: ItemChanged(self, item : DataViewItem)
Called by owning model.
:param `item`:
:type `item`: wx.dataview.DataViewItem
:rtype: `bool`
:returns:
Always return ``True`` from this function in derived classes.
.. method:: ItemDeleted(self, parent : DataViewItem, item : DataViewItem)
Called by owning model.
:param `parent`:
:type `parent`: wx.dataview.DataViewItem
:param `item`:
:type `item`: wx.dataview.DataViewItem
:rtype: `bool`
:returns:
Always return ``True`` from this function in derived classes.
.. method:: ItemsAdded(self, parent : DataViewItem, items : DataViewItemArray)
Called by owning model.
:param `parent`:
:type `parent`: wx.dataview.DataViewItem
:param `items`:
:type `items`: DataViewItemArray
:rtype: `bool`
:returns:
Always return ``True`` from this function in derived classes.
.. method:: ItemsChanged(self, items : DataViewItemArray)
Called by owning model.
:param `items`:
:type `items`: DataViewItemArray
:rtype: `bool`
:returns:
Always return ``True`` from this function in derived classes.
.. method:: ItemsDeleted(self, parent : DataViewItem, items : DataViewItemArray)
Called by owning model.
:param `parent`:
:type `parent`: wx.dataview.DataViewItem
:param `items`:
:type `items`: DataViewItemArray
:rtype: `bool`
:returns:
Always return ``True`` from this function in derived classes.
.. method:: Resort(self)
Called by owning model.
:rtype: `None`
.. method:: SetOwner(self, owner : DataViewModel)
Set owner of this notifier.
Used internally.
:param `owner`:
:type `owner`: wx.dataview.DataViewModel
:rtype: `None`
.. method:: ValueChanged(self, item : DataViewItem, col : int)
Called by owning model.
:param `item`:
:type `item`: wx.dataview.DataViewItem
:param `col`:
:type `col`: int
:rtype: `bool`
:returns:
Always return ``True`` from this function in derived classes.
.. attribute:: Owner
See :meth:`~wx.dataview.DataViewModelNotifier.GetOwner` and :meth:`~wx.dataview.DataViewModelNotifier.SetOwner`