include/wx/msw/icon.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/msw/icon.h
   3 // Purpose:     wxIcon class
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     01/02/97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_ICON_H_
  13 #define _WX_ICON_H_
  14
  15 #ifdef __GNUG__
  16     #pragma interface "icon.h"
  17 #endif
  18
  19 // ----------------------------------------------------------------------------
  20 // headers
  21 // ----------------------------------------------------------------------------
  22
  23 #include "wx/msw/gdiimage.h"
  24
  25 // ---------------------------------------------------------------------------
  26 // icon data
  27 // ---------------------------------------------------------------------------
  28
  29 // notice that although wxIconRefData inherits from wxBitmapRefData, it is not
  30 // a valid wxBitmapRefData
  31 class WXDLLEXPORT wxIconRefData : public wxGDIImageRefData
  32 {
  33 public:
  34     wxIconRefData() { }
  35     virtual ~wxIconRefData() { Free(); }
  36
  37     virtual void Free();
  38 };
  39
  40 // ---------------------------------------------------------------------------
  41 // Icon
  42 // ---------------------------------------------------------------------------
  43
  44 class WXDLLEXPORT wxIcon : public wxGDIImage
  45 {
  46 public:
  47     // ctors
  48         // default
  49     wxIcon() { }
  50
  51         // copy
  52     wxIcon(const wxIcon& icon) { Ref(icon); }
  53
  54         // from raw data
  55     wxIcon(const char bits[], int width, int height);
  56         // from XPM data
  57     wxIcon(const char **data) { CreateIconFromXpm(data); }
  58
  59     wxIcon(char **data) { CreateIconFromXpm((const char **)data); }
  60         // from resource/file
  61     wxIcon(const wxString& name,
  62            long type = wxBITMAP_TYPE_ICO_RESOURCE,
  63            int desiredWidth = -1, int desiredHeight = -1);
  64
  65     virtual ~wxIcon();
  66
  67     virtual bool LoadFile(const wxString& name,
  68                           long type = wxBITMAP_TYPE_ICO_RESOURCE,
  69                           int desiredWidth = -1, int desiredHeight = -1);
  70
  71     wxIcon& operator = (const wxIcon& icon)
  72         { if ( *this != icon ) Ref(icon); return *this; }
  73     bool operator == (const wxIcon& icon) const
  74         { return m_refData == icon.m_refData; }
  75     bool operator != (const wxIcon& icon) const
  76         { return m_refData != icon.m_refData; }
  77
  78     // implementation only from now on
  79     wxIconRefData *GetIconData() const { return (wxIconRefData *)m_refData; }
  80
  81     void SetHICON(WXHICON icon) { SetHandle((WXHANDLE)icon); }
  82     WXHICON GetHICON() const { return (WXHICON)GetHandle(); }
  83
  84     // create from bitmap (which should have a mask unless it's monochrome):
  85     // there shouldn't be any implicit bitmap -> icon conversion (i.e. no
  86     // ctors, assignment operators...), but it's ok to have such function
  87     void CopyFromBitmap(const wxBitmap& bmp);
  88
  89 protected:
  90     virtual wxGDIImageRefData *CreateData() const
  91     {
  92         return new wxIconRefData;
  93     }
  94
  95     // create from XPM data
  96     void CreateIconFromXpm(const char **data);
  97
  98 private:
  99     DECLARE_DYNAMIC_CLASS(wxIcon)
 100 };
 101
 102 #endif
 103     // _WX_ICON_H_