File: wx.lib.agw.aui.tabart.VC8TabArt.txt

package info (click to toggle)
wxpython4.0 4.2.0%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 232,540 kB
  • sloc: cpp: 958,937; python: 233,059; ansic: 150,441; makefile: 51,662; sh: 8,687; perl: 1,563; javascript: 584; php: 326; xml: 200
file content (135 lines) | stat: -rw-r--r-- 5,394 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
.. wxPython Phoenix documentation

   This file was generated by Phoenix's sphinx generator and associated
   tools, do not edit by hand.

   Copyright: (c) 2011-2020 by Total Control Software
   License:   wxWindows License

.. include:: headings.inc

.. currentmodule:: wx.lib.agw.aui.tabart

.. highlight:: python



.. _wx.lib.agw.aui.tabart.VC8TabArt:

==========================================================================================================================================
|phoenix_title|  **wx.lib.agw.aui.tabart.VC8TabArt**
==========================================================================================================================================

A class to draw tabs using the Visual Studio 2005 (VC8) style. 



|

|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>VC8TabArt</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.aui.tabart.VC8TabArt_inheritance.png" alt="Inheritance diagram of VC8TabArt" usemap="#dummy" class="inheritance"/></center>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.lib.agw.aui.tabart.VC8TabArt.html" title="wx.lib.agw.aui.tabart.VC8TabArt" alt="" coords="27,83,256,112"/> <area shape="rect" id="node2" href="wx.lib.agw.aui.tabart.AuiDefaultTabArt.html" title="wx.lib.agw.aui.tabart.AuiDefaultTabArt" alt="" coords="5,5,277,35"/> </map> 
   </p>
   </div>

|


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

:class:`wx.lib.agw.aui.tabart.AuiDefaultTabArt`

|


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

================================================================================ ================================================================================
:meth:`~wx.lib.agw.aui.tabart.VC8TabArt.__init__`                                Default class constructor.
:meth:`~wx.lib.agw.aui.tabart.VC8TabArt.Clone`                                   Clones the art object.
:meth:`~wx.lib.agw.aui.tabart.VC8TabArt.DrawTab`                                 Draws a single tab.
:meth:`~wx.lib.agw.aui.tabart.VC8TabArt.FillVC8GradientColour`                   Fills the tab with the Visual Studio 2005 gradient background.
:meth:`~wx.lib.agw.aui.tabart.VC8TabArt.GetTabSize`                              Returns the tab size for the given caption, bitmap and button state.
:meth:`~wx.lib.agw.aui.tabart.VC8TabArt.SetSizingInfo`                           Sets the tab sizing information.
================================================================================ ================================================================================


|


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


.. class:: VC8TabArt(AuiDefaultTabArt)

   A class to draw tabs using the Visual Studio 2005 (VC8) style. 

   .. method:: __init__(self)

      Default class constructor. 


   .. method:: Clone(self)

      Clones the art object. 


   .. method:: DrawTab(self, dc, wnd, page, in_rect, close_button_state, paint_control=False)

      Draws a single tab.
      
      :param `dc`: a :class:`wx.DC` device context;
      :param `wnd`: a :class:`wx.Window` instance object;
      :param `page`: the tab control page associated with the tab;
      :param wx.Rect `in_rect`: rectangle the tab should be confined to;
      :param integer `close_button_state`: the state of the close button on the tab;
      :param bool `paint_control`: whether to draw the control inside a tab (if any) on a :class:`MemoryDC`.


   .. method:: FillVC8GradientColour(self, dc, tabPoints, active)

      Fills the tab with the Visual Studio 2005 gradient background.
      
      :param `dc`: a :class:`wx.DC` device context;
      :param list `tabPoints`: a list of :class:`wx.Point` objects describing the tab shape;
      :param bool `active`: whether the tab is selected or not.


   .. method:: GetTabSize(self, dc, wnd, caption, bitmap, active, close_button_state, control=None)

      Returns the tab size for the given caption, bitmap and button state.
      
      :param `dc`: a :class:`wx.DC` device context;
      :param `wnd`: a :class:`wx.Window` instance object;
      :param string `caption`: the tab text caption;
      :param wx.Bitmap `bitmap`: the bitmap displayed on the tab;
      :param bool `active`: whether the tab is selected or not;
      :param integer `close_button_state`: the state of the close button on the tab;
      :param wx.Window `control`: a :class:`wx.Window` instance inside a tab (or ``None``).


   .. method:: SetSizingInfo(self, tab_ctrl_size, tab_count, minMaxTabWidth)

      Sets the tab sizing information.
      
      :param wx.Size `tab_ctrl_size`: the size of the tab control area;
      :param integer `tab_count`: the number of tabs;
      :param tuple `minMaxTabWidth`: a tuple containing the minimum and maximum tab widths
       to be used when the ``AUI_NB_TAB_FIXED_WIDTH`` style is active.