Document wxKill(wxSIGTERM) reliance on having an open window in wxMSW.

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

diff --git a/include/wx/os2/bitmap.h b/include/wx/os2/bitmap.h
index 68efa967580514958d5a793a624d68807a257eba..7051a8162dce3251d9c4df00deca3a7aa1629ae6 100644 (file)
--- a/include/wx/os2/bitmap.h
+++ b/include/wx/os2/bitmap.h
@@ -12,24 +12,20 @@
 #ifndef _WX_BITMAP_H_
 #define _WX_BITMAP_H_
 
 #ifndef _WX_BITMAP_H_
 #define _WX_BITMAP_H_
 

-#ifdef __GNUG__
-    #pragma interface "bitmap.h"
-#endif
-

 #include "wx/os2/private.h"
 #include "wx/os2/gdiimage.h"
 #include "wx/gdicmn.h"
 #include "wx/palette.h"
 
 #include "wx/os2/private.h"
 #include "wx/os2/gdiimage.h"
 #include "wx/gdicmn.h"
 #include "wx/palette.h"
 

-class WXDLLEXPORT wxDC;
-class WXDLLEXPORT wxControl;
-class WXDLLEXPORT wxBitmap;
-class WXDLLEXPORT wxBitmapHandler;
-class WXDLLEXPORT wxIcon;
-class WXDLLEXPORT wxMask;
-class WXDLLEXPORT wxCursor;
-class WXDLLEXPORT wxControl;
-class WXDLLEXPORT wxImage;
+class WXDLLIMPEXP_FWD_CORE wxDC;
+class WXDLLIMPEXP_FWD_CORE wxControl;
+class WXDLLIMPEXP_FWD_CORE wxBitmap;
+class WXDLLIMPEXP_FWD_CORE wxBitmapHandler;
+class WXDLLIMPEXP_FWD_CORE wxIcon;
+class WXDLLIMPEXP_FWD_CORE wxMask;
+class WXDLLIMPEXP_FWD_CORE wxCursor;
+class WXDLLIMPEXP_FWD_CORE wxControl;
+class WXDLLIMPEXP_FWD_CORE wxPixelDataBase;

 
 // ----------------------------------------------------------------------------
 // Bitmap data
 
 // ----------------------------------------------------------------------------
 // Bitmap data


