File: wx.lib.ogl.basic.RectangleShape.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 (169 lines) | stat: -rw-r--r-- 5,542 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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
.. 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.ogl.basic

.. highlight:: python



.. _wx.lib.ogl.basic.RectangleShape:

==========================================================================================================================================
|phoenix_title|  **wx.lib.ogl.basic.RectangleShape**
==========================================================================================================================================

The :class:`wx.RectangleShape` class has rounded or square corners.



|

|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>RectangleShape</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.ogl.basic.RectangleShape_inheritance.png" alt="Inheritance diagram of RectangleShape" 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.ogl.basic.RectangleShape.html" title="wx.lib.ogl.basic.RectangleShape" alt="" coords="9,160,240,189"/> <area shape="rect" id="node2" href="wx.lib.ogl.basic.Shape.html" title="wx.lib.ogl.basic.Shape" alt="" coords="41,83,208,112"/> <area shape="rect" id="node3" href="wx.lib.ogl.basic.ShapeEvtHandler.html" title="wx.lib.ogl.basic.ShapeEvtHandler" alt="" coords="5,5,244,35"/> </map> 
   </p>
   </div>

|


|sub_classes| Known Subclasses
==============================

:class:`wx.lib.ogl.basic.ControlPoint`, :class:`wx.lib.ogl.basic.TextShape`, :class:`wx.lib.ogl.bmpshape.BitmapShape`, :class:`wx.lib.ogl.composit.CompositeShape`, :class:`wx.lib.ogl.divided.DividedShape`, :class:`wx.lib.ogl.drawn.DrawnShape`, :class:`wx.lib.ogl.lines.LabelShape`

|


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

:class:`wx.lib.ogl.basic.Shape`

|


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

================================================================================ ================================================================================
:meth:`~wx.lib.ogl.basic.RectangleShape.__init__`                                Default class constructor
:meth:`~wx.lib.ogl.basic.RectangleShape.GetBoundingBoxMin`                       Get the bounding box minimum.
:meth:`~wx.lib.ogl.basic.RectangleShape.GetCornerRadius`                         Get the radius of the rectangle's rounded corners.
:meth:`~wx.lib.ogl.basic.RectangleShape.GetHeight`                               Get the height.
:meth:`~wx.lib.ogl.basic.RectangleShape.GetPerimeterPoint`                       Get the perimeter point.
:meth:`~wx.lib.ogl.basic.RectangleShape.GetWidth`                                Get the width.
:meth:`~wx.lib.ogl.basic.RectangleShape.OnDraw`                                  The draw handler.
:meth:`~wx.lib.ogl.basic.RectangleShape.SetCornerRadius`                         Set the radius of the rectangle's rounded corners.
:meth:`~wx.lib.ogl.basic.RectangleShape.SetHeight`                               Set the height.
:meth:`~wx.lib.ogl.basic.RectangleShape.SetSize`                                 Set the size.
:meth:`~wx.lib.ogl.basic.RectangleShape.SetWidth`                                Set the width.
================================================================================ ================================================================================


|


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


.. class:: RectangleShape(Shape)

   The :class:`wx.RectangleShape` class has rounded or square corners.

   .. method:: __init__(self, w = 0.0, h = 0.0)

      Default class constructor
      
      :param float `w`: the width
      :param float `h`: the height


   .. method:: GetBoundingBoxMin(self)

      Get the bounding box minimum.


   .. method:: GetCornerRadius(self)

      Get the radius of the rectangle's rounded corners.


   .. method:: GetHeight(self)

      Get the height.


   .. method:: GetPerimeterPoint(self, x1, y1, x2, y2)

      Get the perimeter point.
      
      :param `x1`: ???
      :param `y1`: ???
      :param `x2`: ???
      :param `y2`: ???


   .. method:: GetWidth(self)

      Get the width.


   .. method:: OnDraw(self, dc)

      The draw handler.


   .. method:: SetCornerRadius(self, rad)

      Set the radius of the rectangle's rounded corners.
      
      :param `rad`: If the radius is zero, a non-rounded rectangle will be
       drawn. If the radius is negative, the value is the proportion of the
       smaller dimension of the rectangle.


   .. method:: SetHeight(self, h)

      Set the height.
      
      :param `h`: height to be set


   .. method:: SetSize(self, x, y, recursive = False)

      Set the size.
      
      :param `x`: the width
      :param `y`: the height
      :param `recursive`: not used


   .. method:: SetWidth(self, w)

      Set the width.
      
      :param `w`: width to be set