revision contributed by Utensil Candel

[wxWidgets.git] / interface / bitmap.h

diff --git a/interface/bitmap.h b/interface/bitmap.h
index 6c37d33628940124c361e443390122c419ff50ca..8656ae698357535d7be249e86b4bdcb19224e666 100644 (file)
--- a/interface/bitmap.h
+++ b/interface/bitmap.h
@@ -21,7 +21,7 @@
     It is used within wxBitmap and is not normally seen by the application.
 
     If you wish to extend the capabilities of wxBitmap, derive a class from
     It is used within wxBitmap and is not normally seen by the application.
 
     If you wish to extend the capabilities of wxBitmap, derive a class from

-    wxBitmapHandler and add the handler using wxBitmap::AddHandler in your
+    wxBitmapHandler and add the handler using wxBitmap::AddHandler() in your

     application initialisation.
 
     @library{wxcore}
     application initialisation.
 
     @library{wxcore}


@@ -43,7 +43,7 @@ public:
     /**
         Destroys the wxBitmapHandler object.
     */
     /**
         Destroys the wxBitmapHandler object.
     */

-    ~wxBitmapHandler();
+    virtual ~wxBitmapHandler();

 
     /**
         Creates a bitmap from the given data, which can be of arbitrary type.
 
     /**
         Creates a bitmap from the given data, which can be of arbitrary type.


@@ -67,7 +67,7 @@ public:
         @returns @true if the call succeeded, @false otherwise (the default).
     */
     virtual bool Create(wxBitmap* bitmap, const void* data, wxBitmapType type,
         @returns @true if the call succeeded, @false otherwise (the default).
     */
     virtual bool Create(wxBitmap* bitmap, const void* data, wxBitmapType type,

-                        int width, int height, int depth = wxBITMAP_SCREEN_DEPTH);
+                        int width, int height, int depth = 1);

 
     /**
         Gets the file extension associated with this handler.
 
     /**
         Gets the file extension associated with this handler.


@@ -95,12 +95,17 @@ public:
             The meaning of name is determined by the type parameter.
         @param type
             See ::wxBitmapType for values this can take.
             The meaning of name is determined by the type parameter.
         @param type
             See ::wxBitmapType for values this can take.

+        @param desiredWidth
+            The desired width for the loaded bitmap.
+        @param desiredHeight
+            The desired height for the loaded bitmap.

 
         @returns @true if the operation succeeded, @false otherwise.
 
         @see wxBitmap::LoadFile, wxBitmap::SaveFile, SaveFile()
     */
 
         @returns @true if the operation succeeded, @false otherwise.
 
         @see wxBitmap::LoadFile, wxBitmap::SaveFile, SaveFile()
     */

-    bool LoadFile(wxBitmap* bitmap, const wxString& name, wxBitmapType type);
+    virtual bool LoadFile(wxBitmap* bitmap, const wxString& name, wxBitmapType type,
+                          int desiredWidth, int desiredHeight);

 
     /**
         Saves a bitmap in the named file.
 
     /**
         Saves a bitmap in the named file.


@@ -118,8 +123,8 @@ public:
 
         @see wxBitmap::LoadFile, wxBitmap::SaveFile, LoadFile()
     */
 
         @see wxBitmap::LoadFile, wxBitmap::SaveFile, LoadFile()
     */

-    bool SaveFile(wxBitmap* bitmap, const wxString& name, wxBitmapType type,
-                  wxPalette* palette = NULL);
+    virtual bool SaveFile(const wxBitmap* bitmap, const wxString& name, wxBitmapType type,
+                          const wxPalette* palette = NULL) const;

 
     /**
         Sets the handler extension.
 
     /**
         Sets the handler extension.


@@ -218,7 +223,7 @@ public:
     wxBitmap(const void* data, int type, int width, int height, int depth = -1);
 
 
     wxBitmap(const void* data, int type, int width, int height, int depth = -1);
 
 

-        NOTE: this ctor is not implemented by all port, is somewhat useless
+        NOTE: this ctor is not implemented by all ports, is somewhat useless

               without further description of the "data" supported formats and
               uses 'int type' instead of wxBitmapType, so don't document it.
     */
               without further description of the "data" supported formats and
               uses 'int type' instead of wxBitmapType, so don't document it.
     */


@@ -249,6 +254,7 @@ public:
     /**
         Creates a new bitmap. A depth of ::wxBITMAP_SCREEN_DEPTH indicates the
         depth of the current screen or visual.
     /**
         Creates a new bitmap. A depth of ::wxBITMAP_SCREEN_DEPTH indicates the
         depth of the current screen or visual.

+

         Some platforms only support 1 for monochrome and ::wxBITMAP_SCREEN_DEPTH for
         the current colour setting.
 
         Some platforms only support 1 for monochrome and ::wxBITMAP_SCREEN_DEPTH for
         the current colour setting.
 


@@ -311,7 +317,7 @@ public:
         @warning
         Do not delete a bitmap that is selected into a memory device context.
     */
         @warning
         Do not delete a bitmap that is selected into a memory device context.
     */

-    ~wxBitmap();
+    virtual ~wxBitmap();

 
     /**
         Adds a handler to the end of the static list of format handlers.
 
     /**
         Adds a handler to the end of the static list of format handlers.


@@ -335,12 +341,12 @@ public:
         mask information so that bitmaps and images can be converted back
         and forth without loss in that respect.
     */
         mask information so that bitmaps and images can be converted back
         and forth without loss in that respect.
     */

-    wxImage ConvertToImage();
+    virtual wxImage ConvertToImage() const;

 
     /**
         Creates the bitmap from an icon.
     */
 
     /**
         Creates the bitmap from an icon.
     */

