clarify the list of bitmap handlers natively supported.
Clarify that wxBitmap::AddHandler isn't useful to the final user; wxImage::AddHandler should be used instead. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@59304 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -21,7 +21,7 @@
|
|||||||
|
|
||||||
If you wish to extend the capabilities of wxBitmap, derive a class from
|
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.
|
application initialization.
|
||||||
|
|
||||||
Note that all wxBitmapHandlers provided by wxWidgets are part of the
|
Note that all wxBitmapHandlers provided by wxWidgets are part of the
|
||||||
@ref page_libs_wxcore library.
|
@ref page_libs_wxcore library.
|
||||||
@@ -167,17 +167,21 @@ public:
|
|||||||
class (either wxNativePixelData for RGB bitmaps or wxAlphaPixelData
|
class (either wxNativePixelData for RGB bitmaps or wxAlphaPixelData
|
||||||
for bitmaps with an additionaly alpha channel).
|
for bitmaps with an additionaly alpha channel).
|
||||||
|
|
||||||
@note
|
Note that many wxBitmap functions take a @e type parameter, which is a
|
||||||
Many wxBitmap functions take a @e type parameter, which is a value of the
|
value of the ::wxBitmapType enumeration.
|
||||||
::wxBitmapType enumeration.
|
|
||||||
The validity of those values depends however on the platform where your program
|
The validity of those values depends however on the platform where your program
|
||||||
is running and from the wxWidgets configuration.
|
is running and from the wxWidgets configuration.
|
||||||
If all possible wxWidgets settings are used, the Windows platform supports BMP file,
|
If all possible wxWidgets settings are used:
|
||||||
BMP resource, XPM data, and XPM.
|
- wxMSW supports BMP and ICO files, BMP and ICO resources;
|
||||||
Under wxGTK, the available formats are BMP file, XPM data, XPM file, and PNG file.
|
- wxGTK supports XPM files;
|
||||||
Under wxMotif, the available formats are XBM data, XBM file, XPM data, XPM file.
|
- wxMac supports PICT resources;
|
||||||
In addition, wxBitmap can load and save all formats that wxImage; see wxImage for
|
- wxX11 supports XPM files, XPM data, XBM data;
|
||||||
more info. Of course, you must have wxImage handlers loaded.
|
|
||||||
|
In addition, wxBitmap can load and save all formats that wxImage can; see wxImage
|
||||||
|
for more info. Of course, you must have loaded the wxImage handlers
|
||||||
|
(see ::wxInitAllImageHandlers() and wxImage::AddHandler).
|
||||||
|
Note that all available wxBitmapHandlers for a given wxWidgets port are
|
||||||
|
automatically loaded at startup so you won't need to use wxBitmap::AddHandler.
|
||||||
|
|
||||||
@library{wxcore}
|
@library{wxcore}
|
||||||
@category{gdi}
|
@category{gdi}
|
||||||
@@ -337,6 +341,14 @@ public:
|
|||||||
A new bitmap format handler object. There is usually only one instance
|
A new bitmap format handler object. There is usually only one instance
|
||||||
of a given handler class in an application session.
|
of a given handler class in an application session.
|
||||||
|
|
||||||
|
Note that unlike wxImage::AddHandler, there's no documented list of
|
||||||
|
the wxBitmapHandlers available in wxWidgets.
|
||||||
|
This is because they are platform-specific and most important, they are
|
||||||
|
all automatically loaded at startup.
|
||||||
|
|
||||||
|
If you want to be sure that wxBitmap can load a certain type of image,
|
||||||
|
you'd better use wxImage::AddHandler.
|
||||||
|
|
||||||
@see wxBitmapHandler
|
@see wxBitmapHandler
|
||||||
*/
|
*/
|
||||||
static void AddHandler(wxBitmapHandler* handler);
|
static void AddHandler(wxBitmapHandler* handler);
|
||||||
|
@@ -44,7 +44,7 @@ enum wxImagePNGType
|
|||||||
|
|
||||||
If you wish to extend the capabilities of wxImage, derive a class from
|
If you wish to extend the capabilities of wxImage, derive a class from
|
||||||
wxImageHandler and add the handler using wxImage::AddHandler in your
|
wxImageHandler and add the handler using wxImage::AddHandler in your
|
||||||
application initialisation.
|
application initialization.
|
||||||
|
|
||||||
Note that all wxImageHandlers provided by wxWidgets are part of
|
Note that all wxImageHandlers provided by wxWidgets are part of
|
||||||
the @ref page_libs_wxcore library.
|
the @ref page_libs_wxcore library.
|
||||||
@@ -457,6 +457,7 @@ public:
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
Register an image handler.
|
Register an image handler.
|
||||||
|
See @ref image_handlers for a list of the available handlers.
|
||||||
*/
|
*/
|
||||||
static void AddHandler(wxImageHandler* handler);
|
static void AddHandler(wxImageHandler* handler);
|
||||||
|
|
||||||
@@ -1517,6 +1518,7 @@ wxImage wxNullImage;
|
|||||||
/**
|
/**
|
||||||
Initializes all available image handlers. For a list of available handlers,
|
Initializes all available image handlers. For a list of available handlers,
|
||||||
see wxImage.
|
see wxImage.
|
||||||
|
If you don't need/want all image handlers loaded
|
||||||
|
|
||||||
@see wxImage, wxImageHandler
|
@see wxImage, wxImageHandler
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user