/////////////////////////////////////////////////////////////////////////////
-// 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__
-
-#ifdef __GNUG__
-#pragma interface "imaglist.h"
-#endif
+#ifndef _WX_IMAGLIST_H_
+#define _WX_IMAGLIST_H_
#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
{
- 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(const int width, const int height, const bool mask = TRUE, const int initialCount = 1)
+ wxImageList(int width, int height, bool mask = true, int initialCount = 1)
{
Create(width, height, mask, initialCount);
}
- ~wxImageList(void);
+ virtual ~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
////////////////////////////////////////////////////////////////////////////
// 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(const int width, const int height, const bool mask = TRUE, const 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
// Replaces a bitmap, optionally passing a mask bitmap.
// Note that wxImageList creates new bitmaps, so you may delete
// 'bitmap' and 'mask' after calling Replace.
- bool Replace(const int index, const wxBitmap& bitmap, const wxBitmap& mask = wxNullBitmap);
+ bool Replace(int index, const wxBitmap& bitmap, const wxBitmap& mask = wxNullBitmap);
/* Not supported by Win95
// Replacing a bitmap, using the specified colour to create the mask bitmap
// Note that wxImageList creates new bitmaps, so you may delete
// 'bitmap'.
- bool Replace(const int index, const wxBitmap& bitmap, const wxColour& maskColour);
+ bool Replace(int index, const wxBitmap& bitmap, const wxColour& maskColour);
*/
// Replaces a bitmap and mask from an icon.
// You can delete 'icon' after calling Replace.
- bool Replace(const int index, const wxIcon& icon);
+ bool Replace(int index, const wxIcon& icon);
// Removes the image at the given index.
- bool Remove(const int index);
+ 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(const int index, wxDC& dc, const int x, const int y,
- const int flags = wxIMAGELIST_DRAW_NORMAL, const bool solidBackground = FALSE);
+ bool Draw(int index, wxDC& dc, int x, int y,
+ 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
/*
- wxIcon *MakeIcon(const int index);
- bool SetOverlayImage(const int index, const int overlayMask);
+ wxIcon *MakeIcon(int index);
+ bool SetOverlayImage(int index, int overlayMask);
*/
#if 0
// Creates a new drag image by combining the given image (typically a mouse cursor image)
// with the current drag image.
- bool SetDragCursorImage(const int index, const wxPoint& hotSpot);
+ bool SetDragCursorImage(int index, const wxPoint& hotSpot);
// If successful, returns a pointer to the temporary image list that is used for dragging;
// otherwise, NULL.
// current cursor. In response to subsequent mouse move messages, you can move the drag image
// by using the DragMove member function. To end the drag operation, you can use the EndDrag
// member function.
- bool BeginDrag(const int index, const wxPoint& hotSpot);
+ 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
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:
dragImageList->EndDrag();
myWindow->ReleaseMouse();
- wxShowCursor(TRUE);
+ wxShowCursor(true);
*/
#endif
////////////////////////////////////////////////////////////////////////////
// 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_NO_COPY(wxImageList)
};
#endif
- // __IMAGLISTH__
+ // _WX_IMAGLIST_H_
projects / wxWidgets.git / blobdiff