.. 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.persist.persist_handlers
.. highlight:: python
.. _wx.lib.agw.persist.persist_handlers.ToolBarHandler:
==========================================================================================================================================
|phoenix_title| **wx.lib.agw.persist.persist_handlers.ToolBarHandler**
==========================================================================================================================================
Supports saving/restoring the :class:`lib.agw.aui.auibar.AuiToolBar` items state.
This class handles the following wxPython widgets:
- :class:`lib.agw.aui.auibar.AuiToolBar`.
.. todo::
Find a way to handle :class:`ToolBar` UI settings as it has been done for
:class:`lib.agw.aui.auibar.AuiToolBar`: currently :class:`ToolBar` doesn't seem
to have easy access to the underlying toolbar tools.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
ToolBarHandler:
|
|super_classes| Known Superclasses
==================================
:class:`wx.lib.agw.persist.persist_handlers.AbstractHandler`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.agw.persist.persist_handlers.ToolBarHandler.__init__` Default class constructor.
:meth:`~wx.lib.agw.persist.persist_handlers.ToolBarHandler.GetKind` Returns a short and meaningful *string* description of your widget.
:meth:`~wx.lib.agw.persist.persist_handlers.ToolBarHandler.Restore` Restores the widget's settings by calling :meth:`PersistentObject.RestoreValue() `, which in
:meth:`~wx.lib.agw.persist.persist_handlers.ToolBarHandler.Save` Saves the widget's settings by calling :meth:`PersistentObject.SaveValue() `, which in
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: ToolBarHandler(AbstractHandler)
Supports saving/restoring the :class:`lib.agw.aui.auibar.AuiToolBar` items state.
This class handles the following wxPython widgets:
- :class:`lib.agw.aui.auibar.AuiToolBar`.
.. todo::
Find a way to handle :class:`ToolBar` UI settings as it has been done for
:class:`lib.agw.aui.auibar.AuiToolBar`: currently :class:`ToolBar` doesn't seem
to have easy access to the underlying toolbar tools.
.. method:: __init__(self, pObject)
Default class constructor.
:param `pObject`: a :class:`~wx.lib.agw.persist.persistencemanager.PersistentObject` containing information about the
persistent widget.
.. method:: GetKind(self)
Returns a short and meaningful *string* description of your widget.
.. note:: This method must be overridden in derived classes.
.. method:: Restore(self)
Restores the widget's settings by calling :meth:`PersistentObject.RestoreValue() `, which in
turns calls :meth:`PersistenceManager.RestoreValue() `.
.. note:: This method must be overridden in derived classes.
.. method:: Save(self)
Saves the widget's settings by calling :meth:`PersistentObject.SaveValue() `, which in
turns calls :meth:`PersistenceManager.SaveValue() `.
.. note:: This method must be overridden in derived classes.