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 // compatible (even if incorrect) behaviour by default: derive wxIcon from
  24 // wxBitmap
  25 #ifndef wxICON_IS_BITMAP
  26     #define wxICON_IS_BITMAP 1
  27 #endif
  28
  29 #if wxICON_IS_BITMAP
  30     #include "wx/bitmap.h"
  31
  32     #define wxIconRefDataBase   wxBitmapRefData
  33     #define wxIconBase          wxBitmap
  34 #else
  35     #include "wx/msw/gdiimage.h"
  36
  37     #define wxIconRefDataBase   wxGDIImageRefData
  38     #define wxIconBase          wxGDIImage
  39 #endif
  40
  41 // ---------------------------------------------------------------------------
  42 // icon data
  43 // ---------------------------------------------------------------------------
  44
  45 // notice that although wxIconRefData inherits from wxBitmapRefData, it is not
  46 // a valid wxBitmapRefData
  47 class WXDLLEXPORT wxIconRefData : public wxIconRefDataBase
  48 {
  49 public:
  50     wxIconRefData() { }
  51     virtual ~wxIconRefData() { Free(); }
  52
  53     virtual void Free();
  54 };
  55
  56 // ---------------------------------------------------------------------------
  57 // Icon
  58 // ---------------------------------------------------------------------------
  59
  60 class WXDLLEXPORT wxIcon : public wxIconBase
  61 {
  62 public:
  63     // ctors
  64         // default
  65     wxIcon() { }
  66
  67         // copy
  68     wxIcon(const wxIcon& icon) { Ref(icon); }
  69
  70         // from raw data
  71     wxIcon(const char bits[], int width, int height);
  72         // from XPM data
  73     wxIcon(const char **data) { CreateIconFromXpm(data); }
  74     wxIcon(char **data) { CreateIconFromXpm((const char **)data); }
  75         // from resource/file
  76     wxIcon(const wxString& name,
  77            long type = wxBITMAP_TYPE_ICO_RESOURCE,
  78            int desiredWidth = -1, int desiredHeight = -1);
  79
  80     virtual ~wxIcon();
  81
  82     virtual bool LoadFile(const wxString& name,
  83                           long type = wxBITMAP_TYPE_ICO_RESOURCE,
  84                           int desiredWidth = -1, int desiredHeight = -1);
  85
  86     wxIcon& operator = (const wxIcon& icon)
  87         { if ( *this != icon ) Ref(icon); return *this; }
  88     bool operator == (const wxIcon& icon) const
  89         { return m_refData == icon.m_refData; }
  90     bool operator != (const wxIcon& icon) const
  91         { return m_refData != icon.m_refData; }
  92
  93     // implementation only from now on
  94     wxIconRefData *GetIconData() const { return (wxIconRefData *)m_refData; }
  95
  96     void SetHICON(WXHICON icon) { SetHandle((WXHANDLE)icon); }
  97     WXHICON GetHICON() const { return (WXHICON)GetHandle(); }
  98
  99     // create from bitmap (which should have a mask unless it's monochrome):
 100     // there shouldn't be any implicit bitmap -> icon conversion (i.e. no
 101     // ctors, assignment operators...), but it's ok to have such function
 102     void CopyFromBitmap(const wxBitmap& bmp);
 103
 104 protected:
 105     virtual wxGDIImageRefData *CreateData() const
 106     {
 107         return new wxIconRefData;
 108     }
 109
 110     // create from XPM data
 111     void CreateIconFromXpm(const char **data);
 112
 113 private:
 114     DECLARE_DYNAMIC_CLASS(wxIcon)
 115 };
 116
 117 #endif
 118     // _WX_ICON_H_