wxImageList::GetSize() documented and added to wxMSW

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

docs/latex/wx/imaglist.tex

@@ -131,6 +131,26 @@ that the background is solid.}
 
 Returns the number of images in the list.
 
+\membersection{wxImageList::GetSize}\label{wximagelistgetsize}
+
+\constfunc{bool}{GetSize}{\param{int }{index}, \param{int\& }{width}, \param{int \&}{height}}
+
+Retrieves the size of the images in the list. Currently, the {\it index} 
+parameter is ignored as all images in the list have the same size.
+
+\wxheading{Parameters}
+
+\docparam{index}{currently unused, should be 0}
+
+\docparam{width}{receives the width of the images in the list}
+
+\docparam{height}{receives the height of the images in the list}
+
+\wxheading{Return value}
+
+TRUE if the function succeeded, FALSE if it failed (for example, if the image
+list was not yet initialized).
+
 \membersection{wxImageList::Remove}\label{wximagelistremove}
 
 \func{bool}{Remove}{\param{int}{ index}}

include/wx/msw/imaglist.h

@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        imaglist.h
+// Name:        wx/msw/imaglist.h
 // Purpose:     wxImageList class
 // Author:      Julian Smart
 // Modified by:
@@ -49,32 +49,34 @@ enum {
 // now, the app must take care of ownership issues. That is, the
 // image lists must be explicitly deleted after the control(s) that uses them
 // is (are) deleted, or when the app exits.
-class WXDLLEXPORT wxImageList: public wxObject
+class WXDLLEXPORT wxImageList : public wxObject
 {
-  DECLARE_DYNAMIC_CLASS(wxImageList)
+public:
- public:
   /*
    * Public interface
    */
 
-  wxImageList(void);
+  wxImageList();
 
   // Creates an image list.
   // Specify the width and height of the images in the list,
   // whether there are masks associated with them (e.g. if creating images
   // from icons), and the initial size of the list.
-  inline wxImageList(int width, int height, bool mask = TRUE, int initialCount = 1)
+  wxImageList(int width, int height, bool mask = TRUE, int initialCount = 1)
   {
     Create(width, height, mask, initialCount);
   }
-  ~wxImageList(void);
+  ~wxImageList();
 
 
   // Attributes
   ////////////////////////////////////////////////////////////////////////////
 
   // Returns the number of images in the image list.
-  int GetImageCount(void) const;
+  int GetImageCount() const;
+
+  // Returns the size (same for all images) of the images in the list
+  bool GetSize(int index, int &width, int &height) const;
 
   // Operations
   ////////////////////////////////////////////////////////////////////////////
@@ -118,14 +120,15 @@ class WXDLLEXPORT wxImageList: public wxObject
   bool Remove(int index);
 
   // Remove all images
-  bool RemoveAll(void);
+  bool RemoveAll();
 
   // Draws the given image on a dc at the specified position.
   // If 'solidBackground' is TRUE, Draw sets the image list background
   // colour to the background colour of the wxDC, to speed up
   // drawing by eliminating masked drawing where possible.
   bool Draw(int index, wxDC& dc, int x, int y,
-    int flags = wxIMAGELIST_DRAW_NORMAL, bool solidBackground = FALSE);
+            int flags = wxIMAGELIST_DRAW_NORMAL,
+            bool solidBackground = FALSE);
 
   // TODO: miscellaneous functionality
 /*
@@ -155,7 +158,7 @@ class WXDLLEXPORT wxImageList: public wxObject
   bool BeginDrag(int index, const wxPoint& hotSpot);
 
   // Ends a drag operation.
-  bool EndDrag(void);
+  bool EndDrag();
 
   // Call this function to move the image that is being dragged during a drag-and-drop operation.
   // This function is typically called in response to a mouse move message. To begin a drag
@@ -216,10 +219,12 @@ class WXDLLEXPORT wxImageList: public wxObject
   ////////////////////////////////////////////////////////////////////////////
 
   // Returns the native image list handle
-  inline WXHIMAGELIST GetHIMAGELIST(void) const { return m_hImageList; }
+  WXHIMAGELIST GetHIMAGELIST() const { return m_hImageList; }
 
 protected:
   WXHIMAGELIST m_hImageList;
+
+  DECLARE_DYNAMIC_CLASS(wxImageList)
 };
 
 #endif

src/msw/imaglist.cpp

@@ -127,6 +127,14 @@ int wxImageList::GetImageCount() const
     return ImageList_GetImageCount(GetHImageList());
 }
 
+// Returns the size (same for all images) of the images in the list
+bool wxImageList::GetSize(int WXUNUSED(index), int &width, int &height) const
+{
+    wxASSERT_MSG( m_hImageList, _T("invalid image list") );
+
+    return ImageList_GetIconSize(GetHImageList(), &width, &height) != 0;
+}
+
 // ----------------------------------------------------------------------------
 // wxImageList operations
 // ----------------------------------------------------------------------------