MQDockWindow class

(new in Rev4.60)

MQDockWindow class manages a docking window. It inheritsMQWidgetBase - MQWindowBase class

Please refer the inherited class about member functions declared in the inherited class.

class
MQDockWindow Constructor
~MQDockWindow Destructor
member functions
EnableDockableMenu Create dockable menu displayed in system menu.
GetCanDock Whether this can dock
SetCanDock Set whether this can dock
GetShowDockingTitle Get a visibility of a title bar while docking
SetShowDockingTitle Set a visibility of a title bar while docking
GetVerticalTitle Get a direction of a title bar while docking
SetVerticalTitle Set a direction of a title bar while docking
IsDocking Check if this is docking
DockToFrame Dock to a frame
RedockWithJustSize Dock with a just size
static fanction
CreateDockWindow Create docking window

MQDockWindow::MQDockWindow();

MQDockWindow::MQDockWindow(int id);

MQDockWindow::MQDockWindow(MQWindowBase& parent);

id
A widget id created outside the plug-in
parent
A parent window

It is a constructor.


virtual MQDockWindow::~MQDockWindow();

It is a destructor. It is defined as a virtual function.


void MQDockWindow::EnableDockableMenu();

It creates a dockable menu in the system menus on the title bar.


bool MQDockWindow::GetCanDock();

Return value
Whether this can dock

(new in Rev4.64)

It returns whether this window can dock or not.


void MQDockWindow::SetCanDock(bool value);

value
Whether this can dock

(new in Rev4.64)

It specifies whether this window can dock or not.


bool MQDockWindow::GetShowDockingTitle();

Return value
A visibility of a title bar

(new in Rev4.64)

It returns a visibility of a title bar while docking.


void MQDockWindow::SetShowDockingTitle(bool value);

value
A visibility of a title bar

(new in Rev4.64)

It specifies a visibility of a title bar while docking.


bool MQDockWindow::GetVerticalTitle();

Return value
Whether a direction of a title bar is vertical or not (horizontal)

(new in Rev4.64)

It returns a whether a direction of a title bar is vertical or horizontal.


void MQDockWindow::SetVerticalTitle(bool value);

value
Whether a direction of a title bar is vertical or not (horizontal)

(new in Rev4.64)

It specifies whether a direction of a title bar is vertical or horizontal.


bool MQDockWindow::IsDocking();

Return value
Whether this window is docking or not

(new in Rev4.64)

It returns whether this window is currently docking or not.

MQDockFrame::GetDockedWindowStatus() returns more details about docking.


void MQDockWindow::DockToFrame(MQDockFrame *frame, MQDockWindow *hierarchy_parent, MQDockDirection direction);

frame
A destination frame to dock (NULL means undocking)
hierarchy_parent
A nest parent window (NULL means just under a frame)
direction
A direction to the nest parent

(new in Rev4.64)

It docks this window to the specified frame.


void MQDockWindow::RedockWithJustSize();

(new in Rev4.64)

It calculate a just size and apply it to this window while docking.


MQDockWindow *MQDockWindow::CreateDockWindow(MQWindowBase& parent);

parent
A parent window
Return value
A created docking window

It creates a docking window as a child of the specified parent widget.

The widget created by this function must be deleted by calling not 'delete' operator but DeleteWidget().