Vcl.CaptionedDockTree.TCaptionedDockTree.ZoneCaptionHitTest

Delphi

function ZoneCaptionHitTest(const Zone: TDockZone;
const MousePos: TPoint; var HTFlag: Integer): Boolean; override;

C++

virtual bool __fastcall ZoneCaptionHitTest(Vcl::Controls::TDockZone* const Zone, const System::Types::TPoint &MousePos, int &HTFlag);

Type	Visibility	Source	Unit	Parent
function	protected	Vcl.CaptionedDockTree.pas Vcl.CaptionedDockTree.hpp	Vcl.CaptionedDockTree	TCaptionedDockTree

Description

Indicates the location of the mouse cursor, relative to the docked control.

Vcl.CaptionedDockTree.TCaptionedDockTree.ZoneCaptionHitTest inherits from Vcl.Controls.TDockTree.ZoneCaptionHitTest. All content below this line refers to Vcl.Controls.TDockTree.ZoneCaptionHitTest.

Indicates the location of the mouse cursor, relative to the docked control.

TDockTree uses the protected method ZoneCaptionHitTest internally to determine the location of the mouse pointer, relative to the docked control.

Zone indicates the dock zone.

MousePos indicates the location of the mouse pointer.

HTFlag indicates the location of the mouse pointer, relative to the docked control. It has one of the following values:

Value	Meaning
HTNOWHERE	The mouse pointer is not anywhere in the docking region.
HTCLIENT	The mouse pointer is over the client area of the docked control.
HTBORDER	The mouse pointer is over the splitter that allows docking zones to be resized.
HTCAPTION	The mouse pointer is over the grab region where users can start dragging a docked control out of its docked position.
HTCLOSE	The mouse pointer is over the portion of the grab region that contains the "Close" button for closing the docked control window.