cheng/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update wx.IconBundle methods and docstrings

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@45420 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Robin Dunn 2007-04-12 00:49:47 +00:00
parent c533405853
commit e1a4589263
1 changed files with 44 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
wxPython/src/_icon.i
View File

@ -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 );
virtual bool IsOk() const;
%pythoncode { def __nonzero__(self): return self.IsOk() }
// 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 ));
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", "");
// 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;
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", "");
%property(Icon, GetIcon, doc="See `GetIcon`");
};
//---------------------------------------------------------------------------