Share via

CDockingManager::DeterminePaneAndStatus

  • Article

Determines the pane that contains a given point and its docking status.

virtual AFX_CS_STATUS DeterminePaneAndStatus(
   CPoint pt,
   int nSensitivity,
   DWORD dwEnabledAlignment,
   CBasePane** ppTargetBar,
   const CBasePane* pBarToIgnore,
   const CBasePane* pBarToDock
);

Parameters

  • [in] pt
    The location of the pane to check.

  • [in] nSensitivity
    The value to increase the window rectangle of each checked pane. A pane satisfies the search criteria if the given point is in this increased region.

  • [in] dwEnabledAlignment
    The alignment of the docking pane.

  • [out] ppTargetBar
    A pointer to a pointer to the target pane.

  • [in] pBarToIgnore
    The pane that the method ignores.

  • [in] pBarToDock
    The pane that is docked.

Return Value

The docking status.

Remarks

The docking status can be one of the following values:

AFX_CS_STATUS value

Meaning

CS_NOTHING

The pointer is not over a dock site. Therefore, keep the pane floating.

CS_DOCK_IMMEDIATELY

The pointer is over the dock site in the immediate mode (DT_IMMEDIATE style is enabled), so the pane must be docked immediately.

CS_DELAY_DOCK

The pointer is over a dock site that is another docking pane or is an edge of the main frame.

CS_DELAY_DOCK_TO_TAB

The pointer is over a dock site that causes the pane to be docked in a tabbed window. This occurs when the mouse is over a caption of another docking pane or over a tab area of a tabbed pane.

Requirements

Header: afxdockingmanager.h

See Also

Reference

CDockingManager Class

Hierarchy Chart