]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/msw/icon.h
Doc tweaks
[wxWidgets.git] / include / wx / msw / icon.h
index 27d731129856997bf0da0855a90b901629b246c3..1d9305e9aa4dc64d61146df08e31dc2275a7aac3 100644 (file)
 /////////////////////////////////////////////////////////////////////////////
-// Name:        icon.h
+// Name:        wx/msw/icon.h
 // Purpose:     wxIcon class
 // Author:      Julian Smart
 // Modified by:
 // Created:     01/02/97
 // RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart
-// Licence:    wxWindows licence
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_ICON_H_
 #define _WX_ICON_H_
 
 #ifdef __GNUG__
-#pragma interface "icon.h"
+    #pragma interface "icon.h"
 #endif
 
-#include "wx/bitmap.h"
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------
 
-class WXDLLEXPORT wxIconRefData: public wxBitmapRefData
-{
-    friend class WXDLLEXPORT wxBitmap;
-    friend class WXDLLEXPORT wxIcon;
-public:
-    wxIconRefData(void);
-    ~wxIconRefData(void);
-
-public:
-  WXHICON m_hIcon;
-};
-
-#define M_ICONDATA ((wxIconRefData *)m_refData)
-#define M_ICONHANDLERDATA ((wxIconRefData *)bitmap->GetRefData())
-
-// Icon
-class WXDLLEXPORT wxIcon: public wxBitmap
-{
-  DECLARE_DYNAMIC_CLASS(wxIcon)
-
-public:
-  wxIcon(void);
-
-  // Copy constructors
-  inline wxIcon(const wxIcon& icon) { Ref(icon); }
-  inline wxIcon(const wxIcon* icon) { /* UnRef(); */ if (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(void);
-
-  bool LoadFile(const wxString& name, long flags = wxBITMAP_TYPE_ICO_RESOURCE,
-      int desiredWidth = -1, int desiredHeight = -1);
-
-  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; }
+// compatible (even if incorrect) behaviour by default: derive wxIcon from
+// wxBitmap
+#ifndef wxICON_IS_BITMAP
+    #define wxICON_IS_BITMAP 1
+#endif
 
-  void SetHICON(WXHICON ico);
-  inline WXHICON GetHICON(void) const { return (M_ICONDATA ? M_ICONDATA->m_hIcon : 0); }
+#if wxICON_IS_BITMAP
+    #include "wx/bitmap.h"
 
-  virtual bool Ok(void) const { return (m_refData != NULL && M_ICONDATA->m_hIcon) ; }
+    #define wxIconRefDataBase   wxBitmapRefData
+    #define wxIconBase          wxBitmap
+#else
+    #include "wx/msw/gdiimage.h"
 
-  bool FreeResource(bool force = FALSE);
-};
+    #define wxIconRefDataBase   wxGDIImageRefData
+    #define wxIconBase          wxGDIImage
+#endif
 
-// TODO: Put these in separate, private header
+// ---------------------------------------------------------------------------
+// icon data
+// ---------------------------------------------------------------------------
 
-class WXDLLEXPORT wxICOFileHandler: public wxBitmapHandler
+// notice that although wxIconRefData inherits from wxBitmapRefData, it is not
+// a valid wxBitmapRefData
+class WXDLLEXPORT wxIconRefData : public wxIconRefDataBase
 {
-  DECLARE_DYNAMIC_CLASS(wxICOFileHandler)
 public:
-  inline wxICOFileHandler(void)
-  {
-       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);
+    wxIconRefData() { }
+    virtual ~wxIconRefData() { Free(); }
+
+    virtual void Free();
 };
 
-class WXDLLEXPORT wxICOResourceHandler: public wxBitmapHandler
+// ---------------------------------------------------------------------------
+// Icon
+// ---------------------------------------------------------------------------
+
+class WXDLLEXPORT wxIcon : public wxIconBase
 {
-  DECLARE_DYNAMIC_CLASS(wxICOResourceHandler)
 public:
-  inline wxICOResourceHandler(void)
-  {
-       m_name = "ICO resource";
-       m_extension = "ico";
-       m_type = wxBITMAP_TYPE_ICO_RESOURCE;
-  };
-
-  virtual bool LoadFile(wxBitmap *bitmap, const wxString& name, long flags,
-      int desiredWidth = -1, int desiredHeight = -1);
-
+    // ctors
+        // default
+    wxIcon() { }
+
+        // copy
+    wxIcon(const wxIcon& icon) { Ref(icon); }
+
+        // from raw data
+    wxIcon(const char bits[], int width, int height);
+        // from XPM data
+    wxIcon(const char **data) { CreateIconFromXpm(data); }
+    wxIcon(char **data) { CreateIconFromXpm((const char **)data); }
+        // from resource/file
+    wxIcon(const wxString& name,
+           long type = wxBITMAP_TYPE_ICO_RESOURCE,
+           int desiredWidth = -1, int desiredHeight = -1);
+
+    virtual ~wxIcon();
+
+    virtual bool LoadFile(const wxString& name,
+                          long type = wxBITMAP_TYPE_ICO_RESOURCE,
+                          int desiredWidth = -1, int desiredHeight = -1);
+
+    wxIcon& operator = (const wxIcon& icon)
+        { if ( *this != icon ) Ref(icon); return *this; }
+    bool operator == (const wxIcon& icon) const
+        { return m_refData == icon.m_refData; }
+    bool operator != (const wxIcon& icon) const
+        { return m_refData != icon.m_refData; }
+
+    // implementation only from now on
+    wxIconRefData *GetIconData() const { return (wxIconRefData *)m_refData; }
+
+    void SetHICON(WXHICON icon) { SetHandle((WXHANDLE)icon); }
+    WXHICON GetHICON() const { return (WXHICON)GetHandle(); }
+
+    // create from bitmap (which should have a mask unless it's monochrome):
+    // there shouldn't be any implicit bitmap -> icon conversion (i.e. no
+    // ctors, assignment operators...), but it's ok to have such function
+    void CopyFromBitmap(const wxBitmap& bmp);
+
+protected:
+    virtual wxGDIImageRefData *CreateData() const
+    {
+        return new wxIconRefData;
+    }
+
+    // create from XPM data
+    void CreateIconFromXpm(const char **data);
+
+private:
+    DECLARE_DYNAMIC_CLASS(wxIcon)
 };
 
 #endif