OutputDebugStringW95 removed - it's really unnecessary - and the references to

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

diff --git a/include/wx/msw/bitmap.h b/include/wx/msw/bitmap.h
index 4610024f792f401eb1b6d7e32a97bf5c4b902971..4fb10e6877089b84018070dc4dcc5b98284a7f27 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"
@@ -27,6 +27,7 @@ class WXDLLEXPORT wxBitmap;
 class WXDLLEXPORT wxBitmapHandler;
 class WXDLLEXPORT wxIcon;
 class WXDLLEXPORT wxCursor;
+class WXDLLEXPORT wxControl;
 
 // A mask is a mono bitmap used for drawing bitmaps
 // transparently.
@@ -35,7 +36,7 @@ class WXDLLEXPORT wxMask: public wxObject
   DECLARE_DYNAMIC_CLASS(wxMask)
 
 public:
-  wxMask(void);
+  wxMask();
 
   // Construct a mask from a bitmap and a colour indicating
   // the transparent area
@@ -48,7 +49,7 @@ public:
   // Construct a mask from a mono bitmap (copies the bitmap).
   wxMask(const wxBitmap& bitmap);
 
-  ~wxMask(void);
+  ~wxMask();
 
   bool Create(const wxBitmap& bitmap, const wxColour& colour);
   bool Create(const wxBitmap& bitmap, int paletteIndex);
@@ -67,8 +68,8 @@ class WXDLLEXPORT wxBitmapRefData: public wxGDIRefData
     friend class WXDLLEXPORT wxIcon;
     friend class WXDLLEXPORT wxCursor;
 public:
-    wxBitmapRefData(void);
-    ~wxBitmapRefData(void);
+    wxBitmapRefData();
+    ~wxBitmapRefData();
 
 public:
   int           m_width;
@@ -79,7 +80,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)
@@ -120,21 +121,16 @@ class WXDLLEXPORT wxBitmap: public wxGDIObject
   friend class WXDLLEXPORT wxBitmapHandler;
 
 public:
-  wxBitmap(void); // Platform-specific
+  wxBitmap(); // Platform-specific
 
   // 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); }
+  wxBitmap(const wxBitmap& bitmap);
 
   // Initialize with raw data
   wxBitmap(const char bits[], int width, int height, int depth = 1);
 
-#if USE_XPM_IN_MSW
-  class wxItem;
   // Initialize with XPM data
-  wxBitmap(const char **data, wxItem *anItem = NULL);
-#endif
+  wxBitmap(char **data, wxControl *anItem = NULL);
 
   // Load a file or resource
   wxBitmap(const wxString& name, long type = wxBITMAP_TYPE_BMP_RESOURCE);
@@ -144,7 +140,7 @@ public:
 
   // If depth is omitted, will create a bitmap compatible with the display
   wxBitmap(int width, int height, int depth = -1);
-  ~wxBitmap(void);
+  ~wxBitmap();
 
   virtual bool Create(int width, int height, int depth = -1);
   virtual bool Create(void *data, long type, int width, int height, int depth = 1);
@@ -165,13 +161,14 @@ public:
   inline wxPalette *GetColourMap(void) const { return GetPalette(); }
   void SetColourMap(wxPalette *cmap) { SetPalette(*cmap); };
 #endif
-  inline wxPalette* GetPalette(void) const { return (M_BITMAPDATA ? (& M_BITMAPDATA->m_bitmapPalette) : NULL); }
+  inline wxPalette* GetPalette(void) const { return (M_BITMAPDATA ? (& M_BITMAPDATA->m_bitmapPalette) : (wxPalette*) NULL); }
   void SetPalette(const wxPalette& palette);
 
-  inline wxMask *GetMask(void) const { return (M_BITMAPDATA ? M_BITMAPDATA->m_bitmapMask : NULL); }
+  inline wxMask *GetMask(void) const { return (M_BITMAPDATA ? M_BITMAPDATA->m_bitmapMask : (wxMask*) NULL); }
   void SetMask(wxMask *mask) ;
 
   inline wxBitmap& operator = (const wxBitmap& bitmap) { if (*this == bitmap) return (*this); Ref(bitmap); return *this; }
+
   inline bool operator == (const wxBitmap& bitmap) { return m_refData == bitmap.m_refData; }
   inline bool operator != (const wxBitmap& bitmap) { return m_refData != bitmap.m_refData; }
 
@@ -184,8 +181,8 @@ public:
   static wxBitmapHandler *FindHandler(const wxString& extension, long bitmapType);
   static wxBitmapHandler *FindHandler(long bitmapType);
 
-  static void InitStandardHandlers(void);
-  static void CleanUpHandlers(void);
+  static void InitStandardHandlers();
+  static void CleanUpHandlers();
 protected:
   static wxList sm_handlers;
 
@@ -194,9 +191,23 @@ public:
   void SetHBITMAP(WXHBITMAP bmp);
   inline WXHBITMAP GetHBITMAP(void) const { return (M_BITMAPDATA ? M_BITMAPDATA->m_hBitmap : 0); }
   inline void SetSelectedInto(wxDC *dc) { if (M_BITMAPDATA) M_BITMAPDATA->m_selectedInto = dc; }
-  inline wxDC *GetSelectedInto(void) const { return (M_BITMAPDATA ? M_BITMAPDATA->m_selectedInto : NULL); }
+  inline wxDC *GetSelectedInto(void) const { return (M_BITMAPDATA ? M_BITMAPDATA->m_selectedInto : (wxDC*) 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_