Extensive documentation typo patch (closes #13063).

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

diff --git a/include/wx/gtk1/bitmap.h b/include/wx/gtk1/bitmap.h
index 8640396da07e0bb23ca08b20095cd759dbb4f43c..14f94a6664c306bcec924337a2119d4df8af0fbb 100644 (file)
--- a/include/wx/gtk1/bitmap.h
+++ b/include/wx/gtk1/bitmap.h
@@ -17,15 +17,15 @@
 #include "wx/palette.h"
 #include "wx/gdiobj.h"
 
-class WXDLLEXPORT wxPixelDataBase;
+class WXDLLIMPEXP_FWD_CORE wxPixelDataBase;
 
 //-----------------------------------------------------------------------------
 // classes
 //-----------------------------------------------------------------------------
 
-class WXDLLIMPEXP_CORE wxMask;
-class WXDLLIMPEXP_CORE wxBitmap;
-class WXDLLIMPEXP_CORE wxImage;
+class WXDLLIMPEXP_FWD_CORE wxMask;
+class WXDLLIMPEXP_FWD_CORE wxBitmap;
+class WXDLLIMPEXP_FWD_CORE wxImage;
 
 //-----------------------------------------------------------------------------
 // wxMask
@@ -40,7 +40,7 @@ public:
     wxMask( const wxBitmap& bitmap, int paletteIndex );
 #endif // wxUSE_PALETTE
     wxMask( const wxBitmap& bitmap );
-    ~wxMask();
+    virtual ~wxMask();
 
     bool Create( const wxBitmap& bitmap, const wxColour& colour );
 #if wxUSE_PALETTE
@@ -64,23 +64,29 @@ private:
 class WXDLLIMPEXP_CORE wxBitmap: public wxBitmapBase
 {
 public:
-    wxBitmap();
-    wxBitmap( int width, int height, int depth = -1 );
+    wxBitmap() {}
+    wxBitmap( int width, int height, int depth = -1 ) { Create( width, height, depth ); }
+    wxBitmap( const wxSize& sz, int depth = -1 ) { Create( sz, depth ); }
     wxBitmap( const char bits[], int width, int height, int depth = 1 );
-    wxBitmap( const char **bits ) { (void)CreateFromXpm(bits); }
-    wxBitmap( char **bits ) { (void)CreateFromXpm((const char **)bits); }
-    wxBitmap( const wxString &filename, wxBitmapType type = wxBITMAP_TYPE_XPM );
+    wxBitmap( const char* const* bits );
+#ifdef wxNEEDS_CHARPP
+    // needed for old GCC
+    wxBitmap(char** data)
+    {
+        *this = wxBitmap(const_cast<const char* const*>(data));
+    }
+#endif
+    wxBitmap( const wxString &filename, wxBitmapType type = wxBITMAP_DEFAULT_TYPE );
     wxBitmap( const wxImage& image, int depth = -1 ) { (void)CreateFromImage(image, depth); }
-    ~wxBitmap();
-    bool operator == ( const wxBitmap& bmp ) const;
-    bool operator != ( const wxBitmap& bmp ) const;
-    bool Ok() const;
+    virtual ~wxBitmap();
 
-    bool Create(int width, int height, int depth = -1);
+    bool Create(int width, int height, int depth = wxBITMAP_SCREEN_DEPTH);
+    bool Create(const wxSize& sz, int depth = wxBITMAP_SCREEN_DEPTH)
+        { return Create(sz.GetWidth(), sz.GetHeight(), depth); }
 
-    int GetHeight() const;
-    int GetWidth() const;
-    int GetDepth() const;
+    virtual int GetHeight() const;
+    virtual int GetWidth() const;
+    virtual int GetDepth() const;
 
     wxImage ConvertToImage() const;
 
@@ -93,8 +99,8 @@ public:
     wxBitmap GetSubBitmap( const wxRect& rect ) const;
 
     bool SaveFile(const wxString &name, wxBitmapType type,
-                          const wxPalette *palette = (wxPalette *)NULL) const;
-    bool LoadFile(const wxString &name, wxBitmapType type = wxBITMAP_TYPE_XPM );
+                          const wxPalette *palette = NULL) const;
+    bool LoadFile(const wxString &name, wxBitmapType type = wxBITMAP_DEFAULT_TYPE);
 
 #if wxUSE_PALETTE
     wxPalette *GetPalette() const;
@@ -125,12 +131,13 @@ public:
     void UngetRawData(wxPixelDataBase& data);
 
     bool HasAlpha() const;
-    void UseAlpha();
 
 protected:
-    bool CreateFromXpm(const char **bits);
     bool CreateFromImage(const wxImage& image, int depth);
 
+    virtual wxGDIRefData *CreateGDIRefData() const;
+    virtual wxGDIRefData *CloneGDIRefData(const wxGDIRefData *data) const;
+
 private:
     // to be called from CreateFromImage only!
     bool CreateFromImageAsBitmap(const wxImage& image);
@@ -142,24 +149,5 @@ private:
     DECLARE_DYNAMIC_CLASS(wxBitmap)
 };
 
-//-----------------------------------------------------------------------------
-// wxBitmapHandler
-//-----------------------------------------------------------------------------
-
-class WXDLLIMPEXP_CORE wxBitmapHandler: public wxBitmapHandlerBase
-{
-public:
-    wxBitmapHandler() { }
-    virtual ~wxBitmapHandler();
-
-    virtual bool Create(wxBitmap *bitmap, void *data, long flags, int width, int height, int depth = 1);
-    virtual bool LoadFile(wxBitmap *bitmap, const wxString& name, long flags,
-        int desiredWidth, int desiredHeight);
-    virtual bool SaveFile(const wxBitmap *bitmap, const wxString& name, int type, const wxPalette *palette = NULL);
-
-private:
-    DECLARE_DYNAMIC_CLASS(wxBitmapHandler)
-};
-
 
 #endif // __GTKBITMAPH__