]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/bitmap.h
use a different method to prevent an early size_allocate,
[wxWidgets.git] / interface / bitmap.h
index a8aff7efe0d53d0112b88fb0f5cf2bbc8585edc2..22710d45ca4b552faa01385e9c4e686a14ce3ff5 100644 (file)
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        bitmap.h
-// Purpose:     documentation for wxBitmapHandler class
+// Purpose:     interface of wxBitmapHandler
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -10,7 +10,7 @@
     @class wxBitmapHandler
     @wxheader{bitmap.h}
 
-    Overview
+    Overview()
 
     This is the base class for implementing bitmap file loading/saving, and bitmap
     creation from data.
@@ -24,8 +24,7 @@
     @library{wxcore}
     @category{FIXME}
 
-    @seealso
-    wxBitmap, wxIcon, wxCursor
+    @see wxBitmap, wxIcon, wxCursor
 */
 class wxBitmapHandler : public wxObject
 {
@@ -70,17 +69,17 @@ public:
     /**
         Gets the file extension associated with this handler.
     */
-    const wxString GetExtension();
+    const wxString GetExtension() const;
 
     /**
         Gets the name of this handler.
     */
-    const wxString GetName();
+    const wxString GetName() const;
 
     /**
         Gets the bitmap type associated with this handler.
     */
-    long GetType();
+    long GetType() const;
 
     /**
         Loads a bitmap from a file or resource, putting the resulting data into @e
@@ -145,6 +144,7 @@ public:
 };
 
 
+
 /**
     @class wxBitmap
     @wxheader{bitmap.h}
@@ -156,11 +156,9 @@ public:
     @category{gdi}
 
     @stdobjects
-    Objects:
-    wxNullBitmap
+    ::Objects:, ::wxNullBitmap,
 
-    @seealso
-    @ref overview_wxbitmapoverview "wxBitmap overview", @ref
+    @see @ref overview_wxbitmapoverview "wxBitmap overview", @ref
     overview_supportedbitmapformats "supported bitmap file formats", wxDC::Blit, wxIcon, wxCursor, wxBitmap, wxMemoryDC
 */
 class wxBitmap : public wxGDIObject
@@ -400,7 +398,7 @@ public:
         Gets the colour depth of the bitmap. A value of 1 indicates a
         monochrome bitmap.
     */
-    int GetDepth();
+    int GetDepth() const;
 
     /**
         Returns the static list of bitmap format handlers.
@@ -412,7 +410,7 @@ public:
     /**
         Gets the height of the bitmap in pixels.
     */
-    int GetHeight();
+    int GetHeight() const;
 
     /**
         Gets the associated mask (if any) which may have been loaded from a file
@@ -420,7 +418,7 @@ public:
         
         @see SetMask(), wxMask
     */
-    wxMask* GetMask();
+    wxMask* GetMask() const;
 
     /**
         Gets the associated palette (if any) which may have been loaded from a file
@@ -428,20 +426,20 @@ public:
         
         @see wxPalette
     */
-    wxPalette* GetPalette();
+    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.
     */
-    wxBitmap GetSubBitmap(const wxRect& rect);
+    wxBitmap GetSubBitmap(const wxRect& rect) const;
 
     /**
         Gets the width of the bitmap in pixels.
         
         @see GetHeight()
     */
-    int GetWidth();
+    int GetWidth() const;
 
     /**
         Adds the standard bitmap format handlers, which, depending on wxWidgets
@@ -467,7 +465,7 @@ public:
     /**
         Returns @true if bitmap data is present.
     */
-    bool IsOk();
+    bool IsOk() const;
 
     /**
         Loads a bitmap from a file or resource.
@@ -710,6 +708,20 @@ public:
 };
 
 
+/**
+    FIXME
+*/
+wxBitmap Objects:
+;
+
+/**
+    FIXME
+*/
+wxBitmap wxNullBitmap;
+
+
+
+
 /**
     @class wxMask
     @wxheader{bitmap.h}
@@ -724,8 +736,7 @@ public:
     @library{wxcore}
     @category{gdi}
 
-    @seealso
-    wxBitmap, wxDC::Blit, wxMemoryDC
+    @see wxBitmap, wxDC::Blit, wxMemoryDC
 */
 class wxMask : public wxObject
 {
@@ -773,3 +784,4 @@ public:
     bool Create(const wxBitmap& bitmap, int index);
     //@}
 };
+