Class
PanelDock
Description [src]
class Panel.Dock : Gtk.Widget {
parent_instance: GtkWidget
}
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_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.
Constructors
panel_dock_new
Create a new PanelDock
.
Instance methods
panel_dock_foreach_frame
Invokes a callback for each frame in the dock.
panel_dock_get_can_reveal_area
Tells if the panel area can be revealed.
panel_dock_get_can_reveal_bottom
Tells if the bottom panel area can be revealed.
panel_dock_get_can_reveal_end
Tells if the end panel area can be revealed.
panel_dock_get_can_reveal_start
Tells if the start panel area can be revealed.
panel_dock_get_can_reveal_top
Tells if the top panel area can be revealed.
panel_dock_get_reveal_area
Tells if an area if revealed.
panel_dock_get_reveal_bottom
Tells if the bottom area is revealed.
panel_dock_get_reveal_end
Tells if the end area is revealed.
panel_dock_get_reveal_start
Tells if the start area is revealed.
panel_dock_get_reveal_top
Tells if the top area is revealed.
panel_dock_remove
Removes a widget from the dock. If widget
is not a DockChild
,
then the closest DockChild
parent is removed.
panel_dock_set_bottom_height
Set the height of the bottom area.
panel_dock_set_end_width
Set the width of the end area.
panel_dock_set_reveal_area
Sets the reveal status of the area.
panel_dock_set_reveal_bottom
Sets the reveal status of the bottom area.
panel_dock_set_reveal_end
Sets the reveal status of the end area.
panel_dock_set_reveal_start
Sets the reveal status of the start area.
panel_dock_set_reveal_top
Sets the reveal status of the top area.
panel_dock_set_start_width
Set the width of the start area.
panel_dock_set_top_height
Set the height of the top area.
Methods inherited from GtkAccessible (18)
gtk_accessible_get_accessible_parent
Retrieves the accessible parent for an accessible object.
Available since: 4.10
gtk_accessible_get_accessible_role
Retrieves the accessible role of an accessible object.
gtk_accessible_get_at_context
Retrieves the accessible implementation for the given GtkAccessible
.
Available since: 4.10
gtk_accessible_get_bounds
Queries the coordinates and dimensions of this accessible.
Available since: 4.10
gtk_accessible_get_first_accessible_child
Retrieves the first accessible child of an accessible object.
Available since: 4.10
gtk_accessible_get_next_accessible_sibling
Retrieves the next accessible sibling of an accessible object.
Available since: 4.10
gtk_accessible_get_platform_state
Query a platform state, such as focus.
Available since: 4.10
gtk_accessible_reset_property
Resets the accessible property
to its default value.
gtk_accessible_reset_relation
Resets the accessible relation
to its default value.
gtk_accessible_reset_state
Resets the accessible state
to its default value.
gtk_accessible_set_accessible_parent
Sets the parent and sibling of an accessible object.
Available since: 4.10
gtk_accessible_update_next_accessible_sibling
Updates the next accessible sibling of self
.
Available since: 4.10
gtk_accessible_update_property
Updates a list of accessible properties.
gtk_accessible_update_property_value
Updates an array of accessible properties.
gtk_accessible_update_relation
Updates a list of accessible relations.
gtk_accessible_update_relation_value
Updates an array of accessible relations.
gtk_accessible_update_state
Updates a list of accessible states. See the GtkAccessibleState
documentation for the value types of accessible states.
gtk_accessible_update_state_value
Updates an array of accessible states.
Methods inherited from GtkBuildable (1)
gtk_buildable_get_buildable_id
Gets the ID of the buildable
object.
Properties
Panel.Dock:bottom-height
Panel.Dock:can-reveal-bottom
Panel.Dock:can-reveal-end
Panel.Dock:can-reveal-start
Panel.Dock:can-reveal-top
Panel.Dock:end-width
Panel.Dock:reveal-bottom
Panel.Dock:reveal-end
Panel.Dock:reveal-start
Panel.Dock:reveal-top
Panel.Dock:start-width
Panel.Dock:top-height
Properties inherited from GtkWidget (34)
Gtk.Widget:can-focus
Whether the widget or any of its descendents can accept the input focus.
Gtk.Widget:can-target
Whether the widget can receive pointer events.
Gtk.Widget:css-classes
A list of css classes applied to this widget.
Gtk.Widget:css-name
The name of this widget in the CSS tree.
Gtk.Widget:cursor
The cursor used by widget
.
Gtk.Widget:focus-on-click
Whether the widget should grab focus when it is clicked with the mouse.
Gtk.Widget:focusable
Whether this widget itself will accept the input focus.
Gtk.Widget:halign
How to distribute horizontal space if widget gets extra space.
Gtk.Widget:has-default
Whether the widget is the default widget.
Gtk.Widget:has-focus
Whether the widget has the input focus.
Gtk.Widget:has-tooltip
Enables or disables the emission of the ::query-tooltip signal on widget
.
Gtk.Widget:height-request
Override for height request of the widget.
Gtk.Widget:hexpand
Whether to expand horizontally.
Gtk.Widget:hexpand-set
Whether to use the hexpand
property.
Gtk.Widget:layout-manager
The GtkLayoutManager
instance to use to compute the preferred size
of the widget, and allocate its children.
Gtk.Widget:margin-bottom
Margin on bottom side of widget.
Gtk.Widget:margin-end
Margin on end of widget, horizontally.
Gtk.Widget:margin-start
Margin on start of widget, horizontally.
Gtk.Widget:margin-top
Margin on top side of widget.
Gtk.Widget:name
The name of the widget.
Gtk.Widget:opacity
The requested opacity of the widget.
Gtk.Widget:overflow
How content outside the widget’s content area is treated.
Gtk.Widget:parent
The parent widget of this widget.
Gtk.Widget:receives-default
Whether the widget will receive the default action when it is focused.
Gtk.Widget:root
The GtkRoot
widget of the widget tree containing this widget.
Gtk.Widget:scale-factor
The scale factor of the widget.
Gtk.Widget:sensitive
Whether the widget responds to input.
Gtk.Widget:tooltip-markup
Sets the text of tooltip to be the given string, which is marked up with Pango markup.
Gtk.Widget:tooltip-text
Sets the text of tooltip to be the given string.
Gtk.Widget:valign
How to distribute vertical space if widget gets extra space.
Gtk.Widget:vexpand
Whether to expand vertically.
Gtk.Widget:vexpand-set
Whether to use the vexpand
property.
Gtk.Widget:visible
Whether the widget is visible.
Gtk.Widget:width-request
Override for width request of the widget.
Properties inherited from GtkAccessible (1)
Gtk.Accessible:accessible-role
The accessible role of the given GtkAccessible
implementation.
Signals
Panel.Dock::adopt-widget
Signal is emitted when a widget is requesting to be added via a drag-n-drop event.
Available since: 1.2
Panel.Dock::panel-drag-begin
This signal is emitted when dragging of a panel begins.
Panel.Dock::panel-drag-end
This signal is emitted when dragging of a panel either completes or was cancelled.
Signals inherited from GtkWidget (13)
Gtk.Widget::destroy
Signals that all holders of a reference to the widget should release the reference that they hold.
Gtk.Widget::direction-changed
Emitted when the text direction of a widget changes.
Gtk.Widget::hide
Emitted when widget
is hidden.
Gtk.Widget::keynav-failed
Emitted if keyboard navigation fails.
Gtk.Widget::map
Emitted when widget
is going to be mapped.
Gtk.Widget::mnemonic-activate
Emitted when a widget is activated via a mnemonic.
Gtk.Widget::move-focus
Emitted when the focus is moved.
Gtk.Widget::query-tooltip
Emitted when the widgets tooltip is about to be shown.
Gtk.Widget::realize
Emitted when widget
is associated with a GdkSurface
.
Gtk.Widget::show
Emitted when widget
is shown.
Gtk.Widget::state-flags-changed
Emitted when the widget state changes.
Gtk.Widget::unmap
Emitted when widget
is going to be unmapped.
Gtk.Widget::unrealize
Emitted when the GdkSurface
associated with widget
is destroyed.
Signals inherited from GObject (1)
GObject.Object::notify
The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.
Class structure
struct PanelDockClass {
GtkWidgetClass parent_class;
void (* panel_drag_begin) (
PanelDock* self,
PanelWidget* widget
);
void (* panel_drag_end) (
PanelDock* self,
PanelWidget* widget
);
}
Class members
parent_class |
|
No description available. | |
panel_drag_begin |
|
No description available. | |
panel_drag_end |
|
No description available. |