MQDockFrame class

(new in Rev4.60)

MQDockFrame class manages a dock frame. Multiple child widgets can be contained horizontally or vertically in the frame. It inherits a MQFrameBase class.

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

class
MQDockFrame Constructor
~MQDockFrame Destructor
Member functions
RegisterDockableWindow Register dockable window
GetDockedWindowStatus Get a status of a docked window
GetBackColor Get background color
SetBackColor Get background color

MQDockFrame::MQDockFrame();

MQDockFrame::MQDockFrame(int id);

id
A widget ID created outside the plug-in

It is a constructor.


virtual MQDockFrame::~MQDockFrame();

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


void MQDockFrame::RegisterDockableWindow(MQDockWindow *dock_window);

dock_window
A docking window

It register dockable window.


void MQDockFrame::GetDockedWindowStatus(std::map<MQDockWindow*, MQDockWindow::MQDockStatus>& status);

status
A docked status of each window

(new in Rev4.64)

It gets a status of a window docking to this frame.

Status of windows that are currently docking to this frame are stored to 'status', and floating windows are not stored.

struct MQDockStatus {
	int Order;
	MQDockWindow *Parent;
	MQDockDirection Direction;
	double SizeRate;
};
Order
A nest order (Ascending order from 0)
Parent
A nest parent window (NULL means just under a frame)
Direction
A docking direction
SizeRate
A rate of a size to a parent

void MQDockFrame::GetBackColor(int& r, int& g, int& b, int& a);

MQCanvasColor MQDockFrame::GetBackColor();

r
Red
g
Green
b
Blue
a
Opacity

It returns a background color in a frame.


void MQDockFrame::SetBackColor(int r, int g, int b, int a);

void MQDockFrame::SetBackColor(MQCanvasColor col);

r
Red
g
Green
b
Blue
a
Opacity

It specifies a background color in a frame.