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

Inheritance diagram for class
BitmapShape:
|
|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 height
:param `recursive`: not used