Correct wxID_SEPARATOR description in menu documentation.

[wxWidgets.git] / interface / wx / iconbndl.h

diff --git a/interface/wx/iconbndl.h b/interface/wx/iconbndl.h
index 0b4335242a76d503afb57a313f2f918b9d78ad0c..e242d695c46d67aecfb340fb2f437ece5d5202d7 100644 (file)
--- a/interface/wx/iconbndl.h
+++ b/interface/wx/iconbndl.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxIconBundle
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 /**
@@ -29,7 +29,18 @@ public:
     /**
         Initializes the bundle with the icon(s) found in the file.
     */
-    wxIconBundle(const wxString& file, wxBitmapType type);
+    wxIconBundle(const wxString& file, wxBitmapType type = wxBITMAP_TYPE_ANY);
+
+    /**
+        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);
 
     /**
         Initializes the bundle with a single icon.
@@ -47,11 +58,24 @@ public:
     virtual ~wxIconBundle();
 
     /**
-        Adds all the icons contained in the file to the bundle; if the collection
-        already contains icons with the same width and height, they are replaced
-        by the new ones.
+        Adds all the icons contained in the file to the bundle; if the
+        collection already contains icons with the same width and height, they
+        are replaced by the new ones.
+    */
+    void AddIcon(const wxString& file, wxBitmapType type = wxBITMAP_TYPE_ANY);
+
+    /**
+        Adds all the icons contained in the stream to the bundle; if the
+        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(const wxString& file, wxBitmapType type);
+    void AddIcon(wxInputStream& stream, wxBitmapType type = wxBITMAP_TYPE_ANY);
 
     /**
         Adds the icon to the collection; if the collection already
@@ -73,7 +97,7 @@ public:
     /**
         Same as @code GetIcon( wxSize( size, size ) ) @endcode.
     */
-    const wxIcon  GetIcon(wxCoord size = -1) const;
+    wxIcon GetIcon(wxCoord size = wxDefaultCoord) const;
 
     /**
         Returns the icon with exactly the given size or ::wxNullIcon if this