synchronize GTK2 minimum version in docs

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

diff --git a/include/wx/iconbndl.h b/include/wx/iconbndl.h
index 8af8773a59d7f15a25c0cd2ccd12c9b691cc5db4..0955e716546bee1d6b3409fbf83c7ad4a0a5764c 100644 (file)
--- a/include/wx/iconbndl.h
+++ b/include/wx/iconbndl.h
@@ -13,8 +13,7 @@
 #define _WX_ICONBNDL_H_
 
 #include "wx/gdiobj.h"
-// for wxSize
-#include "wx/gdicmn.h"
+#include "wx/gdicmn.h"      // for wxSize
 #include "wx/icon.h"
 
 #include "wx/dynarray.h"
@@ -29,14 +28,33 @@ WX_DECLARE_EXPORTED_OBJARRAY(wxIcon, wxIconArray);
 class WXDLLIMPEXP_CORE wxIconBundle : public wxGDIObject
 {
 public:
+    // Flags that determine what happens if GetIcon() doesn't find the icon of
+    // exactly the requested size.
+    enum
+    {
+        // Return invalid icon if exact size is not found.
+        FALLBACK_NONE = 0,
+
+        // Return the icon of the system icon size if exact size is not found.
+        // May be combined with other non-NONE enum elements to determine what
+        // happens if the system icon size is not found neither.
+        FALLBACK_SYSTEM = 1,
+
+        // Return the icon of closest larger size or, if there is no icon of
+        // larger size in the bundle, the closest icon of smaller size.
+        FALLBACK_NEAREST_LARGER = 2
+    };
+
     // default constructor
     wxIconBundle();
 
     // initializes the bundle with the icon(s) found in the file
+#if wxUSE_STREAMS && wxUSE_IMAGE
+#if wxUSE_FFILE || wxUSE_FILE
     wxIconBundle(const wxString& file, wxBitmapType type = wxBITMAP_TYPE_ANY);
-#if wxUSE_STREAMS
+#endif // wxUSE_FFILE || wxUSE_FILE
     wxIconBundle(wxInputStream& stream, wxBitmapType type = wxBITMAP_TYPE_ANY);
-#endif
+#endif // wxUSE_STREAMS && wxUSE_IMAGE
 
     // initializes the bundle with a single icon
     wxIconBundle(const wxIcon& icon);
@@ -46,10 +64,12 @@ public:
     // adds all the icons contained in the file to the collection,
     // if the collection already contains icons with the same
     // width and height, they are replaced
+#if wxUSE_STREAMS && wxUSE_IMAGE
+#if wxUSE_FFILE || wxUSE_FILE
     void AddIcon(const wxString& file, wxBitmapType type = wxBITMAP_TYPE_ANY);
-#if wxUSE_STREAMS
+#endif // wxUSE_FFILE || wxUSE_FILE
     void AddIcon(wxInputStream& stream, wxBitmapType type = wxBITMAP_TYPE_ANY);
-#endif
+#endif // wxUSE_STREAMS && wxUSE_IMAGE
 
     // adds the icon to the collection, if the collection already
     // contains an icon with the same width and height, it is
@@ -57,13 +77,13 @@ public:
     void AddIcon(const wxIcon& icon);
 
     // returns the icon with the given size; if no such icon exists,
-    // returns the icon with size wxSYS_ICON_[XY]; if no such icon exists,
-    // returns the first icon in the bundle
-    wxIcon GetIcon(const wxSize& size) const;
+    // behavior is specified by the flags.
+    wxIcon GetIcon(const wxSize& size, int flags = FALLBACK_SYSTEM) const;
 
     // equivalent to GetIcon(wxSize(size, size))
-    wxIcon GetIcon(wxCoord size = wxDefaultCoord) const
-        { return GetIcon(wxSize(size, size)); }
+    wxIcon GetIcon(wxCoord size = wxDefaultCoord,
+                   int flags = FALLBACK_SYSTEM) const
+        { return GetIcon(wxSize(size, size), flags); }
 
     // returns the icon exactly of the specified size or wxNullIcon if no icon
     // of exactly given size are available
@@ -84,6 +104,7 @@ public:
     bool IsEmpty() const { return GetIconCount() == 0; }
 
 #if WXWIN_COMPATIBILITY_2_8
+#if wxUSE_STREAMS && wxUSE_IMAGE && (wxUSE_FFILE || wxUSE_FILE)
     wxDEPRECATED( void AddIcon(const wxString& file, long type)
         {
             AddIcon(file, (wxBitmapType)type);
@@ -95,6 +116,7 @@ public:
             AddIcon(file, (wxBitmapType)type);
         }
     )
+#endif // wxUSE_STREAMS && wxUSE_IMAGE && (wxUSE_FFILE || wxUSE_FILE)
 #endif // WXWIN_COMPATIBILITY_2_8
 
 protected: