Fix missing documentation for several GDI functions.

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

diff --git a/include/wx/os2/statbmp.h b/include/wx/os2/statbmp.h
index 394977fddc6c754c5693ce8d41e0348e6f545399..b8c10e29ddfe91934c1dcda068bc0a39ab40b93b 100644 (file)
--- a/include/wx/os2/statbmp.h
+++ b/include/wx/os2/statbmp.h
@@ -1,78 +1,83 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        statbmp.h
+// Name:        wx/os2/statbmp.h
 // Purpose:     wxStaticBitmap class
-// Author:      AUTHOR
+// Author:      David Webster
 // Modified by:
-// Created:     ??/??/98
+// Created:     11/27/99
 // RCS-ID:      $Id$
-// Copyright:   (c) AUTHOR
-// Licence:    wxWindows licence
+// Copyright:   (c) David Webster
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_STATBMP_H_
 #define _WX_STATBMP_H_
 
-#ifdef __GNUG__
-#pragma interface "statbmp.h"
-#endif
-
 #include "wx/control.h"
+#include "wx/icon.h"
 
-WXDLLEXPORT_DATA(extern const char*) wxStaticBitmapNameStr;
-
-class WXDLLEXPORT wxStaticBitmap: public wxControl
+class WXDLLIMPEXP_CORE wxStaticBitmap : public wxStaticBitmapBase
 {
-  DECLARE_DYNAMIC_CLASS(wxStaticBitmap)
  public:
-  inline wxStaticBitmap() { }
+    inline wxStaticBitmap() { Init(); }
 
-  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);
-  }
+    inline wxStaticBitmap( wxWindow*         pParent
+                          ,wxWindowID        nId
+                          ,const wxGDIImage& rLabel
+                          ,const wxPoint&    rPos = wxDefaultPosition
+                          ,const wxSize&     rSize = wxDefaultSize
+                          ,long              lStyle = 0
+                          ,const wxString&   rName = wxStaticBitmapNameStr
+                         )
+    {
+        Create(pParent, nId, rLabel, rPos, rSize, lStyle, rName);
+    }
 
-  bool Create(wxWindow *parent, wxWindowID id,
-           const wxBitmap& label,
-           const wxPoint& pos = wxDefaultPosition,
-           const wxSize& size = wxDefaultSize,
-           long style = 0,
-           const wxString& name = wxStaticBitmapNameStr);
+    bool Create( wxWindow*         pParent
+                ,wxWindowID        nId
+                ,const wxGDIImage& rLabel
+                ,const wxPoint&    rPos = wxDefaultPosition
+                ,const wxSize&     rSize = wxDefaultSize
+                ,long              lStyle = 0
+                ,const wxString&   rName = wxStaticBitmapNameStr
+               );
+    inline virtual ~wxStaticBitmap() { Free(); }
 
-  virtual void SetIcon(const wxIcon& icon) { SetBitmap(icon); }
-  virtual void SetBitmap(const wxBitmap& bitmap);
+    virtual void SetIcon(const wxIcon& rIcon) { SetImage(rIcon); }
+    virtual void SetBitmap(const wxBitmap& rBitmap) { SetImage(rBitmap); }
 
-  // assert failure is provoked by an attempt to get an icon from bitmap or
-  // vice versa
-  const wxIcon& GetIcon() const
-      { wxASSERT( m_isIcon ); return *m_image.icon; }
-  const wxBitmap& GetBitmap() const
-      { wxASSERT( !m_isIcon ); return *m_image.bitmap; }
+    // assert failure is provoked by an attempt to get an icon from bitmap or
+    // vice versa
+    wxIcon GetIcon() const
+      { wxASSERT( m_bIsIcon ); return *(wxIcon *)m_pImage; }
+    wxBitmap GetBitmap() const
+      { wxASSERT( !m_bIsIcon ); return *(wxBitmap *)m_pImage; }
 
-  // overriden base class virtuals
-  virtual bool AcceptsFocus() const { return FALSE; }
+    // overridden base class virtuals
+    virtual bool AcceptsFocus() const { return FALSE; }
+    virtual MRESULT OS2WindowProc( WXUINT   uMsg
+                                  ,WXWPARAM wParam
+                                  ,WXLPARAM lParam
+                                 );
+    void OnPaint(wxPaintEvent& rEvent);
 
 protected:
-  void Init() { m_isIcon = TRUE; m_image.icon = NULL; }
-  void Free();
+    virtual wxSize DoGetBestSize() const;
+
+    void Init() { m_bIsIcon = TRUE; m_pImage = NULL; }
+    void Free();
 
-  // TRUE if icon/bitmap is valid
-  bool ImageIsOk() const;
+    // TRUE if icon/bitmap is valid
+    bool ImageIsOk() const;
 
-  // we can have either an icon or a bitmap
-  bool m_isIcon;
-  union
-  {
-      wxIcon *icon;
-      wxBitmap *bitmap;
-  } m_image;
+    void SetImage(const wxGDIImage& rImage);
 
-  virtual wxSize DoGetBestSize();
-};
+    // we can have either an icon or a bitmap
+    bool                            m_bIsIcon;
+    wxGDIImage*                     m_pImage;
+private:
+    DECLARE_DYNAMIC_CLASS(wxStaticBitmap)
+    DECLARE_EVENT_TABLE()
+}; // end of wxStaticBitmap
 
 #endif
     // _WX_STATBMP_H_