Fix missing documentation for several GDI functions.

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

diff --git a/include/wx/iconbndl.h b/include/wx/iconbndl.h
index e96b1995472aac7e46f840a67581c330e6131d68..0955e716546bee1d6b3409fbf83c7ad4a0a5764c 100644 (file)
--- a/include/wx/iconbndl.h
+++ b/include/wx/iconbndl.h
@@ -12,47 +12,64 @@
 #ifndef _WX_ICONBNDL_H_
 #define _WX_ICONBNDL_H_
 
 #ifndef _WX_ICONBNDL_H_
 #define _WX_ICONBNDL_H_
 

-#include "wx/dynarray.h"

 #include "wx/gdiobj.h"
 #include "wx/gdiobj.h"

-// for wxSize
-#include "wx/gdicmn.h"
+#include "wx/gdicmn.h"      // for wxSize

 #include "wx/icon.h"
 
 #include "wx/icon.h"
 

-class WXDLLIMPEXP_CORE wxIcon;
-class WXDLLIMPEXP_BASE wxString;
+#include "wx/dynarray.h"

 
 

-class WXDLLEXPORT wxIconBundle;
+class WXDLLIMPEXP_FWD_BASE wxInputStream;

 
 WX_DECLARE_EXPORTED_OBJARRAY(wxIcon, wxIconArray);
 
 // this class can't load bitmaps of type wxBITMAP_TYPE_ICO_RESOURCE,
 // if you need them, you have to load them manually and call
 // wxIconCollection::AddIcon
 
 WX_DECLARE_EXPORTED_OBJARRAY(wxIcon, wxIconArray);
 
 // this class can't load bitmaps of type wxBITMAP_TYPE_ICO_RESOURCE,
 // if you need them, you have to load them manually and call
 // wxIconCollection::AddIcon

-class WXDLLEXPORT wxIconBundle : public wxGDIObject
+class WXDLLIMPEXP_CORE wxIconBundle : public wxGDIObject

 {
 public:
 {
 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
     // default constructor
     wxIconBundle();
 
     // initializes the bundle with the icon(s) found in the file

-    wxIconBundle(const wxString& file, long type);
+#if wxUSE_STREAMS && wxUSE_IMAGE
+#if wxUSE_FFILE || wxUSE_FILE
+    wxIconBundle(const wxString& file, wxBitmapType type = wxBITMAP_TYPE_ANY);
+#endif // wxUSE_FFILE || wxUSE_FILE
+    wxIconBundle(wxInputStream& stream, wxBitmapType type = wxBITMAP_TYPE_ANY);
+#endif // wxUSE_STREAMS && wxUSE_IMAGE

 
     // initializes the bundle with a single icon
     wxIconBundle(const wxIcon& icon);
 
 
     // initializes the bundle with a single icon
     wxIconBundle(const wxIcon& icon);
 

-    // initializes the bundle from another icon bundle
-    wxIconBundle(const wxIconBundle& icon);
-
-    wxIconBundle& operator=(const wxIconBundle& ic)
-        { if ( this != &ic) Ref(ic); return *this; }
-
-    virtual bool IsOk() const;
-
+    // default copy ctor and assignment operator are OK

 
     // 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
 
     // 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

-    void AddIcon(const wxString& file, long type);
+#if wxUSE_STREAMS && wxUSE_IMAGE
+#if wxUSE_FFILE || wxUSE_FILE
+    void AddIcon(const wxString& file, wxBitmapType type = wxBITMAP_TYPE_ANY);
+#endif // wxUSE_FFILE || wxUSE_FILE
+    void AddIcon(wxInputStream& stream, wxBitmapType type = wxBITMAP_TYPE_ANY);
+#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
 
     // adds the icon to the collection, if the collection already
     // contains an icon with the same width and height, it is


@@ -60,13 +77,13 @@ public:
     void AddIcon(const wxIcon& icon);
 
     // returns the icon with the given size; if no such icon exists,
     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))
 
     // 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
 
     // returns the icon exactly of the specified size or wxNullIcon if no icon
     // of exactly given size are available


@@ -86,9 +103,25 @@ public:
     // check if we have any icons at all
     bool IsEmpty() const { return GetIconCount() == 0; }
 
     // check if we have any icons at all
     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);
+        }
+    )
+
+    wxDEPRECATED_CONSTRUCTOR( wxIconBundle (const wxString& file, long type)
+        {
+            AddIcon(file, (wxBitmapType)type);
+        }
+    )
+#endif // wxUSE_STREAMS && wxUSE_IMAGE && (wxUSE_FFILE || wxUSE_FILE)
+#endif // WXWIN_COMPATIBILITY_2_8
+

 protected:
 protected:

-    virtual wxObjectRefData *CreateRefData() const;
-    virtual wxObjectRefData *CloneRefData(const wxObjectRefData *data) const;
+    virtual wxGDIRefData *CreateGDIRefData() const;
+    virtual wxGDIRefData *CloneGDIRefData(const wxGDIRefData *data) const;

 
 private:
     // delete all icons
 
 private:
     // delete all icons