[wxWidgets.git] / include / wx / listctrl.h

///////////////////////////////////////////////////////////////////////////////
// Name:        wx/listctrl.h
// Purpose:     wxListCtrl class
// Author:      Vadim Zeitlin
// Modified by:
// Created:     04.12.99
// RCS-ID:      $Id$
// Copyright:   (c) wxWindows team
// Licence:     wxWindows licence
///////////////////////////////////////////////////////////////////////////////

#ifndef _WX_LISTCTRL_H_BASE_
#define _WX_LISTCTRL_H_BASE_

#ifdef __GNUG__
    #pragma interface "listctrlbase.h"
#endif

#if wxUSE_LISTCTRL

// ----------------------------------------------------------------------------
// types
// ----------------------------------------------------------------------------

// type of compare function for wxListCtrl sort operation
typedef int (wxCALLBACK *wxListCtrlCompare)(long item1, long item2, long sortData);

// ----------------------------------------------------------------------------
// wxListCtrl constants
// ----------------------------------------------------------------------------

// style flags
#define wxLC_VRULES          0x0001
#define wxLC_HRULES          0x0002

#define wxLC_ICON            0x0004
#define wxLC_SMALL_ICON      0x0008
#define wxLC_LIST            0x0010
#define wxLC_REPORT          0x0020
#define wxLC_MODE_MASK       \
    (wxLC_ICON | wxLC_SMALL_ICON | wxLC_LIST | wxLC_REPORT)

#define wxLC_ALIGN_TOP       0x0040
#define wxLC_ALIGN_LEFT      0x0080
#define wxLC_AUTOARRANGE     0x0100
#define wxLC_VIRTUAL         0x0200
#define wxLC_EDIT_LABELS     0x0400
#define wxLC_NO_HEADER       0x0800
#define wxLC_NO_SORT_HEADER  0x1000
#define wxLC_SINGLE_SEL      0x2000
#define wxLC_SORT_ASCENDING  0x4000
#define wxLC_SORT_DESCENDING 0x8000

#define wxLC_MASK_TYPE       (wxLC_ICON | wxLC_SMALL_ICON | wxLC_LIST | wxLC_REPORT)
#define wxLC_MASK_ALIGN      (wxLC_ALIGN_TOP | wxLC_ALIGN_LEFT)
#define wxLC_MASK_SORT       (wxLC_SORT_ASCENDING | wxLC_SORT_DESCENDING)

// for compatibility only
#define wxLC_USER_TEXT       wxLC_VIRTUAL

// Omitted because
//  (a) too much detail
//  (b) not enough style flags
//  (c) not implemented anyhow in the generic version
//
// #define wxLC_NO_SCROLL
// #define wxLC_NO_LABEL_WRAP
// #define wxLC_OWNERDRAW_FIXED
// #define wxLC_SHOW_SEL_ALWAYS

// Mask flags to tell app/GUI what fields of wxListItem are valid
#define wxLIST_MASK_STATE           0x0001
#define wxLIST_MASK_TEXT            0x0002
#define wxLIST_MASK_IMAGE           0x0004
#define wxLIST_MASK_DATA            0x0008
#define wxLIST_SET_ITEM             0x0010
#define wxLIST_MASK_WIDTH           0x0020
#define wxLIST_MASK_FORMAT          0x0040

// State flags for indicating the state of an item
#define wxLIST_STATE_DONTCARE       0x0000
#define wxLIST_STATE_DROPHILITED    0x0001      // MSW only
#define wxLIST_STATE_FOCUSED        0x0002
#define wxLIST_STATE_SELECTED       0x0004
#define wxLIST_STATE_CUT            0x0008      // MSW only

// Hit test flags, used in HitTest
#define wxLIST_HITTEST_ABOVE            0x0001  // Above the client area.
#define wxLIST_HITTEST_BELOW            0x0002  // Below the client area.
#define wxLIST_HITTEST_NOWHERE          0x0004  // In the client area but below the last item.
#define wxLIST_HITTEST_ONITEMICON       0x0020  // On the bitmap associated with an item.
#define wxLIST_HITTEST_ONITEMLABEL      0x0080  // On the label (string) associated with an item.
#define wxLIST_HITTEST_ONITEMRIGHT      0x0100  // In the area to the right of an item.
#define wxLIST_HITTEST_ONITEMSTATEICON  0x0200  // On the state icon for a tree view item that is in a user-defined state.
#define wxLIST_HITTEST_TOLEFT           0x0400  // To the left of the client area.
#define wxLIST_HITTEST_TORIGHT          0x0800  // To the right of the client area.

