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
|
.. 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.buttonpanel
.. highlight:: python
.. _wx.lib.agw.buttonpanel.ButtonPanelText:
==========================================================================================================================================
|phoenix_title| **wx.lib.agw.buttonpanel.ButtonPanelText**
==========================================================================================================================================
This class is used to hold data about the main caption in :class:`ButtonPanel`.
|
|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>ButtonPanelText</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.buttonpanel.ButtonPanelText_inheritance.png" alt="Inheritance diagram of ButtonPanelText" 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.EvtHandler.html" title="wx.EvtHandler" alt="" coords="84,83,195,112"/> <area shape="rect" id="node4" href="wx.lib.agw.buttonpanel.Control.html" title="wx.lib.agw.buttonpanel.Control" alt="" coords="33,160,247,189"/> <area shape="rect" id="node2" href="wx.Object.html" title="wx.Object" alt="" coords="41,5,123,35"/> <area shape="rect" id="node3" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="148,5,249,35"/> <area shape="rect" id="node5" href="wx.lib.agw.buttonpanel.ButtonPanelText.html" title="wx.lib.agw.buttonpanel.ButtonPanelText" alt="" coords="5,237,275,267"/> </map>
</p>
|
|super_classes| Known Superclasses
==================================
:class:`wx.lib.agw.buttonpanel.Control`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.agw.buttonpanel.ButtonPanelText.__init__` Default class constructor.
:meth:`~wx.lib.agw.buttonpanel.ButtonPanelText.CreateDC` Convenience function to create a :class:`wx.DC`.
:meth:`~wx.lib.agw.buttonpanel.ButtonPanelText.Draw` Draws the main caption. Actually the drawing is done in :class:`BPArt`.
:meth:`~wx.lib.agw.buttonpanel.ButtonPanelText.GetBestSize` Returns the best size for the main caption in :class:`ButtonPanel`.
:meth:`~wx.lib.agw.buttonpanel.ButtonPanelText.GetText` Returns the caption text.
:meth:`~wx.lib.agw.buttonpanel.ButtonPanelText.SetText` Sets the caption text.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: ButtonPanelText(Control)
This class is used to hold data about the main caption in :class:`ButtonPanel`.
.. method:: __init__(self, parent, text="")
Default class constructor.
:param `parent`: the text parent object, an instance of :class:`ButtonPanel`;
:param string `text`: the actual main caption string.
.. method:: CreateDC(self)
Convenience function to create a :class:`wx.DC`.
.. method:: Draw(self, dc, rect)
Draws the main caption. Actually the drawing is done in :class:`BPArt`.
:param `dc`: an instance of :class:`wx.DC`;
:param wx.Rect `rect`: the main caption text client rectangle.
.. method:: GetBestSize(self)
Returns the best size for the main caption in :class:`ButtonPanel`.
:return: An instance of :class:`wx.Size`.
.. method:: GetText(self)
Returns the caption text.
:return: A string representing the caption text.
.. method:: SetText(self, text="")
Sets the caption text.
:param string `text`: the main caption string.
|
