Gdl.DockMaster¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

	`add` (object)
	`foreach` (function, *user_data)
	`foreach_toplevel` (include_controller, function, *user_data)
	`get_controller` ()
	`get_dock_name` ()
	`get_object` (nick_name)
	`remove` (object)
	`set_controller` (new_controller)

Virtual Methods¶

Inherited:: GObject.Object (7)

do_layout_changed ()

Properties¶

Name	Type	Flags	Short Description
`default-title`	`str`	r/w	Default title for newly created floating docks
`locked`	`int`	r/w	If is set to 1, all the dock items bound to the master are locked; if it’s 0, all are unlocked; -1 indicates inconsistency among the items
`switcher-style`	`Gdl.SwitcherStyle`	r/w	Switcher buttons style
`tab-pos`	`Gtk.PositionType`	r/w	Which side of the notebook holds the tabs
`tab-reorderable`	`bool`	r/w	Whether the tab is reorderable by user action

Signals¶

Inherited:: GObject.Object (1)

Name	Short Description
`layout-changed`	Signals that the layout has changed, one or more widgets have been moved, added or removed.

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
object	`GObject.Object`	r

Class Details¶

class Gdl.DockMaster(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: Gdl.DockMasterClass

add(object)¶

Parameters:: object (Gdl.DockObject) – a Gdl.DockObject

Add a new dock widget to the master.

foreach(function, *user_data)¶

Parameters:

function (GLib.Func) – the function to call with each element’s data
user_data (object or None) – user data to pass to the function

Call function on each dock widget of the master.

foreach_toplevel(include_controller, function, *user_data)¶

Parameters:

include_controller (bool) – True to include the controller
function (GLib.Func) – the function to call with each element’s data
user_data (object or None) – user data to pass to the function

Call function on each top level dock widget of the master, including or not the controller.

get_controller()¶

Returns:: A Gdl.DockObject.
Return type:: Gdl.DockObject

Retrieves the Gdl.DockObject acting as the controller.

get_dock_name()¶

Returns:: a new translated name. The string has to be freed with GLib.free().
Return type:: str

Return an unique translated dock name.

New in version 3.6.

get_object(nick_name)¶

Parameters:: nick_name (str) – the name of the dock widget.
Returns:: A Gdl.DockObject named nick_name or None if it does not exist.
Return type:: Gdl.DockObject or None

Looks for a Gdl.DockObject named nick_name.

remove(object)¶

Parameters:: object (Gdl.DockObject) – a Gdl.DockObject

Remove one dock widget from the master.

set_controller(new_controller)¶

Parameters:: new_controller (Gdl.DockObject) – a Gdl.DockObject

Set a new controller. The controller must be a top level Gdl.DockObject.

do_layout_changed() virtual¶

Signal Details¶

Gdl.DockMaster.signals.layout_changed(dock_master)¶

Signal Name:: layout-changed
Flags:: RUN_LAST
Parameters:: dock_master (Gdl.DockMaster) – The object which received the signal

Signals that the layout has changed, one or more widgets have been moved, added or removed.

Property Details¶

Gdl.DockMaster.props.default_title¶

Name:: default-title
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

Default title for newly created floating docks

Gdl.DockMaster.props.locked¶

Name:: locked
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE

If is set to 1, all the dock items bound to the master are locked; if it’s 0, all are unlocked; -1 indicates inconsistency among the items

Gdl.DockMaster.props.switcher_style¶

Name:: switcher-style
Type:: Gdl.SwitcherStyle
Default Value:: Gdl.SwitcherStyle.BOTH
Flags:: READABLE, WRITABLE

Switcher buttons style

Gdl.DockMaster.props.tab_pos¶

Name:: tab-pos
Type:: Gtk.PositionType
Default Value:: Gtk.PositionType.BOTTOM
Flags:: READABLE, WRITABLE

Which side of the notebook holds the tabs

Gdl.DockMaster.props.tab_reorderable¶

Name:: tab-reorderable
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Whether the tab is reorderable by user action