#define wxLIST_HITTEST_ONITEM (wxLIST_HITTEST_ONITEMICON | wxLIST_HITTEST_ONITEMLABEL | wxLIST_HITTEST_ONITEMSTATEICON)

// Flags for GetNextItem (MSW only except wxLIST_NEXT_ALL)
enum
{
    wxLIST_NEXT_ABOVE,          // Searches for an item above the specified item
    wxLIST_NEXT_ALL,            // Searches for subsequent item by index
    wxLIST_NEXT_BELOW,          // Searches for an item below the specified item
    wxLIST_NEXT_LEFT,           // Searches for an item to the left of the specified item
    wxLIST_NEXT_RIGHT           // Searches for an item to the right of the specified item
};

// Alignment flags for Arrange (MSW only except wxLIST_ALIGN_LEFT)
enum
{
    wxLIST_ALIGN_DEFAULT,
    wxLIST_ALIGN_LEFT,
    wxLIST_ALIGN_TOP,
    wxLIST_ALIGN_SNAP_TO_GRID
};

// Column format (MSW only except wxLIST_FORMAT_LEFT)
enum wxListColumnFormat
{
    wxLIST_FORMAT_LEFT,
    wxLIST_FORMAT_RIGHT,
    wxLIST_FORMAT_CENTRE,
    wxLIST_FORMAT_CENTER = wxLIST_FORMAT_CENTRE
};

// Autosize values for SetColumnWidth
enum
{
    wxLIST_AUTOSIZE = -1,
    wxLIST_AUTOSIZE_USEHEADER = -2      // partly supported by generic version
};

// Flag values for GetItemRect
enum
{
    wxLIST_RECT_BOUNDS,
    wxLIST_RECT_ICON,
    wxLIST_RECT_LABEL
};

// Flag values for FindItem (MSW only)
enum
{
    wxLIST_FIND_UP,
    wxLIST_FIND_DOWN,
    wxLIST_FIND_LEFT,
    wxLIST_FIND_RIGHT
};

// ----------------------------------------------------------------------------
// wxListItemAttr: a structure containing the visual attributes of an item
// ----------------------------------------------------------------------------

class WXDLLEXPORT wxListItemAttr
{
public:
    // ctors
    wxListItemAttr() { }
    wxListItemAttr(const wxColour& colText,
                   const wxColour& colBack,
                   const wxFont& font)
        : m_colText(colText), m_colBack(colBack), m_font(font) { }

    // setters
    void SetTextColour(const wxColour& colText) { m_colText = colText; }
    void SetBackgroundColour(const wxColour& colBack) { m_colBack = colBack; }
    void SetFont(const wxFont& font) { m_font = font; }

    // accessors
    bool HasTextColour() const { return m_colText.Ok(); }
    bool HasBackgroundColour() const { return m_colBack.Ok(); }
    bool HasFont() const { return m_font.Ok(); }

    const wxColour& GetTextColour() const { return m_colText; }
    const wxColour& GetBackgroundColour() const { return m_colBack; }
    const wxFont& GetFont() const { return m_font; }

private:
    wxColour m_colText,
             m_colBack;
    wxFont   m_font;
};

// ----------------------------------------------------------------------------
// wxListItem: the item or column info, used to exchange data with wxListCtrl
// ----------------------------------------------------------------------------

class WXDLLEXPORT wxListItem : public wxObject
{
public:
    wxListItem();
    ~wxListItem() { delete m_attr; }

    // resetting
    void Clear();
    void ClearAttributes();

    // setters
    void SetMask(long mask) { m_mask = mask; }
    void SetId(long id) { m_itemId = id; }
    void SetColumn(int col) { m_col = col; }
    void SetState(long state) { m_state = state; m_stateMask |= state; }
    void SetStateMask(long stateMask) { m_stateMask = stateMask; }
    void SetText(const wxString& text) { m_text = text; }
    void SetImage(int image) { m_image = image; }
    void SetData(long data) { m_data = data; }
    void SetData(void *data) { m_data = (long)data; }

