Submit patch based on Michael W.'s invalid UTF8

[wxWidgets.git] / include / wx / msw / imaglist.h

diff --git a/include/wx/msw/imaglist.h b/include/wx/msw/imaglist.h
index 51812b097f37e46aafb65c2598ebaa5de7a7a2ad..1f66f8c6ca7f374ddcafe08a9d284202704b7136 100644 (file)
--- a/include/wx/msw/imaglist.h
+++ b/include/wx/msw/imaglist.h
@@ -1,18 +1,18 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        imaglist.h
+// Name:        wx/msw/imaglist.h
 // Purpose:     wxImageList class
 // Author:      Julian Smart
 // Modified by:
 // Created:     01/02/97
 // RCS-ID:      $Id$
-// Copyright:   (c) Julian Smart and Markus Holzem
-// Licence:    wxWindows license
+// Copyright:   (c) Julian Smart
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-#ifndef __IMAGLISTH__
-#define __IMAGLISTH__
+#ifndef _WX_IMAGLIST_H_
+#define _WX_IMAGLIST_H_
 
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
 #pragma interface "imaglist.h"
 #endif
 
@@ -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
   ////////////////////////////////////////////////////////////////////////////
@@ -83,7 +85,7 @@ class WXDLLEXPORT wxImageList: public wxObject
   // width, height specify the size of the images in the list (all the same).
   // mask specifies whether the images have masks or not.
   // initialNumber is the initial number of images to reserve.
-  bool Create(int width, int height, bool mask = TRUE, int initialNumber = 1);
+  bool Create(int width, int height, bool mask = true, int initialNumber = 1);
 
   // Adds a bitmap, and optionally a mask bitmap.
   // Note that wxImageList creates *new* bitmaps, so you may delete
@@ -118,14 +120,21 @@ 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
+  // 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);
+
+  // Get a bitmap
+  wxBitmap GetBitmap(int index) const;
+
+  // Get an icon
+  wxIcon GetIcon(int index) const;
 
   // TODO: miscellaneous functionality
 /*
@@ -155,7 +164,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
@@ -188,10 +197,10 @@ class WXDLLEXPORT wxImageList: public wxObject
 
   1) Starting to drag:
 
-  wxImageList *dragImageList = new wxImageList(16, 16, TRUE);
+  wxImageList *dragImageList = new wxImageList(16, 16, true);
   dragImageList->Add(myDragImage); // Provide an image to combine with the current cursor
   dragImageList->BeginDrag(0, wxPoint(0, 0));
-  wxShowCursor(FALSE);        // wxShowCursor not yet implemented in wxWin
+  wxShowCursor(false);        // wxShowCursor not yet implemented in wxWin
   myWindow->CaptureMouse();
 
   2) Dragging:
@@ -207,7 +216,7 @@ class WXDLLEXPORT wxImageList: public wxObject
 
   dragImageList->EndDrag();
   myWindow->ReleaseMouse();
-  wxShowCursor(TRUE);
+  wxShowCursor(true);
 */
 
 #endif
@@ -216,11 +225,13 @@ 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
-    // __IMAGLISTH__
+    // _WX_IMAGLIST_H_