CSmartDockingInfo 类

定义智能停靠标记的外观。

语法

class CSmartDockingInfo : public CObject

成员

公共构造函数

名称	描述
CSmartDockingInfo::CSmartDockingInfo	默认构造函数。

公共方法

名称	描述
CSmartDockingInfo::CopyTo	将当前智能停靠信息参数复制到提供的 CSmartDockingInfo 对象中。

数据成员

名称	描述
CSmartDockingInfo::m_bUseThemeColorInShading	指定框架显示智能停靠标记时，是否使用当前主题颜色。
CSmartDockingInfo::m_clrBaseBackground	指定智能停靠标记的基本背景色。
CSmartDockingInfo::m_clrToneDest	指定在智能停靠标记位图中替换 m_clrToneSrc 的颜色。
CSmartDockingInfo::m_clrToneSrc	指定智能停靠标记位图的颜色。
CSmartDockingInfo::m_clrTransparent	指定智能停靠标记位图在透明时的颜色。
CSmartDockingInfo::m_nCentralGroupOffset	指定智能停靠标记的中心组与中心组矩形边界的偏移量。
CSmartDockingInfo::m_sizeTotal	指定组中所有智能停靠标记的总大小。
CSmartDockingInfo::m_uiMarkerBmpResID	定义位图的资源 ID，该位图由框架用于未突出显示的智能停靠标记。
CSmartDockingInfo::m_uiMarkerLightBmpResID	定义位图的资源 ID，该位图由框架用于已突出显示的智能停靠标记。

注解

框架在内部处理智能停靠标记。 下图显示了标准智能停靠标记：

在此图中，左侧的图像显示中心组智能停靠标记未启用停靠到选项卡。 中间的图像显示右边缘智能停靠标记。 右侧的图像显示中心组智能停靠标记已启用停靠到选项卡。 中心组智能停靠标记有一个主位图和五个智能停靠标记位图。

你可以自定义智能停靠标记的以下参数：

• 颜色。 例如，可以将图中标记的蓝色替换为任何用户定义的颜色。

• 透明色。

• 中心组内智能停靠标记与范围框的边框的偏移量。

• 表示中心组的主位图。

• 表示常规和突出显示的智能停靠标记的位图。

下图显示了已自定义的智能停靠标记的示例：

继承层次结构

CObject

CSmartDockingInfo

要求

标头：afxDockingManager.h

CSmartDockingInfo::CopyTo

将当前智能停靠参数复制到提供的 CSmartDockingInfo 对象中。

void CopyTo(CSmartDockingInfo& params);

参数

params
[out] 使用当前智能停靠参数填充的 CSmartDockingInfo 类型的对象。

CSmartDockingInfo::m_bUseThemeColorInShading

指定框架显示智能停靠标记时，是否使用当前主题颜色。

BOOL m_bUseThemeColorInShading;

注解

如果为 TRUE，则使用当前主题颜色绘制标记；否则使用浅蓝色绘制标记。

默认值是 FALSE。

CSmartDockingInfo::m_clrBaseBackground

指定智能停靠标记的基本背景色。

COLORREF m_clrBaseBackground;

CSmartDockingInfo::m_clrToneDest

指定将在智能停靠标记位图中替换 m_clrToneSrc 的颜色。

COLORREF m_clrToneDest;

备注

设置此值，以编程方式更改标记位图的颜色。 例如，如果要更改框架提供的标准标记的颜色，请将此值设置为所需的颜色。 默认情况下，CSmartDockingInfo::m_clrToneSrc 设置为 RGB (61, 123, 241)（蓝色）。

若要更改自定义标记的颜色，必须同时指定 m_clrToneDest 和 m_clrToneSrc。

CSmartDockingInfo::m_clrToneSrc

指定智能停靠标记位图的颜色。

COLORREF m_clrToneSrc;

注解

只有当想要将自定义位图的颜色替换为另一种颜色时，才设置此值。 如果要更改（框架提供的）标准标记的颜色，则无需设置此值。

使用 (COLORREF)-1 将智能停靠组的成员留空。

CSmartDockingInfo::m_clrTransparent

指定智能停靠标记位图在透明时的颜色。

COLORREF m_clrTransparent;

备注

在停靠组中显示自定义标记和自定义位图时，必须设置此值。

CSmartDockingInfo::m_nCentralGroupOffset

指定智能停靠标记的中心组与中心组矩形边界之间的偏移量。

int m_nCentralGroupOffset;

注解

如果要更改自定义标记与智能停靠标记中心组边界之间的默认偏移量，请指定此值。 默认偏移量为 5 像素。

CSmartDockingInfo::m_sizeTotal

指定包围中心组中所有智能停靠标记的边框的总大小。

CSize m_sizeTotal;

备注

将 m_sizeTotal 设置为中心组标记的边框的大小。 如果是使用标记的自定义位图，需要指定此值。

CSmartDockingInfo::m_uiMarkerBmpResID

定义用于非突出显示的自定义智能停靠标记的位图的资源 ID。

UINT m_uiMarkerBmpResID[AFX_SD_MARKERS_NUM];

备注

使用表示智能停靠标记的位图的资源 ID 填充此数组。 AFX_SD_MARKERS_NUM 当前定义为 5。 按如下所示填充数组：

params.m_uiMarkerBmpResID[0] = IDB_MARKER_LEFT;
params.m_uiMarkerBmpResID[1] = IDB_MARKER_RIGHT;
params.m_uiMarkerBmpResID[2] = IDB_MARKER_TOP;
params.m_uiMarkerBmpResID[3] = IDB_MARKER_BOTTOM;
params.m_uiMarkerBmpResID[4] = IDB_MARKER_CENTER;

CSmartDockingInfo::m_uiMarkerLightBmpResID

定义用于突出显示的自定义智能停靠标记的位图的资源 ID。

UINT m_uiMarkerLightBmpResID[AFX_SD_MARKERS_NUM];

备注

使用表示突出显示的智能停靠标记的位图的资源 ID 填充此数组。 AFX_SD_MARKERS_NUM 当前定义为 5。 按如下所示填充数组：

params.m_uiMarkerLightBmpResID[0] = IDB_MARKER_LEFT_LIGHT;
params.m_uiMarkerLightBmpResID[1] = IDB_MARKER_RIGHT_LIGHT;
params.m_uiMarkerLightBmpResID[2] = IDB_MARKER_TOP_LIGHT;
params.m_uiMarkerLightBmpResID[3] = IDB_MARKER_BOTTOM_LIGHT;
params.m_uiMarkerLightBmpResID[4] = IDB_MARKER_CENTER_LIGHT;

另请参阅

层次结构图
类
CObject 类