synchronize GTK2 minimum version in docs

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

diff --git a/include/wx/msw/imaglist.h b/include/wx/msw/imaglist.h
index 8e2f01580d937292dc37335ab62f5ecb916e4d55..73fc9df7294f045c09d5a04e4fcee0a91546e3ef 100644 (file)
--- a/include/wx/msw/imaglist.h
+++ b/include/wx/msw/imaglist.h
@@ -6,50 +6,19 @@
 // Created:     01/02/97
 // RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart
-// Licence:    wxWidgets licence
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_IMAGLIST_H_
 #define _WX_IMAGLIST_H_
 
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-#pragma interface "imaglist.h"
-#endif
-
 #include "wx/bitmap.h"
 
-/*
- * wxImageList is used for wxListCtrl, wxTreeCtrl. These controls refer to
- * images for their items by an index into an image list.
- * A wxImageList is capable of creating images with optional masks from
- * a variety of sources - a single bitmap plus a colour to indicate the mask,
- * two bitmaps, or an icon.
- *
- * Image lists can also create and draw images used for drag and drop functionality.
- * This is not yet implemented in wxImageList. We need to discuss a generic API
- * for doing drag and drop and see whether it ties in with the Win95 view of it.
- * See below for candidate functions and an explanation of how they might be
- * used.
- */
-
-// Flags for Draw
-#define wxIMAGELIST_DRAW_NORMAL         0x0001
-#define wxIMAGELIST_DRAW_TRANSPARENT    0x0002
-#define wxIMAGELIST_DRAW_SELECTED       0x0004
-#define wxIMAGELIST_DRAW_FOCUSED        0x0008
-
-// Flag values for Set/GetImageList
-enum {
-    wxIMAGE_LIST_NORMAL, // Normal icons
-    wxIMAGE_LIST_SMALL,  // Small icons
-    wxIMAGE_LIST_STATE   // State icons: unimplemented (see WIN32 documentation)
-};
-
 // Eventually we'll make this a reference-counted wxGDIObject. For
 // 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 WXDLLIMPEXP_CORE wxImageList : public wxObject
 {
 public:
   /*
@@ -62,11 +31,11 @@ public:
   // 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.
-  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();
+  virtual ~wxImageList();
 
 
   // Attributes
@@ -85,7 +54,7 @@ public:
   // 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
@@ -123,12 +92,18 @@ public:
   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);
+            bool solidBackground = false);
+
+  // Get a bitmap
+  wxBitmap GetBitmap(int index) const;
+
+  // Get an icon
+  wxIcon GetIcon(int index) const;
 
   // TODO: miscellaneous functionality
 /*
@@ -191,10 +166,10 @@ public:
 
   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:
@@ -210,7 +185,7 @@ public:
 
   dragImageList->EndDrag();
   myWindow->ReleaseMouse();
-  wxShowCursor(TRUE);
+  wxShowCursor(true);
 */
 
 #endif
@@ -224,7 +199,7 @@ public:
 protected:
   WXHIMAGELIST m_hImageList;
 
-  DECLARE_DYNAMIC_CLASS(wxImageList)
+  DECLARE_DYNAMIC_CLASS_NO_COPY(wxImageList)
 };
 
 #endif