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
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. currentmodule:: wx.lib.agw.foldpanelbar
.. highlight:: python
.. _wx.lib.agw.foldpanelbar.CaptionBarEvent:
==========================================================================================================================================
|phoenix_title| **wx.lib.agw.foldpanelbar.CaptionBarEvent**
==========================================================================================================================================
This event will be sent when a ``EVT_CAPTIONBAR`` is mapped in the parent.
It is to notify the parent that the bar is now in collapsed or expanded
state. The parent should re-arrange the associated windows accordingly
|
|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>CaptionBarEvent</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.foldpanelbar.CaptionBarEvent_inheritance.png" alt="Inheritance diagram of CaptionBarEvent" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.Event.html" title="wx.Event" alt="" coords="105,83,183,112"/> <area shape="rect" id="node4" href="wx.CommandEvent.html" title="wx.CommandEvent" alt="" coords="71,160,216,189"/> <area shape="rect" id="node2" href="wx.Object.html" title="wx.Object" alt="" coords="103,5,184,35"/> <area shape="rect" id="node3" href="wx.lib.agw.foldpanelbar.CaptionBarEvent.html" title="wx.lib.agw.foldpanelbar.CaptionBarEvent" alt="" coords="5,237,283,267"/> </map>
</p>
|
|super_classes| Known Superclasses
==================================
:class:`wx.CommandEvent`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.agw.foldpanelbar.CaptionBarEvent.__init__` Default class constructor.
:meth:`~wx.lib.agw.foldpanelbar.CaptionBarEvent.GetBar` Returns the selected :class:`CaptionBar`.
:meth:`~wx.lib.agw.foldpanelbar.CaptionBarEvent.GetFoldStatus` Returns whether the bar is expanded or collapsed. ``True`` means
:meth:`~wx.lib.agw.foldpanelbar.CaptionBarEvent.GetTag` Returns the tag assigned to the selected :class:`CaptionBar`.
:meth:`~wx.lib.agw.foldpanelbar.CaptionBarEvent.SetBar` Sets the bar associated with this event.
:meth:`~wx.lib.agw.foldpanelbar.CaptionBarEvent.SetTag` Assigns a tag to the selected :class:`CaptionBar`.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: CaptionBarEvent(wx.CommandEvent)
This event will be sent when a ``EVT_CAPTIONBAR`` is mapped in the parent.
It is to notify the parent that the bar is now in collapsed or expanded
state. The parent should re-arrange the associated windows accordingly
.. method:: __init__(self, evtType)
Default class constructor.
:param `evtType`: the event type.
.. method:: GetBar(self)
Returns the selected :class:`CaptionBar`.
.. method:: GetFoldStatus(self)
Returns whether the bar is expanded or collapsed. ``True`` means
expanded.
.. method:: GetTag(self)
Returns the tag assigned to the selected :class:`CaptionBar`.
.. method:: SetBar(self, bar)
Sets the bar associated with this event.
:param `bar`: an instance of :class:`CaptionBar`.
:note: Should not be used by any other than the originator of the event.
.. method:: SetTag(self, tag)
Assigns a tag to the selected :class:`CaptionBar`.
:param `tag`: an instance of :class:`FoldPanelBar`.
|
