Unit NppDockingForms

Description
Classes, Interfaces, Objects and Records
Constants

Description

Types and utilities for creating docked plugin dialogs

Overview

Classes, Interfaces, Objects and Records

Name Description
Record TDockMgr  
Class TNppDockingForm Default implementation of a docked plugin dialog

Constants

CAPTION_BOTTOM = FALSE;
CAPTION_TOP = TRUE;
CONT_BOTTOM = 3;
CONT_LEFT = 0;
CONT_RIGHT = 1;
CONT_TOP = 2;
DMM_CANCEL_MOVE = (DMM_MSG + 12);
DMM_CLOSE = (DMM_MSG + 1);
DMM_DOCK = (DMM_MSG + 2);
DMM_DOCKALL = (DMM_MSG + 4);
DMM_DROPDATA = (DMM_MSG + 10);
DMM_FLOAT = (DMM_MSG + 3);
DMM_FLOATALL = (DMM_MSG + 5);
DMM_GETICONPOS = (DMM_MSG + 9);
DMM_GETIMAGELIST = (DMM_MSG + 8);
DMM_LBUTTONUP = (DMM_MSG + 13);
DMM_MOVE = (DMM_MSG + 6);
DMM_MOVE_SPLITTER = (DMM_MSG + 11);
DMM_MSG = $5000;
DMM_UPDATEDISPINFO = (DMM_MSG + 7);
DMN_CLOSE = (DMN_FIRST + 1);
DMN_DOCK = (DMN_FIRST + 2);
DMN_FIRST = 1050;
DMN_FLOAT = (DMN_FIRST + 3);
DMN_FLOATDROPPED = (DMN_FIRST + 6);
DMN_SWITCHIN = (DMN_FIRST + 4);
DMN_SWITCHOFF = (DMN_FIRST + 5);
DM_NOFOCUSWHILECLICKINGCAPTION = 'NOFOCUSWHILECLICKINGCAPTION';
DOCKCONT_MAX = 4;
DWS_ADDINFO = $00000004;
DWS_DF_CONT_BOTTOM = (CONT_BOTTOM shl 28);
DWS_DF_CONT_LEFT = (CONT_LEFT shl 28);
DWS_DF_CONT_RIGHT = (CONT_RIGHT shl 28);
DWS_DF_CONT_TOP = (CONT_TOP shl 28);
DWS_DF_FLOATING = $80000000;
DWS_ICONBAR = $00000002;
DWS_ICONTAB = $00000001;
DWS_PARAMSALL = (DWS_ICONTAB or DWS_ICONBAR or DWS_ADDINFO);
DWS_USEOWNDARKMODE = $00000008;
HIT_TEST_THICKNESS = 20;
IDB_CLOSE_DOWN = 137;
IDB_CLOSE_UP = 138;
IDC_BTN_CAPTION = 1050;
IDC_CLIENT_TAB = 1028;
IDC_EDIT1 = 1000;
IDC_TAB_CONT = 1027;
IDD_CONTAINER_DLG = 139;
IDD_PLUGIN_DLG = 103;
SPLITTER_WIDTH = 4;

Description

Constants

CAPTION_BOTTOM = FALSE;

This item has no description.

CAPTION_TOP = TRUE;

This item has no description.

CONT_BOTTOM = 3;

This item has no description.

CONT_LEFT = 0;

This item has no description.

CONT_RIGHT = 1;

This item has no description.

CONT_TOP = 2;

This item has no description.

DMM_CANCEL_MOVE = (DMM_MSG + 12);

This item has no description.

DMM_CLOSE = (DMM_MSG + 1);

This item has no description.

DMM_DOCK = (DMM_MSG + 2);

This item has no description.

DMM_DOCKALL = (DMM_MSG + 4);

This item has no description.

DMM_DROPDATA = (DMM_MSG + 10);

This item has no description.

DMM_FLOAT = (DMM_MSG + 3);

This item has no description.

DMM_FLOATALL = (DMM_MSG + 5);

