CMFCRibbonSeparator Class
Implements the ribbon separator.
Syntax
class CMFCRibbonSeparator : public CMFCRibbonBaseElement
Members
Public Constructors
| Name | Description |
|---|---|
| CMFCRibbonSeparator::CMFCRibbonSeparator | Constructs a CMFCRibbonSeparator object. |
Public Methods
| Name | Description |
|---|---|
| CMFCRibbonSeparator::AddToListBox | Adds a separator to the Commands list in the Customize dialog box. (Overrides CMFCRibbonBaseElement::AddToListBox.) |
CMFCRibbonSeparator::CreateObject |
Used by the framework to create a dynamic instance of this class type. |
CMFCRibbonSeparator::GetThisClass |
Used by the framework to obtain a pointer to the CRuntimeClass object that is associated with this class type. |
Protected Methods
| Name | Description |
|---|---|
| CMFCRibbonSeparator::CopyFrom | A copy method that sets a separator's member variables from another object. |
| CMFCRibbonSeparator::GetRegularSize | Returns the size of a separator. |
| CMFCRibbonSeparator::IsSeparator | Indicates whether this is a separator. |
| CMFCRibbonSeparator::IsTabStop | Indicates whether this is a tab stop. |
| CMFCRibbonSeparator::OnDraw | Called by the system to draw the separator on either the ribbon or the Quick Access Toolbar. |
| CMFCRibbonSeparator::OnDrawOnList | Called by the system to draw the separator on the Commands list. |
Remarks
A ribbon separator is a vertical or horizontal line that logically separates ribbon elements. A separator can be drawn on the ribbon control, the main application menu, the ribbon status bar, and the Quick Access Toolbar.
To use a separator in your application, construct the new object and add it to the main application menu as shown here:
CMFCRibbonMainPanel* pMainPanel = m_wndRibbonBar.AddMainCategory(_T("Main Menu"),
IDB_FILESMALL,
IDB_FILELARGE);
...
pMainPanel->Add(new CMFCRibbonSeparator(TRUE));
Call CMFCRibbonPanel::AddSeparator to add separators to ribbon panels. The separators are allocated and added internally by the AddSeparator method.
Inheritance Hierarchy
Requirements
Header: afxbaseribbonelement.h
CMFCRibbonSeparator::AddToListBox
Adds a separator to the Commands list in the Customize dialog box.
virtual int AddToListBox(
CMFCRibbonCommandsListBox* pWndListBox,
BOOL bDeep);
Parameters
pWndListBox
[in] A pointer to the Commands list where the separator is added.
bDeep
[in] Ignored.
Return Value
Zero-based index to the string in the list box specified by pWndListBox.
CMFCRibbonSeparator::CMFCRibbonSeparator
Constructs a CMFCRibbonSeparator object.
CMFCRibbonSeparator(BOOL bIsHoriz = FALSE);
Parameters
bIsHoriz
[in] If TRUE, the separator is horizontal; if FALSE, the separator is vertical.
Remarks
Horizontal separators are used in application menus. Vertical separators are used in toolbars.
Example
The following example demonstrates how to construct an object of the CMFCRibbonSeparator class.
// CMFCRibbonMainPanel* pMainPanel
pMainPanel->Add(new CMFCRibbonSeparator(TRUE));
CMFCRibbonSeparator::CopyFrom
A copy method that sets a separator's member variables from another object.
virtual void CopyFrom(const CMFCRibbonBaseElement& src);
Parameters
Src
[in] The source ribbon element to copy from.
CMFCRibbonSeparator::GetRegularSize
Returns the size of a separator.
virtual CSize GetRegularSize(CDC* pDC);
Parameters
pDC
[in] A pointer to a device content.
Return Value
The size of the separator on the given device context.
CMFCRibbonSeparator::IsSeparator
Indicates whether this is a separator.
virtual BOOL IsSeparator() const;
Return Value
Always TRUE for this class.
CMFCRibbonSeparator::IsTabStop
Indicates whether this is a tab stop.
virtual BOOL IsTabStop() const;
Return Value
Always FALSE for this class.
Remarks
A ribbon separator is not a tab stop.
CMFCRibbonSeparator::OnDraw
Called by the system to draw the separator on either the ribbon or the Quick Access Toolbar.
virtual void OnDraw(CDC* pDC);
Parameters
pDC
[in] A pointer to a device context.
CMFCRibbonSeparator::OnDrawOnList
Called by the system to draw the separator on the Commands list.
virtual void OnDrawOnList(
CDC* pDC,
CString strText,
int nTextOffset,
CRect rect,
BOOL bIsSelected,
BOOL bHighlighted);
Parameters
pDC
[in] A pointer to a device context.
strText
[in] Text displayed on the list.
nTextOffset
[in] Spacing between the text and the left side of the bounding rectangle.
rect
[in] Specifies the bounding rectangle.
bIsSelected
[in] Ignored.
bHighlighted
[in] Ignored.