panel.dock

Module for [Dock] class

class Dock DockGidBuilder DockGidBuilderImpl

Types 3

The #PanelDock is a widget designed to contain widgets that can be docked. Use the #PanelDock as the top widget of your dockable UI.

A #PanelDock is divided in 5 areas: panel.types.Area.Top, panel.types.Area.Bottom, panel.types.Area.Start, panel.types.Area.End represent the surrounding areas that can revealed. panel.types.Area.Center represent the main area, that is always displayed and resized depending on the reveal state of the surrounding areas.

It will contain a #PanelDockChild for each of the areas in use, albeit this is done by the widget.

Methods

GType _getGType() static nothrow

GType _gType() @property nothrow

Dock self() nothrowReturns `this`, for use in `with` statements.

DockGidBuilder builder() static nothrowGet builder for [panel.dock.Dock] Returns: New builder object

int bottomHeight() @property nothrow

void bottomHeight(int propval) @property nothrow

bool canRevealBottom() @property nothrow

bool canRevealEnd() @property nothrow

bool canRevealStart() @property nothrow

bool canRevealTop() @property nothrow

int endWidth() @property nothrow

void endWidth(int propval) @property nothrow

bool revealBottom() @property nothrow

void revealBottom(bool propval) @property nothrow

bool revealEnd() @property nothrow

void revealEnd(bool propval) @property nothrow

bool revealStart() @property nothrow

void revealStart(bool propval) @property nothrow

bool revealTop() @property nothrow

void revealTop(bool propval) @property nothrow

int startWidth() @property nothrow

void startWidth(int propval) @property nothrow

int topHeight() @property nothrow

void topHeight(int propval) @property nothrow

void foreachFrame(panel.types.FrameCallback callback) nothrowInvokes a callback for each frame in the dock.

bool getCanRevealArea(panel.types.Area area) nothrowTells if the panel area can be revealed.

bool getCanRevealBottom() nothrowTells if the bottom panel area can be revealed. Returns: whether it can reveal the bottom area or not. If the is no child or the child is empty, will return false.

bool getCanRevealEnd() nothrowTells if the end panel area can be revealed. Returns: whether it can reveal the end area or not. If the is no child or the child is empty, will return false.

bool getCanRevealStart() nothrowTells if the start panel area can be revealed. Returns: whether it can reveal the start area or not. If the is no child or the child is empty, will return false.

bool getCanRevealTop() nothrowTells if the top panel area can be revealed. Returns: whether it can reveal the top area or not. If the is no child or the child is empty, will return false.

bool getRevealArea(panel.types.Area area) nothrowTells if an area if revealed.

bool getRevealBottom() nothrowTells if the bottom area is revealed. Returns: The reveal state of the bottom area.

bool getRevealEnd() nothrowTells if the end area is revealed. Returns: The reveal state of the end area.

bool getRevealStart() nothrowTells if the start area is revealed. Returns: The reveal state of the start area.

bool getRevealTop() nothrowTells if the top area is revealed. Returns: The reveal state of the top area.

void remove(gtk.widget.Widget widget) nothrowRemoves a widget from the dock. If widget is not a #DockChild, then the closest #DockChild parent is removed.

void setBottomHeight(int height) nothrowSet the height of the bottom area.

void setEndWidth(int width) nothrowSet the width of the end area.

void setRevealArea(panel.types.Area area, bool reveal) nothrowSets the reveal status of the area.

void setRevealBottom(bool revealBottom) nothrowSets the reveal status of the bottom area.

void setRevealEnd(bool revealEnd) nothrowSets the reveal status of the end area.

void setRevealStart(bool revealStart) nothrowSets the reveal status of the start area.

void setRevealTop(bool revealTop) nothrowSets the reveal status of the top area.

void setStartWidth(int width) nothrowSet the width of the start area.

void setTopHeight(int height) nothrowSet the height of the top area.

gulong connectAdoptWidget(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  bool)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0] :  panel.widget.Widget)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.none &&  is(Parameters!T[1] :  panel.dock.Dock)))
   &&  Parameters!T.length <  3)

nothrowConnect to `AdoptWidget` signal.

gulong connectCreateFrame(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T :  panel.frame.Frame)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0] :  panel.position.Position)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.none &&  is(Parameters!T[1] :  panel.dock.Dock)))
   &&  Parameters!T.length <  3)

nothrowConnect to `CreateFrame` signal.

gulong connectPanelDragBegin(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0] :  panel.widget.Widget)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.none &&  is(Parameters!T[1] :  panel.dock.Dock)))
   &&  Parameters!T.length <  3)

nothrowConnect to `PanelDragBegin` signal.

gulong connectPanelDragEnd(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0] :  panel.widget.Widget)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.none &&  is(Parameters!T[1] :  panel.dock.Dock)))
   &&  Parameters!T.length <  3)

nothrowConnect to `PanelDragEnd` signal.

Constructors

this(void * ptr, Flag!"Take" take)

this()Create a new #PanelDock. Returns: a newly created #PanelDock

classDockGidBuilderImpl(T) : gtk.widget.WidgetGidBuilderImpl!T

Fluent builder implementation template for panel.dock.Dock

Methods

T bottomHeight(int propval) nothrow

T endWidth(int propval) nothrow

T revealBottom(bool propval) nothrow

T revealEnd(bool propval) nothrow

T revealStart(bool propval) nothrow

T revealTop(bool propval) nothrow

T startWidth(int propval) nothrow

T topHeight(int propval) nothrow

classDockGidBuilder : DockGidBuilderImpl!DockGidBuilder

Fluent builder for panel.dock.Dock

Methods

Dock build() nothrowCreate object from builder. Returns: New object