    void SetWidth(int width) { m_width = width; }
    void SetAlign(wxListColumnFormat align) { m_format = align; }

    void SetTextColour(const wxColour& colText)
        { Attributes().SetTextColour(colText); }
    void SetBackgroundColour(const wxColour& colBack)
        { Attributes().SetBackgroundColour(colBack); }
    void SetFont(const wxFont& font)
        { Attributes().SetFont(font); }

    // accessors
    long GetMask() const { return m_mask; }
    long GetId() const { return m_itemId; }
    int GetColumn() const { return m_col; }
    long GetState() const { return m_state & m_stateMask; }
    const wxString& GetText() const { return m_text; }
    int GetImage() const { return m_image; }
    long GetData() const { return m_data; }

    int GetWidth() const { return m_width; }
    wxListColumnFormat GetAlign() const { return (wxListColumnFormat)m_format; }

    wxListItemAttr *GetAttributes() const { return m_attr; }
    bool HasAttributes() const { return m_attr != NULL; }

    wxColour GetTextColour() const
        { return HasAttributes() ? m_attr->GetTextColour() : wxNullColour; }
    wxColour GetBackgroundColour() const
        { return HasAttributes() ? m_attr->GetBackgroundColour()
                                 : wxNullColour; }
    wxFont GetFont() const
        { return HasAttributes() ? m_attr->GetFont() : wxNullFont; }

    // this conversion is necessary to make old code using GetItem() to
    // compile
    operator long() const { return m_itemId; }

    // these members are public for compatibility

    long            m_mask;     // Indicates what fields are valid
    long            m_itemId;   // The zero-based item position
    int             m_col;      // Zero-based column, if in report mode
    long            m_state;    // The state of the item
    long            m_stateMask;// Which flags of m_state are valid (uses same flags)
    wxString        m_text;     // The label/header text
    int             m_image;    // The zero-based index into an image list
    long            m_data;     // App-defined data

    // For columns only
    int             m_format;   // left, right, centre
    int             m_width;    // width of column

protected:
    // creates m_attr if we don't have it yet
    wxListItemAttr& Attributes()
    {
        if ( !m_attr )
            m_attr = new wxListItemAttr;

        return *m_attr;
    }

    wxListItemAttr *m_attr;     // optional pointer to the items style

private:
    DECLARE_DYNAMIC_CLASS(wxListItem)
};

// ----------------------------------------------------------------------------
// include the wxListCtrl class declaration
// ----------------------------------------------------------------------------

#if defined(__WXUNIVERSAL__)
    #include "wx/generic/listctrl.h"
#elif defined(__WXMSW__)
    #ifdef __WIN16__
        #include "wx/generic/listctrl.h"
    #else
        #include "wx/msw/listctrl.h"
    #endif
#elif defined(__WXMOTIF__)
    #include "wx/generic/listctrl.h"
#elif defined(__WXGTK__)
    #include "wx/generic/listctrl.h"
#elif defined(__WXQT__)
    #include "wx/generic/listctrl.h"
#elif defined(__WXMAC__)
    #include "wx/generic/listctrl.h"
#elif defined(__WXPM__)
    #include "wx/generic/listctrl.h"
#elif defined(__WXSTUBS__)
    #include "wx/generic/listctrl.h"
#endif

// ----------------------------------------------------------------------------
// wxListEvent - the event class for the wxListCtrl notifications
// ----------------------------------------------------------------------------

class WXDLLEXPORT wxListEvent : public wxNotifyEvent
{
public:
    wxListEvent(wxEventType commandType = wxEVT_NULL, int id = 0);

    int           m_code;
    long          m_itemIndex;
    long          m_oldItemIndex;
    int           m_col;
    bool          m_cancelled;
    wxPoint       m_pointDrag;

    wxListItem    m_item;

    int GetCode() const { return m_code; }
    long GetIndex() const { return m_itemIndex; }
    long GetOldIndex() const { return m_oldItemIndex; }
    long GetOldItem() const { return m_oldItemIndex; }
    int GetColumn() const { return m_col; }
    bool Cancelled() const { return m_cancelled; }
    wxPoint GetPoint() const { return m_pointDrag; }
    const wxString& GetLabel() const { return m_item.m_text; }
    const wxString& GetText() const { return m_item.m_text; }
    int GetImage() const { return m_item.m_image; }
    long GetData() const { return m_item.m_data; }
    long GetMask() const { return m_item.m_mask; }
    const wxListItem& GetItem() const { return m_item; }

