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 25b7778b1c7df307a344ad7f711905dafdaa9563..14f94a6664c306bcec924337a2119d4df8af0fbb 100644 (file)
--- a/include/wx/gtk1/bitmap.h
+++ b/include/wx/gtk1/bitmap.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        bitmap.h
+// Name:        wx/gtk1/bitmap.h
 // Purpose:
 // Author:      Robert Roebling
 // RCS-ID:      $Id$
@@ -11,46 +11,48 @@
 #ifndef __GTKBITMAPH__
 #define __GTKBITMAPH__
 
-#if defined(__GNUG__) && !defined(__APPLE__)
-#pragma interface
-#endif
-
 #include "wx/defs.h"
 #include "wx/object.h"
 #include "wx/string.h"
 #include "wx/palette.h"
 #include "wx/gdiobj.h"
 
+class WXDLLIMPEXP_FWD_CORE wxPixelDataBase;
+
 //-----------------------------------------------------------------------------
 // classes
 //-----------------------------------------------------------------------------
 
-class wxMask;
-class wxBitmap;
-class wxImage;
+class WXDLLIMPEXP_FWD_CORE wxMask;
+class WXDLLIMPEXP_FWD_CORE wxBitmap;
+class WXDLLIMPEXP_FWD_CORE wxImage;
 
 //-----------------------------------------------------------------------------
 // wxMask
 //-----------------------------------------------------------------------------
 
-class wxMask: public wxObject
+class WXDLLIMPEXP_CORE wxMask: public wxObject
 {
 public:
     wxMask();
     wxMask( const wxBitmap& bitmap, const wxColour& colour );
+#if wxUSE_PALETTE
     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
     bool Create( const wxBitmap& bitmap, int paletteIndex );
+#endif // wxUSE_PALETTE
     bool Create( const wxBitmap& bitmap );
 
     // implementation
     GdkBitmap   *m_bitmap;
-    
+
     GdkBitmap *GetBitmap() const;
-  
+
 private:
     DECLARE_DYNAMIC_CLASS(wxMask)
 };
@@ -59,29 +61,33 @@ private:
 // wxBitmap
 //-----------------------------------------------------------------------------
 
-class wxBitmap: public wxGDIObject
+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 wxBitmap& bmp );
-    wxBitmap( const wxString &filename, int 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();
-    wxBitmap& operator = ( const wxBitmap& bmp );
-    bool operator == ( const wxBitmap& bmp ) const;
-    bool operator != ( const wxBitmap& bmp ) const;
-    bool Ok() const;
-
-    bool Create(int width, int height, int depth = -1);
-    
-    int GetHeight() const;
-    int GetWidth() const;
-    int GetDepth() const;
-    
+    virtual ~wxBitmap();
+
+    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); }
+
+    virtual int GetHeight() const;
+    virtual int GetWidth() const;
+    virtual int GetDepth() const;
+
     wxImage ConvertToImage() const;
 
     // copies the contents and mask of the given (colour) icon to the bitmap
@@ -89,17 +95,20 @@ public:
 
     wxMask *GetMask() const;
     void SetMask( wxMask *mask );
-    
+
     wxBitmap GetSubBitmap( const wxRect& rect ) const;
 
-    bool SaveFile( const wxString &name, int type, wxPalette *palette = (wxPalette *) NULL );
-    bool LoadFile( const wxString &name, int type = wxBITMAP_TYPE_XPM );
+    bool SaveFile(const wxString &name, wxBitmapType type,
+                          const wxPalette *palette = NULL) const;
+    bool LoadFile(const wxString &name, wxBitmapType type = wxBITMAP_DEFAULT_TYPE);
 
+#if wxUSE_PALETTE
     wxPalette *GetPalette() const;
+    void SetPalette(const wxPalette& palette);
     wxPalette *GetColourMap() const { return GetPalette(); };
+#endif // wxUSE_PALETTE
 
-    static void InitStandardHandlers() { }
-    static void CleanUpHandlers() { }
+    static void InitStandardHandlers();
 
     // implementation
     // --------------
@@ -112,13 +121,33 @@ public:
 
     GdkPixmap *GetPixmap() const;
     GdkBitmap *GetBitmap() const;
-    
+    bool HasPixmap() const;
+
+    // Basically, this corresponds to Win32 StretchBlt()
+    wxBitmap Rescale( int clipx, int clipy, int clipwidth, int clipheight, int width, int height );
+
+    // raw bitmap access support functions
+    void *GetRawData(wxPixelDataBase& data, int bpp);
+    void UngetRawData(wxPixelDataBase& data);
+
+    bool HasAlpha() const;
+
 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);
+    bool CreateFromImageAsPixmap(const wxImage& image);
+
+    friend class wxBitmapHandler;
+
 private:
     DECLARE_DYNAMIC_CLASS(wxBitmap)
 };
 
+
 #endif // __GTKBITMAPH__