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 eeacd6e4c96b9a008bc4ba9895a732fb19c81a5f..7051a8162dce3251d9c4df00deca3a7aa1629ae6 100644 (file)
--- a/include/wx/os2/bitmap.h
+++ b/include/wx/os2/bitmap.h
@@ -17,15 +17,15 @@
 #include "wx/gdicmn.h"
 #include "wx/palette.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


@@ -34,7 +34,7 @@ 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();


@@ -63,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


@@ -86,34 +87,43 @@ public:
 
     // Initialize with XPM data
     wxBitmap(const char* const* bits);
 
     // Initialize with XPM data
     wxBitmap(const char* const* bits);

-#if defined (__GNUC__) && __GNUC__ < 3
+#ifdef wxNEEDS_CHARPP

     // needed for old GCC
     wxBitmap(char** data)
     {
     // needed for old GCC
     wxBitmap(char** data)
     {

-        *this = wxBitmap(wx_const_cast(const char* const*, data));
+        *this = wxBitmap(const_cast<const char* const*>(data));

     }
 #endif
 
     // Load a resource
     wxBitmap( int             nId
     }
 #endif
 
     // Load a resource
     wxBitmap( int             nId

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

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

-                    ,long            WXUNUSED(lType)
+                    ,wxBitmapType    WXUNUSED(lType)

                    )
     { Init(); }
     // New constructor for generalised creation from data
     wxBitmap( const void* pData
                    )
     { Init(); }
     // New constructor for generalised creation from data
     wxBitmap( const void* pData

-             ,long  lType
+             ,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); }


@@ -139,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;


@@ -151,40 +162,49 @@ 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(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
     virtual bool Create( const void* pData

-                        ,long  lType
+                        ,wxBitmapType lType

                         ,int   nWidth
                         ,int   nHeight
                         ,int   nDepth = 1
                        );
     virtual bool LoadFile( int             nId
                         ,int   nWidth
                         ,int   nHeight
                         ,int   nDepth = 1
                        );
     virtual bool LoadFile( int             nId

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

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

-                          ,long            lType = wxBITMAP_TYPE_XPM
+                          ,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) ;
 


@@ -200,7 +220,7 @@ 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; }
 


@@ -216,9 +236,7 @@ protected:
 
     bool CreateFromImage(const wxImage& image, int depth);
 
 
     bool CreateFromImage(const wxImage& image, int depth);
 

-   // ref counting code
-    virtual wxObjectRefData *CreateRefData() const;
-    virtual wxObjectRefData *CloneRefData(const wxObjectRefData *data) const;
+    virtual wxGDIRefData *CloneGDIRefData(const wxGDIRefData *data) const;

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


@@ -231,7 +249,7 @@ 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();


@@ -281,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()


@@ -289,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


@@ -301,51 +319,51 @@ public:
     // old class which worked only with bitmaps
     virtual bool Create( wxBitmap* pBitmap
                         ,const void* pData
     // old class which worked only with bitmaps
     virtual bool Create( wxBitmap* pBitmap
                         ,const void* pData

-                        ,long      lFlags
+                        ,wxBitmapType lType

                         ,int       nWidth
                         ,int       nHeight
                         ,int       nDepth = 1
                        );
     virtual bool LoadFile( wxBitmap*       pBitmap
                           ,int             nId
                         ,int       nWidth
                         ,int       nHeight
                         ,int       nDepth = 1
                        );
     virtual bool LoadFile( wxBitmap*       pBitmap
                           ,int             nId

-                          ,long            lFlags
+                          ,wxBitmapType    lType

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

-                          ,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
                         ,const void* pData
 
     virtual bool Create( wxGDIImage* pImage
                         ,const void* pData

-                        ,long        lFlags
+                        ,wxBitmapType lFlags

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

-                      ,long            lFlags
+                      ,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:
     inline virtual bool Load( wxGDIImage*     WXUNUSED(pImage)
                              ,const wxString& WXUNUSED(rName)
 private:
     inline virtual bool Load( wxGDIImage*     WXUNUSED(pImage)
                              ,const wxString& WXUNUSED(rName)

-                             ,HPS             WXUNUSED(hPs)
-                             ,long            WXUNUSED(lFlags)
+                             ,WXHANDLE        WXUNUSED(hPs)
+                             ,wxBitmapType    WXUNUSED(lFlags)

                              ,int             WXUNUSED(nDesiredWidth)
                              ,int             WXUNUSED(nDesiredHeight)
                             )
                              ,int             WXUNUSED(nDesiredWidth)
                              ,int             WXUNUSED(nDesiredHeight)
                             )