translate "Copy URL" string in the popup menu (feature request 1803958) (should have...

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

diff --git a/include/wx/cocoa/bitmap.h b/include/wx/cocoa/bitmap.h
index 42a6f408c82e033a7a7f72b4b9b123fa621cc269..79d0c6279d243a238033b530ec1ebc77a79f9791 100644 (file)
--- a/include/wx/cocoa/bitmap.h
+++ b/include/wx/cocoa/bitmap.h
@@ -1,12 +1,12 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        include/wx/cocoa/bitmap.h
+// Name:        wx/cocoa/bitmap.h
 // Purpose:     wxBitmap class
 // Author:      David Elliott
 // Modified by:
 // Created:     2003/07/19
 // RCS-ID:      $Id$
 // Copyright:   (c) 2003 David Elliott
-// Licence:    wxWindows licence
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef __WX_COCOA_BITMAP_H__
@@ -15,46 +15,48 @@
 #include "wx/palette.h"
 
 // Bitmap
-class WXDLLEXPORT wxBitmap;
-class WXDLLEXPORT wxIcon;
-class WXDLLEXPORT wxCursor;
-class WXDLLEXPORT wxImage;
+class WXDLLIMPEXP_FWD_CORE wxBitmap;
+class WXDLLIMPEXP_FWD_CORE wxIcon;
+class WXDLLIMPEXP_FWD_CORE wxCursor;
+class WXDLLIMPEXP_FWD_CORE wxImage;
+class WXDLLIMPEXP_FWD_CORE wxPixelDataBase;
 
 // ========================================================================
 // wxMask
 // ========================================================================
-/* DFE: wxMask is not implemented yet */
 
-// A mask is a mono bitmap used for drawing bitmaps
-// transparently.
+// A mask is a 1-bit alpha bitmap used for drawing bitmaps transparently.
 class WXDLLEXPORT wxMask: public wxObject
 {
     DECLARE_DYNAMIC_CLASS(wxMask)
 public:
-  wxMask();
+    wxMask();
 
-  // Construct a mask from a bitmap and a colour indicating
-  // the transparent area
-  wxMask(const wxBitmap& bitmap, const wxColour& colour);
+    // Construct a mask from a bitmap and a colour indicating
+    // the transparent area
+    wxMask(const wxBitmap& bitmap, const wxColour& colour);
 
-  // Construct a mask from a bitmap and a palette index indicating
-  // the transparent area
-  wxMask(const wxBitmap& bitmap, int paletteIndex);
+    // Construct a mask from a bitmap and a palette index indicating
+    // the transparent area
+    wxMask(const wxBitmap& bitmap, int paletteIndex);
 
-  // Construct a mask from a mono bitmap (copies the bitmap).
-  wxMask(const wxBitmap& bitmap);
+    // Construct a mask from a mono bitmap (copies the bitmap).
+    wxMask(const wxBitmap& bitmap);
 
-  ~wxMask();
+    // Copy constructor
+    wxMask(const wxMask& src);
 
-  bool Create(const wxBitmap& bitmap, const wxColour& colour);
-  bool Create(const wxBitmap& bitmap, int paletteIndex);
-  bool Create(const wxBitmap& bitmap);
+    virtual ~wxMask();
 
-  // Implementation
-//  inline WXHBITMAP GetMaskBitmap() const { return m_maskBitmap; }
-//  inline void SetMaskBitmap(WXHBITMAP bmp) { m_maskBitmap = bmp; }
+    bool Create(const wxBitmap& bitmap, const wxColour& colour);
+    bool Create(const wxBitmap& bitmap, int paletteIndex);
+    bool Create(const wxBitmap& bitmap);
+
+    // wxCocoa
+    inline WX_NSBitmapImageRep GetNSBitmapImageRep()
+    {   return m_cocoaNSBitmapImageRep; }
 protected:
-//  WXHBITMAP m_maskBitmap;
+    WX_NSBitmapImageRep m_cocoaNSBitmapImageRep;
 };
 
 // ========================================================================
@@ -62,45 +64,46 @@ protected:
 // ========================================================================
 class WXDLLEXPORT wxBitmap: public wxGDIObject
 {
-    DECLARE_DYNAMIC_CLASS(wxBitmap)
 // ------------------------------------------------------------------------
 // initialization
 // ------------------------------------------------------------------------
 public:
     // Platform-specific default constructor
     wxBitmap();
-    // Copy constructors
-    wxBitmap(const wxBitmap& bitmap)
-    :   wxGDIObject()
-    {   Ref(bitmap); }
     // Initialize with raw data.
     wxBitmap(const char bits[], int width, int height, int depth = 1);
     // Initialize with XPM data
-    wxBitmap(const char **bits) { CreateFromXpm(bits); }
-    wxBitmap(char **bits) { CreateFromXpm((const char**)bits); }
+    wxBitmap(const char* const* bits);
     // Load a file or resource
     wxBitmap(const wxString& name, wxBitmapType type = wxBITMAP_TYPE_BMP_RESOURCE);
+    // Construct from Cocoa's NSImage
+    wxBitmap(NSImage* cocoaNSImage);
+    // Construct from Cocoa's NSBitmapImageRep
+    wxBitmap(NSBitmapImageRep* cocoaNSBitmapImageRep);
     // Constructor for generalised creation from data
-    wxBitmap(void *data, wxBitmapType type, int width, int height, int depth = 1);
+    wxBitmap(const void* data, wxBitmapType type, int width, int height, int depth = 1);
     // If depth is omitted, will create a bitmap compatible with the display
     wxBitmap(int width, int height, int depth = -1);
     // Convert from wxImage:
     wxBitmap(const wxImage& image, int depth = -1)
     {   CreateFromImage(image, depth); }
+    // Convert from wxIcon
+    wxBitmap(const wxIcon& icon) { CopyFromIcon(icon); }
+
     // destructor
-    ~wxBitmap();
-  
+    virtual ~wxBitmap();
+
 // ------------------------------------------------------------------------
 // Implementation
 // ------------------------------------------------------------------------
 public:
-    // Initialize with XPM data
-    bool CreateFromXpm(const char **bits);
     // Initialize from wxImage
     bool CreateFromImage(const wxImage& image, int depth=-1);
 
     virtual bool Create(int width, int height, int depth = -1);
-    virtual bool Create(void *data, wxBitmapType type, int width, int height, int depth = 1);
+    bool Create(NSImage* cocoaNSImage);
+    bool Create(NSBitmapImageRep* cocoaNSBitmapImageRep);
+    virtual bool Create(const void* data, wxBitmapType type, int width, int height, int depth = 1);
     virtual bool LoadFile(const wxString& name, wxBitmapType type = wxBITMAP_TYPE_BMP_RESOURCE);
     virtual bool SaveFile(const wxString& name, wxBitmapType type, const wxPalette *cmap = NULL) const;
 
@@ -112,7 +115,6 @@ public:
     // get the given part of bitmap
     wxBitmap GetSubBitmap( const wxRect& rect ) const;
 
-    bool Ok() const;
     int GetWidth() const;
     int GetHeight() const;
     int GetDepth() const;
@@ -123,6 +125,10 @@ public:
     void SetQuality(int q);
     void SetOk(bool isOk);
 
+    // raw bitmap access support functions
+    void *GetRawData(wxPixelDataBase& data, int bpp);
+    void UngetRawData(wxPixelDataBase& data);
+
     wxPalette* GetPalette() const;
     void SetPalette(const wxPalette& palette);
 
@@ -130,23 +136,25 @@ public:
     void SetMask(wxMask *mask) ;
 
     int GetBitmapType() const;
-  
-    inline wxBitmap& operator = (const wxBitmap& bitmap)
-    {   if (*this == bitmap) return (*this); Ref(bitmap); return *this; }
-    inline bool operator == (const wxBitmap& bitmap) const
-    {   return m_refData == bitmap.m_refData; }
-    inline bool operator != (const wxBitmap& bitmap) const
-    {   return m_refData != bitmap.m_refData; }
-
-    // wxObjectRefData
-    wxObjectRefData *CreateRefData() const;
-    wxObjectRefData *CloneRefData(const wxObjectRefData *data) const;
 
     // wxCocoa
     WX_NSBitmapImageRep GetNSBitmapImageRep();
+    void SetNSBitmapImageRep(WX_NSBitmapImageRep bitmapImageRep);
+    WX_NSImage GetNSImage(bool useMask) const;
 
     static void InitStandardHandlers() { }
     static void CleanUpHandlers() { }
+
+protected:
+    wxGDIRefData *CreateGDIRefData() const;
+    wxGDIRefData *CloneGDIRefData(const wxGDIRefData *data) const;
+
+    DECLARE_DYNAMIC_CLASS(wxBitmap)
+};
+
+class WXDLLIMPEXP_CORE wxBitmapHandler: public wxBitmapHandlerBase
+{
+    DECLARE_ABSTRACT_CLASS(wxBitmapHandler)
 };
 
 #endif // __WX_COCOA_BITMAP_H__