File: wx.lib.ogl.bmpshape.BitmapShape.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 (129 lines) | stat: -rw-r--r-- 4,410 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
.. 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.ogl.bmpshape

.. highlight:: python



.. _wx.lib.ogl.bmpshape.BitmapShape:

==========================================================================================================================================
|phoenix_title|  **wx.lib.ogl.bmpshape.BitmapShape**
==========================================================================================================================================

The :class:`wx.BitmapShape` class draws a bitmap (non-resizable).



|

|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>BitmapShape</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.bmpshape.BitmapShape_inheritance.png" alt="Inheritance diagram of BitmapShape" 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.ogl.bmpshape.BitmapShape.html" title="wx.lib.ogl.bmpshape.BitmapShape" alt="" coords="5,237,248,267"/> <area shape="rect" id="node2" href="wx.lib.ogl.basic.RectangleShape.html" title="wx.lib.ogl.basic.RectangleShape" alt="" coords="15,160,237,189"/> <area shape="rect" id="node3" href="wx.lib.ogl.basic.Shape.html" title="wx.lib.ogl.basic.Shape" alt="" coords="46,83,207,112"/> <area shape="rect" id="node4" href="wx.lib.ogl.basic.ShapeEvtHandler.html" title="wx.lib.ogl.basic.ShapeEvtHandler" alt="" coords="11,5,241,35"/> </map> 
   </p>

|


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

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

|


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

================================================================================ ================================================================================
:meth:`~wx.lib.ogl.bmpshape.BitmapShape.__init__`                                Default class constructor.
:meth:`~wx.lib.ogl.bmpshape.BitmapShape.GetBitmap`                               Get the associated bitmap.
:meth:`~wx.lib.ogl.bmpshape.BitmapShape.GetFilename`                             Return the bitmap filename.
:meth:`~wx.lib.ogl.bmpshape.BitmapShape.OnDraw`                                  The draw handler.
:meth:`~wx.lib.ogl.bmpshape.BitmapShape.SetBitmap`                               Set the associated bitmap.
:meth:`~wx.lib.ogl.bmpshape.BitmapShape.SetFilename`                             Set the bitmap filename.
:meth:`~wx.lib.ogl.bmpshape.BitmapShape.SetSize`                                 Set the size.
================================================================================ ================================================================================


|


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


.. class:: BitmapShape(RectangleShape)

   The :class:`wx.BitmapShape` class draws a bitmap (non-resizable).

   .. method:: __init__(self)

      Default class constructor.


   .. method:: GetBitmap(self)

      Get the associated bitmap.


   .. method:: GetFilename(self)

      Return the bitmap filename.


   .. method:: OnDraw(self, dc)

      The draw handler.


   .. method:: SetBitmap(self, bitmap)

      Set the associated bitmap.
      
      :param `bitmap`: a :class:`wx.Bitmap` instance
      
      :note: You can delete the bitmap from the calling application, since
       reference counting will take care of holding on to the internal bitmap
       data.


   .. method:: SetFilename(self, f)

      Set the bitmap filename.
      
      :param str `f`: the bitmap file name


   .. method:: SetSize(self, w, h, recursive = True)

      Set the size.
      
      :param `w`: the width
      :param `h`: the heigth
      :param `recursive`: not used