Fix missing documentation for several GDI functions.

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

diff --git a/include/wx/generic/imaglist.h b/include/wx/generic/imaglist.h
index 2a0893a3ac18b073195c18c390885d2b35167ad9..4a1ee4fc7dbf1dc66ae2abdcf39fb40af7f68abb 100644 (file)
--- a/include/wx/generic/imaglist.h
+++ b/include/wx/generic/imaglist.h
@@ -1,70 +1,80 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        imaglist.h
+// Name:        wx/generic/imaglist.h
 // Purpose:
 // Author:      Robert Roebling
 // Created:     01/02/97
-// Id:
-// Copyright:   (c) 1998 Robert Roebling, Julian Smart and Markus Holzem
-// Licence:    wxWindows licence
+// Id:          $Id$
+// Copyright:   (c) 1998 Robert Roebling and Julian Smart
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-#ifndef __IMAGELISTH_G__
-#define __IMAGELISTH_G__
+#ifndef _WX_IMAGLISTG_H_
+#define _WX_IMAGLISTG_H_
 
-#ifdef __GNUG__
-#pragma interface "imaglist.h"
-#endif
+#include "wx/list.h"
 
-#include "wx/defs.h"
-#include "wx/gdicmn.h"
-#include "wx/bitmap.h"
-#include "wx/dc.h"
+class WXDLLIMPEXP_FWD_CORE wxDC;
+class WXDLLIMPEXP_FWD_CORE wxBitmap;
+class WXDLLIMPEXP_FWD_CORE wxIcon;
+class WXDLLIMPEXP_FWD_CORE wxColour;
 
-/*
- * 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
-
-class wxImageList: public wxObject
+class WXDLLIMPEXP_CORE wxGenericImageList: public wxObject
 {
-   DECLARE_DYNAMIC_CLASS(wxImageList)
-   
-  public:
-
-    wxImageList::wxImageList() { }
-    wxImageList( int width, int height, bool mask = TRUE, int initialCount = 1 );
-    ~wxImageList();
+public:
+    wxGenericImageList() { m_width = m_height = 0; }
+    wxGenericImageList( int width, int height, bool mask = true, int initialCount = 1 );
+    virtual ~wxGenericImageList();
+    bool Create( int width, int height, bool mask = true, int initialCount = 1 );
     bool Create();
-    int GetImageCount() const;
-    int Add( const wxBitmap &bitmap );
+
+    virtual int GetImageCount() const;
+    virtual bool GetSize( int index, int &width, int &height ) const;
+
+    int Add( const wxBitmap& bitmap );
+    int Add( const wxBitmap& bitmap, const wxBitmap& mask );
+    int Add( const wxBitmap& bitmap, const wxColour& maskColour );
+    wxBitmap GetBitmap(int index) const;
+    wxIcon GetIcon(int index) const;
     bool Replace( int index, const wxBitmap &bitmap );
+    bool Replace( int index, const wxBitmap &bitmap, const wxBitmap& mask );
     bool Remove( int index );
     bool RemoveAll();
-    bool GetSize( int index, int &width, int &height ) const;
-    bool Draw(int index, wxDC& dc, int x, int y,
-      int flags = wxIMAGELIST_DRAW_NORMAL, bool solidBackground = FALSE );
 
-  private:
+    virtual bool Draw(int index, wxDC& dc, int x, int y,
+              int flags = wxIMAGELIST_DRAW_NORMAL,
+              bool solidBackground = false);
+
+    // Internal use only
+    const wxBitmap *GetBitmapPtr(int index) const;
+private:
+    wxObjectList  m_images;
 
-    wxList  m_images;
     int     m_width;
     int     m_height;
+
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxGenericImageList)
 };
 
-#endif  // __IMAGELISTH_G__
+#ifndef wxHAS_NATIVE_IMAGELIST
+
+/*
+ * wxImageList has to be a real class or we have problems with
+ * the run-time information.
+ */
+
+class WXDLLIMPEXP_CORE wxImageList: public wxGenericImageList
+{
+    DECLARE_DYNAMIC_CLASS(wxImageList)
+
+public:
+    wxImageList() {}
+
+    wxImageList( int width, int height, bool mask = true, int initialCount = 1 )
+        : wxGenericImageList(width, height, mask, initialCount)
+    {
+    }
+};
+#endif // !wxHAS_NATIVE_IMAGELIST
 
+#endif  // _WX_IMAGLISTG_H_