include/wx/os2/bitmap.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/os2/bitmap.h
   3 // Purpose:     wxBitmap class
   4 // Author:      David Webster
   5 // Modified by:
   6 // Created:     11/28/99
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) David Webster
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_BITMAP_H_
  13 #define _WX_BITMAP_H_
  14
  15 #include "wx/os2/private.h"
  16 #include "wx/os2/gdiimage.h"
  17 #include "wx/gdicmn.h"
  18 #include "wx/palette.h"
  19
  20 class WXDLLIMPEXP_FWD_CORE wxDC;
  21 class WXDLLIMPEXP_FWD_CORE wxControl;
  22 class WXDLLIMPEXP_FWD_CORE wxBitmap;
  23 class WXDLLIMPEXP_FWD_CORE wxBitmapHandler;
  24 class WXDLLIMPEXP_FWD_CORE wxIcon;
  25 class WXDLLIMPEXP_FWD_CORE wxMask;
  26 class WXDLLIMPEXP_FWD_CORE wxCursor;
  27 class WXDLLIMPEXP_FWD_CORE wxControl;
  28 class WXDLLIMPEXP_FWD_CORE wxPixelDataBase;
  29
  30 // ----------------------------------------------------------------------------
  31 // Bitmap data
  32 //
  33 // NB: this class is private, but declared here to make it possible inline
  34 //     wxBitmap functions accessing it
  35 // ----------------------------------------------------------------------------
  36
  37 class WXDLLIMPEXP_CORE wxBitmapRefData : public wxGDIImageRefData
  38 {
  39 public:
  40     wxBitmapRefData();
  41     wxBitmapRefData(const wxBitmapRefData &tocopy);
  42     virtual ~wxBitmapRefData() { Free(); }
  43
  44     virtual void Free();
  45
  46 public:
  47     int                             m_nNumColors;
  48     wxPalette                       m_vBitmapPalette;
  49     int                             m_nQuality;
  50
  51     // OS2-specific
  52     // ------------
  53
  54     wxDC*                           m_pSelectedInto;
  55
  56     //
  57     // Optional mask for transparent drawing
  58     //
  59     wxMask*                         m_pBitmapMask;
  60 }; // end of CLASS wxBitmapRefData
  61
  62 // ----------------------------------------------------------------------------
  63 // wxBitmap: a mono or colour bitmap
  64 // ----------------------------------------------------------------------------
  65
  66 class WXDLLIMPEXP_CORE wxBitmap : public wxGDIImage,
  67                                   public wxBitmapHelpers
  68 {
  69 public:
  70     // default ctor creates an invalid bitmap, you must Create() it later
  71     wxBitmap() { Init(); }
  72
  73     // Copy constructors
  74     inline wxBitmap(const wxBitmap& rBitmap)
  75         : wxGDIImage(rBitmap)
  76     {
  77         Init();
  78         SetHandle(rBitmap.GetHandle());
  79     }
  80
  81     // Initialize with raw data
  82     wxBitmap( const char bits[]
  83              ,int        nWidth
  84              ,int        nHeight
  85              ,int        nDepth = 1
  86             );
  87
  88     // Initialize with XPM data
  89     wxBitmap(const char* const* bits);
  90 #ifdef wxNEEDS_CHARPP
  91     // needed for old GCC
  92     wxBitmap(char** data)
  93     {
  94         *this = wxBitmap(const_cast<const char* const*>(data));
  95     }
  96 #endif
  97
  98     // Load a resource
  99     wxBitmap( int             nId
 100              ,wxBitmapType    lType = wxBITMAP_DEFAULT_TYPE
 101             );
 102
 103     // For compatiability with other ports, under OS/2 does same as default ctor
 104     inline wxBitmap( const wxString& WXUNUSED(rFilename)
 105                     ,wxBitmapType    WXUNUSED(lType)
 106                    )
 107     { Init(); }
 108     // New constructor for generalised creation from data
 109     wxBitmap( const void* pData
 110              ,wxBitmapType lType
 111              ,int   nWidth
 112              ,int   nHeight
 113              ,int   nDepth = 1
 114             );
 115
 116     // If depth is omitted, will create a bitmap compatible with the display
 117     wxBitmap( int nWidth, int nHeight, int nDepth = -1 )
 118     {
 119         Init();
 120         (void)Create(nWidth, nHeight, nDepth);
 121     }
 122     wxBitmap( const wxSize& sz, int nDepth = -1 )
 123     {
 124         Init();
 125         (void)Create(sz, nDepth);
 126     }
 127
 128     wxBitmap( const wxImage& image, int depth = -1 )
 129                          { (void)CreateFromImage(image, depth); }
 130
 131     // we must have this, otherwise icons are silently copied into bitmaps using
 132     // the copy ctor but the resulting bitmap is invalid!
 133     inline wxBitmap(const wxIcon& rIcon)
 134       { Init(); CopyFromIcon(rIcon); }
 135
 136     wxBitmap& operator=(const wxIcon& rIcon)
 137     {
 138         (void)CopyFromIcon(rIcon);
 139
 140         return(*this);
 141     }
 142
 143     wxBitmap& operator=(const wxCursor& rCursor)
 144     {
 145         (void)CopyFromCursor(rCursor);
 146         return (*this);
 147     }
 148
 149     virtual ~wxBitmap();
 150
 151     wxImage ConvertToImage() const;
 152     wxBitmap ConvertToDisabled(unsigned char brightness = 255) const;
 153
 154     // get the given part of bitmap
 155     wxBitmap GetSubBitmap(const wxRect& rRect) const;
 156
 157     // copies the contents and mask of the given (colour) icon to the bitmap
 158     bool CopyFromIcon(const wxIcon& rIcon);
 159
 160     // copies the contents and mask of the given cursor to the bitmap
 161     bool CopyFromCursor(const wxCursor& rCursor);
 162
 163     virtual bool Create( int nWidth
 164                         ,int nHeight
 165                         ,int nDepth = wxBITMAP_SCREEN_DEPTH
 166                        );
 167     virtual bool Create(const wxSize& sz, int depth = wxBITMAP_SCREEN_DEPTH)
 168         { return Create(sz.GetWidth(), sz.GetHeight(), depth); }
 169
 170     virtual bool Create( const void* pData
 171                         ,wxBitmapType lType
 172                         ,int   nWidth
 173                         ,int   nHeight
 174                         ,int   nDepth = 1
 175                        );
 176     virtual bool LoadFile( int             nId
 177                           ,wxBitmapType    lType = wxBITMAP_DEFAULT_TYPE
 178                          );
 179     virtual bool LoadFile( const wxString& rName
 180                           ,wxBitmapType    lType = wxBITMAP_DEFAULT_TYPE
 181                          );
 182     virtual bool SaveFile( const wxString&  rName
 183                           ,wxBitmapType     lType
 184                           ,const wxPalette* pCmap = NULL
 185                          );
 186
 187     inline wxBitmapRefData* GetBitmapData() const
 188       { return (wxBitmapRefData *)m_refData; }
 189
 190     // raw bitmap access support functions
 191     void *GetRawData(wxPixelDataBase& data, int bpp);
 192     void UngetRawData(wxPixelDataBase& data);
 193
 194     inline int GetQuality() const
 195       { return (GetBitmapData() ? GetBitmapData()->m_nQuality : 0); }
 196
 197     void SetQuality(int nQ);
 198
 199     wxPalette* GetPalette() const
 200       { return (GetBitmapData() ? (& GetBitmapData()->m_vBitmapPalette) : NULL); }
 201
 202     void       SetPalette(const wxPalette& rPalette);
 203
 204     inline wxMask* GetMask() const
 205       { return (GetBitmapData() ? GetBitmapData()->m_pBitmapMask : NULL); }
 206
 207     void SetMask(wxMask* pMask) ;
 208
 209     // Implementation
 210 public:
 211     inline void SetHBITMAP(WXHBITMAP hBmp)
 212       { SetHandle((WXHANDLE)hBmp); }
 213
 214     inline WXHBITMAP GetHBITMAP() const
 215       { return (WXHBITMAP)GetHandle(); }
 216
 217     inline void  SetSelectedInto(wxDC* pDc)
 218       { if (GetBitmapData()) GetBitmapData()->m_pSelectedInto = pDc; }
 219
 220     inline wxDC* GetSelectedInto() const
 221       { return (GetBitmapData() ? GetBitmapData()->m_pSelectedInto : NULL); }
 222
 223     inline bool IsMono(void) const { return m_bIsMono; }
 224
 225     // An OS/2 version that probably doesn't do anything like the msw version
 226     wxBitmap GetBitmapForDC(wxDC& rDc) const;
 227
 228 protected:
 229     // common part of all ctors
 230     void Init();
 231
 232     inline virtual wxGDIImageRefData* CreateData() const
 233         { return new wxBitmapRefData; }
 234
 235     bool CreateFromImage(const wxImage& image, int depth);
 236
 237     virtual wxGDIRefData *CloneGDIRefData(const wxGDIRefData *data) const;
 238
 239 private:
 240     bool CopyFromIconOrCursor(const wxGDIImage& rIcon);
 241
 242     bool                            m_bIsMono;
 243     DECLARE_DYNAMIC_CLASS(wxBitmap)
 244 }; // end of CLASS wxBitmap
 245
 246 // ----------------------------------------------------------------------------
 247 // wxMask: a mono bitmap used for drawing bitmaps transparently.
 248 // ----------------------------------------------------------------------------
 249
 250 class WXDLLIMPEXP_CORE wxMask : public wxObject
 251 {
 252 public:
 253     wxMask();
 254     wxMask( const wxMask& tocopy);
 255
 256     // Construct a mask from a bitmap and a colour indicating the transparent
 257     // area
 258     wxMask( const wxBitmap& rBitmap
 259            ,const wxColour& rColour
 260           );
 261
 262     // Construct a mask from a bitmap and a palette index indicating the
 263     // transparent area
 264     wxMask( const wxBitmap& rBitmap
 265            ,int             nPaletteIndex
 266           );
 267
 268     // Construct a mask from a mono bitmap (copies the bitmap).
 269     wxMask(const wxBitmap& rBitmap);
 270
 271     // construct a mask from the givne bitmap handle
 272     wxMask(WXHBITMAP hBmp)
 273       { m_hMaskBitmap = hBmp; }
 274
 275     virtual ~wxMask();
 276
 277     bool Create( const wxBitmap& bitmap
 278                 ,const wxColour& rColour
 279                );
 280     bool Create( const wxBitmap& rBitmap
 281                 ,int             nPaletteIndex
 282                );
 283     bool Create(const wxBitmap& rBitmap);
 284
 285     // Implementation
 286     WXHBITMAP GetMaskBitmap() const
 287       { return m_hMaskBitmap; }
 288     void SetMaskBitmap(WXHBITMAP hBmp)
 289       { m_hMaskBitmap = hBmp; }
 290
 291 protected:
 292     WXHBITMAP                       m_hMaskBitmap;
 293     DECLARE_DYNAMIC_CLASS(wxMask)
 294 }; // end of CLASS wxMask
 295
 296 // ----------------------------------------------------------------------------
 297 // wxBitmapHandler is a class which knows how to load/save bitmaps to/from file
 298 // ----------------------------------------------------------------------------
 299
 300 class WXDLLIMPEXP_CORE wxBitmapHandler : public wxGDIImageHandler
 301 {
 302 public:
 303     inline wxBitmapHandler()
 304       { m_lType = wxBITMAP_TYPE_INVALID; }
 305
 306     inline wxBitmapHandler( const wxString& rName
 307                     ,const wxString& rExt
 308                     ,wxBitmapType lType
 309                    )
 310                    : wxGDIImageHandler( rName
 311                                        ,rExt
 312                                        ,lType)
 313     {
 314     }
 315
 316     // keep wxBitmapHandler derived from wxGDIImageHandler compatible with the
 317     // old class which worked only with bitmaps
 318     virtual bool Create( wxBitmap* pBitmap
 319                         ,const void* pData
 320                         ,wxBitmapType lType
 321                         ,int       nWidth
 322                         ,int       nHeight
 323                         ,int       nDepth = 1
 324                        );
 325     virtual bool LoadFile( wxBitmap*       pBitmap
 326                           ,int             nId
 327                           ,wxBitmapType    lType
 328                           ,int             nDesiredWidth
 329                           ,int             nDesiredHeight
 330                          );
 331     virtual bool LoadFile( wxBitmap*       pBitmap
 332                           ,const wxString& rName
 333                           ,wxBitmapType    lType
 334                           ,int             nDesiredWidth
 335                           ,int             nDesiredHeight
 336                          );
 337     virtual bool SaveFile( wxBitmap*        pBitmap
 338                           ,const wxString&  rName
 339                           ,wxBitmapType     lType
 340                           ,const wxPalette* pPalette = NULL
 341                          ) const;
 342
 343     virtual bool Create( wxGDIImage* pImage
 344                         ,const void* pData
 345                         ,wxBitmapType lFlags
 346                         ,int         nWidth
 347                         ,int         nHeight
 348                         ,int         nDepth = 1
 349                        );
 350     virtual bool Load( wxGDIImage*     pImage
 351                       ,int             nId
 352                       ,wxBitmapType    lFlags
 353                       ,int             nDesiredWidth
 354                       ,int             nDesiredHeight
 355                      );
 356     virtual bool Save( const wxGDIImage* pImage
 357                       ,const wxString&   rName
 358                       ,wxBitmapType      lType
 359                      ) const;
 360 private:
 361     inline virtual bool Load( wxGDIImage*     WXUNUSED(pImage)
 362                              ,const wxString& WXUNUSED(rName)
 363                              ,WXHANDLE        WXUNUSED(hPs)
 364                              ,wxBitmapType    WXUNUSED(lFlags)
 365                              ,int             WXUNUSED(nDesiredWidth)
 366                              ,int             WXUNUSED(nDesiredHeight)
 367                             )
 368     { return false; }
 369     DECLARE_DYNAMIC_CLASS(wxBitmapHandler)
 370 }; // end of CLASS wxBitmapHandler
 371
 372 #endif
 373   // _WX_BITMAP_H_