interface/statbmp.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        statbmp.h
   3 // Purpose:     documentation for wxStaticBitmap class
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxStaticBitmap
  11     @wxheader{statbmp.h}
  12
  13     A static bitmap control displays a bitmap. It is meant for display of the
  14     small icons in the dialog boxes and is not meant to be a general purpose image
  15     display control. In particular, under Windows 9x the size of bitmap is limited
  16     to 64*64 pixels and thus you should use your own control if you want to
  17     display larger images portably.
  18
  19     @library{wxcore}
  20     @category{ctrl}
  21     @appearance{staticbitmap.png}
  22
  23     @seealso
  24     wxStaticBitmap, wxStaticBox
  25 */
  26 class wxStaticBitmap : public wxControl
  27 {
  28 public:
  29     //@{
  30     /**
  31         Constructor, creating and showing a static bitmap control.
  32
  33         @param parent
  34             Parent window. Should not be @NULL.
  35         @param id
  36             Control identifier. A value of -1 denotes a default value.
  37         @param label
  38             Bitmap label.
  39         @param pos
  40             Window position.
  41         @param size
  42             Window size.
  43         @param style
  44             Window style. See wxStaticBitmap.
  45         @param name
  46             Window name.
  47
  48         @see Create()
  49     */
  50     wxStaticBitmap();
  51     wxStaticBitmap(wxWindow* parent, wxWindowID id,
  52                    const wxBitmap& label,
  53                    const wxPoint& pos = wxDefaultPosition,
  54                    const wxSize& size = wxDefaultSize,
  55                    long style = 0,
  56                    const wxString& name = "staticBitmap");
  57     //@}
  58
  59     /**
  60         Creation function, for two-step construction. For details see wxStaticBitmap().
  61     */
  62     bool Create(wxWindow* parent, wxWindowID id,
  63                 const wxBitmap& label,
  64                 const wxPoint& pos = wxDefaultPosition,
  65                 const wxSize& size = wxDefaultSize,
  66                 long style = 0,
  67                 const wxString& name = "staticBitmap");
  68
  69     /**
  70         Returns the bitmap currently used in the control. Notice that this method can
  71         be called even if SetIcon() had been used.
  72
  73         @see SetBitmap()
  74     */
  75     wxBitmap GetBitmap() const;
  76
  77     /**
  78         Returns the icon currently used in the control. Notice that this method can
  79         only be called if SetIcon() had been used: an icon
  80         can't be retrieved from the control if a bitmap had been set (using
  81         wxStaticBitmap::SetBitmap).
  82
  83         @see SetIcon()
  84     */
  85     wxIcon GetIcon() const;
  86
  87     /**
  88         Sets the bitmap label.
  89
  90         @param label
  91             The new bitmap.
  92
  93         @see GetBitmap()
  94     */
  95     virtual void SetBitmap(const wxBitmap& label);
  96
  97     /**
  98         Sets the label to the given icon.
  99
 100         @param label
 101             The new icon.
 102     */
 103     virtual void SetIcon(const wxIcon& label);
 104 };