document effect of loading an icon bundle on stream position

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@60906 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/interface/wx/iconbndl.h b/interface/wx/iconbndl.h
index aecfe287f5976907922ad7b42659d9fdeb1890bf..49609c12f78b578c5c4c73eb5dd74c6154606b08 100644 (file)
--- a/interface/wx/iconbndl.h
+++ b/interface/wx/iconbndl.h
@@ -34,6 +34,10 @@ public:
     /**
         Initializes the bundle with the icon(s) found in the stream.
 
     /**
         Initializes the bundle with the icon(s) found in the stream.
 

+        Notice that the @a stream must be seekable, at least if it contains
+        more than one icon. The stream pointer is positioned after the last
+        icon read from the stream when this function returns.
+

         @since 2.9.0
     */
     wxIconBundle(wxInputStream& stream, wxBitmapType type = wxBITMAP_TYPE_ANY);
         @since 2.9.0
     */
     wxIconBundle(wxInputStream& stream, wxBitmapType type = wxBITMAP_TYPE_ANY);


@@ -65,6 +69,10 @@ public:
         collection already contains icons with the same width and height, they
         are replaced by the new ones.
 
         collection already contains icons with the same width and height, they
         are replaced by the new ones.
 

+        Notice that, as well as in the constructor loading the icon bundle from
+        stream, the @a stream must be seekable, at least if more than one icon
+        is to be loaded from it.
+

         @since 2.9.0
     */
     void AddIcon(wxInputStream& stream, wxBitmapType type = wxBITMAP_TYPE_ANY);
         @since 2.9.0
     */
     void AddIcon(wxInputStream& stream, wxBitmapType type = wxBITMAP_TYPE_ANY);