include/wx/msw/imaglist.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        imaglist.h
   3 // Purpose:     wxImageList class
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     01/02/97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_IMAGLIST_H_
  13 #define _WX_IMAGLIST_H_
  14
  15 #ifdef __GNUG__
  16 #pragma interface "imaglist.h"
  17 #endif
  18
  19 #include "wx/bitmap.h"
  20
  21 /*
  22  * wxImageList is used for wxListCtrl, wxTreeCtrl. These controls refer to
  23  * images for their items by an index into an image list.
  24  * A wxImageList is capable of creating images with optional masks from
  25  * a variety of sources - a single bitmap plus a colour to indicate the mask,
  26  * two bitmaps, or an icon.
  27  *
  28  * Image lists can also create and draw images used for drag and drop functionality.
  29  * This is not yet implemented in wxImageList. We need to discuss a generic API
  30  * for doing drag and drop and see whether it ties in with the Win95 view of it.
  31  * See below for candidate functions and an explanation of how they might be
  32  * used.
  33  */
  34
  35 // Flags for Draw
  36 #define wxIMAGELIST_DRAW_NORMAL         0x0001
  37 #define wxIMAGELIST_DRAW_TRANSPARENT    0x0002
  38 #define wxIMAGELIST_DRAW_SELECTED       0x0004
  39 #define wxIMAGELIST_DRAW_FOCUSED        0x0008
  40
  41 // Flag values for Set/GetImageList
  42 enum {
  43     wxIMAGE_LIST_NORMAL, // Normal icons
  44     wxIMAGE_LIST_SMALL,  // Small icons
  45     wxIMAGE_LIST_STATE   // State icons: unimplemented (see WIN32 documentation)
  46 };
  47
  48 // Eventually we'll make this a reference-counted wxGDIObject. For
  49 // now, the app must take care of ownership issues. That is, the
  50 // image lists must be explicitly deleted after the control(s) that uses them
  51 // is (are) deleted, or when the app exits.
  52 class WXDLLEXPORT wxImageList: public wxObject
  53 {
  54   DECLARE_DYNAMIC_CLASS(wxImageList)
  55  public:
  56   /*
  57    * Public interface
  58    */
  59
  60   wxImageList(void);
  61
  62   // Creates an image list.
  63   // Specify the width and height of the images in the list,
  64   // whether there are masks associated with them (e.g. if creating images
  65   // from icons), and the initial size of the list.
  66   inline wxImageList(int width, int height, bool mask = TRUE, int initialCount = 1)
  67   {
  68     Create(width, height, mask, initialCount);
  69   }
  70   ~wxImageList(void);
  71
  72
  73   // Attributes
  74   ////////////////////////////////////////////////////////////////////////////
  75
  76   // Returns the number of images in the image list.
  77   int GetImageCount(void) const;
  78
  79   // Operations
  80   ////////////////////////////////////////////////////////////////////////////
  81
  82   // Creates an image list
  83   // width, height specify the size of the images in the list (all the same).
  84   // mask specifies whether the images have masks or not.
  85   // initialNumber is the initial number of images to reserve.
  86   bool Create(int width, int height, bool mask = TRUE, int initialNumber = 1);
  87
  88   // Adds a bitmap, and optionally a mask bitmap.
  89   // Note that wxImageList creates *new* bitmaps, so you may delete
  90   // 'bitmap' and 'mask' after calling Add.
  91   int Add(const wxBitmap& bitmap, const wxBitmap& mask = wxNullBitmap);
  92
  93   // Adds a bitmap, using the specified colour to create the mask bitmap
  94   // Note that wxImageList creates *new* bitmaps, so you may delete
  95   // 'bitmap' after calling Add.
  96   int Add(const wxBitmap& bitmap, const wxColour& maskColour);
  97
  98   // Adds a bitmap and mask from an icon.
  99   int Add(const wxIcon& icon);
 100
 101   // Replaces a bitmap, optionally passing a mask bitmap.
 102   // Note that wxImageList creates new bitmaps, so you may delete
 103   // 'bitmap' and 'mask' after calling Replace.
 104   bool Replace(int index, const wxBitmap& bitmap, const wxBitmap& mask = wxNullBitmap);
 105
 106 /* Not supported by Win95
 107   // Replacing a bitmap, using the specified colour to create the mask bitmap
 108   // Note that wxImageList creates new bitmaps, so you may delete
 109   // 'bitmap'.
 110   bool Replace(int index, const wxBitmap& bitmap, const wxColour& maskColour);
 111 */
 112
 113   // Replaces a bitmap and mask from an icon.
 114   // You can delete 'icon' after calling Replace.
 115   bool Replace(int index, const wxIcon& icon);
 116
 117   // Removes the image at the given index.
 118   bool Remove(int index);
 119
 120   // Remove all images
 121   bool RemoveAll(void);
 122
 123   // Draws the given image on a dc at the specified position.
 124   // If 'solidBackground' is TRUE, Draw sets the image list background
 125   // colour to the background colour of the wxDC, to speed up
 126   // drawing by eliminating masked drawing where possible.
 127   bool Draw(int index, wxDC& dc, int x, int y,
 128     int flags = wxIMAGELIST_DRAW_NORMAL, bool solidBackground = FALSE);
 129
 130   // TODO: miscellaneous functionality
 131 /*
 132   wxIcon *MakeIcon(int index);
 133   bool SetOverlayImage(int index, int overlayMask);
 134
 135 */
 136
 137   // TODO: Drag-and-drop related functionality.
 138
 139 #if 0
 140   // Creates a new drag image by combining the given image (typically a mouse cursor image)
 141   // with the current drag image.
 142   bool SetDragCursorImage(int index, const wxPoint& hotSpot);
 143
 144   // If successful, returns a pointer to the temporary image list that is used for dragging;
 145   // otherwise, NULL.
 146   // dragPos: receives the current drag position.
 147   // hotSpot: receives the offset of the drag image relative to the drag position.
 148   static wxImageList *GetDragImageList(wxPoint& dragPos, wxPoint& hotSpot);
 149
 150   // Call this function to begin dragging an image. This function creates a temporary image list
 151   // that is used for dragging. The image combines the specified image and its mask with the
 152   // current cursor. In response to subsequent mouse move messages, you can move the drag image
 153   // by using the DragMove member function. To end the drag operation, you can use the EndDrag
 154   // member function.
 155   bool BeginDrag(int index, const wxPoint& hotSpot);
 156
 157   // Ends a drag operation.
 158   bool EndDrag(void);
 159
 160   // Call this function to move the image that is being dragged during a drag-and-drop operation.
 161   // This function is typically called in response to a mouse move message. To begin a drag
 162   // operation, use the BeginDrag member function.
 163   static bool DragMove(const wxPoint& point);
 164
 165   // During a drag operation, locks updates to the window specified by lockWindow and displays
 166   // the drag image at the position specified by point.
 167   // The coordinates are relative to the window's upper left corner, so you must compensate
 168   // for the widths of window elements, such as the border, title bar, and menu bar, when
 169   // specifying the coordinates.
 170   // If lockWindow is NULL, this function draws the image in the display context associated
 171   // with the desktop window, and coordinates are relative to the upper left corner of the screen.
 172   // This function locks all other updates to the given window during the drag operation.
 173   // If you need to do any drawing during a drag operation, such as highlighting the target
 174   // of a drag-and-drop operation, you can temporarily hide the dragged image by using the
 175   // wxImageList::DragLeave function.
 176
 177   // lockWindow: pointer to the window that owns the drag image.
 178   // point:      position at which to display the drag image. Coordinates are relative to the
 179   //             upper left corner of the window (not the client area).
 180
 181   static bool DragEnter( wxWindow *lockWindow, const wxPoint& point );
 182
 183   // Unlocks the window specified by pWndLock and hides the drag image, allowing the
 184   // window to be updated.
 185   static bool DragLeave( wxWindow *lockWindow );
 186
 187   /* Here's roughly how you'd use these functions if implemented in this Win95-like way:
 188
 189   1) Starting to drag:
 190
 191   wxImageList *dragImageList = new wxImageList(16, 16, TRUE);
 192   dragImageList->Add(myDragImage); // Provide an image to combine with the current cursor
 193   dragImageList->BeginDrag(0, wxPoint(0, 0));
 194   wxShowCursor(FALSE);        // wxShowCursor not yet implemented in wxWin
 195   myWindow->CaptureMouse();
 196
 197   2) Dragging:
 198
 199   // Called within mouse move event. Could also use dragImageList instead of assuming
 200   // these are static functions.
 201   // These two functions could possibly be combined into one, since DragEnter is
 202   // a bit obscure.
 203   wxImageList::DragMove(wxPoint(x, y));  // x, y are current cursor position
 204   wxImageList::DragEnter(NULL, wxPoint(x, y)); // NULL assumes dragging across whole screen
 205
 206   3) Finishing dragging:
 207
 208   dragImageList->EndDrag();
 209   myWindow->ReleaseMouse();
 210   wxShowCursor(TRUE);
 211 */
 212
 213 #endif
 214
 215   // Implementation
 216   ////////////////////////////////////////////////////////////////////////////
 217
 218   // Returns the native image list handle
 219   inline WXHIMAGELIST GetHIMAGELIST(void) const { return m_hImageList; }
 220
 221 protected:
 222   WXHIMAGELIST m_hImageList;
 223 };
 224
 225 #endif
 226     // _WX_IMAGLIST_H_