wxPython/src/_imaglist.i

/////////////////////////////////////////////////////////////////////////////
// Name:        _imaglist.i
// Purpose:     SWIG interface defs for wxImageList and releated classes
//
// Author:      Robin Dunn
//
// Created:     7-July-1997
// RCS-ID:      $Id$
// Copyright:   (c) 2003 by Total Control Software
// Licence:     wxWindows license
/////////////////////////////////////////////////////////////////////////////

// Not a %module


//---------------------------------------------------------------------------

%{
%}

//---------------------------------------------------------------------------
%newgroup

enum {
    wxIMAGELIST_DRAW_NORMAL ,
    wxIMAGELIST_DRAW_TRANSPARENT,
    wxIMAGELIST_DRAW_SELECTED,
    wxIMAGELIST_DRAW_FOCUSED,

    wxIMAGE_LIST_NORMAL,
    wxIMAGE_LIST_SMALL,
    wxIMAGE_LIST_STATE
};


MustHaveApp(wxImageList);


//  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.
class wxImageList : public wxObject {
public:
    wxImageList(int width, int height, int mask=true, int initialCount=1);
    ~wxImageList();

    int Add(const wxBitmap& bitmap, const wxBitmap& mask = wxNullBitmap);
    %Rename(AddWithColourMask,int, Add(const wxBitmap& bitmap, const wxColour& maskColour));
    %Rename(AddIcon,int, Add(const wxIcon& icon));

    wxBitmap GetBitmap(int index) const;
    wxIcon GetIcon(int index) const;

#ifdef __WXMSW__
    bool Replace(int index, const wxBitmap& bitmap, const wxBitmap& mask = wxNullBitmap);
#else
//      %Rename(ReplaceIcon,bool, Replace(int index, const wxIcon& icon));
//      int Add(const wxBitmap& bitmap);
    bool Replace(int index, const wxBitmap& bitmap);
#endif

    bool Draw(int index, wxDC& dc, int x, int x, int flags = wxIMAGELIST_DRAW_NORMAL,
              const bool solidBackground = false);

    int GetImageCount();
    bool Remove(int index);
    bool RemoveAll();

    DocDeclA(
        void, GetSize(int index, int& OUTPUT, int& OUTPUT),
        "GetSize() -> (width,height)");

};

//---------------------------------------------------------------------------
Commit	Line	Data
	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	#ifdef __WXMSW__
	57	bool Replace(int index, const wxBitmap& bitmap, const wxBitmap& mask = wxNullBitmap);
	58	#else
	59	// %Rename(ReplaceIcon,bool, Replace(int index, const wxIcon& icon));
	60	// int Add(const wxBitmap& bitmap);
	61	bool Replace(int index, const wxBitmap& bitmap);
	62	#endif
	63
	64	bool Draw(int index, wxDC& dc, int x, int x, int flags = wxIMAGELIST_DRAW_NORMAL,
	65	const bool solidBackground = false);
	66
	67	int GetImageCount();
	68	bool Remove(int index);
	69	bool RemoveAll();
	70
	71	DocDeclA(
	72	void, GetSize(int index, int& OUTPUT, int& OUTPUT),
	73	"GetSize() -> (width,height)");
	74
	75	};
	76
	77	//---------------------------------------------------------------------------