]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/wx/iconbndl.h
Avoid needless second string conversion when adding files to memory FS.
[wxWidgets.git] / interface / wx / iconbndl.h
index aecfe287f5976907922ad7b42659d9fdeb1890bf..28c54ee38cfdb6723ccff11794534c0f834dfdd0 100644 (file)
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxIconBundle
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 /**
@@ -34,6 +34,10 @@ public:
     /**
         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);
@@ -65,6 +69,10 @@ public:
         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);
@@ -97,6 +105,16 @@ public:
     */
     wxIcon GetIconOfExactSize(const wxSize& size) const;
 
+    /**
+       return the number of available icons
+    */
+    size_t GetIconCount() const;
+
+    /**
+       return the icon at index (must be < GetIconCount())
+    */
+    wxIcon GetIconByIndex(size_t n) const;
+
     /**
         Returns @true if the bundle doesn't contain any icons, @false otherwise
         (in which case a call to GetIcon() with default parameter should return
@@ -109,15 +127,6 @@ public:
     */
     wxIconBundle& operator=(const wxIconBundle& ic);
 
-    /**
-        Equality operator. This returns @true if two icon bundles are equal.
-    */
-    bool operator ==(const wxIconBundle& ic);
-
-    /**
-        Inequality operator. This returns true if two icon bundles are not equal.
-    */
-    bool operator !=(const wxIconBundle& ic);
 };