Panel.DocumentWorkspace¶

Subclasses:: None

Methods¶

Inherited:: Panel.Workspace (8), Adw.ApplicationWindow (9), Gtk.ApplicationWindow (6), Gtk.Window (62), Gtk.Widget (183), GObject.Object (37), Gtk.Accessible (17), Gtk.Buildable (1), Gtk.Native (6), Gtk.Root (3), Gio.ActionGroup (14), Gio.ActionMap (5)
Structs:: Panel.WorkspaceClass (2), Gtk.WidgetClass (18), GObject.ObjectClass (5)

class	`new` ()
	`add_widget` (widget, position)
	`get_dock` ()
	`get_grid` ()
	`get_statusbar` ()
	`get_titlebar` ()
	`set_titlebar` (titlebar)

Virtual Methods¶

Inherited:: Gtk.Window (5), Gtk.Widget (25), GObject.Object (7), Gtk.Accessible (6), Gtk.Buildable (9), Gtk.ShortcutManager (2), Gio.ActionGroup (14), Gio.ActionMap (3)

do_add_widget (widget, position)

Properties¶

Inherited:: Panel.Workspace (1), Adw.ApplicationWindow (5), Gtk.ApplicationWindow (1), Gtk.Window (25), Gtk.Widget (35), Gtk.Accessible (1)

Name	Type	Flags
`dock`	`Panel.Dock`	r/en
`grid`	`Panel.Grid`	r/en
`statusbar`	`Panel.Statusbar`	r/en

Signals¶

Inherited:: Gtk.Window (5), Gtk.Widget (13), GObject.Object (1), Gio.ActionGroup (4)

Name	Short Description
`add-widget`	This signal is used to add a `Panel.Widget` to the document workspace, generally in the document grid.
`create-frame`	Creates a new `Panel.Frame` to be added to the document grid.

Fields¶

Inherited:: Gtk.Window (5), Gtk.Widget (13), GObject.Object (1), Gio.ActionGroup (4)

Name	Type	Access	Description
parent_instance	`Panel.Workspace`	r

Class Details¶

class Panel.DocumentWorkspace(*args, **kwargs)¶

Bases:: Panel.Workspace
Abstract:: No
Structure:: Panel.DocumentWorkspaceClass

classmethod new()¶

Returns:: a Panel.DocumentWorkspace
Return type:: Panel.DocumentWorkspace

Creates a new Panel.DocumentWorkspace.

New in version 1.4.

add_widget(widget, position)¶

Parameters:

widget (Panel.Widget) – a Panel.Widget
position (Panel.Position or None) – a Panel.Position or None

Returns:

True if widget was added; otherwise False and widget will have GObject.Object.ref_sink() called and unref’d from an idle callback.

Return type:

bool

Requests the workspace add widget to the dock at position.

New in version 1.4.

get_dock()¶

Returns:: a Panel.Dock
Return type:: Panel.Dock

Get the Panel.Dock for the workspace.

New in version 1.4.

get_grid()¶

Returns:: a Panel.Grid
Return type:: Panel.Grid

Get the document grid for the workspace.

New in version 1.4.

get_statusbar()¶

Returns:: a Panel.Statusbar
Return type:: Panel.Statusbar or None

Gets the statusbar for the workspace.

New in version 1.4.

get_titlebar()¶

Returns:: a Gtk.Widget or None
Return type:: Gtk.Widget or None

Gets the titlebar for the workspace.

New in version 1.4.

set_titlebar(titlebar)¶

Parameters:: titlebar (Gtk.Widget) –

do_add_widget(widget, position) virtual¶

Parameters:

widget (Panel.Widget) – a Panel.Widget
position (Panel.Position or None) – a Panel.Position or None

Returns:

True if widget was added; otherwise False and widget will have GObject.Object.ref_sink() called and unref’d from an idle callback.

Return type:

bool

Requests the workspace add widget to the dock at position.

New in version 1.4.

Signal Details¶

Panel.DocumentWorkspace.signals.add_widget(document_workspace, widget, position)¶

Signal Name:

add-widget

Flags:

RUN_LAST

Parameters:

document_workspace (Panel.DocumentWorkspace) – The object which received the signal
widget (Panel.Widget) – a Panel.Widget
position (Panel.Position) – a Panel.Position

Returns:

True if the widget was added and no more signal handlers will be notified.

Return type:

bool

This signal is used to add a Panel.Widget to the document workspace, generally in the document grid.

New in version 1.4.

Panel.DocumentWorkspace.signals.create_frame(document_workspace, position)¶

Signal Name:

create-frame

Flags:

RUN_LAST

Parameters:

document_workspace (Panel.DocumentWorkspace) – The object which received the signal
position (Panel.Position) – the position of the frame

Returns:

a Panel.Frame

Return type:

Panel.Frame

Creates a new Panel.Frame to be added to the document grid.

New in version 1.4.

Property Details¶

Panel.DocumentWorkspace.props.dock¶

Name:: dock
Type:: Panel.Dock
Default Value:: None
Flags:: READABLE, EXPLICIT_NOTIFY

Panel.DocumentWorkspace.props.grid¶

Name:: grid
Type:: Panel.Grid
Default Value:: None
Flags:: READABLE, EXPLICIT_NOTIFY

Panel.DocumentWorkspace.props.statusbar¶

Name:: statusbar
Type:: Panel.Statusbar
Default Value:: None
Flags:: READABLE, EXPLICIT_NOTIFY