    void CopyObject(wxObject& object_dest) const;

private:
    DECLARE_DYNAMIC_CLASS(wxListEvent)
};

// ----------------------------------------------------------------------------
// wxListCtrl event macros
// ----------------------------------------------------------------------------

BEGIN_DECLARE_EVENT_TYPES()
    DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_BEGIN_DRAG, 700)
    DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_BEGIN_RDRAG, 701)
    DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT, 702)
    DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_END_LABEL_EDIT, 703)
    DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_DELETE_ITEM, 704)
    DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS, 705)
    DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_GET_INFO, 706)
    DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_SET_INFO, 707)
    DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_SELECTED, 708)
    DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_DESELECTED, 709)
    DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_KEY_DOWN, 710)
    DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_INSERT_ITEM, 711)
    DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_CLICK, 712)
    DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK, 713)
    DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK, 714)
    DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_ACTIVATED, 715)
END_DECLARE_EVENT_TYPES()

typedef void (wxEvtHandler::*wxListEventFunction)(wxListEvent&);

#define EVT_LIST_BEGIN_DRAG(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_BEGIN_DRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
#define EVT_LIST_BEGIN_RDRAG(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_BEGIN_RDRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
#define EVT_LIST_BEGIN_LABEL_EDIT(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
#define EVT_LIST_END_LABEL_EDIT(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_END_LABEL_EDIT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
#define EVT_LIST_DELETE_ITEM(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_DELETE_ITEM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
#define EVT_LIST_DELETE_ALL_ITEMS(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
#define EVT_LIST_GET_INFO(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_GET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
#define EVT_LIST_SET_INFO(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_SET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
#define EVT_LIST_ITEM_SELECTED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_ITEM_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
#define EVT_LIST_ITEM_DESELECTED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_ITEM_DESELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
#define EVT_LIST_KEY_DOWN(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_KEY_DOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
#define EVT_LIST_INSERT_ITEM(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_INSERT_ITEM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
#define EVT_LIST_COL_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_COL_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
#define EVT_LIST_ITEM_RIGHT_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL ),
#define EVT_LIST_ITEM_MIDDLE_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL ),
#define EVT_LIST_ITEM_ACTIVATED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_ITEM_ACTIVATED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL ),

#endif // wxUSE_LISTCTRL

#endif
    // _WX_LISTCTRL_H_BASE_
Commit	Line	Data
bdc72a22 VZ	1	///////////////////////////////////////////////////////////////////////////////
	2	// Name: wx/listctrl.h
	3	// Purpose: wxListCtrl class
	4	// Author: Vadim Zeitlin
	5	// Modified by:
	6	// Created: 04.12.99
	7	// RCS-ID: $Id$
	8	// Copyright: (c) wxWindows team
	9	// Licence: wxWindows licence
	10	///////////////////////////////////////////////////////////////////////////////
	11
34138703 JS	12	#ifndef _WX_LISTCTRL_H_BASE_
34138703 JS	13	#define _WX_LISTCTRL_H_BASE_
c801d85f	14
510fc784 RR	15	#ifdef __GNUG__
	16	#pragma interface "listctrlbase.h"
	17	#endif
	18
1e6feb95 VZ	19	#if wxUSE_LISTCTRL
1e6feb95 VZ	20
bdc72a22 VZ	21	// ----------------------------------------------------------------------------
	22	// types
	23	// ----------------------------------------------------------------------------
	24
	25	// type of compare function for wxListCtrl sort operation
	26	typedef int (wxCALLBACK *wxListCtrlCompare)(long item1, long item2, long sortData);
	27
	28	// ----------------------------------------------------------------------------
	29	// wxListCtrl constants
	30	// ----------------------------------------------------------------------------
	31
98ec9dbe VZ	32	// style flags
	33	#define wxLC_VRULES 0x0001
	34	#define wxLC_HRULES 0x0002
cf1dfa6b	35
98ec9dbe VZ	36	#define wxLC_ICON 0x0004
	37	#define wxLC_SMALL_ICON 0x0008
	38	#define wxLC_LIST 0x0010
	39	#define wxLC_REPORT 0x0020
