// XListCtrl.h Version 1.4
//
// Author: Hans Dietrich
// hdietrich@gmail.com
//
// License:
// This software is released into the public domain. You are free to use
// it in any way you like, except that you may not sell this source code.
//
// This software is provided "as is" with no expressed or implied warranty.
// I accept no liability for any damage or loss of business that this
// software may cause.
//
///////////////////////////////////////////////////////////////////////////////
#ifndef XLISTCTRL_H
#define XLISTCTRL_H
#include "XHeaderCtrl.h"
#ifndef DO_NOT_INCLUDE_XCOMBOLIST
#include "XCombo.h"
#include "AdvComboBox.h"
#endif
#include "XEdit.h"
#if defined XLISTCTRLLIB_STATIC
#define XLISTCTRLLIBDLLEXPORT
#else
#ifdef XLISTCTRLLIB_EXPORTS
#define XLISTCTRLLIBDLLEXPORT _declspec(dllexport)
#else
#define XLISTCTRLLIBDLLEXPORT _declspec(dllimport)
#endif
#endif
///////////////////////////////////////////////////////////////////////////////
// The first two letters of the library name specify the MFC/XListCtrl
// build configuration as follows:
// MFC MFC XListCtrl XListCtrl
// DLL Static DLL Static
// DD x x
// DS x x
// SS x x
// SD ----------- not provided -----------
//
// The third letter specifies Release/Debug.
// The fourth letter specifies ANSI/UNICODE.
///////////////////////////////////////////////////////////////////////////////
#ifndef XLISTCTRLLIB_NOAUTOLIB
#if defined _AFXDLL && !defined XLISTCTRLLIB_STATIC
// MFC shared DLL with XListCtrl shared DLL
#ifdef _UNICODE
#ifdef _DEBUG
#pragma comment(lib,"XListCtrlDDDU.lib")
#pragma message("Automatically linking with XListCtrlDDDU.lib")
#else
#pragma comment(lib,"XListCtrlDDRU.lib")
#pragma message("Automatically linking with XListCtrlDDRU.lib")
#endif
#else
#ifdef _DEBUG
#pragma comment(lib,"XListCtrlDDDA.lib")
#pragma message("Automatically linking with XListCtrlDDDA.lib")
#else
#pragma comment(lib,"XListCtrlDDRA.lib")
#pragma message("Automatically linking with XListCtrlDDRA.lib")
#endif
#endif
#elif defined _AFXDLL && defined XLISTCTRLLIB_STATIC
// MFC shared DLL with XListCtrl static lib
#ifdef _UNICODE
#ifdef _DEBUG
#pragma comment(lib,"XListCtrlDSDU.lib")
#pragma message("Automatically linking with XListCtrlDSDU.lib")
#else
#pragma comment(lib,"XListCtrlDSRU.lib")
#pragma message("Automatically linking with XListCtrlDSRU.lib")
#endif
#else
#ifdef _DEBUG
#pragma comment(lib,"XListCtrlDSDA.lib")
#pragma message("Automatically linking with XListCtrlDSDA.lib")
#else
#pragma comment(lib,"XListCtrlDSRA.lib")
#pragma message("Automatically linking with XListCtrlDSRA.lib")
#endif
#endif
#elif !defined _AFXDLL && defined XLISTCTRLLIB_STATIC
// MFC static lib with XListCtrl static lib
#ifdef _UNICODE
#ifdef _DEBUG
#pragma comment(lib,"XListCtrlSSDU.lib")
#pragma message("Automatically linking with XListCtrlSSDU.lib")
#else
#pragma comment(lib,"XListCtrlSSRU.lib")
#pragma message("Automatically linking with XListCtrlSSRU.lib")
#endif
#else
#ifdef _DEBUG
#pragma comment(lib,"XListCtrlSSDA.lib")
#pragma message("Automatically linking with XListCtrlSSDA.lib")
#else
#pragma comment(lib,"XListCtrlSSRA.lib")
#pragma message("Automatically linking with XListCtrlSSRA.lib")
#endif
#endif
#else
#pragma message(" ")
#pragma message("--------------------------------------------------------------------------------")
#pragma message(" The SD build configuration (MFC static, XListCtrl DLL) is not available. ")
#pragma message("--------------------------------------------------------------------------------")
#pragma message(" ")
#error This build configuration is not available.
#endif
#endif
#if !defined XLISTCTRLLIB_EXPORTS && !defined XLISTCTRLLIB_STATIC
XLISTCTRLLIBDLLEXPORT UINT WM_XLISTCTRL_COMBO_SELECTION;
XLISTCTRLLIBDLLEXPORT UINT WM_XLISTCTRL_EDIT_END;
XLISTCTRLLIBDLLEXPORT UINT WM_XLISTCTRL_CHECKBOX_CLICKED;
#elif !defined XLISTCTRLLIB_EXPORTS && defined XLISTCTRLLIB_STATIC
extern UINT WM_XLISTCTRL_COMBO_SELECTION;
extern UINT WM_XLISTCTRL_EDIT_END;
extern UINT WM_XLISTCTRL_CHECKBOX_CLICKED;
#endif
///////////////////////////////////////////////////////////////////////////////
// CXListCtrl data
struct XLISTCTRLDATA
{
// ctor
XLISTCTRLDATA()
{
bEnabled = TRUE;
bBold = FALSE;
bModified = FALSE;
nImage = -1;
#ifndef NO_XLISTCTRL_TOOL_TIPS
strToolTip = _T("");
#endif
bCombo = FALSE;
bSort = FALSE;
psa = NULL;
nComboListHeight = 10;
nInitialComboSel = -1; // use default
bEdit = FALSE;
crText = ::GetSysColor(COLOR_WINDOWTEXT);
crBackground = ::GetSysColor(COLOR_WINDOW);
bShowProgress = FALSE;
nProgressPercent = 0;
strProgressMessage = _T("");
bShowProgressMessage = TRUE;
nCheckedState = -1;
dwItemData = 0;
}
BOOL bEnabled; // TRUE = enabled, FALSE = disabled (gray text)
BOOL bBold; // TRUE = display bold text
BOOL bModified; // TRUE = subitem has been modified
int nImage; // index in image list, else -1
#ifndef NO_XLISTCTRL_TOOL_TIPS
CString strToolTip; // tool tip text for cell
#endif
// for combo
BOOL bCombo; // TRUE = display combobox
BOOL bSort; // TRUE = add CBS_SORT style; this means
// that the list will be re-sorted on
// each AddString()
CStringArray * psa; // pointer to string array for combo listbox
int nComboListHeight; // combo listbox height (in rows)
int nInitialComboSel; // initial combo listbox selection (0 = first)
//for edit
BOOL bEdit; // true = enable editing
// for color
COLORREF crText;
COLORREF crBackground;
// for progress
BOOL bShowProgress; // true = show progress control
int nProgressPercent; // 0 - 100
CString strProgressMessage; // custom message for progress indicator -
// MUST INCLUDE %d
BOOL bShowProgressMessage; // TRUE = display % message, or custom message
// if one is supplied
// for checkbox
int nCheckedState; // -1 = don't show, 0 = unchecked, 1 = checked
DWORD dwItemData; // pointer to app's data
};
///////////////////////////////////////////////////////////////////////////////
// CXListCtrl class
class XLISTCTRLLIBDLLEXPORT CXListCtrl : public CListCtrl
{
// Construction
public:
CXListCtrl();
virtual ~CXListCtrl();
// Attributes
public:
// Operations
public:
int CountCheckedItems(int nSubItem);
BOOL DeleteAllItems();
BOOL DeleteItem(int nItem);
void DeleteProgress(int nItem, int nSubItem);
int FindDataItem(DWORD dwData); //+++
BOOL GetBold(int nItem, int nSubItem);
int GetCellPadding() { return m_nPadding; } //+++
int GetCheckbox(int nItem, int nSubItem);
int GetColumns();
CString GetComboText(int iItem, int iSubItem);
int GetCurSel();
BOOL GetEllipsis() { return m_bUseEllipsis; } //+++
BOOL GetEnabled(int nItem);
DWORD GetExtendedStyleX() { return m_dwExtendedStyleX; }
int GetHeaderCheckedState(int nSubItem);
int GetItemCheckedState(int nItem, int nSubItem); //+++
BOOL GetItemColors(int nItem, //+++
int nSubItem,
COLORREF& crText,
COLORREF& crBackground);
DWORD GetItemData(int nItem);
BOOL GetListModified() { return m_bListModified; } //+++
BOOL GetModified(int nItem, int nSubItem); //+++
BOOL GetSubItemRect(int iItem, int iSubItem, int nArea, CRect& rect);
int InsertItem(int nItem, LPCTSTR lpszItem);
int InsertItem(int nItem,
LPCTSTR lpszItem,
COLORREF crText,
COLORREF crBackground);
int InsertItem(const LVITEM* pItem);
BOOL SetBold(int nItem, int nSubItem, BOOL bBold);
void SetCellPadding(int nPadding) { m_nPadding = nPadding; } //+++
BOOL SetComboBox(int nItem,
int nSubItem,
BOOL bEnableCombo,
CStringArray *psa,
int nComboListHeight,
int nInitialComboSel,
BOOL bSort = FALSE); //+++
BOOL SetCheckbox(int nItem, int nSubItem, int nCheckedState);
virtual int SetColumnWidth(int nCol, int cx)
{
CListCtrl::SetColumnWidth(nCol, cx);
int w = CListCtrl::GetColumnWidth(nCol);
return CListCtrl::SetColumnWidth(nCol, w + (m_HeaderCtrl.GetSpacing()*2));
}
BOOL SetCurSel(int nItem, BOOL bEnsureVisible = FALSE); //+++
BOOL SetEdit(int nItem, int nSubItem);
BOOL SetEllipsis(BOOL bEllipsis) //+++
{
BOOL bOldEllipsis = m_bUseEllipsis;
m_bUseEllipsis = bEllipsis;
return bOldEllipsis;
}
BOOL SetEnabled(int nItem, BOOL bEnable);
DWORD SetExtendedStyleX(DWORD dwNewStyle)
{
DWORD dwOldStyle = m_dwExtendedStyleX;
m_dwExtendedStyleX = dwNewStyle;
return dwOldStyle;
}
void SetHeaderAlignment(UINT nFormat) { m_HeaderCtrl.SetAlignment(nFormat); } //+++
void SetHeaderTextColor(COLORREF rgbText) { m_HeaderCtrl.SetTextColor(rgbText); } //+++
BOOL SetHeaderCheckedState(int nSubItem, int nCheckedState);
void SetItemCheckedState(int nItem, int nSubItem, int nCheckedState); //+++
int SetItem(const LVITEM* pItem);
void SetItemColors(int nItem, //+++
int nSubItem,
COLORREF crText,
COLORREF crBackground);
BOOL SetItemData(int nItem, DWORD dwData);
BOOL SetItemImage(int nItem, int nSubItem, int nImage);
BOOL SetItemText(int nItem, int nSubItem, LPCTSTR lpszText);
BOOL SetItemText(int nItem,
int nSubItem,
LPCTSTR lpszText,
COLORREF crText,
COLORREF crBackground);
void SetListModified(BOOL bListModified) { m_bListModified = bListModified; } //+++
void SetModified(int nItem, int nSubItem, BOOL bModified); //+++
BOOL SetProgress(int nItem,
int nSubItem,
BOOL bShowProgressText = TRUE,
LPCTSTR lpszProgressText = NULL);
void UpdateProgress(int nItem, int nSubItem, int nPercent);
void UpdateSubItem(int nItem, int nSubItem);
#ifndef NO_XLISTCTRL_TOOL_TIPS
void DeleteAllToolTips();
BOOL SetItemToolTipText(int nItem, int nSubItem, LPCTSTR lpszToolTipText);
CString GetItemToolTipText(int nItem, int nSubItem);
virtual int OnToolHitTest(CPoint point, TOOLINFO * pTI) const;
#endif
// Overrides
// ClassWizard generated virtual function overrides
//{{AFX_VIRTUAL(CXListCtrl)
public:
virtual void PreSubclassWindow();
//}}AFX_VIRTUAL
// Implementation
public:
CXHeaderCtrl m_HeaderCtrl;
CImageList m_cImageList; // Image list for the header control
protected:
void DrawCheckbox(int nItem,
int nSubItem,
CDC *pDC,
COLORREF crText,
COLORREF crBkgnd,
CRect& rect,
XLISTCTRLDATA *pCLD);
#ifndef DO_NOT_INCLUDE_XCOMBOLIST
void DrawComboBox(int nItem,
int nSubItem);
#endif
void DrawEdit(int nItem, int nSubItem);
int DrawImage(int nItem,
int nSubItem,
CDC* pDC,
COLORREF crText,
COLORREF crBkgnd,
CRect rect,
XLISTCTRLDATA *pXLCD);
void DrawProgress(int nItem,
int nSubItem,
CDC *pDC,
COLORREF crText,
COLORREF crBkgnd,
CRect& rect,
XLISTCTRLDATA *pCLD);
void DrawText(int nItem,
int nSubItem,
CDC *pDC,
COLORREF crText,
COLORREF crBkgnd,
CRect& rect,
XLISTCTRLDATA *pCLD);
void GetColors();
void GetDrawColors(int nItem,
int nSubItem,
COLORREF& colorText,
COLORREF& colorBkgnd);
void SubclassHeaderControl();
BOOL m_bHeaderIsSubclassed;
BOOL m_bUseEllipsis; //+++
BOOL m_bListModified; //+++
DWORD m_dwExtendedStyleX;
int m_nPadding; //+++
CString m_strInitialString; // used to save the initial string
// for edit and combo fields
BOOL m_bInitialCheck; // initial check state of a checkbox field
// for edit box
CXEdit * m_pEdit; //+++
int m_nEditItem;
int m_nEditSubItem;
#ifndef DO_NOT_INCLUDE_XCOMBOLIST //-----------------------------------------
BOOL m_bComboIsClicked;
int m_nComboItem;
int m_nComboSubItem;
CRect m_rectComboButton;
CRect m_rectComboList;
CXCombo * m_pCombo;
CFont m_ListboxFont;
BOOL m_bFontIsCreated;
#endif //---------------------------------------------------------------------
COLORREF m_cr3DFace;
COLORREF m_cr3DHighLight;
COLORREF m_cr3DShadow;
COLORREF m_crActiveCaption;
COLORREF m_crBtnFace;
COLORREF m_crBtnShadow;
COLORREF m_crBtnText;
COLORREF m_crGrayText;
COLORREF m_crHighLight;
COLORREF m_crHighLightText;
COLORREF m_crInactiveCaption;
COLORREF m_crInactiveCaptionText;
COLORREF m_crWindow;
COLORREF m_crWindowText;
// Generated message map functions
protected:
//{{AFX_MSG(CXListCtrl)
afx_msg BOOL OnClick(NMHDR* pNMHDR, LRESULT* pResult);
afx_msg BOOL OnColumnClick(NMHDR* pNMHDR, LRESULT* pResult);
afx_msg int OnCreate(LPCREATESTRUCT lpCreateStruct);
afx_msg void OnCustomDraw(NMHDR* pNMHDR, LRESULT* pResult);
afx_msg void OnDestroy();
afx_msg void OnLButtonDown(UINT nFlags, CPoint point);
afx_msg void OnPaint();
afx_msg void OnSysColorChange();
afx_msg BOOL OnEraseBkgnd(CDC* pDC);
afx_msg void OnKeyDown(UINT nChar, UINT nRepCnt, UINT nFlags);
afx_msg void OnRButtonDown(UINT nFlags, CPoint point);
afx_msg void OnNcLButtonDown(UINT nHitTest, CPoint point);
//}}AFX_MSG
#ifndef DO_NOT_INCLUDE_XCOMBOLIST
afx_msg void OnTimer(UINT nIDEvent);
afx_msg LRESULT OnComboEscape(WPARAM, LPARAM);
afx_msg LRESULT OnComboComplete(WPARAM, LPARAM);
#endif
#ifndef NO_XLISTCTRL_TOOL_TIPS
virtual afx_msg BOOL OnToolTipText(UINT id, NMHDR * pNMHDR, LRESULT * pResult);
#endif
afx_msg LRESULT OnXEditKillFocus(WPARAM, LPARAM);
afx_msg LRESULT OnXEditEscape(WPARAM, LPARAM);
DECLARE_MESSAGE_MAP()
};
/////////////////////////////////////////////////////////////////////////////
//{{AFX_INSERT_LOCATION}}
// Microsoft Visual C++ will insert additional declarations immediately before the previous line.
#endif //XLISTCTRL_H
Submit an article or tip