Fix missing documentation for several GDI functions.

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

diff --git a/include/wx/cocoa/bitmap.h b/include/wx/cocoa/bitmap.h
index ca2b3b07759934b8bfb66c9f583af838c61ef175..59e7bbb732ec205ce10db6f62d1fe1bc09816df4 100644 (file)
--- a/include/wx/cocoa/bitmap.h
+++ b/include/wx/cocoa/bitmap.h
@@ -26,7 +26,7 @@ class WXDLLIMPEXP_FWD_CORE wxPixelDataBase;
 // ========================================================================
 
 // A mask is a 1-bit alpha bitmap used for drawing bitmaps transparently.
-class WXDLLEXPORT wxMask: public wxObject
+class WXDLLIMPEXP_CORE wxMask: public wxObject
 {
     DECLARE_DYNAMIC_CLASS(wxMask)
 public:
@@ -59,12 +59,14 @@ protected:
     WX_NSBitmapImageRep m_cocoaNSBitmapImageRep;
 };
 
+
 // ========================================================================
 // wxBitmap
 // ========================================================================
-class WXDLLEXPORT wxBitmap: public wxGDIObject
+
+class WXDLLIMPEXP_CORE wxBitmap: public wxGDIObject,
+                                 public wxBitmapHelpers
 {
-    DECLARE_DYNAMIC_CLASS(wxBitmap)
 // ------------------------------------------------------------------------
 // initialization
 // ------------------------------------------------------------------------
@@ -76,14 +78,21 @@ public:
     // Initialize with XPM data
     wxBitmap(const char* const* bits);
     // Load a file or resource
-    wxBitmap(const wxString& name, wxBitmapType type = wxBITMAP_TYPE_BMP_RESOURCE);
+    wxBitmap(const wxString& name, wxBitmapType type = wxBITMAP_DEFAULT_TYPE);
+    // Construct from Cocoa's NSImage
+    wxBitmap(NSImage* cocoaNSImage);
+    // Construct from Cocoa's NSBitmapImageRep
+    wxBitmap(NSBitmapImageRep* cocoaNSBitmapImageRep);
     // Constructor for generalised creation from data
     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);
+    wxBitmap(int width, int height, int depth = -1)
+        { (void)Create(width, height, depth); }
+    wxBitmap(const wxSize& sz, int depth = -1)
+        { (void)Create(sz, depth); }
     // Convert from wxImage:
     wxBitmap(const wxImage& image, int depth = -1)
-    {   CreateFromImage(image, depth); }
+        { CreateFromImage(image, depth); }
     // Convert from wxIcon
     wxBitmap(const wxIcon& icon) { CopyFromIcon(icon); }
 
@@ -97,9 +106,14 @@ public:
     // Initialize from wxImage
     bool CreateFromImage(const wxImage& image, int depth=-1);
 
-    virtual bool Create(int width, int height, int depth = -1);
+    virtual bool Create(int width, int height, int depth = wxBITMAP_SCREEN_DEPTH);
+    virtual bool Create(const wxSize& sz, int depth = wxBITMAP_SCREEN_DEPTH)
+        { return Create(sz.GetWidth(), sz.GetHeight(), depth); }
+
+    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 LoadFile(const wxString& name, wxBitmapType type = wxBITMAP_DEFAULT_TYPE);
     virtual bool SaveFile(const wxString& name, wxBitmapType type, const wxPalette *cmap = NULL) const;
 
     // copies the contents and mask of the given (colour) icon to the bitmap
@@ -110,8 +124,6 @@ public:
     // get the given part of bitmap
     wxBitmap GetSubBitmap( const wxRect& rect ) const;
 
-    bool Ok() const { return IsOk(); }
-    bool IsOk() const;
     int GetWidth() const;
     int GetHeight() const;
     int GetDepth() const;
@@ -132,11 +144,7 @@ public:
     wxMask *GetMask() const;
     void SetMask(wxMask *mask) ;
 
-    int GetBitmapType() const;
-
-    // wxObjectRefData
-    wxObjectRefData *CreateRefData() const;
-    wxObjectRefData *CloneRefData(const wxObjectRefData *data) const;
+    wxBitmapType GetBitmapType() const;
 
     // wxCocoa
     WX_NSBitmapImageRep GetNSBitmapImageRep();
@@ -145,12 +153,13 @@ public:
 
     static void InitStandardHandlers() { }
     static void CleanUpHandlers() { }
-};
 
-class WXDLLIMPEXP_CORE wxBitmapHandler: public wxBitmapHandlerBase
-{
-    DECLARE_ABSTRACT_CLASS(wxBitmapHandler)
+protected:
+    wxGDIRefData *CreateGDIRefData() const;
+    wxGDIRefData *CloneGDIRefData(const wxGDIRefData *data) const;
+
+    DECLARE_DYNAMIC_CLASS(wxBitmap)
 };
 
-#endif
-    // __WX_COCOA_BITMAP_H__
+
+#endif // __WX_COCOA_BITMAP_H__