[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_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(__WIN32__) && !defined(__WXUNIVERSAL__)
    #include "wx/msw/listctrl.h"
#else
    #include "wx/generic/listctrl.h"
#endif

// ----------------------------------------------------------------------------
// wxListView: a class which provides a better API for list control
// ----------------------------------------------------------------------------

class WXDLLEXPORT wxListView : public wxListCtrl
{
public:
    wxListView() { }
    wxListView( wxWindow *parent,
                wxWindowID id = -1,
                const wxPoint& pos = wxDefaultPosition,
                const wxSize& size = wxDefaultSize,
                long style = wxLC_REPORT,
                const wxValidator& validator = wxDefaultValidator,
                const wxString &name = "listctrl" )
    {
        Create(parent, id, pos, size, style, wxDefaultValidator, name);
    }

    // [de]select an item
    void Select(long n, bool on = true)
    {
        SetItemState(n, on ? wxLIST_STATE_SELECTED : 0, wxLIST_STATE_SELECTED);
    }

    // focus and show the given item
    void Focus(long index)
    {
        SetItemState(index, wxLIST_STATE_FOCUSED, wxLIST_STATE_FOCUSED);
        EnsureVisible(index);
    }

    // get the currently focused item or -1 if none
    long GetFocusedItem() const
    {
        return GetNextItem(-1, wxLIST_NEXT_ALL, wxLIST_STATE_FOCUSED);
    }

    // get first and subsequent selected items, return -1 when no more
    long GetNextSelected(long item) const
        { return GetNextItem(item, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED); }
    long GetFirstSelected() const
        { return GetNextSelected(-1); }

    // return TRUE if the item is selected
    bool IsSelected(long index)
        { return GetItemState(index, wxLIST_STATE_SELECTED) != 0; }
};

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