1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
|
.. 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.ToggleButtonHandler:
==========================================================================================================================================
|phoenix_title| **wx.lib.agw.persist.persist_handlers.ToggleButtonHandler**
==========================================================================================================================================
Supports saving/restoring a :class:`ToggleButton` and friends state.
This class handles the following wxPython widgets:
- :class:`ToggleButton`;
- :class:`lib.buttons.GenToggleButton`;
- :class:`lib.buttons.GenBitmapToggleButton`;
- :class:`lib.buttons.GenBitmapTextToggleButton`;
- :class:`lib.agw.shapedbutton.SToggleButton`;
- :class:`lib.agw.shapedbutton.SBitmapToggleButton`;
- :class:`lib.agw.shapedbutton.SBitmapTextToggleButton`.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>ToggleButtonHandler</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.lib.agw.persist.persist_handlers.ToggleButtonHandler_inheritance.png" alt="Inheritance diagram of ToggleButtonHandler" usemap="#dummy" class="inheritance"/></center>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.lib.agw.persist.persist_handlers.ToggleButtonHandler.html" title="wx.lib.agw.persist.persist_handlers.ToggleButtonHandler" alt="" coords="5,83,396,112"/> <area shape="rect" id="node2" href="wx.lib.agw.persist.persist_handlers.AbstractHandler.html" title="wx.lib.agw.persist.persist_handlers.AbstractHandler" alt="" coords="21,5,380,35"/> </map>
</p>
</div>
|
|super_classes| Known Superclasses
==================================
:class:`wx.lib.agw.persist.persist_handlers.AbstractHandler`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.agw.persist.persist_handlers.ToggleButtonHandler.__init__` Default class constructor.
:meth:`~wx.lib.agw.persist.persist_handlers.ToggleButtonHandler.GetKind` Returns a short and meaningful *string* description of your widget.
:meth:`~wx.lib.agw.persist.persist_handlers.ToggleButtonHandler.Restore` Restores the widget's settings by calling :meth:`PersistentObject.RestoreValue() <lib.agw.persist.persistencemanager.PersistentObject.RestoreValue>`, which in
:meth:`~wx.lib.agw.persist.persist_handlers.ToggleButtonHandler.Save` Saves the widget's settings by calling :meth:`PersistentObject.SaveValue() <lib.agw.persist.persistencemanager.PersistentObject.SaveValue>`, which in
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: ToggleButtonHandler(AbstractHandler)
Supports saving/restoring a :class:`ToggleButton` and friends state.
This class handles the following wxPython widgets:
- :class:`ToggleButton`;
- :class:`lib.buttons.GenToggleButton`;
- :class:`lib.buttons.GenBitmapToggleButton`;
- :class:`lib.buttons.GenBitmapTextToggleButton`;
- :class:`lib.agw.shapedbutton.SToggleButton`;
- :class:`lib.agw.shapedbutton.SBitmapToggleButton`;
- :class:`lib.agw.shapedbutton.SBitmapTextToggleButton`.
.. 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() <lib.agw.persist.persistencemanager.PersistentObject.RestoreValue>`, which in
turns calls :meth:`PersistenceManager.RestoreValue() <lib.agw.persist.persistencemanager.PersistenceManager.RestoreValue>`.
:note: This method must be overridden in derived classes.
.. method:: Save(self)
Saves the widget's settings by calling :meth:`PersistentObject.SaveValue() <lib.agw.persist.persistencemanager.PersistentObject.SaveValue>`, which in
turns calls :meth:`PersistenceManager.SaveValue() <lib.agw.persist.persistencemanager.PersistenceManager.SaveValue>`.
:note: This method must be overridden in derived classes.
|
