fix the incoherence pointed out by ifacecheck between wx docs, that documents usage...

[wxWidgets.git] / include / wx / msw / statbmp.h

diff --git a/include/wx/msw/statbmp.h b/include/wx/msw/statbmp.h
index 3a5fd03e743dea17ee8d464386999953b024b6cf..7989fce4bc7bdc0b9c3c98261a80c485dedb116c 100644 (file)
--- a/include/wx/msw/statbmp.h
+++ b/include/wx/msw/statbmp.h
@@ -1,67 +1,93 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        statbmp.h
-// Purpose:     wxStaticBitmap class
+// Name:        wx/msw/statbmp.h
+// Purpose:     wxStaticBitmap class for wxMSW
 // Author:      Julian Smart
 // Modified by:
 // Created:     01/02/97
 // RCS-ID:      $Id$
-// Copyright:   (c) Julian Smart and Markus Holzem
-// Licence:    wxWindows license
+// Copyright:   (c) Julian Smart
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-#ifndef __STATBMPH__
-#define __STATBMPH__
-
-#ifdef __GNUG__
-#pragma interface "statbmp.h"
-#endif
+#ifndef _WX_STATBMP_H_
+#define _WX_STATBMP_H_
 
 #include "wx/control.h"
+#include "wx/icon.h"
+#include "wx/bitmap.h"
 
-WXDLLEXPORT_DATA(extern const char*) wxStaticBitmapNameStr;
+extern WXDLLIMPEXP_DATA_CORE(const char) wxStaticBitmapNameStr[];
 
-class WXDLLEXPORT wxStaticBitmap: public wxControl
+// a control showing an icon or a bitmap
+class WXDLLIMPEXP_CORE wxStaticBitmap : public wxStaticBitmapBase
 {
-  DECLARE_DYNAMIC_CLASS(wxStaticBitmap)
- public:
-  inline wxStaticBitmap(void) { }
+public:
+    wxStaticBitmap() { Init(); }
+
+    wxStaticBitmap(wxWindow *parent,
+                   wxWindowID id,
+                   const wxGDIImage& label,
+                   const wxPoint& pos = wxDefaultPosition,
+                   const wxSize& size = wxDefaultSize,
+                   long style = 0,
+                   const wxString& name = wxStaticBitmapNameStr)
+    {
+        Init();
+
+        Create(parent, id, label, pos, size, style, name);
+    }
+
+    bool Create(wxWindow *parent,
+                wxWindowID id,
+                const wxGDIImage& label,
+                const wxPoint& pos = wxDefaultPosition,
+                const wxSize& size = wxDefaultSize,
+                long style = 0,
+                const wxString& name = wxStaticBitmapNameStr);
+
+    virtual ~wxStaticBitmap() { Free(); }
+
+    virtual void SetIcon(const wxIcon& icon) { SetImage(&icon); }
+    virtual void SetBitmap(const wxBitmap& bitmap) { SetImage(&bitmap); }
+    virtual wxBitmap GetBitmap() const;
+    virtual wxIcon GetIcon() const;
+
+    virtual WXDWORD MSWGetStyle(long style, WXDWORD *exstyle) const;
+
+    // returns true if the platform should explicitly apply a theme border
+    virtual bool CanApplyThemeBorder() const { return false; }
 
-  inline wxStaticBitmap(wxWindow *parent, wxWindowID id,
-           const wxBitmap& label,
-           const wxPoint& pos = wxDefaultPosition,
-           const wxSize& size = wxDefaultSize,
-           long style = 0,
-           const wxString& name = wxStaticBitmapNameStr)
-  {
-    Create(parent, id, label, pos, size, style, name);
-  }
+protected:
+    virtual wxSize DoGetBestSize() const;
 
-  bool Create(wxWindow *parent, wxWindowID id,
-           const wxBitmap& label,
-           const wxPoint& pos = wxDefaultPosition,
-           const wxSize& size = wxDefaultSize,
-           long style = 0,
-           const wxString& name = wxStaticBitmapNameStr);
+    // ctor/dtor helpers
+    void Init() { m_isIcon = true; m_image = NULL; m_currentHandle = 0; }
+    void Free();
 
-  virtual void SetBitmap(const wxBitmap& bitmap);
+    // true if icon/bitmap is valid
+    bool ImageIsOk() const;
 
-  virtual void Command(wxCommandEvent& WXUNUSED(event)) {};
-  virtual void ProcessCommand(wxCommandEvent& WXUNUSED(event)) {};
+    void SetImage(const wxGDIImage* image);
+    void SetImageNoCopy( wxGDIImage* image );
 
-  void SetSize(int x, int y, int width, int height, int sizeFlags = wxSIZE_AUTO);
+#ifndef __WXWINCE__
+    // draw the bitmap ourselves here if the OS can't do it correctly (if it
+    // can we leave it to it)
+    void DoPaintManually(wxPaintEvent& event);
+#endif // !__WXWINCE__
 
-  inline wxBitmap& GetBitmap(void) const { return (wxBitmap&) m_messageBitmap; }
 
-  // overriden base class virtuals
-  virtual bool AcceptsFocus() const { return FALSE; }
+    // we can have either an icon or a bitmap
+    bool m_isIcon;
+    wxGDIImage *m_image;
 
-  // Implementation
-  virtual bool MSWOnDraw(WXDRAWITEMSTRUCT *item);
-  virtual long MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
- protected:
-  wxBitmap m_messageBitmap;
+    // handle used in last call to STM_SETIMAGE
+    WXHANDLE m_currentHandle;
 
+private:
+    DECLARE_DYNAMIC_CLASS(wxStaticBitmap)
+    DECLARE_NO_COPY_CLASS(wxStaticBitmap)
 };
 
 #endif
-    // __STATBMPH__
+    // _WX_STATBMP_H_