This item has no description.

DMM_GETICONPOS = (DMM_MSG + 9);

This item has no description.

DMM_GETIMAGELIST = (DMM_MSG + 8);

This item has no description.

DMM_LBUTTONUP = (DMM_MSG + 13);

This item has no description.

DMM_MOVE = (DMM_MSG + 6);

This item has no description.

DMM_MOVE_SPLITTER = (DMM_MSG + 11);

This item has no description.

DMM_MSG = $5000;

This item has no description.

DMM_UPDATEDISPINFO = (DMM_MSG + 7);

This item has no description.

DMN_CLOSE = (DMN_FIRST + 1);

See DMN_FIRST

DMN_DOCK = (DMN_FIRST + 2);

See DMN_FIRST

DMN_FIRST = 1050;

Notification codes from DMN_CLOSE to DMN_FLOATDROPPED are sent to docking dialogs in the Code field of the NMHdr member of a TWMNotify record.

For example: 

procedure TMyDockingForm.OnWM_NOTIFY(var AMsg: TWMNotify);
begin
  case AMsg.NMHdr.Code and $ffff of
    { dialog is being docked }
    DMN_DOCK: begin
      // ...
    end;
    { dialog is being *un*docked }
    DMN_FLOAT: begin
      // ...
    end;
    { dialog is about to close }
    DMN_CLOSE: begin
      // ...
    end;
  end;
  AMsg.Result := 0;
end;

See also
TNppDockingForm.OnWM_NOTIFY
Handles the DMN_FLOAT, DMN_DOCK and DMN_CLOSE Docking Manager messages.
DMN_FLOAT = (DMN_FIRST + 3);

See DMN_FIRST

DMN_FLOATDROPPED = (DMN_FIRST + 6);

See DMN_FIRST

DMN_SWITCHIN = (DMN_FIRST + 4);

See DMN_FIRST

DMN_SWITCHOFF = (DMN_FIRST + 5);

See DMN_FIRST

DM_NOFOCUSWHILECLICKINGCAPTION = 'NOFOCUSWHILECLICKINGCAPTION';

This item has no description.

DOCKCONT_MAX = 4;

This item has no description.

DWS_ADDINFO = $00000004;

Display a string of additional information in the title bar

DWS_DF_CONT_BOTTOM = (CONT_BOTTOM shl 28);

Default docking on bottom

DWS_DF_CONT_LEFT = (CONT_LEFT shl 28);

Default docking on left

DWS_DF_CONT_RIGHT = (CONT_RIGHT shl 28);

Default docking on right

DWS_DF_CONT_TOP = (CONT_TOP shl 28);

Default docking on top

DWS_DF_FLOATING = $80000000;

Default state is floating

DWS_ICONBAR = $00000002;

Display an icon in the title bar (currently not supported)

DWS_ICONTAB = $00000001;

Display an icon on the docking tab (i.e., when this dialog loses focus in a dock group)

DWS_PARAMSALL = (DWS_ICONTAB or DWS_ICONBAR or DWS_ADDINFO);

This item has no description.

DWS_USEOWNDARKMODE = $00000008;

Use plugin's own dark mode (i.e., prevent automatic subclassing; see NPPM_DARKMODESUBCLASSANDTHEME)

HIT_TEST_THICKNESS = 20;

This item has no description.

IDB_CLOSE_DOWN = 137;

This item has no description.

IDB_CLOSE_UP = 138;

This item has no description.

IDC_BTN_CAPTION = 1050;

This item has no description.

IDC_CLIENT_TAB = 1028;

This item has no description.

IDC_EDIT1 = 1000;

This item has no description.

IDC_TAB_CONT = 1027;

This item has no description.

IDD_CONTAINER_DLG = 139;

This item has no description.

IDD_PLUGIN_DLG = 103;

This item has no description.

SPLITTER_WIDTH = 4;

This item has no description.

This documentation is in the public domain under the Creative Commons Zero v1.0 Universal public license.