cf1dfa6b VZ	40	#define wxLC_MODE_MASK \
	41	(wxLC_ICON \| wxLC_SMALL_ICON \| wxLC_LIST \| wxLC_REPORT)
	42
98ec9dbe VZ	43	#define wxLC_ALIGN_TOP 0x0040
	44	#define wxLC_ALIGN_LEFT 0x0080
	45	#define wxLC_AUTOARRANGE 0x0100
	46	#define wxLC_VIRTUAL 0x0200
	47	#define wxLC_EDIT_LABELS 0x0400
	48	#define wxLC_NO_HEADER 0x0800
	49	#define wxLC_NO_SORT_HEADER 0x1000
	50	#define wxLC_SINGLE_SEL 0x2000
	51	#define wxLC_SORT_ASCENDING 0x4000
	52	#define wxLC_SORT_DESCENDING 0x8000
	53
	54	#define wxLC_MASK_TYPE (wxLC_ICON \| wxLC_SMALL_ICON \| wxLC_LIST \| wxLC_REPORT)
	55	#define wxLC_MASK_ALIGN (wxLC_ALIGN_TOP \| wxLC_ALIGN_LEFT)
	56	#define wxLC_MASK_SORT (wxLC_SORT_ASCENDING \| wxLC_SORT_DESCENDING)
	57
	58	// for compatibility only
	59	#define wxLC_USER_TEXT wxLC_VIRTUAL
	60
	61	// Omitted because
	62	// (a) too much detail
	63	// (b) not enough style flags
	64	// (c) not implemented anyhow in the generic version
	65	//
	66	// #define wxLC_NO_SCROLL
	67	// #define wxLC_NO_LABEL_WRAP
	68	// #define wxLC_OWNERDRAW_FIXED
	69	// #define wxLC_SHOW_SEL_ALWAYS
	70
