Fix missing documentation for several GDI functions.

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

diff --git a/include/wx/os2/icon.h b/include/wx/os2/icon.h
index 07a1f4fb5596233f3cdd8757ab537fa345697691..83cef7afa1598a6ad3c9806be3f817f354ff3c07 100644 (file)
--- a/include/wx/os2/icon.h
+++ b/include/wx/os2/icon.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        icon.h
+// Name:        wx/os2/icon.h
 // Purpose:     wxIcon class
 // Author:      David Webster
 // Modified by:
@@ -12,91 +12,81 @@
 #ifndef _WX_ICON_H_
 #define _WX_ICON_H_
 
-#include "wx/bitmap.h"
-
-class WXDLLEXPORT wxIconRefData: public wxBitmapRefData
-{
-    friend class WXDLLEXPORT wxBitmap;
-    friend class WXDLLEXPORT wxIcon;
-public:
-    wxIconRefData();
-    ~wxIconRefData();
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------
 
-public:
-    WXHICON m_hIcon;
-};
+#include "wx/bitmap.h"
+#include "wx/os2/gdiimage.h"
 
-#define M_ICONDATA ((wxIconRefData *)m_refData)
-#define M_ICONHANDLERDATA ((wxIconRefData *)bitmap->GetRefData())
+#define wxIconRefDataBase   wxGDIImageRefData
+#define wxIconBase          wxGDIImage
 
-// Icon
-class WXDLLEXPORT wxIcon: public wxBitmap
+class WXDLLIMPEXP_CORE wxIconRefData: public wxIconRefDataBase
 {
-  DECLARE_DYNAMIC_CLASS(wxIcon)
-
 public:
-  wxIcon();
-
-  // Copy constructors
-  inline wxIcon(const wxIcon& icon) { Ref(icon); }
-
-  wxIcon(const char bits[], int width, int height);
-  wxIcon(const wxString& name, long flags = wxBITMAP_TYPE_ICO_RESOURCE,
-    int desiredWidth = -1, int desiredHeight = -1);
-  ~wxIcon();
-
-  bool LoadFile(const wxString& name, long flags = wxBITMAP_TYPE_ICO_RESOURCE,
-      int desiredWidth = -1, int desiredHeight = -1);
+    wxIconRefData() { }
+    virtual ~wxIconRefData() { Free(); }
 
-  inline wxIcon& operator = (const wxIcon& icon) { if (*this == icon) return (*this); Ref(icon); return *this; }
-  inline bool operator == (const wxIcon& icon) { return m_refData == icon.m_refData; }
-  inline bool operator != (const wxIcon& icon) { return m_refData != icon.m_refData; }
+    virtual void Free();
+}; // end of
 
-  void SetHICON(WXHICON ico);
-  inline WXHICON GetHICON() const { return (M_ICONDATA ? M_ICONDATA->m_hIcon : 0); }
-
-  virtual bool Ok() const { return (m_refData != NULL) ; }
-private:
-  // supress virtual function hiding warning
-  virtual bool LoadFile( const wxString& name
-                        ,long type = wxBITMAP_TYPE_BMP_RESOURCE
-                       )
-   { return(wxBitmap::LoadFile(name, type)); };
-};
-
-// Example handlers. TODO: write your own handlers for relevant types.
-
-class WXDLLEXPORT wxICOFileHandler: public wxBitmapHandler
-{
-  DECLARE_DYNAMIC_CLASS(wxICOFileHandler)
-public:
-  inline wxICOFileHandler()
-  {
-    m_name = "ICO icon file";
-    m_extension = "ico";
-    m_type = wxBITMAP_TYPE_ICO;
-  };
-
-  virtual bool LoadFile(wxBitmap *bitmap, const wxString& name, long flags,
-      int desiredWidth = -1, int desiredHeight = -1);
-};
+// ---------------------------------------------------------------------------
+// Icon
+// ---------------------------------------------------------------------------
 
-class WXDLLEXPORT wxICOResourceHandler: public wxBitmapHandler
+class WXDLLIMPEXP_CORE wxIcon: public wxIconBase
 {
-  DECLARE_DYNAMIC_CLASS(wxICOResourceHandler)
 public:
-  inline wxICOResourceHandler()
-  {
-    m_name = "ICO resource";
-    m_extension = "ico";
-    m_type = wxBITMAP_TYPE_ICO_RESOURCE;
-  };
+    wxIcon();
+
+    wxIcon( const char bits[]
+           ,int        nWidth
+           ,int        nHeight
+          );
+    wxIcon(const char* const* ppData) { CreateIconFromXpm(ppData); }
+#ifdef wxNEEDS_CHARPP
+    wxIcon(char** ppData) { CreateIconFromXpm(const_cast<const char* const*>(ppData)); }
+#endif
+    wxIcon( const wxString& rName
+           ,wxBitmapType    lFlags = wxICON_DEFAULT_TYPE
+           ,int             nDesiredWidth = -1
+           ,int             nDesiredHeight = -1
+          );
+    wxIcon(const wxIconLocation& loc)
+    {
+        LoadFile(loc.GetFileName(), wxBITMAP_TYPE_ICO);
+    }
+
+    virtual ~wxIcon();
+
+    bool LoadFile( const wxString& rName
+                  ,wxBitmapType    lFlags = wxICON_DEFAULT_TYPE
+                  ,int             nDesiredWidth = -1
+                  ,int             nDesiredHeight = -1
+                 );
+
+    wxIconRefData *GetIconData() const { return (wxIconRefData *)m_refData; }
+
+    inline void SetHICON(WXHICON hIcon) { SetHandle((WXHANDLE)hIcon); }
+    inline WXHICON GetHICON() const { return (WXHICON)GetHandle(); }
+    inline bool    IsXpm(void) const { return m_bIsXpm; }
+    inline const wxBitmap& GetXpmSrc(void) const { return m_vXpmSrc; }
+
+    void CopyFromBitmap(const wxBitmap& rBmp);
+protected:
+    virtual wxGDIImageRefData* CreateData() const
+    {
+        return new wxIconRefData;
+    }
+    void    CreateIconFromXpm(const char* const* ppData);
 
-  virtual bool LoadFile(wxBitmap *bitmap, const wxString& name, long flags,
-      int desiredWidth = -1, int desiredHeight = -1);
+private:
+    bool                            m_bIsXpm;
+    wxBitmap                        m_vXpmSrc;
 
+    DECLARE_DYNAMIC_CLASS(wxIcon)
 };
 
 #endif
     // _WX_ICON_H_
-