-    bool CopyFromIcon(const wxIcon& icon);
+    virtual bool CopyFromIcon(const wxIcon& icon);

 
     /**
         Creates a fresh bitmap.
 
     /**
         Creates a fresh bitmap.


@@ -412,7 +418,7 @@ public:
         Gets the colour depth of the bitmap.
         A value of 1 indicates a monochrome bitmap.
     */
         Gets the colour depth of the bitmap.
         A value of 1 indicates a monochrome bitmap.
     */

-    int GetDepth() const;
+    virtual int GetDepth() const;

 
     /**
         Returns the static list of bitmap format handlers.
 
     /**
         Returns the static list of bitmap format handlers.


@@ -424,7 +430,7 @@ public:
     /**
         Gets the height of the bitmap in pixels.
     */
     /**
         Gets the height of the bitmap in pixels.
     */

-    int GetHeight() const;
+    virtual int GetHeight() const;

 
     /**
         Gets the associated mask (if any) which may have been loaded from a file
 
     /**
         Gets the associated mask (if any) which may have been loaded from a file


@@ -432,7 +438,7 @@ public:
 
         @see SetMask(), wxMask
     */
 
         @see SetMask(), wxMask
     */

-    wxMask* GetMask() const;
+    virtual wxMask* GetMask() const;

 
     /**
         Gets the associated palette (if any) which may have been loaded from a file
 
     /**
         Gets the associated palette (if any) which may have been loaded from a file


@@ -440,20 +446,20 @@ public:
 
         @see wxPalette
     */
 
         @see wxPalette
     */

-    wxPalette* GetPalette() const;
+    virtual wxPalette* GetPalette() const;

 
     /**
         Returns a sub bitmap of the current one as long as the rect belongs entirely to
         the bitmap. This function preserves bit depth and mask information.
     */
 
     /**
         Returns a sub bitmap of the current one as long as the rect belongs entirely to
         the bitmap. This function preserves bit depth and mask information.
     */

-    wxBitmap GetSubBitmap(const wxRect& rect) const;
+    virtual wxBitmap GetSubBitmap(const wxRect& rect) const;

 
     /**
         Gets the width of the bitmap in pixels.
 
         @see GetHeight()
     */
 
     /**
         Gets the width of the bitmap in pixels.
 
         @see GetHeight()
     */

-    int GetWidth() const;
+    virtual int GetWidth() const;

 
     /**
         Adds the standard bitmap format handlers, which, depending on wxWidgets
 
     /**
         Adds the standard bitmap format handlers, which, depending on wxWidgets


@@ -501,7 +507,7 @@ public:
 
         @see SaveFile()
     */
 
         @see SaveFile()
     */

-    bool LoadFile(const wxString& name, wxBitmapType type);
+    virtual bool LoadFile(const wxString& name, wxBitmapType type);

 
     /**
         Finds the handler with the given name, and removes it.
 
     /**
         Finds the handler with the given name, and removes it.


@@ -534,8 +540,8 @@ public:
 
         @see LoadFile()
     */
 
         @see LoadFile()
     */

-    bool SaveFile(const wxString& name, wxBitmapType type,
-                  const wxPalette* palette = NULL);
+    virtual bool SaveFile(const wxString& name, wxBitmapType type,
+                          const wxPalette* palette = NULL) const;

 
     /**
         Sets the depth member (does not affect the bitmap data).
 
     /**
         Sets the depth member (does not affect the bitmap data).


@@ -546,7 +552,7 @@ public:
         @param depth
             Bitmap depth.
     */
         @param depth
             Bitmap depth.
     */

-    void SetDepth(int depth);
+    virtual void SetDepth(int depth);

 
     /**
         Sets the height member (does not affect the bitmap data).
 
     /**
         Sets the height member (does not affect the bitmap data).


@@ -554,7 +560,7 @@ public:
         @param height
             Bitmap height in pixels.
     */
         @param height
             Bitmap height in pixels.
     */

-    void SetHeight(int height);
+    virtual void SetHeight(int height);

 
     /**
         Sets the mask for this bitmap.
 
     /**
         Sets the mask for this bitmap.


@@ -563,7 +569,7 @@ public:
 
         @see GetMask(), wxMask
     */
 
         @see GetMask(), wxMask
     */

-    void SetMask(wxMask* mask);
+    virtual void SetMask(wxMask* mask);

 
     /**
         Sets the associated palette. (Not implemented under GTK+).
 
     /**
         Sets the associated palette. (Not implemented under GTK+).


@@ -573,7 +579,7 @@ public:
 
         @see wxPalette
     */
 
         @see wxPalette
     */

-    void SetPalette(const wxPalette& palette);
+    virtual void SetPalette(const wxPalette& palette);

 
     /**
         Sets the width member (does not affect the bitmap data).
 
     /**
         Sets the width member (does not affect the bitmap data).


@@ -581,15 +587,7 @@ public:
         @param width
             Bitmap width in pixels.
     */
         @param width
             Bitmap width in pixels.
     */

-    void SetWidth(int width);
-
-    /**
-        Assignment operator, using @ref overview_refcount "reference counting".
-
-        @param bitmap
-            Bitmap to assign.
-    */
-    wxBitmap operator =(const wxBitmap& bitmap);
+    virtual void SetWidth(int width);

 };
 
 /**
 };
 
 /**


@@ -657,7 +655,7 @@ public:
     /**
         Destroys the wxMask object and the underlying bitmap data.
     */
     /**
         Destroys the wxMask object and the underlying bitmap data.
     */

-    ~wxMask();
+    virtual ~wxMask();

 
     /**
         Constructs a mask from a bitmap and a palette index that indicates the
 
     /**
         Constructs a mask from a bitmap and a palette index that indicates the