File: wx.lib.agw.flatnotebook.FNBRendererVC8.txt

package info (click to toggle)
wxpython4.0 4.0.4%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 211,112 kB
  • sloc: cpp: 888,355; python: 223,130; makefile: 52,087; ansic: 45,780; sh: 3,012; xml: 1,534; perl: 264
file content (145 lines) | stat: -rw-r--r-- 5,652 bytes parent folder | download
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
.. 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.FNBRendererVC8:

==========================================================================================================================================
|phoenix_title|  **wx.lib.agw.flatnotebook.FNBRendererVC8**
==========================================================================================================================================

This class handles the drawing of tabs using the `VC8` renderer.



|

|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>FNBRendererVC8</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.FNBRendererVC8_inheritance.png" alt="Inheritance diagram of FNBRendererVC8" 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.FNBRendererVC8.html" title="wx.lib.agw.flatnotebook.FNBRendererVC8" alt="" coords="5,83,285,112"/> <area shape="rect" id="node2" href="wx.lib.agw.flatnotebook.FNBRenderer.html" title="wx.lib.agw.flatnotebook.FNBRenderer" alt="" coords="18,5,272,35"/> </map> 
   </p>

|


|super_classes| Known Superclasses
==================================

:class:`wx.lib.agw.flatnotebook.FNBRenderer`

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~wx.lib.agw.flatnotebook.FNBRendererVC8.__init__`                         Default class constructor.
:meth:`~wx.lib.agw.flatnotebook.FNBRendererVC8.DrawTab`                          Draws a tab using the `VC8` style.
:meth:`~wx.lib.agw.flatnotebook.FNBRendererVC8.DrawTabs`                         Draws all the tabs using `VC8` style.
:meth:`~wx.lib.agw.flatnotebook.FNBRendererVC8.FillVC8GradientColour`            Fills a tab with a gradient shading.
:meth:`~wx.lib.agw.flatnotebook.FNBRendererVC8.GetEndX`                          Returns the `x` end position of a tab.
:meth:`~wx.lib.agw.flatnotebook.FNBRendererVC8.GetStartX`                        Returns the `x` start position of a tab.
:meth:`~wx.lib.agw.flatnotebook.FNBRendererVC8.NumberTabsCanFit`                 Calculates the number of tabs that can fit on the available space on screen.
================================================================================ ================================================================================


|


|api| Class API
===============


.. class:: FNBRendererVC8(FNBRenderer)

   This class handles the drawing of tabs using the `VC8` renderer.

   .. method:: __init__(self)

      Default class constructor. 


   .. method:: DrawTab(self, pageContainer, dc, posx, tabIdx, tabWidth, tabHeight, btnStatus)

      Draws a tab using the `VC8` style.
      
      :param `pageContainer`: an instance of :class:`FlatNotebook`;
      :param `dc`: an instance of :class:`wx.DC`;
      :param `posx`: the x position of the tab;
      :param `tabIdx`: the index of the tab;
      :param `tabWidth`: the tab's width;
      :param `tabHeight`: the tab's height;
      :param `btnStatus`: the status of the 'X' button inside this tab.


   .. method:: DrawTabs(self, pageContainer, dc)

      Draws all the tabs using `VC8` style.
      
      :param `pageContainer`: an instance of :class:`FlatNotebook`;
      :param `dc`: an instance of :class:`wx.DC`.


   .. method:: FillVC8GradientColour(self, pageContainer, dc, tabPoints, bSelectedTab, tabIdx)

      Fills a tab with a gradient shading.
      
      :param `pageContainer`: an instance of :class:`FlatNotebook`;
      :param `dc`: an instance of :class:`wx.DC`;
      :param `tabPoints`: a Python list of :class:`wx.Point` representing the tab outline;
      :param `bSelectedTab`: ``True`` if the tab is selected, ``False`` otherwise;
      :param `tabIdx`: the index of the tab;


   .. method:: GetEndX(self, tabPoints, y, style)

      Returns the `x` end position of a tab.
      
      :param `tabPoints`: a Python list of :class:`wx.Point` representing the tab outline;
      :param `y`: the y end position of the tab;
      :param `style`: can be ``FNB_BOTTOM`` or the default (tabs at top).


   .. method:: GetStartX(self, tabPoints, y, style)

      Returns the `x` start position of a tab.
      
      :param `tabPoints`: a Python list of :class:`wx.Point` representing the tab outline;
      :param `y`: the y start position of the tab;
      :param `style`: can be ``FNB_BOTTOM`` or the default (tabs at top).


   .. 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.