// Purpose: interface of wxStaticBitmap
// Author: wxWidgets team
// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
@class wxStaticBitmap
- A static bitmap control displays a bitmap. Native implementations on some
- platforms are only meant for display of the small icons in the dialog
+ 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. In particular, under Windows 9x the size of bitmap is limited
to 64*64 pixels.
- If you want to display larger images portably, you may use generic
- implementation wxGenericStaticBitmap declared in <wx/generic/statbmpg.h>.
+
+ If you want to display larger images portably, you may use generic
+ implementation wxGenericStaticBitmap 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
+ 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.
@library{wxcore}
@category{ctrl}
- <!-- @appearance{staticbitmap.png} -->
+ @appearance{staticbitmap}
@see wxStaticBitmap, wxStaticBox
*/
Default constructor
*/
wxStaticBitmap();
-
+
/**
Constructor, creating and showing a static bitmap control.
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = 0,
- const wxString& name = "staticBitmap");
+ const wxString& name = wxStaticBitmapNameStr);
/**
Creation function, for two-step construction. For details see wxStaticBitmap().
*/
- bool Create(wxWindow* parent, wxWindowID id,
- const wxBitmap& label,
+ bool Create(wxWindow* parent, wxWindowID id, const wxBitmap& label,
const wxPoint& pos = wxDefaultPosition,
- const wxSize& size = wxDefaultSize,
- long style = 0,
- const wxString& name = "staticBitmap");
+ const wxSize& size = wxDefaultSize, long style = 0,
+ const wxString& name = wxStaticBitmapNameStr);
/**
- Returns the bitmap currently used in the control. Notice that this method can
- be called even if SetIcon() had been used.
+ Returns the bitmap currently used in the control.
+ Notice that this method can be called even if SetIcon() had been used.
@see SetBitmap()
*/
virtual wxBitmap GetBitmap() const;
/**
- 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
- wxStaticBitmap::SetBitmap).
+ 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 wxStaticBitmap::SetBitmap).
@see SetIcon()
*/