/////////////////////////////////////////////////////////////////////////////
// Name: bitmap.h
-// Purpose: documentation for wxBitmapHandler class
+// Purpose: interface of wxBitmapHandler
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
@class wxBitmapHandler
@wxheader{bitmap.h}
- Overview
+ Overview()
This is the base class for implementing bitmap file loading/saving, and bitmap
creation from data.
@library{wxcore}
@category{FIXME}
- @seealso
- wxBitmap, wxIcon, wxCursor
+ @see wxBitmap, wxIcon, wxCursor
*/
class wxBitmapHandler : public wxObject
{
/**
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
};
+
/**
@class wxBitmap
@wxheader{bitmap.h}
@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
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.
/**
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
@see SetMask(), wxMask
*/
- wxMask* GetMask();
+ wxMask* GetMask() const;
/**
Gets the associated palette (if any) which may have been loaded from a file
@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
/**
Returns @true if bitmap data is present.
*/
- bool IsOk();
+ bool IsOk() const;
/**
Loads a bitmap from a file or resource.
};
+/**
+ FIXME
+*/
+wxBitmap Objects:
+;
+
+/**
+ FIXME
+*/
+wxBitmap wxNullBitmap;
+
+
+
+
/**
@class wxMask
@wxheader{bitmap.h}
@library{wxcore}
@category{gdi}
- @seealso
- wxBitmap, wxDC::Blit, wxMemoryDC
+ @see wxBitmap, wxDC::Blit, wxMemoryDC
*/
class wxMask : public wxObject
{
bool Create(const wxBitmap& bitmap, int index);
//@}
};
+