222 lines
10 KiB
C++
222 lines
10 KiB
C++
// XTCaption.h : interface for the CXTCaption class.
|
|
//
|
|
// This file is a part of the Xtreme Toolkit for MFC.
|
|
// ©1998-2003 Codejock Software, All Rights Reserved.
|
|
//
|
|
// This source code can only be used under the terms and conditions
|
|
// outlined in the accompanying license agreement.
|
|
//
|
|
// support@codejock.com
|
|
// http://www.codejock.com
|
|
//
|
|
//////////////////////////////////////////////////////////////////////
|
|
|
|
#if !defined(__XTCAPTION_H__)
|
|
#define __XTCAPTION_H__
|
|
|
|
#if _MSC_VER >= 1000
|
|
#pragma once
|
|
#endif // _MSC_VER >= 1000
|
|
|
|
//////////////////////////////////////////////////////////////////////
|
|
// Summary: CXTCaptionButton is a CXTButton derived class. It is used by
|
|
// the CXTCaption class to activate a CXTCaptionPopupWnd window.
|
|
class _XT_EXT_CLASS CXTCaptionButton : public CXTButton
|
|
{
|
|
public:
|
|
|
|
// Input: clrFace - An RGB value that represents the button background color.
|
|
// clrText - An RGB value that represents the font color.
|
|
// Returns: TRUE if successful, otherwise returns FALSE.
|
|
// Summary: This member function will set the style for the caption button.
|
|
virtual BOOL SetButtonStyle(COLORREF clrFace, COLORREF clrText);
|
|
|
|
protected:
|
|
|
|
// Input: pDC - A CDC pointer that represents the current device context.
|
|
// nState - A UINT value that represents the current state for the button.
|
|
// rcItem - A CRect reference that represents the current size for the button.
|
|
// Summary: This member function will draw the text for the button, if any.
|
|
virtual void DrawButtonText(CDC* pDC, UINT nState, CRect& rcItem);
|
|
|
|
// Input: pDC - A CDC pointer that represents the current device context.
|
|
// nState - A UINT value that represents the current state for the button.
|
|
// rcItem - A CRect reference that represents the current size for the button.
|
|
// Summary: This member function draws the icon for the button, if any.
|
|
virtual void DrawButtonIcon(CDC* pDC, UINT nState, CRect& rcItem);
|
|
};
|
|
|
|
class CXTCaptionPopupWnd;
|
|
|
|
//////////////////////////////////////////////////////////////////////
|
|
// Summary: CXTCaption is a CStatic derived class. It is used to create caption
|
|
// or info bars similar to those in Microsoft® Outlook™.
|
|
class _XT_EXT_CLASS CXTCaption : public CStatic
|
|
{
|
|
DECLARE_DYNAMIC(CXTCaption)
|
|
|
|
public:
|
|
|
|
// Summary: Constructs a CXTCaption object.
|
|
CXTCaption();
|
|
|
|
// Summary: Destroys a CXTCaption object, handles cleanup and de-allocation.
|
|
virtual ~CXTCaption();
|
|
|
|
protected:
|
|
|
|
int m_nOffset; // Size, in pixels, that the child window should leave for its caption area.
|
|
int m_nBorder; // Size, in pixels, for the caption border.
|
|
bool m_bUserColors; // true if the user has specified caption colors other than the default.
|
|
CWnd* m_pChildWnd; // A CWnd pointer that represents the child window displayed in the popup window.
|
|
CWnd* m_pParentView; // A CWnd pointer that represents the child window's parent view.
|
|
CWnd* m_pSplitterWnd; // A CWnd pointer that represents the splitter window. It is used to track size changes.
|
|
CSize m_sizeIcon; // Width and height of the caption icon area.
|
|
CRect m_rcChild; // Size of the child window displayed in the popup.
|
|
CRect m_rcParent; // Size of the child's parent view.
|
|
CRect m_rcSplitter; // Size of the splitter window.
|
|
DWORD m_dwExStyle; // Border style bits, either CPWS_EX_GROOVE_EDGE | CPWS_EX_RAISED_EDGE.
|
|
DWORD m_dwTextStyle; // Text style, one of DT_ styles. See CDC::DrawText(...) for more details.
|
|
HICON m_hIcon; // User defined icon handle. The default value is NULL.
|
|
CString m_strCaption; // Text that will be displayed in the caption.
|
|
COLORREF m_clrBorder; // An RGB value that represents the user defined border color.
|
|
COLORREF m_clrFace; // An RGB value that represents the user defined background color.
|
|
COLORREF m_clrText; // An RGB value that represents the user defined font color.
|
|
CImageList m_ilButton; // Image list used to create the close button icon.
|
|
CXTCaptionButton m_btnCaption; // Button used to 'tack' the popup window back in place.
|
|
CXTCaptionPopupWnd* m_pPopupWnd; // Points to the popup window.
|
|
|
|
public:
|
|
|
|
// Returns: A reference to a CXTCaptionButton object.
|
|
// Summary: Call this member function to get a reference to the caption's close
|
|
// / popup button.
|
|
CXTCaptionButton& GetCaptionButton();
|
|
|
|
// Input: clrBorder - An RGB value that represents the new border color.
|
|
// clrFace - An RGB value that represents the new background color.
|
|
// clrText - An RGB value that represents the new font color.
|
|
// Summary: This member function will set the caption bar border, background,
|
|
// and font colors.
|
|
virtual void SetCaptionColors(COLORREF clrBorder, COLORREF clrFace, COLORREF clrText);
|
|
|
|
// Input: nBorderSize - Specifies size, in pixels, of the banner border.
|
|
// pFont - Specifies the new caption font.
|
|
// lpszWindText - NULL terminated string specifying the new caption text.
|
|
// hIcon - Handle of the icon to be drawn in the caption.
|
|
// Summary: This function will modify the caption style. You can use this
|
|
// member function to set the border size that is drawn around the
|
|
// caption banner, the font that the caption will use, and the caption text
|
|
// and icon to be displayed.
|
|
virtual void ModifyCaptionStyle(int nBorderSize, CFont* pFont=NULL, LPCTSTR lpszWindText=NULL, HICON hIcon=NULL);
|
|
|
|
// Input: pChild - A CWnd pointer that represents the child window to be displayed in
|
|
// the popup window.
|
|
// pNotifyWnd - A CWnd pointer that represents the window to receive notification
|
|
// messages.
|
|
// Summary: Call this member function to set the child and notification windows
|
|
// for the caption bar.
|
|
virtual void SetChildWindow(CWnd* pChild, CWnd* pNotifyWnd);
|
|
|
|
// Summary: This member function is called to destroy the popup window and associated
|
|
// children.
|
|
virtual void KillChildWindow();
|
|
|
|
// Input: lpszWindowText - NULL terminated string to display in the caption bar.
|
|
// hIcon - Handle of the icon to display in the caption bar. It can be NULL.
|
|
// Summary: This member function is called to update the text and icon for the
|
|
// caption bar.
|
|
virtual void UpdateCaption(LPCTSTR lpszWindowText, HICON hIcon);
|
|
|
|
// Input: dwStyle - Specifies the method of formatting the text. See CDC::DrawText
|
|
// for a detailed listing of available styles.
|
|
// Summary: This member function is called to set the formatting style of the
|
|
// text that is displayed in the caption bar.
|
|
virtual void SetTextStyle(DWORD dwStyle);
|
|
|
|
// Returns: A DWORD value that represents the formatting style of the current caption text.
|
|
// Summary: This member function is called to retrieve the formatting style of
|
|
// the text that is displayed in the caption bar.
|
|
virtual DWORD GetTextStyle();
|
|
|
|
// Input: pParentWnd - Specifies the parent window.
|
|
// lpszWindowName - Points to a null-terminated character string that contains
|
|
// the window name. This will be displayed in the caption area.
|
|
// dwExStyle - Specifies caption bar style. Can be either CPWS_EX_RAISED_EDGE
|
|
// which will draw a 3D edge around the caption bar, or CPWS_EX_GROOVE_EDGE
|
|
// which will draw a sunken edge.
|
|
// dwStyle - Specifies the control window style. Apply any combination of
|
|
// caption bar styles to the control.
|
|
// rect - Specifies the position and size of the caption bar. It can be
|
|
// either a RECT structure or a CRect object.
|
|
// nID - Specifies the caption bar control ID.
|
|
// Returns: TRUE if successful, otherwise returns FALSE.
|
|
// Summary: This method creates a caption bar window and attaches it to the
|
|
// CXTCaption object. You construct a caption bar in two steps. First,
|
|
// call the constructor, which constructs the CXTCaption object. Then
|
|
// call Create, which creates the Window's child window and attaches it
|
|
// to CXTCaption. Create initializes the window class name and window
|
|
// name and registers values for its style, parent, and ID.
|
|
virtual BOOL Create(CWnd* pParentWnd, LPCTSTR lpszWindowName, DWORD dwExStyle=CPWS_EX_RAISED_EDGE, DWORD dwStyle=WS_VISIBLE|SS_CENTER|SS_CENTERIMAGE, const CRect& rect=CRect(0,0,0,0), UINT nID = 0xffff);
|
|
|
|
// Ignore:
|
|
//{{AFX_VIRTUAL(CXTCaption)
|
|
//}}AFX_VIRTUAL
|
|
|
|
protected:
|
|
|
|
// Input: pDC - A CDC pointer that represents the current device context.
|
|
// rcItem - A CRect reference that represents the size of the area to paint.
|
|
// Summary: This member function is called to draw the caption background.
|
|
virtual void DrawCaptionBack(CDC* pDC, CRect& rcItem);
|
|
|
|
// Input: pDC - A CDC pointer that represents the current device context.
|
|
// rcItem - A CRect reference that represents the size of the area to paint.
|
|
// Summary: This member function is called to paint the caption text.
|
|
virtual void DrawCaptionText(CDC* pDC, CRect& rcItem);
|
|
|
|
// Input: pDC - A CDC pointer that represents the current device context.
|
|
// rcItem - A CRect reference that represents the size of the area to paint.
|
|
// Summary: This member function is called to paint the caption icon.
|
|
virtual void DrawCaptionIcon(CDC* pDC, CRect& rcItem);
|
|
|
|
// Input: pDC - A CDC pointer that represents the current device context.
|
|
// rcItem - A CRect reference that represents the size of the area to paint.
|
|
// Summary: This member function is called to update the caption text.
|
|
virtual void UpdateCaptionText(CDC* pDC, CRect& rcItem);
|
|
|
|
// Ignore:
|
|
//{{AFX_MSG(CXTCaption)
|
|
afx_msg void OnPaint();
|
|
afx_msg BOOL OnEraseBkgnd(CDC* pDC);
|
|
afx_msg void OnWindowPosChanged(WINDOWPOS FAR* lpwndpos);
|
|
afx_msg void OnSysColorChange();
|
|
//}}AFX_MSG
|
|
|
|
afx_msg void OnCaptButton();
|
|
afx_msg void OnPushPinButton();
|
|
afx_msg void OnPushPinCancel();
|
|
|
|
DECLARE_MESSAGE_MAP()
|
|
|
|
friend class CXTCaptionButton;
|
|
};
|
|
|
|
//////////////////////////////////////////////////////////////////////
|
|
|
|
AFX_INLINE void CXTCaption::SetTextStyle(DWORD dwStyle) {
|
|
m_dwTextStyle = dwStyle;
|
|
}
|
|
AFX_INLINE DWORD CXTCaption::GetTextStyle() {
|
|
return m_dwTextStyle;
|
|
}
|
|
AFX_INLINE CXTCaptionButton& CXTCaption::GetCaptionButton() {
|
|
ASSERT(::IsWindow(m_btnCaption.m_hWnd)); return m_btnCaption;
|
|
}
|
|
|
|
//////////////////////////////////////////////////////////////////////
|
|
|
|
//{{AFX_INSERT_LOCATION}}
|
|
// Microsoft Developer Studio will insert additional declarations immediately before the previous line.
|
|
|
|
#endif // #if !defined(__XTCAPTION_H__)
|