interface/wx/statbmp.h

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