fix few doxygen warnings

[wxWidgets.git] / interface / wx / bitmap.h

diff --git a/interface/wx/bitmap.h b/interface/wx/bitmap.h
index 1bcf959e19af98c378fab2c040e562b82ee5b045..b0a215917ee9024b92482f2f955da99e04137b43 100644 (file)
--- a/interface/wx/bitmap.h
+++ b/interface/wx/bitmap.h
@@ -14,7 +14,6 @@
 
 /**
     @class wxBitmapHandler
-    @wxheader{bitmap.h}
 
     This is the base class for implementing bitmap file loading/saving, and
     bitmap creation from data.
@@ -24,6 +23,11 @@
     wxBitmapHandler and add the handler using wxBitmap::AddHandler() in your
     application initialisation.
 
+    Note that all wxBitmapHandlers provided by wxWidgets are part of the
+    @ref page_libs_wxcore library.
+    For details about the default handlers, please see the note in the
+    wxBitmap class documentation.
+
     @library{wxcore}
     @category{misc}
 
@@ -154,11 +158,10 @@ public:
 
 /**
     @class wxBitmap
-    @wxheader{bitmap.h}
 
     This class encapsulates the concept of a platform-dependent bitmap,
     either monochrome or colour or colour with alpha channel support.
-    
+
     If you need direct access the bitmap data instead going through
     drawing to it using wxMemoryDC you need to use the wxPixelData
     class (either wxNativePixelData for RGB bitmaps or wxAlphaPixelData
@@ -281,10 +284,13 @@ public:
         @param type
             May be one of the ::wxBitmapType values and indicates which type of
             bitmap should be loaded. See the note in the class detailed description.
+            Note that the wxBITMAP_DEFAULT_TYPE constant has different value under
+            different wxWidgets ports. See the bitmap.h header for the value it takes
+            for a specific port.
 
         @see LoadFile()
     */
-    wxBitmap(const wxString& name, wxBitmapType type = wxBITMAP_TYPE_XPM);
+    wxBitmap(const wxString& name, wxBitmapType type = wxBITMAP_DEFAULT_TYPE);
 
     /**
         Creates this bitmap object from the given image.
@@ -430,10 +436,12 @@ public:
 
         @see wxBitmapHandler
     */
-    static wxList GetHandlers();
+    static wxList& GetHandlers();
 
     /**
         Gets the height of the bitmap in pixels.
+
+        @see GetWidth(), GetSize()
     */
     virtual int GetHeight() const;
 
@@ -459,10 +467,19 @@ public:
     */
     virtual wxBitmap GetSubBitmap(const wxRect& rect) const;
 
+    /**
+        Returns the size of the bitmap in pixels.
+
+        @since 2.9.0
+
+        @see GetHeight(), GetWidth()
+    */
+    wxSize GetSize() const;
+
     /**
         Gets the width of the bitmap in pixels.
 
-        @see GetHeight()
+        @see GetHeight(), GetSize()
     */
     virtual int GetWidth() const;
 
@@ -491,7 +508,7 @@ public:
     /**
         Returns @true if bitmap data is present.
     */
-    bool IsOk() const;
+    virtual bool IsOk() const;
 
     /**
         Loads a bitmap from a file or resource.
@@ -502,6 +519,9 @@ public:
         @param type
             One of the ::wxBitmapType values; see the note in the class
             detailed description.
+            Note that the wxBITMAP_DEFAULT_TYPE constant has different value under
+            different wxWidgets ports. See the bitmap.h header for the value it takes
+            for a specific port.
 
         @return @true if the operation succeeded, @false otherwise.
 
@@ -512,7 +532,7 @@ public:
 
         @see SaveFile()
     */
-    virtual bool LoadFile(const wxString& name, wxBitmapType type);
+    virtual bool LoadFile(const wxString& name, wxBitmapType type = wxBITMAP_DEFAULT_TYPE);
 
     /**
         Finds the handler with the given name, and removes it.
@@ -605,7 +625,6 @@ wxBitmap wxNullBitmap;
 
 /**
     @class wxMask
-    @wxheader{bitmap.h}
 
     This class encapsulates a monochrome mask bitmap, where the masked area is
     black and the unmasked area is white.