Added wxPrivateDropTarget

[wxWidgets.git] / include / wx / msw / bitmap.h

diff --git a/include/wx/msw/bitmap.h b/include/wx/msw/bitmap.h
index 650d75c4d490efcfe0d0b2faf460cf01d1288323..aa9fa411f68b69dac64f60a5e80ca307dfaef81c 100644 (file)
--- a/include/wx/msw/bitmap.h
+++ b/include/wx/msw/bitmap.h
@@ -5,12 +5,12 @@
 // Modified by:
 // Created:     01/02/97
 // RCS-ID:      $Id$
-// Copyright:   (c) Julian Smart and Markus Holzem
-// Licence:    wxWindows license
+// Copyright:   (c) Julian Smart
+// Licence:    wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-#ifndef __BITMAPH__
-#define __BITMAPH__
+#ifndef _WX_BITMAP_H_
+#define _WX_BITMAP_H_
 
 #ifdef __GNUG__
 #pragma interface "bitmap.h"
@@ -43,7 +43,7 @@ public:
 
   // Construct a mask from a bitmap and a palette index indicating
   // the transparent area
-  wxMask(const wxBitmap& bitmap, const int paletteIndex);
+  wxMask(const wxBitmap& bitmap, int paletteIndex);
 
   // Construct a mask from a mono bitmap (copies the bitmap).
   wxMask(const wxBitmap& bitmap);
@@ -51,7 +51,7 @@ public:
   ~wxMask(void);
 
   bool Create(const wxBitmap& bitmap, const wxColour& colour);
-  bool Create(const wxBitmap& bitmap, const int paletteIndex);
+  bool Create(const wxBitmap& bitmap, int paletteIndex);
   bool Create(const wxBitmap& bitmap);
 
   // Implementation
@@ -79,7 +79,7 @@ public:
   wxPalette     m_bitmapPalette;
   int           m_quality;
 
-#ifdef __WINDOWS__
+#ifdef __WXMSW__
   WXHBITMAP     m_hBitmap;
   wxDC *        m_selectedInto; // So bitmap knows whether it's been selected into
                       // a device context (for error checking)
@@ -95,14 +95,14 @@ class WXDLLEXPORT wxBitmapHandler: public wxObject
 public:
   wxBitmapHandler(void) { m_name = ""; m_extension = ""; m_type = 0; };
 
-  virtual bool Create(wxBitmap *bitmap, void *data, const long flags, const int width, const int height, const int depth = 1);
-  virtual bool LoadFile(wxBitmap *bitmap, const wxString& name, const long flags,
+  virtual bool Create(wxBitmap *bitmap, void *data, long flags, int width, int height, int depth = 1);
+  virtual bool LoadFile(wxBitmap *bitmap, const wxString& name, long flags,
       int desiredWidth, int desiredHeight);
-  virtual bool SaveFile(wxBitmap *bitmap, const wxString& name, const int type, const wxPalette *palette = NULL);
+  virtual bool SaveFile(wxBitmap *bitmap, const wxString& name, int type, const wxPalette *palette = NULL);
 
   inline void SetName(const wxString& name) { m_name = name; }
   inline void SetExtension(const wxString& ext) { m_extension = ext; }
-  inline void SetType(const long type) { m_type = type; }
+  inline void SetType(long type) { m_type = type; }
   inline wxString GetName(void) const { return m_name; }
   inline wxString GetExtension(void) const { return m_extension; }
   inline long GetType(void) const { return m_type; }
@@ -125,31 +125,30 @@ public:
   // Copy constructors
   inline wxBitmap(const wxBitmap& bitmap)
   { Ref(bitmap); if ( wxTheBitmapList ) wxTheBitmapList->AddBitmap(this); }
-  inline wxBitmap(const wxBitmap* bitmap) { if (bitmap) Ref(*bitmap); if ( wxTheBitmapList ) wxTheBitmapList->AddBitmap(this); }
 
   // Initialize with raw data
-  wxBitmap(const char bits[], const int width, const int height, const int depth = 1);
+  wxBitmap(const char bits[], int width, int height, int depth = 1);
 
-#if USE_XPM_IN_MSW
+#if wxUSE_XPM_IN_MSW
   class wxItem;
   // Initialize with XPM data
-  wxBitmap(const char **data, wxItem *anItem = NULL);
+  wxBitmap(char **data, wxItem *anItem = NULL);
 #endif
 
   // Load a file or resource
-  wxBitmap(const wxString& name, const long type = wxBITMAP_TYPE_BMP_RESOURCE);
+  wxBitmap(const wxString& name, long type = wxBITMAP_TYPE_BMP_RESOURCE);
 
   // New constructor for generalised creation from data
-  wxBitmap(void *data, const long type, const int width, const int height, const int depth = 1);
+  wxBitmap(void *data, long type, int width, int height, int depth = 1);
 
   // If depth is omitted, will create a bitmap compatible with the display
-  wxBitmap(const int width, const int height, const int depth = -1);
+  wxBitmap(int width, int height, int depth = -1);
   ~wxBitmap(void);
 
-  virtual bool Create(const int width, const int height, const int depth = -1);
-  virtual bool Create(void *data, const long type, const int width, const int height, const int depth = 1);
-  virtual bool LoadFile(const wxString& name, const long type = wxBITMAP_TYPE_BMP_RESOURCE);
-  virtual bool SaveFile(const wxString& name, const int type, const wxPalette *cmap = NULL);
+  virtual bool Create(int width, int height, int depth = -1);
+  virtual bool Create(void *data, long type, int width, int height, int depth = 1);
+  virtual bool LoadFile(const wxString& name, long type = wxBITMAP_TYPE_BMP_RESOURCE);
+  virtual bool SaveFile(const wxString& name, int type, const wxPalette *cmap = NULL);
 
   inline bool Ok(void) const { return (M_BITMAPDATA && M_BITMAPDATA->m_ok); }
   inline int GetWidth(void) const { return (M_BITMAPDATA ? M_BITMAPDATA->m_width : 0); }
@@ -197,6 +196,19 @@ public:
   inline wxDC *GetSelectedInto(void) const { return (M_BITMAPDATA ? M_BITMAPDATA->m_selectedInto : NULL); }
   bool FreeResource(bool force = FALSE);
 
+  // Creates a bitmap that matches the device context's depth, from
+  // an arbitray bitmap. At present, the original bitmap must have an
+  // associated palette. (TODO: use a default palette if no palette exists.)
+  // This function is necessary for you to Blit an arbitrary bitmap (which may have
+  // the wrong depth). wxDC::SelectObject will compare the depth of the bitmap
+  // with the DC's depth, and create a new bitmap if the depths differ.
+  // Eventually we should perhaps make this a public API function so that
+  // an app can efficiently produce bitmaps of the correct depth.
+  // The Windows solution is to use SetDibBits to blit an arbotrary DIB directly to a DC, but
+  // this is too Windows-specific, hence this solution of quietly converting the wxBitmap.
+  // Contributed by Frederic Villeneuve <frederic.villeneuve@natinst.com>
+  wxBitmap GetBitmapForDC(wxDC& dc) const;
+
 };
 #endif
-  // __BITMAPH__
+  // _WX_BITMAP_H_