Panel.Dock – libpanel-1 – Vala Binding Reference

Description:

[ CCode ( type_id = "panel_dock_get_type ()" ) ]
public class Dock : Widget, Accessible, Buildable, ConstraintTarget

The Dock is a widget designed to contain widgets that can be docked.

Use the Dock as the top widget of your dockable UI.

A Dock is divided in 5 areas: panel_area_top, panel_area_bottom, panel_area_start, panel_area_end represent the surrounding areas that can revealed. panel_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.

Namespace: Panel

Content:

Properties:

public int bottom_height { get; set; }

public bool can_reveal_bottom { get; }

public bool can_reveal_end { get; }

public bool can_reveal_start { get; }

public bool can_reveal_top { get; }

public int end_width { get; set; }

public bool reveal_bottom { get; set; }

public bool reveal_end { get; set; }

public bool reveal_start { get; set; }

public bool reveal_top { get; set; }

public int start_width { get; set; }

public int top_height { get; set; }

Creation methods:

public Dock ()

Create a new Dock.

Methods:

public void foreach_frame (FrameCallback callback)

Invokes a callback for each frame in the dock.

public bool get_can_reveal_area (Area area)

Tells if the panel area can be revealed.

public bool get_can_reveal_bottom ()

Tells if the bottom panel area can be revealed.

public bool get_can_reveal_end ()

Tells if the end panel area can be revealed.

public bool get_can_reveal_start ()

Tells if the start panel area can be revealed.

public bool get_can_reveal_top ()

Tells if the top panel area can be revealed.

public bool get_reveal_area (Area area)

Tells if an area if revealed.

public bool get_reveal_bottom ()

Tells if the bottom area is revealed.

public bool get_reveal_end ()

Tells if the end area is revealed.

public bool get_reveal_start ()

Tells if the start area is revealed.

public bool get_reveal_top ()

Tells if the top area is revealed.

public void remove (Widget widget)

Removes a widget from the dock.

public void set_bottom_height (int height)

Set the height of the bottom area.

public void set_end_width (int width)

Set the width of the end area.

public void set_reveal_area (Area area, bool reveal)

Sets the reveal status of the area.

public void set_reveal_bottom (bool reveal_bottom)

Sets the reveal status of the bottom area.

public void set_reveal_end (bool reveal_end)

Sets the reveal status of the end area.

public void set_reveal_start (bool reveal_start)

Sets the reveal status of the start area.

public void set_reveal_top (bool reveal_top)

Sets the reveal status of the top area.

public void set_start_width (int width)

Set the width of the start area.

public void set_top_height (int height)

Set the height of the top area.

Signals:

public signal bool adopt_widget (Widget widget)

Signal is emitted when a widget is requesting to be added via a drag-n-drop event.

public signal Frame create_frame (Position position)

This signal is emitted when a new frame is needed.

public virtual signal void panel_drag_begin (Widget widget)

This signal is emitted when dragging of a panel begins.

public virtual signal void panel_drag_end (Widget widget)

This signal is emitted when dragging of a panel either completes or was cancelled.

Inherited Members:

Dock