.. 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.TextCtrlHandler:
==========================================================================================================================================
|phoenix_title| **wx.lib.agw.persist.persist_handlers.TextCtrlHandler**
==========================================================================================================================================
Supports saving/restoring a :class:`TextCtrl` entered string.
This class handles the following wxPython widgets:
- :class:`TextCtrl`;
- :class:`SearchCtrl`;
- :class:`lib.expando.ExpandoTextCtrl`;
- :class:`lib.masked.textctrl.TextCtrl`;
- :class:`lib.masked.combobox.ComboBox`;
- :class:`lib.masked.ipaddrctrl.IpAddrCtrl`;
- :class:`lib.masked.timectrl.TimeCtrl`;
- :class:`lib.masked.numctrl.NumCtrl`;
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
TextCtrlHandler:
|
|sub_classes| Known Subclasses
==============================
:class:`wx.lib.agw.persist.persist_handlers.TextEntryHandler`
|
|super_classes| Known Superclasses
==================================
:class:`wx.lib.agw.persist.persist_handlers.AbstractHandler`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.agw.persist.persist_handlers.TextCtrlHandler.__init__` Default class constructor.
:meth:`~wx.lib.agw.persist.persist_handlers.TextCtrlHandler.GetKind` Returns a short and meaningful *string* description of your widget.
:meth:`~wx.lib.agw.persist.persist_handlers.TextCtrlHandler.Restore` Restores the widget's settings by calling :meth:`PersistentObject.RestoreValue() `, which in
:meth:`~wx.lib.agw.persist.persist_handlers.TextCtrlHandler.Save` Saves the widget's settings by calling :meth:`PersistentObject.SaveValue() `, which in
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: TextCtrlHandler(AbstractHandler)
Supports saving/restoring a :class:`TextCtrl` entered string.
This class handles the following wxPython widgets:
- :class:`TextCtrl`;
- :class:`SearchCtrl`;
- :class:`lib.expando.ExpandoTextCtrl`;
- :class:`lib.masked.textctrl.TextCtrl`;
- :class:`lib.masked.combobox.ComboBox`;
- :class:`lib.masked.ipaddrctrl.IpAddrCtrl`;
- :class:`lib.masked.timectrl.TimeCtrl`;
- :class:`lib.masked.numctrl.NumCtrl`;
.. 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.