]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/wx/bitmap.h
document Connect(host, port) overload
[wxWidgets.git] / interface / wx / bitmap.h
index 1bcf959e19af98c378fab2c040e562b82ee5b045..ef1996453ca5aa229cee54f931e1c1fad233f6af 100644 (file)
@@ -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.
@@ -154,11 +153,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 +279,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.
@@ -502,6 +503,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 +516,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 +609,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.