@@ -38,10 +34,11 @@ class WXDLLEXPORT wxImage;
 //     wxBitmap functions accessing it
 // ----------------------------------------------------------------------------
 
 //     wxBitmap functions accessing it
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxBitmapRefData : public wxGDIImageRefData
+class WXDLLIMPEXP_CORE wxBitmapRefData : public wxGDIImageRefData

 {
 public:
     wxBitmapRefData();
 {
 public:
     wxBitmapRefData();

+    wxBitmapRefData(const wxBitmapRefData &tocopy);

     virtual ~wxBitmapRefData() { Free(); }
 
     virtual void Free();
     virtual ~wxBitmapRefData() { Free(); }
 
     virtual void Free();


@@ -66,7 +63,8 @@ public:
 // wxBitmap: a mono or colour bitmap
 // ----------------------------------------------------------------------------
 
 // wxBitmap: a mono or colour bitmap
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxBitmap : public wxGDIImage
+class WXDLLIMPEXP_CORE wxBitmap : public wxGDIImage,
+                                  public wxBitmapHelpers

 {
 public:
     // default ctor creates an invalid bitmap, you must Create() it later
 {
 public:
     // default ctor creates an invalid bitmap, you must Create() it later


@@ -74,7 +72,11 @@ public:
 
     // Copy constructors
     inline wxBitmap(const wxBitmap& rBitmap)
 
     // Copy constructors
     inline wxBitmap(const wxBitmap& rBitmap)

-      { Init(); Ref(rBitmap); }
+        : wxGDIImage(rBitmap)
+    {
+        Init();
+        SetHandle(rBitmap.GetHandle());
+    }

 
     // Initialize with raw data
     wxBitmap( const char bits[]
 
     // Initialize with raw data
     wxBitmap( const char bits[]


@@ -84,27 +86,44 @@ public:
             );
 
     // Initialize with XPM data
             );
 
     // Initialize with XPM data

-    wxBitmap(const char** ppData) { CreateFromXpm(ppData); }
-    wxBitmap(char** ppData) { CreateFromXpm((const char**)ppData); }
+    wxBitmap(const char* const* bits);
+#ifdef wxNEEDS_CHARPP
+    // needed for old GCC
+    wxBitmap(char** data)
+    {
+        *this = wxBitmap(const_cast<const char* const*>(data));
+    }
+#endif

 
 

-    // Load a file or resource
-    wxBitmap( const wxString& rName
-             ,long            lType = wxBITMAP_TYPE_BMP_RESOURCE
+    // Load a resource
+    wxBitmap( int             nId
+             ,wxBitmapType    lType = wxBITMAP_DEFAULT_TYPE

             );
 
             );
 

+    // For compatiability with other ports, under OS/2 does same as default ctor
+    inline wxBitmap( const wxString& WXUNUSED(rFilename)
+                    ,wxBitmapType    WXUNUSED(lType)
+                   )
+    { Init(); }

     // New constructor for generalised creation from data
     // New constructor for generalised creation from data

-    wxBitmap( void* pData
-             ,long  lType
+    wxBitmap( const void* pData
+             ,wxBitmapType lType

              ,int   nWidth
              ,int   nHeight
              ,int   nDepth = 1
             );
 
     // If depth is omitted, will create a bitmap compatible with the display
              ,int   nWidth
              ,int   nHeight
              ,int   nDepth = 1
             );
 
     // If depth is omitted, will create a bitmap compatible with the display

-    wxBitmap( int nWidth
-             ,int nHeight
-             ,int nDepth = -1
-            );
+    wxBitmap( int nWidth, int nHeight, int nDepth = -1 )
+    {
+        Init();
+        (void)Create(nWidth, nHeight, nDepth);
+    }
+    wxBitmap( const wxSize& sz, int nDepth = -1 )
+    {
+        Init();
+        (void)Create(sz, nDepth);
+    }

 
     wxBitmap( const wxImage& image, int depth = -1 )
                          { (void)CreateFromImage(image, depth); }
 
     wxBitmap( const wxImage& image, int depth = -1 )
                          { (void)CreateFromImage(image, depth); }


@@ -114,13 +133,6 @@ public:
     inline wxBitmap(const wxIcon& rIcon)
       { Init(); CopyFromIcon(rIcon); }
 
     inline wxBitmap(const wxIcon& rIcon)
       { Init(); CopyFromIcon(rIcon); }
 

-    wxBitmap& operator=(const wxBitmap& rBitmap)
-    {
-        if ( m_refData != rBitmap.m_refData )
-            Ref(rBitmap);
-        return(*this);
-    }
-

     wxBitmap& operator=(const wxIcon& rIcon)
     {
         (void)CopyFromIcon(rIcon);
     wxBitmap& operator=(const wxIcon& rIcon)
     {
         (void)CopyFromIcon(rIcon);


@@ -137,6 +149,7 @@ public:
     virtual ~wxBitmap();
 
     wxImage ConvertToImage() const;
     virtual ~wxBitmap();
 
     wxImage ConvertToImage() const;

+    wxBitmap ConvertToDisabled(unsigned char brightness = 255) const;

 
     // get the given part of bitmap
     wxBitmap GetSubBitmap(const wxRect& rRect) const;
 
     // get the given part of bitmap
     wxBitmap GetSubBitmap(const wxRect& rRect) const;


@@ -149,59 +162,52 @@ public:
 
     virtual bool Create( int nWidth
                         ,int nHeight
 
     virtual bool Create( int nWidth
                         ,int nHeight

-                        ,int nDepth = -1
+                        ,int nDepth = wxBITMAP_SCREEN_DEPTH

                        );
                        );

-    virtual bool Create( void* pData
-                        ,long  lType
+    virtual bool Create(const wxSize& sz, int depth = wxBITMAP_SCREEN_DEPTH)
+        { return Create(sz.GetWidth(), sz.GetHeight(), depth); }
+    virtual bool Create(int width, int height, const wxDC& WXUNUSED(dc))
+        { return Create(width,height); }
+
+    virtual bool Create( const void* pData
+                        ,wxBitmapType lType

                         ,int   nWidth
                         ,int   nHeight
                         ,int   nDepth = 1
                        );
                         ,int   nWidth
                         ,int   nHeight
                         ,int   nDepth = 1
                        );

+    virtual bool LoadFile( int             nId
+                          ,wxBitmapType    lType = wxBITMAP_DEFAULT_TYPE
+                         );

     virtual bool LoadFile( const wxString& rName
     virtual bool LoadFile( const wxString& rName

-                          ,long            lType = wxBITMAP_TYPE_BMP_RESOURCE
+                          ,wxBitmapType    lType = wxBITMAP_DEFAULT_TYPE

                          );
     virtual bool SaveFile( const wxString&  rName
                          );
     virtual bool SaveFile( const wxString&  rName

-                          ,int              lType
+                          ,wxBitmapType     lType

                           ,const wxPalette* pCmap = NULL
                          );
 
     inline wxBitmapRefData* GetBitmapData() const
       { return (wxBitmapRefData *)m_refData; }
 
                           ,const wxPalette* pCmap = NULL
                          );
 
     inline wxBitmapRefData* GetBitmapData() const
       { return (wxBitmapRefData *)m_refData; }
 

+    // raw bitmap access support functions
+    void *GetRawData(wxPixelDataBase& data, int bpp);
+    void UngetRawData(wxPixelDataBase& data);
+

     inline int GetQuality() const
       { return (GetBitmapData() ? GetBitmapData()->m_nQuality : 0); }
 
     void SetQuality(int nQ);
 
     wxPalette* GetPalette() const
     inline int GetQuality() const
       { return (GetBitmapData() ? GetBitmapData()->m_nQuality : 0); }
 
     void SetQuality(int nQ);
 
     wxPalette* GetPalette() const

-      { return (GetBitmapData() ? (& GetBitmapData()->m_vBitmapPalette) : (wxPalette*) NULL); }
+      { return (GetBitmapData() ? (& GetBitmapData()->m_vBitmapPalette) : NULL); }

 
     void       SetPalette(const wxPalette& rPalette);
 
     inline wxMask* GetMask() const
 
     void       SetPalette(const wxPalette& rPalette);
 
     inline wxMask* GetMask() const

-      { return (GetBitmapData() ? GetBitmapData()->m_pBitmapMask : (wxMask*) NULL); }
+      { return (GetBitmapData() ? GetBitmapData()->m_pBitmapMask : NULL); }

 
     void SetMask(wxMask* pMask) ;
 
 
     void SetMask(wxMask* pMask) ;
 

-    inline bool operator==(const wxBitmap& rBitmap) const
-      { return m_refData == rBitmap.m_refData; }
-
-    inline bool operator!=(const wxBitmap& rBitmap) const
-      { return m_refData != rBitmap.m_refData; }
-
-#if WXWIN_COMPATIBILITY_2
-    void SetOk(bool bIsOk);
-#endif // WXWIN_COMPATIBILITY_2
-
-#if WXWIN_COMPATIBILITY
-    inline wxPalette* GetColourMap() const
-      { return GetPalette(); }
-
-    inline void       SetColourMap(wxPalette* pCmap)
-      { SetPalette(*pCmap); };
-
-#endif // WXWIN_COMPATIBILITY
-

     // Implementation
 public:
     inline void SetHBITMAP(WXHBITMAP hBmp)
     // Implementation
 public:
     inline void SetHBITMAP(WXHBITMAP hBmp)


@@ -214,18 +220,13 @@ public:
       { if (GetBitmapData()) GetBitmapData()->m_pSelectedInto = pDc; }
 
     inline wxDC* GetSelectedInto() const
       { if (GetBitmapData()) GetBitmapData()->m_pSelectedInto = pDc; }
 
     inline wxDC* GetSelectedInto() const

-      { return (GetBitmapData() ? GetBitmapData()->m_pSelectedInto : (wxDC*) NULL); }
+      { return (GetBitmapData() ? GetBitmapData()->m_pSelectedInto : NULL); }

 
     inline bool IsMono(void) const { return m_bIsMono; }
 
 
     inline bool IsMono(void) const { return m_bIsMono; }
 

-

     // An OS/2 version that probably doesn't do anything like the msw version
     wxBitmap GetBitmapForDC(wxDC& rDc) const;
 
     // An OS/2 version that probably doesn't do anything like the msw version
     wxBitmap GetBitmapForDC(wxDC& rDc) const;
 

-//    inline LONG GetId() const
-//      { return (GetBitmapData() ? GetBitmapData()->m_lId : 0L); }
-
-

 protected:
     // common part of all ctors
     void Init();
 protected:
     // common part of all ctors
     void Init();


@@ -233,10 +234,10 @@ protected:
     inline virtual wxGDIImageRefData* CreateData() const
         { return new wxBitmapRefData; }
 
     inline virtual wxGDIImageRefData* CreateData() const
         { return new wxBitmapRefData; }
 

-    // creates the bitmap from XPM data, supposed to be called from ctor
-    bool CreateFromXpm(const char** ppData);

     bool CreateFromImage(const wxImage& image, int depth);
 
     bool CreateFromImage(const wxImage& image, int depth);
 

+    virtual wxGDIRefData *CloneGDIRefData(const wxGDIRefData *data) const;
+

 private:
     bool CopyFromIconOrCursor(const wxGDIImage& rIcon);
 
 private:
     bool CopyFromIconOrCursor(const wxGDIImage& rIcon);
 


@@ -248,10 +249,11 @@ private:
 // wxMask: a mono bitmap used for drawing bitmaps transparently.
 // ----------------------------------------------------------------------------
 
 // wxMask: a mono bitmap used for drawing bitmaps transparently.
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxMask : public wxObject
+class WXDLLIMPEXP_CORE wxMask : public wxObject

 {
 public:
     wxMask();
 {
 public:
     wxMask();

+    wxMask( const wxMask& tocopy);

 
     // Construct a mask from a bitmap and a colour indicating the transparent
     // area
 
     // Construct a mask from a bitmap and a colour indicating the transparent
     // area


@@ -297,7 +299,7 @@ protected:
 // wxBitmapHandler is a class which knows how to load/save bitmaps to/from file
 // ----------------------------------------------------------------------------
 
 // wxBitmapHandler is a class which knows how to load/save bitmaps to/from file
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxBitmapHandler : public wxGDIImageHandler
+class WXDLLIMPEXP_CORE wxBitmapHandler : public wxGDIImageHandler

 {
 public:
     inline wxBitmapHandler()
 {
 public:
     inline wxBitmapHandler()


@@ -305,7 +307,7 @@ public:
 
     inline wxBitmapHandler( const wxString& rName
                     ,const wxString& rExt
 
     inline wxBitmapHandler( const wxString& rName
                     ,const wxString& rExt

-                    ,long            lType
+                    ,wxBitmapType lType

                    )
                    : wxGDIImageHandler( rName
                                        ,rExt
                    )
                    : wxGDIImageHandler( rName
                                        ,rExt


@@ -316,44 +318,56 @@ public:
     // keep wxBitmapHandler derived from wxGDIImageHandler compatible with the
     // old class which worked only with bitmaps
     virtual bool Create( wxBitmap* pBitmap
     // keep wxBitmapHandler derived from wxGDIImageHandler compatible with the
     // old class which worked only with bitmaps
     virtual bool Create( wxBitmap* pBitmap

-                        ,void*     pData
-                        ,long      lFlags
+                        ,const void* pData
+                        ,wxBitmapType lType

                         ,int       nWidth
                         ,int       nHeight
                         ,int       nDepth = 1
                        );
                         ,int       nWidth
                         ,int       nHeight
                         ,int       nDepth = 1
                        );

+    virtual bool LoadFile( wxBitmap*       pBitmap
+                          ,int             nId
+                          ,wxBitmapType    lType
+                          ,int             nDesiredWidth
+                          ,int             nDesiredHeight
+                         );

     virtual bool LoadFile( wxBitmap*       pBitmap
                           ,const wxString& rName
     virtual bool LoadFile( wxBitmap*       pBitmap
                           ,const wxString& rName

-                          ,HPS             hPs
-                          ,long            lFlags
+                          ,wxBitmapType    lType

                           ,int             nDesiredWidth
                           ,int             nDesiredHeight
                          );
     virtual bool SaveFile( wxBitmap*        pBitmap
                           ,const wxString&  rName
                           ,int             nDesiredWidth
                           ,int             nDesiredHeight
                          );
     virtual bool SaveFile( wxBitmap*        pBitmap
                           ,const wxString&  rName

-                          ,int              lType
+                          ,wxBitmapType     lType

                           ,const wxPalette* pPalette = NULL
                           ,const wxPalette* pPalette = NULL

-                         );
+                         ) const;

 
     virtual bool Create( wxGDIImage* pImage
 
     virtual bool Create( wxGDIImage* pImage

-                        ,void*       pData
-                        ,long        lFlags
+                        ,const void* pData
+                        ,wxBitmapType lFlags

                         ,int         nWidth
                         ,int         nHeight
                         ,int         nDepth = 1
                        );
     virtual bool Load( wxGDIImage*     pImage
                         ,int         nWidth
                         ,int         nHeight
                         ,int         nDepth = 1
                        );
     virtual bool Load( wxGDIImage*     pImage

-                      ,const wxString& rName
-                      ,HPS             hPs
-                      ,long            lFlags
+                      ,int             nId
+                      ,wxBitmapType    lFlags

                       ,int             nDesiredWidth
                       ,int             nDesiredHeight
                      );
                       ,int             nDesiredWidth
                       ,int             nDesiredHeight
                      );

-    virtual bool Save( wxGDIImage*     pImage
-                      ,const wxString& rName
-                      ,int             lType
-                     );
+    virtual bool Save( const wxGDIImage* pImage
+                      ,const wxString&   rName
+                      ,wxBitmapType      lType
+                     ) const;

 private:
 private:

+    inline virtual bool Load( wxGDIImage*     WXUNUSED(pImage)
+                             ,const wxString& WXUNUSED(rName)
+                             ,WXHANDLE        WXUNUSED(hPs)
+                             ,wxBitmapType    WXUNUSED(lFlags)
+                             ,int             WXUNUSED(nDesiredWidth)
+                             ,int             WXUNUSED(nDesiredHeight)
+                            )
+    { return false; }

     DECLARE_DYNAMIC_CLASS(wxBitmapHandler)
 }; // end of CLASS wxBitmapHandler
 
     DECLARE_DYNAMIC_CLASS(wxBitmapHandler)
 }; // end of CLASS wxBitmapHandler