wx.StaticBitmap

A static bitmap control displays a bitmap.

Native implementations on some platforms are only meant for display of the small icons in the dialog boxes.

If you want to display larger images portably, you may use generic implementation GenericStaticBitmap declared in <wx/generic/statbmpg.h>.

Notice that for the best results, the size of the control should be the same as the size of the image displayed in it, as happens by default if it’s not resized explicitly. Otherwise, behaviour depends on the platform: under MSW, the bitmap is drawn centred inside the control, while elsewhere it is drawn at the origin of the control. You can use SetScaleMode to control how the image is scaled inside the control.

See also

wx.Bitmap

Class Hierarchy

Inheritance diagram for class StaticBitmap:

Control Appearance

wxMSW

wxMAC

wxGTK

Methods Summary

__init__	Default constructor.
Create	Creation function, for two-step construction.
GetBitmap	Returns the bitmap currently used in the control.
GetClassDefaultAttributes
GetIcon	Returns the icon currently used in the control.
GetScaleMode	Returns the scale mode currently used in the control.
SetBitmap	Sets the bitmap label.
SetIcon	Sets the label to the given icon.
SetScaleMode	Sets the scale mode.

Properties Summary

Bitmap	See GetBitmap and SetBitmap
Icon	See GetIcon and SetIcon

Class API

class wx.StaticBitmap(Control)

Possible constructors:

StaticBitmap()

StaticBitmap(parent, id=ID_ANY, bitmap=NullBitmap, pos=DefaultPosition,
             size=DefaultSize, style=0, name=StaticBitmapNameStr)

A static bitmap control displays a bitmap.

Methods

__init__(self, *args, **kw)

Overloaded Implementations:

---

__init__ (self)

Default constructor.

---

__init__ (self, parent, id=ID_ANY, bitmap=NullBitmap, pos=DefaultPosition, size=DefaultSize, style=0, name=StaticBitmapNameStr)

Constructor, creating and showing a static bitmap control.

Parameters

• parent (wx.Window) – Parent window. Should not be None.

• id (wx.WindowID) – Control identifier. A value of -1 denotes a default value.

• bitmap (wx.BitmapBundle) –

• pos (wx.Point) – Window position.

• size (wx.Size) – Window size.

• style (long) – Window style. See wx.StaticBitmap.

• name (string) – Window name.

Bitmap label.

See also

Create

---

---

Create(self, parent, id=ID_ANY, bitmap=NullBitmap, pos=DefaultPosition, size=DefaultSize, style=0, name=StaticBitmapNameStr)

Creation function, for two-step construction.

For details see wx.StaticBitmap.

Parameters

• parent (wx.Window) –

• id (wx.WindowID) –

• bitmap (wx.BitmapBundle) –

• pos (wx.Point) –

• size (wx.Size) –

• style (long) –

• name (string) –

Return type

bool

---

GetBitmap(self)

Returns the bitmap currently used in the control.

Notice that this method can be called even if SetIcon had been used.

Return type

wx.Bitmap

See also

SetBitmap

---

static GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)

Parameters

variant (WindowVariant) –

Return type

wx.VisualAttributes

---

GetIcon(self)

Returns the icon currently used in the control.

Notice that this method can only be called if SetIcon had been used: an icon can’t be retrieved from the control if a bitmap had been set (using wx.StaticBitmap.SetBitmap ).

Return type

wx.Icon

See also

SetIcon

---

GetScaleMode(self)

Returns the scale mode currently used in the control.

Return type

wx.GenericStaticBitmap.ScaleMode

New in version 4.1/wxWidgets-3.1.0.

See also

SetScaleMode

---

SetBitmap(self, label)

Sets the bitmap label.

Parameters

label (wx.BitmapBundle) – The new bitmap.

See also

GetBitmap

---

SetIcon(self, label)

Sets the label to the given icon.

Parameters

label (wx.Icon) – The new icon.

---

SetScaleMode(self, scaleMode)

Sets the scale mode.

Parameters

scaleMode (ScaleMode) – Controls how the bitmap is scaled inside the control.

New in version 4.1/wxWidgets-3.1.0.

Note

Currently only the generic implementation supports all scaling modes. You may use generic implementation GenericStaticBitmap declared in <wx/generic/statbmpg.h> in all ports.

See also

GetScaleMode

Properties

Bitmap

See GetBitmap and SetBitmap

---

Icon

See GetIcon and SetIcon