improved wxImage documentation.

moved description of wxIMAGE_OPTION_GIF_COMMENT from wxImage::GetOptionInt documentation to wxImage::GetOption because the value of the GIF option is a string, not int.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@68779 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Dimitri Schoolwerth
2011-08-19 01:13:16 +00:00
parent 7a10e465ca
commit 6f54591185

View File

@@ -1084,10 +1084,16 @@ public:
/** /**
Gets a user-defined string-valued option. Gets a user-defined string-valued option.
Currently the only defined string option is Generic options:
@li @c wxIMAGE_OPTION_FILENAME: The name of the file from which the image @li @c wxIMAGE_OPTION_FILENAME: The name of the file from which the image
was loaded. was loaded.
Options specific to wxGIFHandler:
@li @c wxIMAGE_OPTION_GIF_COMMENT: The comment text that is read from
or written to the GIF file. In an animated GIF each frame can have
its own comment. If there is only a comment in the first frame of
a GIF it will not be repeated in other frames.
@param name @param name
The name of the option, case-insensitive. The name of the option, case-insensitive.
@return @return
@@ -1162,12 +1168,6 @@ public:
the resulting PNG file. Use this option if your application produces the resulting PNG file. Use this option if your application produces
images with small size variation. images with small size variation.
Options specific to wxGIFHandler:
@li @c wxIMAGE_OPTION_GIF_COMMENT: The comment text that is read from
or written to the GIF file. In an animated GIF each frame can have
its own comment. If there is only a comment in the first frame of
a GIF it will not be repeated in other frames.
@param name @param name
The name of the option, case-insensitive. The name of the option, case-insensitive.
@return @return