You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
496 lines
21 KiB
C++
496 lines
21 KiB
C++
// XTPHeaderCtrl.h interface for the CXTPHeaderCtrl class.
|
|
//
|
|
// This file is a part of the XTREME CONTROLS MFC class library.
|
|
// (c)1998-2012 Codejock Software, All Rights Reserved.
|
|
//
|
|
// THIS SOURCE FILE IS THE PROPERTY OF CODEJOCK SOFTWARE AND IS NOT TO BE
|
|
// RE-DISTRIBUTED BY ANY MEANS WHATSOEVER WITHOUT THE EXPRESSED WRITTEN
|
|
// CONSENT OF CODEJOCK SOFTWARE.
|
|
//
|
|
// THIS SOURCE CODE CAN ONLY BE USED UNDER THE TERMS AND CONDITIONS OUTLINED
|
|
// IN THE XTREME TOOLKIT PRO LICENSE AGREEMENT. CODEJOCK SOFTWARE GRANTS TO
|
|
// YOU (ONE SOFTWARE DEVELOPER) THE LIMITED RIGHT TO USE THIS SOFTWARE ON A
|
|
// SINGLE COMPUTER.
|
|
//
|
|
// CONTACT INFORMATION:
|
|
// support@codejock.com
|
|
// http://www.codejock.com
|
|
//
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
//{{AFX_CODEJOCK_PRIVATE
|
|
#if !defined(__XTHEADERCTRL_H__)
|
|
#define __XTHEADERCTRL_H__
|
|
//}}AFX_CODEJOCK_PRIVATE
|
|
|
|
#if _MSC_VER >= 1000
|
|
#pragma once
|
|
#endif // _MSC_VER >= 1000
|
|
|
|
class CXTPImageManager;
|
|
class CXTPHeaderCtrlTheme;
|
|
|
|
//========================================================================
|
|
// Summary:
|
|
// CXTPHeaderCtrl is a CHeaderCtrl derived class. It is used to create
|
|
// a CXTPHeaderCtrl window similar to CHeaderCtrl, but with additional functionality.
|
|
// Remarks:
|
|
// A "header control" is a window that is usually positioned above columns of text
|
|
// or numbers. It contains a title for each column, and it can be divided
|
|
// into parts. The user can drag the dividers that separate the parts to
|
|
// set the width of each column.
|
|
//
|
|
// Use a header control, represented by class CXTPHeaderCtrl, to display
|
|
// column headers for a columnar list. For example, a header control would
|
|
// be useful for implementing column controls in a spreadsheet.
|
|
//
|
|
// The header control is usually divided into parts, called "header items",
|
|
// each bearing a title for the associated column of text or numbers. Depending
|
|
// on the styles you set, you can provide a number of direct ways for users
|
|
// to manipulate the header items.
|
|
//========================================================================
|
|
class _XTP_EXT_CLASS CXTPHeaderCtrl : public CHeaderCtrl
|
|
{
|
|
DECLARE_DYNAMIC(CXTPHeaderCtrl)
|
|
|
|
public:
|
|
//--------------------------------------------------------------------
|
|
// Summary:
|
|
// Constructs a CXTPHeaderCtrl object
|
|
//--------------------------------------------------------------------
|
|
CXTPHeaderCtrl();
|
|
|
|
//--------------------------------------------------------------------
|
|
// Summary:
|
|
// Destroys a CXTPHeaderCtrl object, handles cleanup and deallocation
|
|
//--------------------------------------------------------------------
|
|
virtual ~CXTPHeaderCtrl();
|
|
|
|
public:
|
|
|
|
//--------------------------------------------------------------------
|
|
// Summary:
|
|
// Call this member function to enable auto-sizing for the header control.
|
|
// This will cause the columns in the list control to be sized to fit
|
|
// in the available space when the list control is resized.
|
|
// Parameters:
|
|
// bEnable - true to enable an auto-sizing header control.
|
|
//--------------------------------------------------------------------
|
|
void EnableAutoSize(bool bEnable = true);
|
|
|
|
//--------------------------------------------------------------------
|
|
// Summary:
|
|
// Call this member function to freeze a column in the header control.
|
|
// Freezing a column will disable sizing for the column.
|
|
// Parameters:
|
|
// iCol - Index of the column to freeze.
|
|
//--------------------------------------------------------------------
|
|
void FreezeColumn(int iCol);
|
|
|
|
//--------------------------------------------------------------------
|
|
// Summary:
|
|
// Call this member function to thaw a column in the header control.
|
|
// Thawing a column will enable sizing for the column if it was previously
|
|
// frozen.
|
|
// Parameters:
|
|
// iCol - Index of the column to thaw.
|
|
//--------------------------------------------------------------------
|
|
void ThawColumn(int iCol);
|
|
|
|
//--------------------------------------------------------------------
|
|
// Summary:
|
|
// Call this member function to thaw all column in the header control.
|
|
// This will will enable sizing for any column that was previously
|
|
// frozen.
|
|
//--------------------------------------------------------------------
|
|
void ThawAllColumns();
|
|
|
|
//--------------------------------------------------------------------
|
|
// Summary:
|
|
// Call this member function to determine if the specified column is
|
|
// frozen.
|
|
// Parameters:
|
|
// iCol - Index of the column to check.
|
|
// Returns:
|
|
// true if the column is frozen, otherwise returns false.
|
|
//--------------------------------------------------------------------
|
|
bool IsColFrozen(int iCol);
|
|
|
|
//--------------------------------------------------------------------
|
|
// Summary:
|
|
// Call this member to set the minimum size for auto-sizing columns.
|
|
// The minimum size represents the smallest size that all columns can
|
|
// be sized to.
|
|
// Parameters:
|
|
// iMinSize - Minimum column size.
|
|
//--------------------------------------------------------------------
|
|
void SetMinSize(int iMinSize);
|
|
|
|
//--------------------------------------------------------------------
|
|
// Summary:
|
|
// This member function will set the sort image for the specified column.
|
|
// Parameters:
|
|
// iSortCol - Zero-based index of the column to set the sort image for.
|
|
// bSortAsc - TRUE if ascending, otherwise FALSE.
|
|
// Returns:
|
|
// A zero-based index of the previously sorted column.
|
|
//--------------------------------------------------------------------
|
|
int SetSortImage(int iSortCol, BOOL bSortAsc);
|
|
|
|
//--------------------------------------------------------------------
|
|
// Summary:
|
|
// Call this member function to return the index to the currently sorted
|
|
// column.
|
|
// Parameters:
|
|
// pbSortAsc - Set to TRUE if ascending, otherwise FALSE.
|
|
// Returns:
|
|
// The index of the currently sorted column.
|
|
//--------------------------------------------------------------------
|
|
int GetSortedCol(BOOL* pbSortAsc = NULL);
|
|
|
|
//--------------------------------------------------------------------
|
|
// Summary:
|
|
// Call this member function to set the bitmap image for the specified
|
|
// header item.
|
|
// Parameters:
|
|
// iCol - Zero-based index of the column to set the sort image for.
|
|
// uBitmapID - Resource ID of the bitmap to use.
|
|
// bRemove - TRUE to remove a bitmap, FALSE if adding a bitmap.
|
|
// dwRemove - Indicates the header format style to remove, see HD_ITEM structure.
|
|
// crMask - Color used to generate the mask. Each pixel of
|
|
// this color in the given bitmap is changed to black
|
|
// and the corresponding bit in the mask is set to one.
|
|
// Example:
|
|
// The following example demonstrates the use of SetBitmap.
|
|
// <code>
|
|
// // add bitmap images.
|
|
// m_header.SetBitmap(0, IDB_COLUMN_0, FALSE, RGB(0, 255, 0));
|
|
// m_header.SetBitmap(1, IDB_COLUMN_1, FALSE, RGB(0, 255, 0));
|
|
// m_header.SetBitmap(2, IDB_COLUMN_2, FALSE, RGB(0, 255, 0));
|
|
// </code>
|
|
//--------------------------------------------------------------------
|
|
void SetBitmap(int iCol, UINT uBitmapID, DWORD dwRemove = NULL);
|
|
void SetBitmap(int iCol, UINT uBitmapID, BOOL bRemove, COLORREF crMask); //<combine CXTPHeaderCtrl::SetBitmap@int@UINT@DWORD>
|
|
|
|
//--------------------------------------------------------------------
|
|
// Summary:
|
|
// Call this member function to determine if the specified header
|
|
// item is pressed (selected).
|
|
// Parameters:
|
|
// iItem - Index of the header item to check.
|
|
// Returns:
|
|
// TRUE if the specified header item is pressed (selected).
|
|
//--------------------------------------------------------------------
|
|
virtual BOOL ItemPressed(int iItem);
|
|
|
|
// ------------------------------------------------------------------
|
|
// Summary:
|
|
// This member function is called whenever the theme has changed.
|
|
// Remarks:
|
|
// Override this member function to add additional functionality
|
|
// whenever the control theme changes.
|
|
// ------------------------------------------------------------------
|
|
virtual void OnThemeChanged();
|
|
|
|
//--------------------------------------------------------------------
|
|
// Summary:
|
|
// This member function is called to check if the header control
|
|
// is using a theme.
|
|
// Returns:
|
|
// TRUE if a theme is used, otherwise FALSE.
|
|
//--------------------------------------------------------------------
|
|
BOOL IsThemeValid() const;
|
|
|
|
// --------------------------------------------------------------------------
|
|
// Summary:
|
|
// Tests a point to determine which header item, if any, is at the
|
|
// specified point.
|
|
// Parameters:
|
|
// pt - POINT structure that contains the point to be hit test, in
|
|
// client coordinates.
|
|
// pFlags - Variable that receives information about the results of a hit
|
|
// test. This member can be one or more of the values listed in
|
|
// the Remarks section.
|
|
// Remarks:
|
|
// pFlags can be one or more of the following values:
|
|
// * <b>HHT_ABOVE</b> The point is above the header control's
|
|
// bounding rectangle.
|
|
// * <b>HHT_BELOW</b> The point is below the header control's
|
|
// bounding rectangle.
|
|
// * <b>HHT_NOWHERE</b> The point is inside the header control's
|
|
// bounding rectangle but is not over a header item.
|
|
// * <b>HHT_ONDIVIDER</b> The point is on the divider between two
|
|
// header items.
|
|
// * <b>HHT_ONDIVOPEN</b> The point is on the divider of an item
|
|
// that has a width of zero. Dragging the divider reveals the item
|
|
// instead of resizing the item to the left of the divider.
|
|
// * <b>HHT_ONHEADER</b> The point is inside the header control's
|
|
// bounding rectangle.
|
|
// * <b>HHT_ONFILTER</b> Version 5.80 The point is over the
|
|
// filter area.
|
|
// * <b>HHT_ONFILTERBUTTON</b> Version 5.80 The point is on the
|
|
// filter button.
|
|
// * <b>HHT_TOLEFT</b> The point is to the left of the header
|
|
// control's bounding rectangle.
|
|
// * <b>HHT_TORIGHT</b> The point is to the right of the header
|
|
// control's bounding rectangle.
|
|
// Returns:
|
|
// If the hit test is successful, contains the index of the item at
|
|
// the hit test point, if any, or - 1 otherwise.
|
|
// --------------------------------------------------------------------------
|
|
int HitTest(CPoint pt, UINT* pFlags = NULL) const;
|
|
|
|
//--------------------------------------------------------------------
|
|
// Summary:
|
|
// Called by the header control to recalculate the size and layout
|
|
// for the header control and header items.
|
|
// Returns:
|
|
// TRUE if successful, otherwise FALSE.
|
|
//--------------------------------------------------------------------
|
|
BOOL RecalcLayout();
|
|
|
|
//--------------------------------------------------------------------
|
|
// Summary:
|
|
// This member function must be called after creation to initialize
|
|
// the font that the header will use.
|
|
// Parameters:
|
|
// bBoldFont - TRUE if the header's font should be bold.
|
|
//--------------------------------------------------------------------
|
|
virtual void InitializeHeader(BOOL bBoldFont);
|
|
|
|
//--------------------------------------------------------------------
|
|
// Summary:
|
|
// This member function is called to associate a menu and toolbar
|
|
// resource with the context menu.
|
|
// Parameters:
|
|
// popupMenuID - Resource ID for the popup menu used with the header.
|
|
// nPos - Position of the submenu to be displayed.
|
|
//--------------------------------------------------------------------
|
|
virtual void SetMenuID(UINT popupMenuID, int nPos = 0);
|
|
|
|
//--------------------------------------------------------------------
|
|
// Summary:
|
|
// This member function can be used to toggle the font from bold to normal.
|
|
// Parameters:
|
|
// bBoldFont - TRUE if the header's font should be bold.
|
|
//--------------------------------------------------------------------
|
|
virtual void SetFontBold(BOOL bBoldFont = TRUE);
|
|
|
|
//--------------------------------------------------------------------
|
|
// Summary:
|
|
// Call this member function to enable or disable the column sort arrow.
|
|
// Parameters:
|
|
// bSortArrow - Set to TRUE to draw the column sort arrow.
|
|
//--------------------------------------------------------------------
|
|
virtual void ShowSortArrow(BOOL bSortArrow);
|
|
|
|
//--------------------------------------------------------------------
|
|
// Summary:
|
|
// Call this member function to set the text justification for the
|
|
// header control.
|
|
// Parameters:
|
|
// nFlag - Text alignment, either LVCFMT_CENTER, LVCFMT_LEFT, or LVCFMT_RIGHT.
|
|
// Returns:
|
|
// TRUE if successful, otherwise returns FALSE.
|
|
//--------------------------------------------------------------------
|
|
virtual BOOL SetAlingment(int nFlag);
|
|
|
|
//--------------------------------------------------------------------
|
|
// Summary:
|
|
// Call this member function to return the current sorting order.
|
|
// Returns:
|
|
// TRUE if the sorting order is ascending, otherwise returns FALSE.
|
|
//--------------------------------------------------------------------
|
|
BOOL GetAscending() const;
|
|
|
|
//--------------------------------------------------------------------
|
|
// Summary:
|
|
// Call this member function to enable or disable the popup menu display whenever
|
|
// a user right clicks on the header control.
|
|
// Parameters:
|
|
// bEnableMenus - TRUE to enable popup menus, and FALSE to disable.
|
|
//--------------------------------------------------------------------
|
|
void EnablePopupMenus(BOOL bEnableMenus);
|
|
|
|
//--------------------------------------------------------------------
|
|
// Summary:
|
|
// Call this member function to determine if the header control displays
|
|
// a sort arrow.
|
|
// Returns:
|
|
// TRUE if the header control displays a sort arrow, otherwise returns FALSE.
|
|
//--------------------------------------------------------------------
|
|
BOOL HasSortArrow();
|
|
|
|
//--------------------------------------------------------------------
|
|
// Summary:
|
|
// Call this member function to resize all header columns equally
|
|
// to fit the available client area.
|
|
//--------------------------------------------------------------------
|
|
void ResizeColumnsToFit();
|
|
|
|
//-----------------------------------------------------------------------
|
|
// Summary:
|
|
// Retrieves Image manager associated with Header.
|
|
// Returns:
|
|
// Pointer to the image manager object that stores the images in
|
|
// the Header.
|
|
//-----------------------------------------------------------------------
|
|
CXTPImageManager* GetImageManager() const;
|
|
|
|
//-----------------------------------------------------------------------
|
|
// Summary:
|
|
// Call this method to assign new image manager.
|
|
// Parameters:
|
|
// pImageManager - Pointer to the image manager object that stores the
|
|
// images in the Header.
|
|
//-----------------------------------------------------------------------
|
|
void SetImageManager(CXTPImageManager* pImageManager);
|
|
|
|
//-----------------------------------------------------------------------
|
|
// Summary:
|
|
// Call this member to switch the visual theme of the control.
|
|
// Parameters:
|
|
// eTheme - New window theme. Can be any of the values listed in the Remarks section.
|
|
// eScheme - Color scheme used the the theme. Can be any of the values listed in the Remarks section.
|
|
// Remarks:
|
|
// eTheme can be one of the following values:
|
|
// * <b>xtpControlThemeDefault</b> Use default theme.
|
|
// * <b>xtpControlThemeNativeWinXP</b> Use Windows Explorer theme.
|
|
// * <b>xtpControlThemeOfficeXP</b> Use Office XP theme.
|
|
// * <b>xtpControlThemeOffice2003</b> Use Office 2003 theme.
|
|
//-----------------------------------------------------------------------
|
|
BOOL SetTheme(XTPControlTheme eTheme);
|
|
BOOL SetTheme(CXTPHeaderCtrlTheme* pTheme);
|
|
|
|
//-----------------------------------------------------------------------
|
|
// Summary:
|
|
// Call this member function to get a pointer to the currently selected theme.
|
|
// Returns:
|
|
// A pointer to a CXTPHeaderCtrlTheme object representing the currently selected theme.
|
|
//-----------------------------------------------------------------------
|
|
CXTPHeaderCtrlTheme* GetTheme();
|
|
|
|
protected:
|
|
|
|
//--------------------------------------------------------------------
|
|
// Summary:
|
|
// This member function is used by the header control to determine
|
|
// the text alignment for the system locale.
|
|
// Returns:
|
|
// true if the text alignment is right-to-left, and false if the text
|
|
// alignment is left-to-right.
|
|
//--------------------------------------------------------------------
|
|
virtual bool DetermineRTL();
|
|
|
|
//--------------------------------------------------------------------
|
|
// Summary:
|
|
// This member function is used by the header control to auto-size the
|
|
// columns for the list control.
|
|
// Parameters:
|
|
// iNewWidth - New width to resize all columns to.
|
|
//--------------------------------------------------------------------
|
|
virtual void ApplyFieldWidths(int iNewWidth);
|
|
|
|
//--------------------------------------------------------------------
|
|
// Summary:
|
|
// This member function is used by the header control to determine
|
|
// the new width for auto-sized columns and resize accordingly.
|
|
// Parameters:
|
|
// iNewWidth - New width to resize all columns to. If iNewWidth
|
|
// is '0', the columns are equally sized to fit the
|
|
// available client area.
|
|
//--------------------------------------------------------------------
|
|
virtual void FitFieldWidths(int iNewWidth);
|
|
|
|
//--------------------------------------------------------------------
|
|
// Summary:
|
|
// This member function is used by the header control to determine
|
|
// the total width of all frozen columns in the header control.
|
|
// Returns:
|
|
// The combined size in pixels of all frozen columns.
|
|
//--------------------------------------------------------------------
|
|
virtual int GetFrozenColWidth();
|
|
|
|
//--------------------------------------------------------------------
|
|
// Summary:
|
|
// Called to send WM_NOTIFY to tell parent's owner that the column needs
|
|
// to be sorted.
|
|
// Parameters:
|
|
// iIndex - Index of the column to be sorted.
|
|
//--------------------------------------------------------------------
|
|
void SendNotify(int iIndex);
|
|
|
|
//-----------------------------------------------------------------------
|
|
// Summary:
|
|
// Call this member function to refresh theme colors and redraw the control.
|
|
//-----------------------------------------------------------------------
|
|
virtual void RefreshMetrics();
|
|
|
|
//{{AFX_VIRTUAL(CXTPHeaderCtrl)
|
|
virtual BOOL OnWndMsg(UINT message, WPARAM wParam, LPARAM lParam, LRESULT* pResult);
|
|
//}}AFX_VIRTUAL
|
|
|
|
protected:
|
|
//{{AFX_CODEJOCK_PRIVATE
|
|
DECLARE_MESSAGE_MAP()
|
|
|
|
//{{AFX_MSG(CXTPHeaderCtrl)
|
|
afx_msg void OnWindowPosChanging(WINDOWPOS FAR* lpwndpos);
|
|
afx_msg BOOL OnSetCursor(CWnd* pWnd, UINT nHitTest, UINT message);
|
|
afx_msg void OnPaint();
|
|
afx_msg LRESULT OnPrintClient(WPARAM wParam, LPARAM /*lParam*/);
|
|
afx_msg BOOL OnEraseBkgnd(CDC* pDC);
|
|
afx_msg void OnLButtonDown(UINT nFlags, CPoint point);
|
|
afx_msg void OnLButtonUp(UINT nFlags, CPoint point);
|
|
afx_msg void OnMouseMove(UINT nFlags, CPoint point);
|
|
afx_msg void OnTimer(UINT_PTR nIDEvent);
|
|
afx_msg LRESULT OnLayout(WPARAM wparam, LPARAM lparam);
|
|
afx_msg void OnDestroy();
|
|
afx_msg BOOL OnItemchanging(NMHDR* pNMHDR, LRESULT* pResult);
|
|
afx_msg void OnRButtonDown(UINT nFlags, CPoint point);
|
|
afx_msg void OnSortAsc();
|
|
afx_msg void OnSortDsc();
|
|
afx_msg void OnAlignLeft();
|
|
afx_msg void OnAlignCenter();
|
|
afx_msg void OnAlignRight();
|
|
//}}AFX_MSG
|
|
afx_msg LRESULT OnSetTheme(WPARAM wParam, LPARAM lParam);
|
|
//}}AFX_CODEJOCK_PRIVATE
|
|
|
|
protected:
|
|
int m_iMinSize; // Minimum column size for an auto-size header control.
|
|
int m_nPos; // Index of the popup menu contained in the menu.
|
|
int m_iOverIndex; // Column mouse is currently hovering.
|
|
int m_nSortedCol; // Last column pressed during sort.
|
|
bool m_bRTL; // Used internally to determine if text is right-to-left or left-to-right (depends on system locale).
|
|
bool m_bAutoSize; // true if the header control columns are auto-sizing.
|
|
BOOL m_bEnableMenus; // TRUE to disable the popup menu display.
|
|
BOOL m_bAscending; // Used, when column is pressed, to draw a sort arrow.
|
|
BOOL m_bLBtnDown; // TRUE if left mouse button is pressed.
|
|
BOOL m_bPainted; // Used during paint operations.
|
|
UINT m_popupMenuID; // Popup menu resource ID.
|
|
CPoint m_pt; // Point where right click took place.
|
|
CList<int, int&> m_arFrozenCols; // List of columns that are not sizable.
|
|
CXTPHeaderCtrlTheme* m_pTheme; // Points to the active theme.
|
|
CXTPImageManager* m_pImageManager; // Pointer to ImageManager associated with header.
|
|
|
|
friend class CXTPHeaderCtrlTheme;
|
|
};
|
|
|
|
//////////////////////////////////////////////////////////////////////
|
|
|
|
AFX_INLINE BOOL CXTPHeaderCtrl::GetAscending() const {
|
|
ASSERT(::IsWindow(m_hWnd)); return m_bAscending;
|
|
}
|
|
AFX_INLINE void CXTPHeaderCtrl::EnablePopupMenus(BOOL bEnableMenus) {
|
|
m_bEnableMenus = bEnableMenus;
|
|
}
|
|
AFX_INLINE CXTPImageManager* CXTPHeaderCtrl::GetImageManager() const {
|
|
return m_pImageManager;
|
|
}
|
|
AFX_INLINE CXTPHeaderCtrlTheme* CXTPHeaderCtrl::GetTheme() {
|
|
return m_pTheme;
|
|
}
|
|
|
|
#endif // #if !defined(__XTHEADERCTRL_H__)
|