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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
|
.. 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.FoldWindowItem:
==========================================================================================================================================
|phoenix_title| **wx.lib.agw.foldpanelbar.FoldWindowItem**
==========================================================================================================================================
This class is a child sibling of the :class:`FoldPanelItem` class. It
will contain :class:`wx.Window` that can be either a separator (a coloured
line simulated by a :class:`wx.Window`) or a wxPython controls (such as a
:class:`Button`, a :class:`ListCtrl` etc...).
|
|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>FoldWindowItem</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.FoldWindowItem_inheritance.png" alt="Inheritance diagram of FoldWindowItem" 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.lib.agw.foldpanelbar.FoldWindowItem.html" title="wx.lib.agw.foldpanelbar.FoldWindowItem" alt="" coords="4,5,275,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.agw.foldpanelbar.FoldWindowItem.__init__` Default class constructor
:meth:`~wx.lib.agw.foldpanelbar.FoldWindowItem.GetLeftSpacing` Returns the left indent of :class:`FoldWindowItem`.
:meth:`~wx.lib.agw.foldpanelbar.FoldWindowItem.GetLineColour` Returns the separator line colour.
:meth:`~wx.lib.agw.foldpanelbar.FoldWindowItem.GetLineLength` Returns the separator line length.
:meth:`~wx.lib.agw.foldpanelbar.FoldWindowItem.GetLineY` Returns the y position of the separator.
:meth:`~wx.lib.agw.foldpanelbar.FoldWindowItem.GetRightSpacing` Returns the right indent of :class:`FoldWindowItem`.
:meth:`~wx.lib.agw.foldpanelbar.FoldWindowItem.GetSpacing` Returns the spacing of :class:`FoldWindowItem`.
:meth:`~wx.lib.agw.foldpanelbar.FoldWindowItem.GetType` Returns the :class:`FoldWindowItem` type.
:meth:`~wx.lib.agw.foldpanelbar.FoldWindowItem.GetWindowLength` Returns space needed by the window if type is :class:`FoldWindowItem`
:meth:`~wx.lib.agw.foldpanelbar.FoldWindowItem.ResizeItem` Resizes the element, whatever it is.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: FoldWindowItem(object)
This class is a child sibling of the :class:`FoldPanelItem` class. It
will contain :class:`wx.Window` that can be either a separator (a coloured
line simulated by a :class:`wx.Window`) or a wxPython controls (such as a
:class:`Button`, a :class:`ListCtrl` etc...).
.. method:: __init__(self, parent, window=None, \*\*kw)
Default class constructor
:param `parent`: the :class:`FoldWindowItem` parent;
:param `window`: the window contained in this item.
:keyword `Type`: can be "WINDOW" or "SEPARATOR";
:keyword `lineColour`: the separator colour (meaningful for separators only);
:keyword `y`: the separator y position (meaningful for separators only);
:keyword `flags`: the alignment flags;
:keyword `spacing`: reserves a number of pixels before the window/separator element;
:keyword `leftSpacing`: an indent, in pixels;
:keyword `rightSpacing`: a right spacing, only relevant when the style
``FPB_ALIGN_WIDTH`` is chosen.
:see: :meth:`FoldPanelBar.AddFoldPanelWindow() <FoldPanelBar.AddFoldPanelWindow>` for a list of valid alignment flags.
.. method:: GetLeftSpacing(self)
Returns the left indent of :class:`FoldWindowItem`.
.. method:: GetLineColour(self)
Returns the separator line colour.
.. method:: GetLineLength(self)
Returns the separator line length.
.. method:: GetLineY(self)
Returns the y position of the separator.
.. method:: GetRightSpacing(self)
Returns the right indent of :class:`FoldWindowItem`.
.. method:: GetSpacing(self)
Returns the spacing of :class:`FoldWindowItem`.
.. method:: GetType(self)
Returns the :class:`FoldWindowItem` type.
.. method:: GetWindowLength(self, vertical=True)
Returns space needed by the window if type is :class:`FoldWindowItem`
"WINDOW" and returns the total size plus the extra spacing.
:param `vertical`: ``True`` if the parent :class:`FoldPanelBar` is in vertical
mode.
.. method:: ResizeItem(self, size, vertical=True)
Resizes the element, whatever it is.
A separator or line will be always aligned by width or height
depending on orientation of the whole panel.
:param `size`: the maximum size available for the :class:`FoldWindowItem`;
:param `vertical`: ``True`` if the parent :class:`FoldPanelBar` is in vertical
mode.
|
