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()

GType _gType() @property

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

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

int bottomHeight() @property

void bottomHeight(int propval) @property

bool canRevealBottom() @property

bool canRevealEnd() @property

bool canRevealStart() @property

bool canRevealTop() @property

int endWidth() @property

void endWidth(int propval) @property

bool revealBottom() @property

void revealBottom(bool propval) @property

bool revealEnd() @property

void revealEnd(bool propval) @property

bool revealStart() @property

void revealStart(bool propval) @property

bool revealTop() @property

void revealTop(bool propval) @property

int startWidth() @property

void startWidth(int propval) @property

int topHeight() @property

void topHeight(int propval) @property

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

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

bool getCanRevealBottom()Tells 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()Tells 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()Tells 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()Tells 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)Tells if an area if revealed.

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

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

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

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

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

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

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

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

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

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

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

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

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

void setTopHeight(int height)Set 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)

Connect 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)

Connect 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)

Connect 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)

Connect 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

Methods

T bottomHeight(int propval)

T endWidth(int propval)

T revealBottom(bool propval)

T revealEnd(bool propval)

T revealStart(bool propval)

T revealTop(bool propval)

T startWidth(int propval)

T topHeight(int propval)

classDockGidBuilder : DockGidBuilderImpl!DockGidBuilder

Fluent builder for [panel.dock.Dock]

Methods

Dock build()