Share via

CSmartDockingInfo Class

  • Article

Defines the appearance of smart docking markers.

class CSmartDockingInfo : public CObject

Members

Public Constructors

Name

Description

CSmartDockingInfo::CSmartDockingInfo

Default constructor.

Public Methods

Name

Description

CSmartDockingInfo::CopyTo

Copies the current smart docking info parameters into the provided CSmartDockingInfo object.

Data Members

Name

Description

CSmartDockingInfo::m_bUseThemeColorInShading

Specifies whether to use the current theme color when the framework displays smart docking markers.

CSmartDockingInfo::m_clrBaseBackground

Specifies the base background color of smart docking markers.

CSmartDockingInfo::m_clrToneDest

Specifies the color that replaces m_clrToneSrc in smart docking marker bitmaps.

CSmartDockingInfo::m_clrToneSrc

Specifies the color of smart docking marker bitmaps.

CSmartDockingInfo::m_clrTransparent

Specifies the color of smart docking marker bitmaps when they are transparent.

CSmartDockingInfo::m_nCentralGroupOffset

Specifies the offset of the central group of smart docking markers from the boundaries of the central group rectangle.

CSmartDockingInfo::m_sizeTotal

Specifies the total size of all smart docking markers in a group.

CSmartDockingInfo::m_uiMarkerBmpResID

Defines the resource IDs of the bitmaps that the framework uses for smart docking markers that are not highlighted.

CSmartDockingInfo::m_uiMarkerLightBmpResID

Defines the resource IDs of the bitmaps that the framework uses for smart docking markers that are highlighted.

Remarks

The framework handles smart docking markers internally. The following illustration shows the standard smart docking markers:

standard smart docking markers

In this figure, the image on the left shows a central group smart docking marker that does not have docking to a tab enabled. The image in the middle shows a right edge smart docking marker. The image on the right shows a central group smart docking marker that does have docking to a tab enabled. The central group smart docking marker has a main bitmap and five smart docking marker bitmaps.

You can customize the following parameters of smart docking markers:

  • Color. For example, you can replace the blue color of the markers in the figure with any user-defined color.

  • Transparency color.

  • Offset of a smart docking marker in the central group from the border of the bounding rectangle.

  • The main bitmap that represents the central group.

  • The bitmaps that represents the regular and highlighted smart docking markers.

The following illustration shows an example of smart docking markers that have been customized:

Smart Docking Custom Markers

Inheritance Hierarchy

CObject

   CSmartDockingInfo

Requirements

Header: afxDockingManager.h

See Also

Reference

Hierarchy Chart

CObject Class

Other Resources

MFC Classes