interface header revisions

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

interface/wx/bitmap.h

@@ -23,6 +23,11 @@
     wxBitmapHandler and add the handler using wxBitmap::AddHandler() in your
     application initialisation.
 
+    Note that all wxBitmapHandlers provided by wxWidgets are part of the
+    @ref page_libs_wxcore library.
+    For details about the default handlers, please see the note in the
+    wxBitmap class documentation.
+
     @library{wxcore}
     @category{misc}
 

interface/wx/iconbndl.h

@@ -9,12 +9,11 @@
 /**
     @class wxIconBundle
 
-    This class contains multiple copies of an icon in different sizes,
+    This class contains multiple copies of an icon in different sizes.
-    see also wxDialog::SetIcons and
+    It is typically used in wxDialog::SetIcons and wxTopLevelWindow::SetIcons.
-    wxTopLevelWindow::SetIcons.
 
     @library{wxcore}
-    @category{FIXME}
+    @category{gdi}
 
     @stdobjects
     ::wxNullIconBundle
@@ -22,54 +21,75 @@
 class wxIconBundle : public wxGDIObject
 {
 public:
-    //@{
+    /**
+        Default ctor.
+    */
+    wxIconBundle();
+
+    /**
+        Initializes the bundle with the icon(s) found in the file.
+    */
+    wxIconBundle(const wxString& file, wxBitmapType type);
+
+    /**
+        Initializes the bundle with a single icon.
+    */
+    wxIconBundle(const wxIcon& icon);
+
     /**
         Copy constructor.
     */
-    wxIconBundle();
-    wxIconBundle(const wxString& file, wxBitmapType type);
-    wxIconBundle(const wxIcon& icon);
     wxIconBundle(const wxIconBundle& ic);
-    //@}
 
     /**
         Destructor.
     */
     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.
+    */
+    void AddIcon(const wxString& file, wxBitmapType type);
+
     /**
         Adds the icon to the collection; if the collection already
         contains an icon with the same width and height, it is
         replaced by the new one.
     */
-    void AddIcon(const wxString& file, wxBitmapType type);
     void AddIcon(const wxIcon& icon);
-    //@}
 
-    //@{
     /**
-        Same as GetIcon( wxSize( size, size ) ).
+        Returns the icon with the given size; if no such icon exists, returns
+        the icon with size @c wxSYS_ICON_X and @c wxSYS_ICON_Y; if no such icon
+        exists, returns the first icon in the bundle.
+
+        If size = wxDefaultSize, returns the icon with size @c wxSYS_ICON_X and
+        @c wxSYS_ICON_Y.
     */
     wxIcon GetIcon(const wxSize& size) const;
-    const wxIcon  GetIcon(wxCoord size = -1) const;
-    //@}
 
     /**
-        Returns the icon with exactly the given size or @c wxNullIcon if this
+        Same as @code GetIcon( wxSize( size, size ) ) @endcode.
+    */
+    const wxIcon  GetIcon(wxCoord size = -1) const;
+
+    /**
+        Returns the icon with exactly the given size or ::wxNullIcon if this
         size is not available.
     */
     wxIcon GetIconOfExactSize(const wxSize& size) const;
 
     /**
-        Returns @true if the bundle doesn't contain any icons, @false otherwise (in
+        Returns @true if the bundle doesn't contain any icons, @false otherwise
-        which case a call to GetIcon() with default
+        (in which case a call to GetIcon() with default parameter should return
-        parameter should return a valid icon).
+        a valid icon).
     */
     bool IsEmpty() const;
 
     /**
-        Assignment operator, using @ref overview_trefcount "reference counting".
+        Assignment operator, using @ref overview_refcount "reference counting".
     */
     wxIconBundle operator =(const wxIconBundle& ic);
 
@@ -77,6 +97,11 @@ public:
         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);
 };
 
 

interface/wx/iconloc.h

@@ -22,7 +22,7 @@
     a wxIcon from it.
 
     @library{wxbase}
-    @category{FIXME}
+    @category{gdi}
 
     @see wxIcon, wxFileType::GetIcon
 */