.. 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.shapedbutton
.. highlight:: python
.. _wx.lib.agw.shapedbutton.SBitmapTextButton:
==========================================================================================================================================
|phoenix_title| **wx.lib.agw.shapedbutton.SBitmapTextButton**
==========================================================================================================================================
Subclass of :class:`SButton` which displays a bitmap and a label.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
SBitmapTextButton:
|
|appearance| Control Appearance
===============================
|
.. container:: control-appearance-figures
.. figure:: _static/images/widgets/fullsize/wxmsw/wx.lib.agw.shapedbutton.sbitmaptextbutton.png
:alt: wxMSW
:figclass: appearance-figure
**wxMSW**
.. figure:: _static/images/widgets/fullsize/wxmac/../no_appearance.png
:alt: wxMAC
:figclass: appearance-figure
**wxMAC**
.. figure:: _static/images/widgets/fullsize/wxgtk/wx.lib.agw.shapedbutton.sbitmaptextbutton.png
:alt: wxGTK
:figclass: appearance-figure
**wxGTK**
|
|sub_classes| Known Subclasses
==============================
:class:`wx.lib.agw.shapedbutton.SBitmapTextToggleButton`
|
|super_classes| Known Superclasses
==================================
:class:`wx.lib.agw.shapedbutton.SBitmapButton`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.agw.shapedbutton.SBitmapTextButton.__init__` Default class constructor.
:meth:`~wx.lib.agw.shapedbutton.SBitmapTextButton.DrawLabel` Draws the bitmap and the text label.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: SBitmapTextButton(SBitmapButton)
Subclass of :class:`SButton` which displays a bitmap and a label.
.. method:: __init__(self, parent, id, bitmap, label, pos=wx.DefaultPosition, size=wx.DefaultSize)
Default class constructor.
:param `parent`: the :class:`SBitmapTextButton` parent. Must not be ``None``;
:param `id`: window identifier. A value of -1 indicates a default value;
:param `bitmap`: the button bitmap (if any);
:param `label`: the button text label;
:param `pos`: the control position. A value of (-1, -1) indicates a default position,
chosen by either the windowing system or wxPython, depending on platform;
:param `size`: the control size. A value of (-1, -1) indicates a default size,
chosen by either the windowing system or wxPython, depending on platform.
.. method:: DrawLabel(self, dc, width, height, dw=0, dh=0)
Draws the bitmap and the text label.
:param `dc`: an instance of :class:`wx.DC`;
:param `width`: the button width;
:param `height`: the button height;
:param `dw`: width differential, to show a 3D effect;
:param `dh`: height differential, to show a 3D effect.