bdc72a22 VZ	71	// Mask flags to tell app/GUI what fields of wxListItem are valid
	72	#define wxLIST_MASK_STATE 0x0001
	73	#define wxLIST_MASK_TEXT 0x0002
	74	#define wxLIST_MASK_IMAGE 0x0004
	75	#define wxLIST_MASK_DATA 0x0008
	76	#define wxLIST_SET_ITEM 0x0010
	77	#define wxLIST_MASK_WIDTH 0x0020
	78	#define wxLIST_MASK_FORMAT 0x0040
	79
	80	// State flags for indicating the state of an item
	81	#define wxLIST_STATE_DONTCARE 0x0000
	82	#define wxLIST_STATE_DROPHILITED 0x0001 // MSW only
	83	#define wxLIST_STATE_FOCUSED 0x0002
	84	#define wxLIST_STATE_SELECTED 0x0004
	85	#define wxLIST_STATE_CUT 0x0008 // MSW only
	86
	87	// Hit test flags, used in HitTest
	88	#define wxLIST_HITTEST_ABOVE 0x0001 // Above the client area.
	89	#define wxLIST_HITTEST_BELOW 0x0002 // Below the client area.
	90	#define wxLIST_HITTEST_NOWHERE 0x0004 // In the client area but below the last item.
	91	#define wxLIST_HITTEST_ONITEMICON 0x0020 // On the bitmap associated with an item.
	92	#define wxLIST_HITTEST_ONITEMLABEL 0x0080 // On the label (string) associated with an item.
	93	#define wxLIST_HITTEST_ONITEMRIGHT 0x0100 // In the area to the right of an item.
	94	#define wxLIST_HITTEST_ONITEMSTATEICON 0x0200 // On the state icon for a tree view item that is in a user-defined state.
	95	#define wxLIST_HITTEST_TOLEFT 0x0400 // To the left of the client area.
	96	#define wxLIST_HITTEST_TORIGHT 0x0800 // To the right of the client area.
	97
	98	#define wxLIST_HITTEST_ONITEM (wxLIST_HITTEST_ONITEMICON \| wxLIST_HITTEST_ONITEMLABEL \| wxLIST_HITTEST_ONITEMSTATEICON)
	99
	100	// Flags for GetNextItem (MSW only except wxLIST_NEXT_ALL)
	101	enum
	102	{
	103	wxLIST_NEXT_ABOVE, // Searches for an item above the specified item
	104	wxLIST_NEXT_ALL, // Searches for subsequent item by index
	105	wxLIST_NEXT_BELOW, // Searches for an item below the specified item
	106	wxLIST_NEXT_LEFT, // Searches for an item to the left of the specified item
43543d98	107	wxLIST_NEXT_RIGHT // Searches for an item to the right of the specified item
bdc72a22 VZ	108	};
	109
	110	// Alignment flags for Arrange (MSW only except wxLIST_ALIGN_LEFT)
	111	enum
	112	{
	113	wxLIST_ALIGN_DEFAULT,
	114	wxLIST_ALIGN_LEFT,
	115	wxLIST_ALIGN_TOP,
	116	wxLIST_ALIGN_SNAP_TO_GRID
	117	};
	118
	119	// Column format (MSW only except wxLIST_FORMAT_LEFT)
	120	enum wxListColumnFormat
	121	{
	122	wxLIST_FORMAT_LEFT,
	123	wxLIST_FORMAT_RIGHT,
	124	wxLIST_FORMAT_CENTRE,
	125	wxLIST_FORMAT_CENTER = wxLIST_FORMAT_CENTRE
	126	};
	127
	128	// Autosize values for SetColumnWidth
	129	enum
	130	{
	131	wxLIST_AUTOSIZE = -1,
	132	wxLIST_AUTOSIZE_USEHEADER = -2 // partly supported by generic version
	133	};
	134
	135	// Flag values for GetItemRect
	136	enum
	137	{
	138	wxLIST_RECT_BOUNDS,
	139	wxLIST_RECT_ICON,
	140	wxLIST_RECT_LABEL
	141	};
	142
	143	// Flag values for FindItem (MSW only)
	144	enum
	145	{
	146	wxLIST_FIND_UP,
	147	wxLIST_FIND_DOWN,
	148	wxLIST_FIND_LEFT,
	149	wxLIST_FIND_RIGHT
	150	};
	151
	152	// ----------------------------------------------------------------------------
	153	// wxListItemAttr: a structure containing the visual attributes of an item
	154	// ----------------------------------------------------------------------------
	155
	156	class WXDLLEXPORT wxListItemAttr
	157	{
	158	public:
	159	// ctors
	160	wxListItemAttr() { }
	161	wxListItemAttr(const wxColour& colText,
	162	const wxColour& colBack,
	163	const wxFont& font)
	164	: m_colText(colText), m_colBack(colBack), m_font(font) { }
	165
	166	// setters
	167	void SetTextColour(const wxColour& colText) { m_colText = colText; }
	168	void SetBackgroundColour(const wxColour& colBack) { m_colBack = colBack; }
	169	void SetFont(const wxFont& font) { m_font = font; }
	170
	171	// accessors
d62228a6 VZ	172	bool HasTextColour() const { return m_colText.Ok(); }
	173	bool HasBackgroundColour() const { return m_colBack.Ok(); }
	174	bool HasFont() const { return m_font.Ok(); }
	175
bdc72a22 VZ	176	const wxColour& GetTextColour() const { return m_colText; }
	177	const wxColour& GetBackgroundColour() const { return m_colBack; }
	178	const wxFont& GetFont() const { return m_font; }
	179
	180	private:
	181	wxColour m_colText,
	182	m_colBack;
	183	wxFont m_font;
	184	};
	185
	186	// ----------------------------------------------------------------------------
	187	// wxListItem: the item or column info, used to exchange data with wxListCtrl
	188	// ----------------------------------------------------------------------------
	189
	190	class WXDLLEXPORT wxListItem : public wxObject
	191	{
	192	public:
	193	wxListItem();
d62228a6	194	~wxListItem() { delete m_attr; }
bdc72a22	195
9b00bb16 RR	196	// resetting
	197	void Clear();
	198	void ClearAttributes();
	199
bdc72a22 VZ	200	// setters
	201	void SetMask(long mask) { m_mask = mask; }
	202	void SetId(long id) { m_itemId = id; }
	203	void SetColumn(int col) { m_col = col; }
	204	void SetState(long state) { m_state = state; m_stateMask \|= state; }
	205	void SetStateMask(long stateMask) { m_stateMask = stateMask; }
	206	void SetText(const wxString& text) { m_text = text; }
	207	void SetImage(int image) { m_image = image; }
	208	void SetData(long data) { m_data = data; }
	209	void SetData(void *data) { m_data = (long)data; }
	210
	211	void SetWidth(int width) { m_width = width; }
	212	void SetAlign(wxListColumnFormat align) { m_format = align; }
	213
	214	void SetTextColour(const wxColour& colText)
	215	{ Attributes().SetTextColour(colText); }
	216	void SetBackgroundColour(const wxColour& colBack)
	217	{ Attributes().SetBackgroundColour(colBack); }
	218	void SetFont(const wxFont& font)
	219	{ Attributes().SetFont(font); }
	220
	221	// accessors
	222	long GetMask() const { return m_mask; }
	223	long GetId() const { return m_itemId; }
	224	int GetColumn() const { return m_col; }
	225	long GetState() const { return m_state & m_stateMask; }
	226	const wxString& GetText() const { return m_text; }
	227	int GetImage() const { return m_image; }
	228	long GetData() const { return m_data; }
	229
	230	int GetWidth() const { return m_width; }
	231	wxListColumnFormat GetAlign() const { return (wxListColumnFormat)m_format; }
	232
	233	wxListItemAttr *GetAttributes() const { return m_attr; }
	234	bool HasAttributes() const { return m_attr != NULL; }
	235
13111b2a	236	wxColour GetTextColour() const
bdc72a22	237	{ return HasAttributes() ? m_attr->GetTextColour() : wxNullColour; }
13111b2a	238	wxColour GetBackgroundColour() const
bdc72a22 VZ	239	{ return HasAttributes() ? m_attr->GetBackgroundColour()
bdc72a22 VZ	240	: wxNullColour; }
13111b2a	241	wxFont GetFont() const
bdc72a22 VZ	242	{ return HasAttributes() ? m_attr->GetFont() : wxNullFont; }
bdc72a22 VZ	243
cff5ce9e VZ	244	// this conversion is necessary to make old code using GetItem() to
	245	// compile
	246	operator long() const { return m_itemId; }
	247
bdc72a22 VZ	248	// these members are public for compatibility
	249
	250	long m_mask; // Indicates what fields are valid
	251	long m_itemId; // The zero-based item position
	252	int m_col; // Zero-based column, if in report mode
	253	long m_state; // The state of the item
	254	long m_stateMask;// Which flags of m_state are valid (uses same flags)
	255	wxString m_text; // The label/header text
	256	int m_image; // The zero-based index into an image list
	257	long m_data; // App-defined data
	258
	259	// For columns only
	260	int m_format; // left, right, centre
	261	int m_width; // width of column
	262
	263	protected:
	264	// creates m_attr if we don't have it yet
	265	wxListItemAttr& Attributes()
	266	{
	267	if ( !m_attr )
	268	m_attr = new wxListItemAttr;
	269
	270	return *m_attr;
	271	}
	272
	273	wxListItemAttr *m_attr; // optional pointer to the items style
	274
	275	private:
	276	DECLARE_DYNAMIC_CLASS(wxListItem)
	277	};
	278
	279	// ----------------------------------------------------------------------------
	280	// include the wxListCtrl class declaration
	281	// ----------------------------------------------------------------------------
	282
