From: Robin Dunn Date: Thu, 12 Apr 2007 00:49:47 +0000 (+0000) Subject: update wx.IconBundle methods and docstrings X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/e1a45892630ddad847b3b1c2b799370dc1190697?ds=inline update wx.IconBundle methods and docstrings git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@45420 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- diff --git a/wxPython/src/_icon.i b/wxPython/src/_icon.i index 0e3ff73d7a..072b8119a9 100644 --- a/wxPython/src/_icon.i +++ b/wxPython/src/_icon.i @@ -155,22 +155,53 @@ public: ~wxIconBundle(); - // adds the icon to the collection, if the collection already - // contains an icon with the same width and height, it is - // replaced - void AddIcon( const wxIcon& icon ); - - // 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 - %Rename(AddIconFromFile,void, AddIcon( const wxString& file, long type )); - - // 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 - const wxIcon& GetIcon( const wxSize& size ) const; - - %property(Icon, GetIcon, doc="See `GetIcon`"); + virtual bool IsOk() const; + %pythoncode { def __nonzero__(self): return self.IsOk() } + + + DocDeclStr( + void , AddIcon( const wxIcon& icon ), + "Adds the icon to the collection, if the collection already contains an +icon with the same width and height, it is replaced", ""); + + + DocDeclStrName( + void , AddIcon( const wxString& file, long type ), + "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", "", + AddIconFromFile); + + + DocDeclStr( + const wxIcon& , GetIcon( const wxSize& size ) const, + "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", ""); + + + + DocDeclStr( + wxIcon , GetIconOfExactSize(const wxSize& size) const, + "Returns the icon exactly of the specified size or wxNullIcon if no +icon of exactly given size are available.", ""); + + + + DocDeclStr( + size_t , GetIconCount() const, + "return the number of available icons", ""); + + + DocDeclStr( + wxIcon , GetIconByIndex(size_t n) const, + "Return the icon at index (must be < GetIconCount())", ""); + + + DocDeclStr( + bool , IsEmpty() const, + "Check if we have any icons at all", ""); + }; //---------------------------------------------------------------------------