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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
|
.. 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.flatnotebook
.. highlight:: python
.. _wx.lib.agw.flatnotebook.FNBRenderer:
==========================================================================================================================================
|phoenix_title| **wx.lib.agw.flatnotebook.FNBRenderer**
==========================================================================================================================================
Parent class for the 6 renderers defined: `Standard`, `VC71`, `Fancy`, `Firefox 2`,
`VC8` and `Ribbon`. This class implements the common methods of all 6 renderers.
|
|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>FNBRenderer</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.flatnotebook.FNBRenderer_inheritance.png" alt="Inheritance diagram of FNBRenderer" 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.flatnotebook.FNBRenderer.html" title="wx.lib.agw.flatnotebook.FNBRenderer" alt="" coords="5,5,259,35"/> </map>
</p>
|
|sub_classes| Known Subclasses
==============================
:class:`wx.lib.agw.flatnotebook.FNBRendererDefault`, :class:`wx.lib.agw.flatnotebook.FNBRendererFancy`, :class:`wx.lib.agw.flatnotebook.FNBRendererFirefox2`, :class:`wx.lib.agw.flatnotebook.FNBRendererRibbonTabs`, :class:`wx.lib.agw.flatnotebook.FNBRendererVC71`, :class:`wx.lib.agw.flatnotebook.FNBRendererVC8`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.agw.flatnotebook.FNBRenderer.__init__` Default class constructor.
:meth:`~wx.lib.agw.flatnotebook.FNBRenderer.CalcTabHeight` Calculates the height of the input tab.
:meth:`~wx.lib.agw.flatnotebook.FNBRenderer.CalcTabWidth` Calculates the width of the input tab.
:meth:`~wx.lib.agw.flatnotebook.FNBRenderer.DrawArrowAccordingToState` Draws the left and right scrolling arrows.
:meth:`~wx.lib.agw.flatnotebook.FNBRenderer.DrawDragHint` Draws tab drag hint, the default implementation is to do nothing.
:meth:`~wx.lib.agw.flatnotebook.FNBRenderer.DrawDropDownArrow` Draws the drop-down arrow in the navigation area.
:meth:`~wx.lib.agw.flatnotebook.FNBRenderer.DrawFocusRectangle` Draws a focus rectangle like the native :class:`Notebook`.
:meth:`~wx.lib.agw.flatnotebook.FNBRenderer.DrawLeftArrow` Draws the left navigation arrow.
:meth:`~wx.lib.agw.flatnotebook.FNBRenderer.DrawRightArrow` Draws the right navigation arrow.
:meth:`~wx.lib.agw.flatnotebook.FNBRenderer.DrawTabs` Actually draws the tabs in :class:`FlatNotebook`.
:meth:`~wx.lib.agw.flatnotebook.FNBRenderer.DrawTabsLine` Draws a line over the tabs.
:meth:`~wx.lib.agw.flatnotebook.FNBRenderer.DrawTabX` Draws the 'X' in the selected tab.
:meth:`~wx.lib.agw.flatnotebook.FNBRenderer.DrawX` Draw the 'X' navigation button in the navigation area.
:meth:`~wx.lib.agw.flatnotebook.FNBRenderer.GetButtonsAreaLength` Returns the navigation area width.
:meth:`~wx.lib.agw.flatnotebook.FNBRenderer.GetDropArrowButtonPos` Returns the drop down button position in the navigation area.
:meth:`~wx.lib.agw.flatnotebook.FNBRenderer.GetLeftButtonPos` Returns the left button position in the navigation area.
:meth:`~wx.lib.agw.flatnotebook.FNBRenderer.GetRightButtonPos` Returns the right button position in the navigation area.
:meth:`~wx.lib.agw.flatnotebook.FNBRenderer.GetXPos` Returns the 'X' button position in the navigation area.
:meth:`~wx.lib.agw.flatnotebook.FNBRenderer.NumberTabsCanFit` Calculates the number of tabs that can fit on the available space on screen.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: FNBRenderer(object)
Parent class for the 6 renderers defined: `Standard`, `VC71`, `Fancy`, `Firefox 2`,
`VC8` and `Ribbon`. This class implements the common methods of all 6 renderers.
.. method:: __init__(self)
Default class constructor.
.. method:: CalcTabHeight(self, pageContainer)
Calculates the height of the input tab.
:param `pageContainer`: an instance of :class:`FlatNotebook`.
.. method:: CalcTabWidth(self, pageContainer, tabIdx, tabHeight)
Calculates the width of the input tab.
:param `pageContainer`: an instance of :class:`FlatNotebook`;
:param `tabIdx`: the index of the input tab;
:param `tabHeight`: the height of the tab.
.. method:: DrawArrowAccordingToState(self, dc, pc, rect)
Draws the left and right scrolling arrows.
:param `dc`: an instance of :class:`wx.DC`;
:param `pc`: an instance of :class:`FlatNotebook`;
:param `rect`: the client rectangle containing the scrolling arrows.
.. method:: DrawDragHint(self, pc, tabIdx)
Draws tab drag hint, the default implementation is to do nothing.
You can override this function to provide a nice feedback to user.
:param `pc`: an instance of :class:`FlatNotebook`;
:param `tabIdx`: the index of the tab we are dragging.
:note: To show your own custom drag and drop UI feedback, you must override
this method in your derived class.
.. method:: DrawDropDownArrow(self, pageContainer, dc)
Draws the drop-down arrow in the navigation area.
:param `pageContainer`: an instance of :class:`FlatNotebook`;
:param `dc`: an instance of :class:`wx.DC`.
.. method:: DrawFocusRectangle(self, dc, pageContainer, page)
Draws a focus rectangle like the native :class:`Notebook`.
:param `dc`: an instance of :class:`wx.DC`;
:param `pageContainer`: an instance of :class:`FlatNotebook`;
:param `page`: an instance of :class:`PageInfo`, representing a page in the notebook.
.. method:: DrawLeftArrow(self, pageContainer, dc)
Draws the left navigation arrow.
:param `pageContainer`: an instance of :class:`FlatNotebook`;
:param `dc`: an instance of :class:`wx.DC`.
.. method:: DrawRightArrow(self, pageContainer, dc)
Draws the right navigation arrow.
:param `pageContainer`: an instance of :class:`FlatNotebook`;
:param `dc`: an instance of :class:`wx.DC`.
.. method:: DrawTabs(self, pageContainer, dc)
Actually draws the tabs in :class:`FlatNotebook`.
:param `pageContainer`: an instance of :class:`FlatNotebook`;
:param `dc`: an instance of :class:`wx.DC`.
.. method:: DrawTabsLine(self, pageContainer, dc, selTabX1=-1, selTabX2=-1)
Draws a line over the tabs.
:param `pageContainer`: an instance of :class:`FlatNotebook`;
:param `dc`: an instance of :class:`wx.DC`;
:param `selTabX1`: first x coordinate of the tab line;
:param `selTabX2`: second x coordinate of the tab line.
.. method:: DrawTabX(self, pageContainer, dc, rect, tabIdx, btnStatus)
Draws the 'X' in the selected tab.
:param `pageContainer`: an instance of :class:`FlatNotebook`;
:param `dc`: an instance of :class:`wx.DC`;
:param `rect`: the current tab client rectangle;
:param `tabIdx`: the index of the current tab;
:param `btnStatus`: the status of the 'X' button in the current tab.
.. method:: DrawX(self, pageContainer, dc)
Draw the 'X' navigation button in the navigation area.
:param `pageContainer`: an instance of :class:`FlatNotebook`;
:param `dc`: an instance of :class:`wx.DC`.
.. method:: GetButtonsAreaLength(self, pageContainer)
Returns the navigation area width.
:param `pageContainer`: an instance of :class:`FlatNotebook`.
.. method:: GetDropArrowButtonPos(self, pageContainer)
Returns the drop down button position in the navigation area.
:param `pageContainer`: an instance of :class:`FlatNotebook`.
.. method:: GetLeftButtonPos(self, pageContainer)
Returns the left button position in the navigation area.
:param `pageContainer`: an instance of :class:`FlatNotebook`.
.. method:: GetRightButtonPos(self, pageContainer)
Returns the right button position in the navigation area.
:param `pageContainer`: an instance of :class:`FlatNotebook`.
.. method:: GetXPos(self, pageContainer)
Returns the 'X' button position in the navigation area.
:param `pageContainer`: an instance of :class:`FlatNotebook`.
.. method:: NumberTabsCanFit(self, pageContainer, fr=-1)
Calculates the number of tabs that can fit on the available space on screen.
:param `pageContainer`: an instance of :class:`FlatNotebook`;
:param `fr`: the current first visible tab.
|
