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
159
160
161
162
163
164
|
.. 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.labelbook
.. highlight:: python
.. _wx.lib.agw.labelbook.ImageInfo:
==========================================================================================================================================
|phoenix_title| **wx.lib.agw.labelbook.ImageInfo**
==========================================================================================================================================
This class holds all the information (caption, image, etc...) belonging to a
single tab in :class:`LabelBook`.
|
|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>ImageInfo</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.labelbook.ImageInfo_inheritance.png" alt="Inheritance diagram of ImageInfo" 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.labelbook.ImageInfo.html" title="wx.lib.agw.labelbook.ImageInfo" alt="" coords="5,5,221,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.agw.labelbook.ImageInfo.__init__` Default class constructor.
:meth:`~wx.lib.agw.labelbook.ImageInfo.EnableTab` Sets the tab enabled or disabled.
:meth:`~wx.lib.agw.labelbook.ImageInfo.GetCaption` Returns the tab caption.
:meth:`~wx.lib.agw.labelbook.ImageInfo.GetEnabled` Returns whether the tab is enabled or not.
:meth:`~wx.lib.agw.labelbook.ImageInfo.GetImageIndex` Returns the tab image index.
:meth:`~wx.lib.agw.labelbook.ImageInfo.GetPosition` Returns the tab position.
:meth:`~wx.lib.agw.labelbook.ImageInfo.GetSize` Returns the tab size.
:meth:`~wx.lib.agw.labelbook.ImageInfo.GetTextRect` Returns the client rectangle available for the tab text.
:meth:`~wx.lib.agw.labelbook.ImageInfo.SetCaption` Sets the tab caption.
:meth:`~wx.lib.agw.labelbook.ImageInfo.SetImageIndex` Sets the tab image index.
:meth:`~wx.lib.agw.labelbook.ImageInfo.SetPosition` Sets the tab position.
:meth:`~wx.lib.agw.labelbook.ImageInfo.SetSize` Sets the tab size.
:meth:`~wx.lib.agw.labelbook.ImageInfo.SetTextRect` Sets the client rectangle available for the tab text.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: ImageInfo(object)
This class holds all the information (caption, image, etc...) belonging to a
single tab in :class:`LabelBook`.
.. method:: __init__(self, strCaption="", imageIndex=-1, enabled=True)
Default class constructor.
:param `strCaption`: the tab caption;
:param `imageIndex`: the tab image index based on the assigned (set)
:class:`wx.ImageList` (if any);
:param `enabled`: sets the tab as enabled or disabled.
.. method:: EnableTab(self, enabled)
Sets the tab enabled or disabled.
:param `enabled`: ``True`` to enable a tab, ``False`` to disable it.
.. method:: GetCaption(self)
Returns the tab caption.
.. method:: GetEnabled(self)
Returns whether the tab is enabled or not.
.. method:: GetImageIndex(self)
Returns the tab image index.
.. method:: GetPosition(self)
Returns the tab position.
.. method:: GetSize(self)
Returns the tab size.
.. method:: GetTextRect(self)
Returns the client rectangle available for the tab text.
.. method:: SetCaption(self, value)
Sets the tab caption.
:param `value`: the new tab caption.
.. method:: SetImageIndex(self, value)
Sets the tab image index.
:param `value`: an index into the image list..
.. method:: SetPosition(self, value)
Sets the tab position.
:param `value`: the new tab position, an instance of :class:`wx.Point`.
.. method:: SetSize(self, value)
Sets the tab size.
:param `value`: the new tab size, an instance of :class:`wx.Size`.
.. method:: SetTextRect(self, rect)
Sets the client rectangle available for the tab text.
:param `rect`: the tab text client rectangle, an instance of :class:`wx.Rect`.
|
