Merge recent wxPython changes from 2.8 branch to HEAD

[wxWidgets.git] / wxPython / src / _icon.i

diff --git a/wxPython/src/_icon.i b/wxPython/src/_icon.i
index bd112d3d98cec215172168b53ed1e917ffbe092d..072b8119a9ac15ebdcd495b86fe84f034927457a 100644 (file)
--- a/wxPython/src/_icon.i
+++ b/wxPython/src/_icon.i
@@ -20,23 +20,27 @@
 //---------------------------------------------------------------------------
 
 
 //---------------------------------------------------------------------------
 
 

+MustHaveApp(wxIcon);
+

 class wxIcon : public wxGDIObject
 {
 public:
 class wxIcon : public wxGDIObject
 {
 public:

-    wxIcon(const wxString& name, long flags,
+    wxIcon(const wxString& name, wxBitmapType type,

            int desiredWidth = -1, int desiredHeight = -1);
     ~wxIcon();
 
     // alternate constructors
            int desiredWidth = -1, int desiredHeight = -1);
     ~wxIcon();
 
     // alternate constructors

-    %name(EmptyIcon) wxIcon();
-    %name(IconFromLocation) wxIcon(const wxIconLocation& loc);
+    %RenameCtor(EmptyIcon, wxIcon());
+    %RenameCtor(IconFromLocation,  wxIcon(const wxIconLocation& loc));

     %extend {
     %extend {

-        %name(IconFromBitmap) wxIcon(const wxBitmap& bmp) {
+        %RenameCtor(IconFromBitmap, wxIcon(const wxBitmap& bmp))
+        {

             wxIcon* icon = new wxIcon();
             icon->CopyFromBitmap(bmp);
             return icon;
         }
             wxIcon* icon = new wxIcon();
             icon->CopyFromBitmap(bmp);
             return icon;
         }

-        %name(IconFromXPMData) wxIcon(PyObject* listOfStrings) {
+        %RenameCtor(IconFromXPMData, wxIcon(PyObject* listOfStrings))
+        {

             char**  cArray = NULL;
             wxIcon* icon;
 
             char**  cArray = NULL;
             wxIcon* icon;
 


@@ -51,15 +55,18 @@ public:
 
     
 #ifndef __WXMAC__
 
     
 #ifndef __WXMAC__

-    bool LoadFile(const wxString& name, long flags);
+    bool LoadFile(const wxString& name, wxBitmapType type);

 #endif
 
     // wxGDIImage methods
 #ifdef __WXMSW__
     long GetHandle();
 #endif
 
     // wxGDIImage methods
 #ifdef __WXMSW__
     long GetHandle();

-    void SetHandle(long handle);
+    %extend {
+        void SetHandle(long handle) { self->SetHandle((WXHANDLE)handle); }
+    }

 #endif
 #endif

-    bool Ok();
+    bool IsOk();
+    %pythoncode { Ok = IsOk }

     int GetWidth();
     int GetHeight();
     int GetDepth();
     int GetWidth();
     int GetHeight();
     int GetDepth();


@@ -71,7 +78,12 @@ public:
 #endif
     void CopyFromBitmap(const wxBitmap& bmp);
 
 #endif
     void CopyFromBitmap(const wxBitmap& bmp);
 

-    %pythoncode { def __nonzero__(self): return self.Ok() }
+    %pythoncode { def __nonzero__(self): return self.IsOk() }
+    
+    %property(Depth, GetDepth, SetDepth, doc="See `GetDepth` and `SetDepth`");
+    %property(Height, GetHeight, SetHeight, doc="See `GetHeight` and `SetHeight`");
+    %property(Width, GetWidth, SetWidth, doc="See `GetWidth` and `SetWidth`");
+

 };
 
 //---------------------------------------------------------------------------
 };
 
 //---------------------------------------------------------------------------


@@ -93,9 +105,9 @@ public:
     ~wxIconLocation();
 
 
     ~wxIconLocation();
 
 

-    // returns true if this object is valid/initialized
+    // returns True if this object is valid/initialized

     bool IsOk() const;
     bool IsOk() const;

-    %pythoncode { def __nonzero__(self): return self.Ok() }
+    %pythoncode { def __nonzero__(self): return self.IsOk() }

 
     // set/get the icon file name
     void SetFileName(const wxString& filename);
 
     // set/get the icon file name
     void SetFileName(const wxString& filename);


@@ -118,6 +130,10 @@ public:
 #endif
         }
     }
 #endif
         }
     }

+
+    %property(FileName, GetFileName, SetFileName, doc="See `GetFileName` and `SetFileName`");
+    %property(Index, GetIndex, SetIndex, doc="See `GetIndex` and `SetIndex`");
+    

 };
 
 
 };
 
 


@@ -132,27 +148,60 @@ public:
     wxIconBundle();
 
     // initializes the bundle with the icon(s) found in the file
     wxIconBundle();
 
     // initializes the bundle with the icon(s) found in the file

-    %name(IconBundleFromFile) wxIconBundle( const wxString& file, long type );
+    %RenameCtor(IconBundleFromFile, wxIconBundle( const wxString& file, long type ));

 
     // initializes the bundle with a single icon
 
     // initializes the bundle with a single icon

-    %name(IconBundleFromIcon)wxIconBundle( const wxIcon& icon );
+    %RenameCtor(IconBundleFromIcon, wxIconBundle( const wxIcon& icon ));

 
     ~wxIconBundle();
 
 
     ~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() }
+    
+
+    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())", "");
+    

 
 

-    // 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
-    %name(AddIconFromFile)void AddIcon( const wxString& file, long type );
+    DocDeclStr(
+        bool , IsEmpty() const,
+        "Check if we have any icons at all", "");    

 
 

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

 };
 
 //---------------------------------------------------------------------------
 };
 
 //---------------------------------------------------------------------------