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 383fd39e166d4bf16385d620beb6e36a6d67af78..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:
@@ -16,28 +16,16 @@
 // headers
 // ----------------------------------------------------------------------------
 
-// compatible (even if incorrect) behaviour by default: derive wxIcon from
-// wxBitmap
-#ifndef wxICON_IS_BITMAP
-    #define wxICON_IS_BITMAP 1
-#endif
-
-#if wxICON_IS_BITMAP
-    #include "wx/bitmap.h"
-
-    #define wxIconRefDataBase   wxBitmapRefData
-    #define wxIconBase          wxBitmap
-#else
-    #include "wx/os2/gdiimage.h"
+#include "wx/bitmap.h"
+#include "wx/os2/gdiimage.h"
 
-    #define wxIconRefDataBase   wxGDIImageRefData
-    #define wxIconBase          wxGDIImage
-#endif
+#define wxIconRefDataBase   wxGDIImageRefData
+#define wxIconBase          wxGDIImage
 
-class WXDLLEXPORT wxIconRefData: public wxIconRefDataBase
+class WXDLLIMPEXP_CORE wxIconRefData: public wxIconRefDataBase
 {
 public:
-    wxIconRefData() { };
+    wxIconRefData() { }
     virtual ~wxIconRefData() { Free(); }
 
     virtual void Free();
@@ -47,50 +35,56 @@ public:
 // Icon
 // ---------------------------------------------------------------------------
 
-class WXDLLEXPORT wxIcon: public wxIconBase
+class WXDLLIMPEXP_CORE wxIcon: public wxIconBase
 {
 public:
     wxIcon();
 
-    // Copy constructors
-    inline wxIcon(const wxIcon& icon) { Ref(icon); }
-
     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
-           ,long            lFlags = wxBITMAP_TYPE_ICO_RESOURCE
+           ,wxBitmapType    lFlags = wxICON_DEFAULT_TYPE
            ,int             nDesiredWidth = -1
            ,int             nDesiredHeight = -1
           );
-    ~wxIcon();
+    wxIcon(const wxIconLocation& loc)
+    {
+        LoadFile(loc.GetFileName(), wxBITMAP_TYPE_ICO);
+    }
+
+    virtual ~wxIcon();
 
     bool LoadFile( const wxString& rName
-                  ,long            lFlags = wxBITMAP_TYPE_ICO_RESOURCE
+                  ,wxBitmapType    lFlags = wxICON_DEFAULT_TYPE
                   ,int             nDesiredWidth = -1
                   ,int             nDesiredHeight = -1
                  );
 
-    inline wxIcon& operator = (const wxIcon& rIcon)
-       { if (*this != rIcon) Ref(rIcon); return *this; }
-    inline bool operator == (const wxIcon& rIcon)
-       { return m_refData == rIcon.m_refData; }
-    inline bool operator != (const wxIcon& rIcon)
-       { return m_refData != rIcon.m_refData; }
-
     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);
 
 private:
+    bool                            m_bIsXpm;
+    wxBitmap                        m_vXpmSrc;
+
     DECLARE_DYNAMIC_CLASS(wxIcon)
 };