wxPython/src/_imaglist.i

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        _imaglist.i
   3 // Purpose:     SWIG interface defs for wxImageList and releated classes
   4 //
   5 // Author:      Robin Dunn
   6 //
   7 // Created:     7-July-1997
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c) 2003 by Total Control Software
  10 // Licence:     wxWindows license
  11 /////////////////////////////////////////////////////////////////////////////
  12
  13 // Not a %module
  14
  15
  16 //---------------------------------------------------------------------------
  17
  18 %{
  19 %}
  20
  21 //---------------------------------------------------------------------------
  22 %newgroup
  23
  24 enum {
  25     wxIMAGELIST_DRAW_NORMAL ,
  26     wxIMAGELIST_DRAW_TRANSPARENT,
  27     wxIMAGELIST_DRAW_SELECTED,
  28     wxIMAGELIST_DRAW_FOCUSED,
  29
  30     wxIMAGE_LIST_NORMAL,
  31     wxIMAGE_LIST_SMALL,
  32     wxIMAGE_LIST_STATE
  33 };
  34
  35
  36 MustHaveApp(wxImageList);
  37
  38
  39 //  wxImageList is used for wxListCtrl, wxTreeCtrl. These controls refer to
  40 //  images for their items by an index into an image list.
  41 //  A wxImageList is capable of creating images with optional masks from
  42 //  a variety of sources - a single bitmap plus a colour to indicate the mask,
  43 //  two bitmaps, or an icon.
  44 class wxImageList : public wxObject {
  45 public:
  46     wxImageList(int width, int height, int mask=true, int initialCount=1);
  47     ~wxImageList();
  48
  49     int Add(const wxBitmap& bitmap, const wxBitmap& mask = wxNullBitmap);
  50     %Rename(AddWithColourMask,int, Add(const wxBitmap& bitmap, const wxColour& maskColour));
  51     %Rename(AddIcon,int, Add(const wxIcon& icon));
  52
  53     wxBitmap GetBitmap(int index) const;
  54     wxIcon GetIcon(int index) const;
  55
  56     bool Replace(int index, const wxBitmap& bitmap, const wxBitmap& mask = wxNullBitmap);
  57
  58     bool Draw(int index, wxDC& dc, int x, int x, int flags = wxIMAGELIST_DRAW_NORMAL,
  59               const bool solidBackground = false);
  60
  61     int GetImageCount();
  62     bool Remove(int index);
  63     bool RemoveAll();
  64
  65     DocDeclA(
  66         void, GetSize(int index, int& OUTPUT, int& OUTPUT),
  67         "GetSize(index) -> (width,height)");
  68
  69     %property(ImageCount, GetImageCount, doc="See `GetImageCount`");
  70     %property(Size, GetSize, doc="See `GetSize`");
  71 };
  72
  73 //---------------------------------------------------------------------------