Fixed some function/define paramter names to match old docs.

[wxWidgets.git] / interface / iconbndl.h

diff --git a/interface/iconbndl.h b/interface/iconbndl.h
index 031e4f79c472665d9ec4a82cc5a608f75647866c..1ac83d47c51658f57faa9c1fb6eb730a522570f4 100644 (file)
--- a/interface/iconbndl.h
+++ b/interface/iconbndl.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        iconbndl.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        iconbndl.h

-// Purpose:     documentation for wxIconBundle class
+// Purpose:     interface of wxIconBundle

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license


@@ -9,16 +9,16 @@
 /**
     @class wxIconBundle
     @wxheader{iconbndl.h}
 /**
     @class wxIconBundle
     @wxheader{iconbndl.h}

-    
+

     This class contains multiple copies of an icon in different sizes,
     see also wxDialog::SetIcons and
     wxTopLevelWindow::SetIcons.
     This class contains multiple copies of an icon in different sizes,
     see also wxDialog::SetIcons and
     wxTopLevelWindow::SetIcons.

-    
+

     @library{wxcore}
     @category{FIXME}
     @library{wxcore}
     @category{FIXME}

-    
+

     @stdobjects
     @stdobjects

-    wxNullIconBundle
+    ::wxNullIconBundle,

 */
 class wxIconBundle : public wxGDIObject
 {
 */
 class wxIconBundle : public wxGDIObject
 {


@@ -28,9 +28,9 @@ public:
         Copy constructor.
     */
     wxIconBundle();
         Copy constructor.
     */
     wxIconBundle();

-        wxIconBundle(const wxString& file, long type);
-        wxIconBundle(const wxIcon& icon);
-        wxIconBundle(const wxIconBundle& ic);
+    wxIconBundle(const wxString& file, long type);
+    wxIconBundle(const wxIcon& icon);
+    wxIconBundle(const wxIconBundle& ic);

     //@}
 
     /**
     //@}
 
     /**


@@ -45,29 +45,29 @@ public:
         replaced by the new one.
     */
     void AddIcon(const wxString& file, long type);
         replaced by the new one.
     */
     void AddIcon(const wxString& file, long type);

-        void AddIcon(const wxIcon& icon);
+    void AddIcon(const wxIcon& icon);

     //@}
 
     //@{
     /**
         Same as GetIcon( wxSize( size, size ) ).
     */
     //@}
 
     //@{
     /**
         Same as GetIcon( wxSize( size, size ) ).
     */

-    wxIcon GetIcon(const wxSize& size);
-        wxIcon GetIcon(wxCoord size = -1);
+    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
         size is not available.
     */
     //@}
 
     /**
         Returns the icon with exactly the given size or @c wxNullIcon if this
         size is not available.
     */

-    wxIcon GetIconOfExactSize(const wxSize& size);
+    wxIcon GetIconOfExactSize(const wxSize& size) 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 a valid icon).
     */
 
     /**
         Returns @true if the bundle doesn't contain any icons, @false otherwise (in
         which case a call to GetIcon() with default
         parameter should return a valid icon).
     */

-    bool IsEmpty();
+    bool IsEmpty() const;

 
     /**
         Assignment operator, using @ref overview_trefcount "reference counting".
 
     /**
         Assignment operator, using @ref overview_trefcount "reference counting".


@@ -79,3 +79,11 @@ public:
     */
     bool operator ==(const wxIconBundle& ic);
 };
     */
     bool operator ==(const wxIconBundle& ic);
 };

+
+
+/**
+    FIXME
+*/
+wxIconBundle wxNullIconBundle;
+
+