/////////////////////////////////////////////////////////////////////////////
// Name: statbmp.h
-// Purpose: documentation for wxStaticBitmap class
+// Purpose: interface of wxStaticBitmap
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
@category{ctrl}
@appearance{staticbitmap.png}
- @seealso
- wxStaticBitmap, wxStaticBox
+ @see wxStaticBitmap, wxStaticBox
*/
class wxStaticBitmap : public wxControl
{
//@{
/**
Constructor, creating and showing a static bitmap control.
-
+
@param parent
- Parent window. Should not be @NULL.
-
+ Parent window. Should not be @NULL.
@param id
- Control identifier. A value of -1 denotes a default value.
-
+ Control identifier. A value of -1 denotes a default value.
@param label
- Bitmap label.
-
+ Bitmap label.
@param pos
- Window position.
-
+ Window position.
@param size
- Window size.
-
+ Window size.
@param style
- Window style. See wxStaticBitmap.
-
+ Window style. See wxStaticBitmap.
@param name
- Window name.
-
- @sa Create()
+ Window name.
+
+ @see Create()
*/
wxStaticBitmap();
wxStaticBitmap(wxWindow* parent, wxWindowID id,
/**
Returns the bitmap currently used in the control. Notice that this method can
be called even if SetIcon() had been used.
-
- @sa SetBitmap()
+
+ @see SetBitmap()
*/
- wxBitmap GetBitmap();
+ 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).
-
- @sa SetIcon()
+
+ @see SetIcon()
*/
- wxIcon GetIcon();
+ wxIcon GetIcon() const;
/**
Sets the bitmap label.
-
+
@param label
- The new bitmap.
-
- @sa GetBitmap()
+ The new bitmap.
+
+ @see GetBitmap()
*/
virtual void SetBitmap(const wxBitmap& label);
/**
Sets the label to the given icon.
-
+
@param label
- The new icon.
+ The new icon.
*/
virtual void SetIcon(const wxIcon& label);
};
+