3e6e2754 JS	283	#if defined(__WXUNIVERSAL__)
	284	#include "wx/generic/listctrl.h"
	285	#elif defined(__WXMSW__)
bdc72a22 VZ	286	#ifdef __WIN16__
	287	#include "wx/generic/listctrl.h"
	288	#else
	289	#include "wx/msw/listctrl.h"
	290	#endif
2049ba38	291	#elif defined(__WXMOTIF__)
bdc72a22	292	#include "wx/generic/listctrl.h"
2049ba38	293	#elif defined(__WXGTK__)
bdc72a22	294	#include "wx/generic/listctrl.h"
b4e76e0d	295	#elif defined(__WXQT__)
bdc72a22	296	#include "wx/generic/listctrl.h"
34138703	297	#elif defined(__WXMAC__)
bdc72a22	298	#include "wx/generic/listctrl.h"
1777b9bb	299	#elif defined(__WXPM__)
bdc72a22	300	#include "wx/generic/listctrl.h"
34138703	301	#elif defined(__WXSTUBS__)
bdc72a22	302	#include "wx/generic/listctrl.h"
c801d85f KB	303	#endif
c801d85f KB	304
86f975a8 VZ	305	// ----------------------------------------------------------------------------
	306	// wxListEvent - the event class for the wxListCtrl notifications
	307	// ----------------------------------------------------------------------------
	308
	309	class WXDLLEXPORT wxListEvent : public wxNotifyEvent
	310	{
	311	public:
	312	wxListEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
	313
	314	int m_code;
	315	long m_itemIndex;
	316	long m_oldItemIndex;
	317	int m_col;
	318	bool m_cancelled;
	319	wxPoint m_pointDrag;
	320
	321	wxListItem m_item;
cdf1e714	322
225fe9d6 VZ	323	int GetCode() const { return m_code; }
	324	long GetIndex() const { return m_itemIndex; }
	325	long GetOldIndex() const { return m_oldItemIndex; }
	326	long GetOldItem() const { return m_oldItemIndex; }
	327	int GetColumn() const { return m_col; }
	328	bool Cancelled() const { return m_cancelled; }
	329	wxPoint GetPoint() const { return m_pointDrag; }
	330	const wxString& GetLabel() const { return m_item.m_text; }
	331	const wxString& GetText() const { return m_item.m_text; }
	332	int GetImage() const { return m_item.m_image; }
	333	long GetData() const { return m_item.m_data; }
	334	long GetMask() const { return m_item.m_mask; }
	335	const wxListItem& GetItem() const { return m_item; }
86f975a8	336
e4c730e9	337	void CopyObject(wxObject& object_dest) const;
e4c730e9	338
86f975a8 VZ	339	private:
	340	DECLARE_DYNAMIC_CLASS(wxListEvent)
	341	};
	342
