Files
Leviathan/Library/External/XTToolkitPro/include/Ribbon/Themes/XTPRibbonThemeResource.h
T
2026-06-01 12:46:52 +02:00

293 lines
13 KiB
C++

// XTPRibbonThemeResource.h: interface for the CXTPRibbonOffice2013Theme class.
//
// This file is a part of the XTREME RIBBON MFC class library.
// (c)1998-2013 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(__XTPRIBBONTHEMERESOURCE_H__)
#define __XTPRIBBONTHEMERESOURCE_H__
//}}AFX_CODEJOCK_PRIVATE
#if _MSC_VER > 1000
#pragma once
#endif // _MSC_VER > 1000
class _XTP_EXT_CLASS CXTPRibbonThemeResource : public CXTPRibbonPaintManager
{
public:
// --------------------------------------------------------
// Summary:
// Constructs a CXTPRibbonThemeResource object
// Parameters:
// pPaintManager : \Returns a CXTPPaintManager object.
// --------------------------------------------------------
CXTPRibbonThemeResource(CXTPPaintManager *pPaintManager);
//-----------------------------------------------------------------------
// Summary:
// Destroys a CXTPRibbonThemeResource object, handles cleanup and deallocation
//-----------------------------------------------------------------------
virtual ~CXTPRibbonThemeResource();
//-------------------------------------------------------------------------
// Summary:
// This method is called to refresh the visual metrics of manager.
// Remarks:
// Refreshes all of the colors in the Ribbon Bar. Many of the colors
// used are set with the GROUP_COLOR structure.
// See Also:
// GROUP_COLOR
//-------------------------------------------------------------------------
virtual void RefreshMetrics();
public: // Drawing interface
//-----------------------------------------------------------------------
// Summary:
// Draws the specified CXTPRibbonGroup.
// Parameters:
// pDC - Pointer to a valid device context
// pGroup - Pointer to the CXTPRibbonGroup to be drawn
// Remarks:
// Draws the entire groups including background, caption and text.
// This will not draw the option button or group pop-up.
// See Also: GROUP_COLOR, FillRibbonBar, FillGroupRect, RefreshMetrics
//-----------------------------------------------------------------------
virtual void DrawGroup(CDC *pDC, CXTPRibbonGroup *pGroup);
//-----------------------------------------------------------------------
// Summary:
// This method is called to fill background of a CXTPRibbonGroup.
// Parameters:
// pDC - Pointer to a valid device context
// pActiveTab - Pointer to the tab that is currently active
// rcGroups - Bounding rectangle of the group
// Remarks:
// Performs a gradient fill using the GROUP_COLOR::clrBackground for
// the main group background and GROUP_COLOR::clrCaption to fill the
// group caption rectangle.
// See Also: CXTPRibbonGroup::GetRect, GROUP_COLOR
//-----------------------------------------------------------------------
virtual void FillGroupRect(CDC *pDC, CXTPRibbonTab *pActiveTab, CRect rcGroups);
//-----------------------------------------------------------------------
// Summary:
// Draws the group pop-up button.
// Parameters:
// pDC - Pointer to a valid device context
// pControlGroupPopup - Pointer to a CXTPControlPopup object.
// bDraw - TRUE to draw group pop-up button; FALSE to retrieve the size of the control.
// Remarks:
// A single group button will be displayed if there is not enough
// room to display the items in the group. A group pop-up is displayed
// when the button is clicked. The pop-up contains all the items in
// the group. When a group button is clicked, a CXTPControlPopup
// is displayed that contains the items of the group.
// Returns:
// If bDraw is TRUE, then the size of the group pop-up button is returned.
// See Also: CXTPRibbonGroup::GetControlGroupPopup
//-----------------------------------------------------------------------
virtual CSize DrawControlGroupPopup(CDC *pDC, CXTPControlPopup *pControlGroupPopup, BOOL bDraw);
//-----------------------------------------------------------------------
// Summary:
// This method is called to draw pop-up toolbar of reduced group
// Parameters:
// pDC - Pointer to a valid device context
// pGroup - Parent group of pop-up'ed toolbar
// pCommandBar - pop-up toolbar to draw
//-----------------------------------------------------------------------
virtual void FillGroupPopupToolBar(CDC *pDC, CXTPRibbonGroup *pGroup, CXTPCommandBar *pCommandBar);
//-----------------------------------------------------------------------
// Summary:
// This method is called to fill background of Ribbon Bar control.
// Parameters:
// pDC - Pointer to a valid device context
// pRibbonBar - Points to a CXTPRibbonBar object
//-----------------------------------------------------------------------
virtual void FillRibbonBar(CDC *pDC, CXTPRibbonBar *pRibbonBar);
//-----------------------------------------------------------------------
// Summary:
// Draws the group option button.
// Parameters:
// pDC - Pointer to a valid device context
// pControlGroupOption - Pointer to a CXTPControl object.
// bDraw - TRUE to draw option button; FALSE to retrieve the size of the control.
// Remarks:
// The option button is typically used to launch a dialog associated with the group.
// It is drawn on the right side of the group caption.
// Returns:
// If bDraw is TRUE, then the size of the option button control is returned.
// See Also: CXTPRibbonGroup::ShowOptionButton, CXTPRibbonGroup::GetControlGroupOption
//-----------------------------------------------------------------------
virtual CSize DrawControlGroupOption(CDC *pDC, CXTPControl *pControlGroupOption, BOOL bDraw);
//-----------------------------------------------------------------------
// Summary:
// This method is called to draw ribbon context headers
// Parameters:
// pDC - Pointer to a valid device context
// pContextHeaders - Collection of context header
// pRibbonBar - Parent RibbonBar pointer
//-----------------------------------------------------------------------
virtual void DrawRibbonFrameContextHeaders(CDC *pDC, CXTPRibbonBar *pRibbonBar, CXTPRibbonTabContextHeaders *pContextHeaders);
//-----------------------------------------------------------------------
// Summary:
// This member fills in the tab header and tab client area. It
// will then draw tab client frame.
// Parameters:
// pRibbonBar - Pointer to ribbon to draw the tab control.
// pDC - Pointer to a valid device context.
// rcControl - Bounding rectangle of the tab control.
//-----------------------------------------------------------------------
virtual void FillRibbonTabControl(CDC *pDC, CXTPRibbonBar *pRibbonBar, CRect rcControl);
//-----------------------------------------------------------------------
// Summary:
// This method is called to draw single tab of ribbon bar
// Parameters:
// pDC - Pointer to a valid device context
// pItem - Ribbon tab to draw
//-----------------------------------------------------------------------
virtual void DrawRibbonTab(CDC *pDC, CXTPRibbonTab *pItem);
//-----------------------------------------------------------------------
// Summary:
// This method is called to draw ribbon caption if EnableFrameTheme was not called.
// Parameters:
// pDC - Pointer to a valid device context
// pRibbonBar - Ribbon Bar to draw
//-----------------------------------------------------------------------
virtual void DrawRibbonFrameCaptionBar(CDC *pDC, CXTPRibbonBar *pRibbonBar, BOOL bActive);
//-----------------------------------------------------------------------
// Summary:
// This method is called to draw Ribbon caption
// Parameters:
// pDC - Pointer to a valid device context
// pRibbonBar - Ribbon Bar to draw
// bActive - TRUE if ribbon frame is active
//-----------------------------------------------------------------------
virtual void DrawRibbonFrameCaption(CDC *pDC, CXTPRibbonBar *pRibbonBar, BOOL bActive);
//-----------------------------------------------------------------------
// Summary:
// This method is called to draw Ribbon quick access controls
//-----------------------------------------------------------------------
virtual void DrawRibbonQuickAccessControls(CDC *pDC, CXTPRibbonBar *pRibbonBar);
//-----------------------------------------------------------------------
// Summary:
// This method is called to draw quick access customize button
// Parameters:
// pDC - Pointer to a valid device context
// pControl - Pointer to Quick Access customize button
// See Also: DrawRibbonQuickAccessMoreButton
//-----------------------------------------------------------------------
virtual void DrawRibbonQuickAccessButton(CDC *pDC, CXTPControlPopup *pControl);
//-----------------------------------------------------------------------
// Summary:
// This method is called to draw quick access more button
// Parameters:
// pDC - Pointer to a valid device context
// pControl - Pointer to Quick Access more button
// See Also: DrawRibbonQuickAccessButton
//-----------------------------------------------------------------------
virtual void DrawRibbonQuickAccessMoreButton(CDC *pDC, CXTPControlPopup *pControl);
//-----------------------------------------------------------------------
// Summary:
// Draws top-left system button
// Parameters:
// pDC - Pointer to a valid device context
// pControl - System button control
// rc - Bounding rectangle of control
//-----------------------------------------------------------------------
virtual void DrawRibbonFrameSystemButton(CDC *pDC, CXTPRibbonControlSystemButton *pControl, CRect rc);
//-----------------------------------------------------------------------
// Summary:
// This method is called to draw scroll groups buttons
// Parameters:
// pDC - Pointer to a valid device context
// pControl - Scroll button to draw
// bScrollLeft - TRUE to draw left button; FALSE - right
//-----------------------------------------------------------------------
virtual void DrawRibbonScrollButton(CDC *pDC, CXTPControl *pControl, BOOL bScrollLeft);
//-----------------------------------------------------------------------
// Summary:
// This method is called to draw pop-up bar of more button
// Parameters:
// pDC - Pointer to a valid device context
// pBar - ToolBar to fill
//-----------------------------------------------------------------------
virtual void FillMorePopupToolBarEntry(CDC *pDC, CXTPCommandBar *pBar);
//-----------------------------------------------------------------------
// Summary:
// This method is called to draw pop-up bar of the system button
// Parameters:
// pDC - Pointer to a valid device context
// pBar - ToolBar to fill
//-----------------------------------------------------------------------
virtual void FillSystemPopupBarEntry(CDC *pDC, CXTPPopupBar *pBar);
// ---------------------------------------------------
// Summary:
// This method is called to draw pop-up bar buttons
// Parameters:
// pDC : Pointer to a valid device context
// pButton : Popup bar button to draw
//
// ---------------------------------------------------
virtual void DrawSystemPopupBarButton(CDC *pDC, CXTPControl *pButton);
//-----------------------------------------------------------------------
// Summary:
// This method is called to draw the ribbon group when the group is minimized
// and only a button is displayed. When the button is pressed the group is
// displayed as a pop-up.
// Parameters:
// pDC - Pointer to a valid device context
// pButton - Button to draw
//-----------------------------------------------------------------------
virtual BOOL DrawRibbonGroupControlEntry(CDC *pDC, CXTPControl *pButton);
public:
//-----------------------------------------------------------------------
// Summary:
// Calculates ribbon caption height
//-----------------------------------------------------------------------
virtual int GetRibbonCaptionHeight(const CXTPRibbonBar *pRibbonBar) const;
protected:
int m_nFileButtonImageCount;
};
#endif // !defined(__XTPRIBBONTHEMERESOURCE_H__)