03647350fc
This commit is huge but there are no non-white-space changes in it. Some files containing third-party sources (src/msw/wince/time.cpp, src/x11/pango*.cpp) were left unchanged. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@61724 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
397 lines
14 KiB
C++
397 lines
14 KiB
C++
/////////////////////////////////////////////////////////////////////////////
|
|
// Name: wx/palmos/listctrl.h
|
|
// Purpose: wxListCtrl class
|
|
// Author: William Osborne - minimal working wxPalmOS port
|
|
// Modified by: Yunhui Fu
|
|
// Created: 10/13/04
|
|
// RCS-ID: $Id$
|
|
// Copyright: (c) William Osborne
|
|
// Licence: wxWindows licence
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef _WX_LISTCTRL_H_
|
|
#define _WX_LISTCTRL_H_
|
|
|
|
#if wxUSE_LISTCTRL
|
|
|
|
#include "wx/control.h"
|
|
#include "wx/event.h"
|
|
#include "wx/hash.h"
|
|
#include "wx/textctrl.h"
|
|
|
|
|
|
class WXDLLIMPEXP_FWD_CORE wxImageList;
|
|
|
|
/*
|
|
The wxListCtrl can show lists of items in four different modes:
|
|
wxLC_LIST: multicolumn list view, with optional small icons (icons could be
|
|
optional for some platforms). Columns are computed automatically,
|
|
i.e. you don't set columns as in wxLC_REPORT. In other words,
|
|
the list wraps, unlike a wxListBox.
|
|
wxLC_REPORT: single or multicolumn report view (with optional header)
|
|
wxLC_ICON: large icon view, with optional labels
|
|
wxLC_SMALL_ICON: small icon view, with optional labels
|
|
|
|
You can change the style dynamically, either with SetSingleStyle or
|
|
SetWindowStyleFlag.
|
|
|
|
Further window styles:
|
|
|
|
wxLC_ALIGN_TOP icons align to the top (default)
|
|
wxLC_ALIGN_LEFT icons align to the left
|
|
wxLC_AUTOARRANGE icons arrange themselves
|
|
wxLC_USER_TEXT the app provides label text on demand, except for column headers
|
|
wxLC_EDIT_LABELS labels are editable: app will be notified.
|
|
wxLC_NO_HEADER no header in report mode
|
|
wxLC_NO_SORT_HEADER can't click on header
|
|
wxLC_SINGLE_SEL single selection
|
|
wxLC_SORT_ASCENDING sort ascending (must still supply a comparison callback in SortItems)
|
|
wxLC_SORT_DESCENDING sort descending (ditto)
|
|
|
|
Items are referred to by their index (position in the list starting from zero).
|
|
|
|
Label text is supplied via insertion/setting functions and is stored by the
|
|
control, unless the wxLC_USER_TEXT style has been specified, in which case
|
|
the app will be notified when text is required (see sample).
|
|
|
|
Images are dealt with by (optionally) associating 3 image lists with the control.
|
|
Zero-based indexes into these image lists indicate which image is to be used for
|
|
which item. Each image in an image list can contain a mask, and can be made out
|
|
of either a bitmap, two bitmaps or an icon. See ImagList.h for more details.
|
|
|
|
Notifications are passed via the wxWidgets 2.0 event system, or using virtual
|
|
functions in wxWidgets 1.66.
|
|
|
|
See the sample wxListCtrl app for API usage.
|
|
|
|
TODO:
|
|
- addition of further convenience functions
|
|
to avoid use of wxListItem in some functions
|
|
- state/overlay images: probably not needed.
|
|
- testing of whole API, extending current sample.
|
|
|
|
|
|
*/
|
|
|
|
class WXDLLIMPEXP_CORE wxListCtrl: public wxControl
|
|
{
|
|
public:
|
|
/*
|
|
* Public interface
|
|
*/
|
|
|
|
wxListCtrl() { Init(); }
|
|
|
|
wxListCtrl(wxWindow *parent,
|
|
wxWindowID id = wxID_ANY,
|
|
const wxPoint& pos = wxDefaultPosition,
|
|
const wxSize& size = wxDefaultSize,
|
|
long style = wxLC_ICON,
|
|
const wxValidator& validator = wxDefaultValidator,
|
|
const wxString& name = wxListCtrlNameStr)
|
|
{
|
|
Init();
|
|
|
|
Create(parent, id, pos, size, style, validator, name);
|
|
}
|
|
|
|
virtual ~wxListCtrl();
|
|
|
|
bool Create(wxWindow *parent,
|
|
wxWindowID id = wxID_ANY,
|
|
const wxPoint& pos = wxDefaultPosition,
|
|
const wxSize& size = wxDefaultSize,
|
|
long style = wxLC_ICON,
|
|
const wxValidator& validator = wxDefaultValidator,
|
|
const wxString& name = wxListCtrlNameStr);
|
|
|
|
|
|
// Attributes
|
|
////////////////////////////////////////////////////////////////////////////
|
|
|
|
// Set the control colours
|
|
bool SetForegroundColour(const wxColour& col);
|
|
bool SetBackgroundColour(const wxColour& col);
|
|
|
|
// Gets information about this column
|
|
bool GetColumn(int col, wxListItem& item) const;
|
|
|
|
// Sets information about this column
|
|
bool SetColumn(int col, wxListItem& item) ;
|
|
|
|
// Gets the column width
|
|
int GetColumnWidth(int col) const;
|
|
|
|
// Sets the column width
|
|
bool SetColumnWidth(int col, int width) ;
|
|
|
|
// Gets the number of items that can fit vertically in the
|
|
// visible area of the list control (list or report view)
|
|
// or the total number of items in the list control (icon
|
|
// or small icon view)
|
|
int GetCountPerPage() const;
|
|
|
|
// return the total area occupied by all the items (icon/small icon only)
|
|
wxRect GetViewRect() const;
|
|
|
|
// Gets the edit control for editing labels.
|
|
wxTextCtrl* GetEditControl() const;
|
|
|
|
// Gets information about the item
|
|
bool GetItem(wxListItem& info) const ;
|
|
|
|
// Sets information about the item
|
|
bool SetItem(wxListItem& info) ;
|
|
|
|
// Sets a string field at a particular column
|
|
long SetItem(long index, int col, const wxString& label, int imageId = -1);
|
|
|
|
// Gets the item state
|
|
int GetItemState(long item, long stateMask) const ;
|
|
|
|
// Sets the item state
|
|
bool SetItemState(long item, long state, long stateMask) ;
|
|
|
|
// Sets the item image
|
|
bool SetItemImage(long item, int image, int selImage) ;
|
|
bool SetItemColumnImage(long item, long column, int image);
|
|
|
|
// Gets the item text
|
|
wxString GetItemText(long item) const ;
|
|
|
|
// Sets the item text
|
|
void SetItemText(long item, const wxString& str) ;
|
|
|
|
// Gets the item data
|
|
long GetItemData(long item) const ;
|
|
|
|
// Sets the item data
|
|
bool SetItemPtrData(long item, wxUIntPtr data);
|
|
bool SetItemData(long item, long data) { return SetItemPtrData(item, data); }
|
|
|
|
// Gets the item rectangle
|
|
bool GetItemRect(long item, wxRect& rect, int code = wxLIST_RECT_BOUNDS) const ;
|
|
|
|
// Gets the item position
|
|
bool GetItemPosition(long item, wxPoint& pos) const ;
|
|
|
|
// Sets the item position
|
|
bool SetItemPosition(long item, const wxPoint& pos) ;
|
|
|
|
// Gets the number of items in the list control
|
|
int GetItemCount() const;
|
|
|
|
// Gets the number of columns in the list control
|
|
int GetColumnCount() const { return m_colCount; }
|
|
|
|
// get the horizontal and vertical components of the item spacing
|
|
wxSize GetItemSpacing() const;
|
|
|
|
// Foreground colour of an item.
|
|
void SetItemTextColour( long item, const wxColour& col);
|
|
wxColour GetItemTextColour( long item ) const;
|
|
|
|
// Background colour of an item.
|
|
void SetItemBackgroundColour( long item, const wxColour &col);
|
|
wxColour GetItemBackgroundColour( long item ) const;
|
|
|
|
// Gets the number of selected items in the list control
|
|
int GetSelectedItemCount() const;
|
|
|
|
// Gets the text colour of the listview
|
|
wxColour GetTextColour() const;
|
|
|
|
// Sets the text colour of the listview
|
|
void SetTextColour(const wxColour& col);
|
|
|
|
// Gets the index of the topmost visible item when in
|
|
// list or report view
|
|
long GetTopItem() const ;
|
|
|
|
// Add or remove a single window style
|
|
void SetSingleStyle(long style, bool add = true) ;
|
|
|
|
// Searches for an item, starting from 'item'.
|
|
// item can be -1 to find the first item that matches the
|
|
// specified flags.
|
|
// Returns the item or -1 if unsuccessful.
|
|
long GetNextItem(long item, int geometry = wxLIST_NEXT_ALL, int state = wxLIST_STATE_DONTCARE) const ;
|
|
|
|
// Gets one of the three image lists
|
|
wxImageList *GetImageList(int which) const ;
|
|
|
|
// Sets the image list
|
|
void SetImageList(wxImageList *imageList, int which) ;
|
|
void AssignImageList(wxImageList *imageList, int which) ;
|
|
|
|
// are we in report mode?
|
|
bool InReportView() const { return HasFlag(wxLC_REPORT); }
|
|
|
|
// are we in virtual report mode?
|
|
bool IsVirtual() const { return HasFlag(wxLC_VIRTUAL); }
|
|
|
|
// refresh items selectively (only useful for virtual list controls)
|
|
void RefreshItem(long item);
|
|
void RefreshItems(long itemFrom, long itemTo);
|
|
|
|
// Operations
|
|
////////////////////////////////////////////////////////////////////////////
|
|
|
|
// Arranges the items
|
|
bool Arrange(int flag = wxLIST_ALIGN_DEFAULT);
|
|
|
|
// Deletes an item
|
|
bool DeleteItem(long item);
|
|
|
|
// Deletes all items
|
|
bool DeleteAllItems() ;
|
|
|
|
// Deletes a column
|
|
bool DeleteColumn(int col);
|
|
|
|
// Deletes all columns
|
|
bool DeleteAllColumns();
|
|
|
|
// Clears items, and columns if there are any.
|
|
void ClearAll();
|
|
|
|
// Edit the label
|
|
wxTextCtrl* EditLabel(long item, wxClassInfo* textControlClass = CLASSINFO(wxTextCtrl));
|
|
|
|
// End label editing, optionally cancelling the edit
|
|
bool EndEditLabel(bool cancel);
|
|
|
|
// Ensures this item is visible
|
|
bool EnsureVisible(long item) ;
|
|
|
|
// Find an item whose label matches this string, starting from the item after 'start'
|
|
// or the beginning if 'start' is -1.
|
|
long FindItem(long start, const wxString& str, bool partial = false);
|
|
|
|
// Find an item whose data matches this data, starting from the item after 'start'
|
|
// or the beginning if 'start' is -1.
|
|
long FindItem(long start, long data);
|
|
|
|
// Find an item nearest this position in the specified direction, starting from
|
|
// the item after 'start' or the beginning if 'start' is -1.
|
|
long FindItem(long start, const wxPoint& pt, int direction);
|
|
|
|
// Determines which item (if any) is at the specified point,
|
|
// giving details in 'flags' (see wxLIST_HITTEST_... flags above)
|
|
long HitTest(const wxPoint& point, int& flags);
|
|
|
|
// Inserts an item, returning the index of the new item if successful,
|
|
// -1 otherwise.
|
|
long InsertItem(wxListItem& info);
|
|
|
|
// Insert a string item
|
|
long InsertItem(long index, const wxString& label);
|
|
|
|
// Insert an image item
|
|
long InsertItem(long index, int imageIndex);
|
|
|
|
// Insert an image/string item
|
|
long InsertItem(long index, const wxString& label, int imageIndex);
|
|
|
|
// For list view mode (only), inserts a column.
|
|
long InsertColumn(long col, wxListItem& info);
|
|
|
|
long InsertColumn(long col,
|
|
const wxString& heading,
|
|
int format = wxLIST_FORMAT_LEFT,
|
|
int width = -1);
|
|
|
|
// set the number of items in a virtual list control
|
|
void SetItemCount(long count);
|
|
|
|
// Scrolls the list control. If in icon, small icon or report view mode,
|
|
// x specifies the number of pixels to scroll. If in list view mode, x
|
|
// specifies the number of columns to scroll.
|
|
// If in icon, small icon or list view mode, y specifies the number of pixels
|
|
// to scroll. If in report view mode, y specifies the number of lines to scroll.
|
|
bool ScrollList(int dx, int dy);
|
|
|
|
// Sort items.
|
|
|
|
// fn is a function which takes 3 long arguments: item1, item2, data.
|
|
// item1 is the long data associated with a first item (NOT the index).
|
|
// item2 is the long data associated with a second item (NOT the index).
|
|
// data is the same value as passed to SortItems.
|
|
// The return value is a negative number if the first item should precede the second
|
|
// item, a positive number of the second item should precede the first,
|
|
// or zero if the two items are equivalent.
|
|
|
|
// data is arbitrary data to be passed to the sort function.
|
|
bool SortItems(wxListCtrlCompare fn, long data);
|
|
|
|
// bring the control in sync with current m_windowStyle value
|
|
void UpdateStyle();
|
|
|
|
// Event handlers
|
|
////////////////////////////////////////////////////////////////////////////
|
|
// Necessary for drawing hrules and vrules, if specified
|
|
void OnPaint(wxPaintEvent& event);
|
|
|
|
|
|
virtual bool ShouldInheritColours() const { return false; }
|
|
|
|
virtual wxVisualAttributes GetDefaultAttributes() const
|
|
{
|
|
return GetClassDefaultAttributes(GetWindowVariant());
|
|
}
|
|
|
|
static wxVisualAttributes
|
|
GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
|
|
|
|
protected:
|
|
// common part of all ctors
|
|
void Init();
|
|
|
|
// free memory taken by all internal data
|
|
void FreeAllInternalData();
|
|
|
|
wxTextCtrl* m_textCtrl; // The control used for editing a label
|
|
wxImageList * m_imageListNormal; // The image list for normal icons
|
|
wxImageList * m_imageListSmall; // The image list for small icons
|
|
wxImageList * m_imageListState; // The image list state icons (not implemented yet)
|
|
bool m_ownsImageListNormal,
|
|
m_ownsImageListSmall,
|
|
m_ownsImageListState;
|
|
|
|
int m_colCount; // Windows doesn't have GetColumnCount so must
|
|
// keep track of inserted/deleted columns
|
|
long m_count; // Keep track of item count to save calls to
|
|
// ListView_GetItemCount
|
|
bool m_ignoreChangeMessages;
|
|
|
|
// true if we have any internal data (user data & attributes)
|
|
bool m_AnyInternalData;
|
|
|
|
// true if we have any items with custom attributes
|
|
bool m_hasAnyAttr;
|
|
|
|
// these functions are only used for virtual list view controls, i.e. the
|
|
// ones with wxLC_VIRTUAL style
|
|
|
|
// return the text for the given column of the given item
|
|
virtual wxString OnGetItemText(long item, long column) const;
|
|
|
|
// return the icon for the given item. In report view, OnGetItemImage will
|
|
// only be called for the first column. See OnGetItemColumnImage for
|
|
// details.
|
|
virtual int OnGetItemImage(long item) const;
|
|
|
|
// return the attribute for the item (may return NULL if none)
|
|
virtual wxListItemAttr *OnGetItemAttr(long item) const;
|
|
|
|
private:
|
|
|
|
DECLARE_DYNAMIC_CLASS(wxListCtrl)
|
|
DECLARE_EVENT_TABLE()
|
|
wxDECLARE_NO_COPY_CLASS(wxListCtrl);
|
|
};
|
|
|
|
#endif // wxUSE_LISTCTRL
|
|
|
|
#endif // _WX_LISTCTRL_H_
|