2e4df4bf VZ	343	// ----------------------------------------------------------------------------
	344	// wxListCtrl event macros
	345	// ----------------------------------------------------------------------------
	346
	347	BEGIN_DECLARE_EVENT_TYPES()
	348	DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_BEGIN_DRAG, 700)
	349	DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_BEGIN_RDRAG, 701)
	350	DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT, 702)
	351	DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_END_LABEL_EDIT, 703)
	352	DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_DELETE_ITEM, 704)
	353	DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS, 705)
	354	DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_GET_INFO, 706)
	355	DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_SET_INFO, 707)
	356	DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_SELECTED, 708)
	357	DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_DESELECTED, 709)
	358	DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_KEY_DOWN, 710)
	359	DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_INSERT_ITEM, 711)
	360	DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_CLICK, 712)
	361	DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK, 713)
	362	DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK, 714)
	363	DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_ACTIVATED, 715)
	364	END_DECLARE_EVENT_TYPES()
	365
86f975a8 VZ	366	typedef void (wxEvtHandler::*wxListEventFunction)(wxListEvent&);
86f975a8 VZ	367
2e4df4bf VZ	368	#define EVT_LIST_BEGIN_DRAG(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_BEGIN_DRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
	369	#define EVT_LIST_BEGIN_RDRAG(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_BEGIN_RDRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
	370	#define EVT_LIST_BEGIN_LABEL_EDIT(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
	371	#define EVT_LIST_END_LABEL_EDIT(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_END_LABEL_EDIT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
	372	#define EVT_LIST_DELETE_ITEM(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_DELETE_ITEM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
	373	#define EVT_LIST_DELETE_ALL_ITEMS(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
	374	#define EVT_LIST_GET_INFO(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_GET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
	375	#define EVT_LIST_SET_INFO(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_SET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
	376	#define EVT_LIST_ITEM_SELECTED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_ITEM_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
	377	#define EVT_LIST_ITEM_DESELECTED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_ITEM_DESELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
	378	#define EVT_LIST_KEY_DOWN(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_KEY_DOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
	379	#define EVT_LIST_INSERT_ITEM(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_INSERT_ITEM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
	380	#define EVT_LIST_COL_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_COL_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
	381	#define EVT_LIST_ITEM_RIGHT_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL ),
	382	#define EVT_LIST_ITEM_MIDDLE_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL ),
	383	#define EVT_LIST_ITEM_ACTIVATED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_ITEM_ACTIVATED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL ),
86f975a8	384
1e6feb95 VZ	385	#endif // wxUSE_LISTCTRL
1e6feb95 VZ	386
c801d85f	387	#endif
34138703	388	// _WX_LISTCTRL_H_BASE_