### Class

# Panel DocumentWorkspace

#### Description

    class Panel.DocumentWorkspace : Panel.Workspace {
      parent_instance: PanelWorkspace
    }

No description available.

#### Ancestors

- PanelWorkspace
- AdwApplicationWindow
- GtkApplicationWindow
- GtkWindow
- GtkWidget
- GInitiallyUnowned
- GObject

#### Implements

- GActionGroup
- GActionMap
- GtkAccessible
- GtkBuildable
- GtkConstraintTarget
- GtkNative
- GtkRoot
- GtkShortcutManager

#### Constructors

###### panel_document_workspace_new

Creates a new `PanelDocumentWorkspace`.

since: 1.4

#### Instance methods

###### panel_document_workspace_add_widget

Requests the workspace add `widget` to the dock at `position`.

since: 1.4

###### panel_document_workspace_get_dock

Get the `PanelDock` for the workspace.

since: 1.4

###### panel_document_workspace_get_grid

Get the document grid for the workspace.

since: 1.4

###### panel_document_workspace_get_statusbar

Gets the statusbar for the workspace.

since: 1.4

###### panel_document_workspace_get_titlebar

Gets the titlebar for the workspace.

since: 1.4

###### panel_document_workspace_set_titlebar

No description available.

##### Methods inherited from PanelWorkspace (5)

###### panel_workspace_action_set_enabled

No description available.

###### panel_workspace_get_id

No description available.

###### panel_workspace_get_workbench

Gets the `PanelWorkbench` `self` is a part of.

since: 1.4

###### panel_workspace_inhibit

Inhibits one or more particular actions in the session.

since: 1.4

###### panel_workspace_set_id

No description available.

##### Methods inherited from AdwApplicationWindow (4)

###### adw_application_window_add_breakpoint

Adds `breakpoint` to `self`.

since: 1.4

###### adw_application_window_get_content

Gets the content widget of `self`.

###### adw_application_window_get_current_breakpoint

Gets the current breakpoint.

since: 1.4

###### adw_application_window_set_content

Sets the content widget of `self`.

##### Methods inherited from GtkApplicationWindow (5)

###### gtk_application_window_get_help_overlay

Gets the `GtkShortcutsWindow` that is associated with `window`.

###### gtk_application_window_get_id

Returns the unique ID of the window.

###### gtk_application_window_get_show_menubar

Returns whether the window will display a menubar for the app menu and menubar as needed.

###### gtk_application_window_set_help_overlay

Associates a shortcuts window with the application window.

###### gtk_application_window_set_show_menubar

Sets whether the window will display a menubar for the app menu and menubar as needed.

##### Methods inherited from GtkWindow (55)

Please see GtkWindow for a full list of methods.

##### Methods inherited from GtkWidget (162)

Please see GtkWidget for a full list of methods.

##### Methods inherited from GObject (43)

Please see GObject for a full list of methods.

##### Methods inherited from GActionGroup (14)

###### g_action_group_action_added

Emits the `GActionGroup::action-added` signal on `action_group`.

unstable since: 2.28

###### g_action_group_action_enabled_changed

Emits the `GActionGroup::action-enabled-changed` signal on `action_group`.

unstable since: 2.28

###### g_action_group_action_removed

Emits the `GActionGroup::action-removed` signal on `action_group`.

unstable since: 2.28

###### g_action_group_action_state_changed

Emits the `GActionGroup::action-state-changed` signal on `action_group`.

unstable since: 2.28

###### g_action_group_activate_action

Activate the named action within `action_group`.

unstable since: 2.28

###### g_action_group_change_action_state

Request for the state of the named action within `action_group` to be changed to `value`.

unstable since: 2.28

###### g_action_group_get_action_enabled

Checks if the named action within `action_group` is currently enabled.

unstable since: 2.28

###### g_action_group_get_action_parameter_type

Queries the type of the parameter that must be given when activating the named action within `action_group`.

unstable since: 2.28

###### g_action_group_get_action_state

Queries the current state of the named action within `action_group`.

unstable since: 2.28

###### g_action_group_get_action_state_hint

Requests a hint about the valid range of values for the state of the named action within `action_group`.

unstable since: 2.28

###### g_action_group_get_action_state_type

Queries the type of the state of the named action within `action_group`.

unstable since: 2.28

###### g_action_group_has_action

Checks if the named action exists within `action_group`.

unstable since: 2.28

###### g_action_group_list_actions

Lists the actions contained within `action_group`.

unstable since: 2.28

###### g_action_group_query_action

Queries all aspects of the named action within an `action_group`.

unstable since: 2.32

##### Methods inherited from GActionMap (4)

###### g_action_map_add_action

Adds an action to the `action_map`.

unstable since: 2.32

###### g_action_map_add_action_entries

A convenience function for creating multiple `GSimpleAction` instances and adding them to a `GActionMap`.

unstable since: 2.32

###### g_action_map_lookup_action

Looks up the action with the name `action_name` in `action_map`.

unstable since: 2.32

###### g_action_map_remove_action

Removes the named action from the action map.

unstable since: 2.32

##### Methods inherited from GtkAccessible (18)

###### gtk_accessible_get_accessible_parent

Retrieves the accessible parent for an accessible object.

unstable 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`.

unstable since: 4.10

###### gtk_accessible_get_bounds

Queries the coordinates and dimensions of this accessible.

unstable since: 4.10

###### gtk_accessible_get_first_accessible_child

Retrieves the first accessible child of an accessible object.

unstable since: 4.10

###### gtk_accessible_get_next_accessible_sibling

Retrieves the next accessible sibling of an accessible object.

unstable since: 4.10

###### gtk_accessible_get_platform_state

Query a platform state, such as focus.

unstable 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.

unstable since: 4.10

###### gtk_accessible_update_next_accessible_sibling

Updates the next accessible sibling of `self`.

unstable 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.

##### Methods inherited from GtkNative (5)

###### gtk_native_get_renderer

Returns the renderer that is used for this `GtkNative`.

###### gtk_native_get_surface

Returns the surface of this `GtkNative`.

###### gtk_native_get_surface_transform

Retrieves the surface transform of `self`.

###### gtk_native_realize

Realizes a `GtkNative`.

###### gtk_native_unrealize

Unrealizes a `GtkNative`.

##### Methods inherited from GtkRoot (3)

###### gtk_root_get_display

Returns the display that this `GtkRoot` is on.

###### gtk_root_get_focus

Retrieves the current focused widget within the root.

###### gtk_root_set_focus

If `focus` is not the current focus widget, and is focusable, sets it as the focus widget for the root.

#### Properties

###### Panel.DocumentWorkspace:dock

No description available.

###### Panel.DocumentWorkspace:grid

No description available.

###### Panel.DocumentWorkspace:statusbar

No description available.

##### Properties inherited from PanelWorkspace (1)

###### Panel.Workspace:id

The “id” of the workspace.

since: 1.4

##### Properties inherited from AdwApplicationWindow (2)

###### Adw.ApplicationWindow:content

The content widget.

###### Adw.ApplicationWindow:current-breakpoint

The current breakpoint.

since: 1.4

##### Properties inherited from GtkApplicationWindow (1)

###### Gtk.ApplicationWindow:show-menubar

If this property is `TRUE`, the window will display a menubar unless it is shown by the desktop shell.

##### Properties inherited from GtkWindow (25)

###### Gtk.Window:application

The `GtkApplication` associated with the window.

###### Gtk.Window:child

The child widget.

###### Gtk.Window:decorated

Whether the window should have a frame (also known as decorations).

###### Gtk.Window:default-height

The default height of the window.

###### Gtk.Window:default-widget

The default widget.

###### Gtk.Window:default-width

The default width of the window.

###### Gtk.Window:deletable

Whether the window frame should have a close button.

###### Gtk.Window:destroy-with-parent

If this window should be destroyed when the parent is destroyed.

###### Gtk.Window:display

The display that will display this window.

###### Gtk.Window:focus-visible

Whether ‘focus rectangles’ are currently visible in this window.

###### Gtk.Window:focus-widget

The focus widget.

###### Gtk.Window:fullscreened

Whether the window is fullscreen.

###### Gtk.Window:handle-menubar-accel

Whether the window frame should handle F10 for activating menubars.

unstable since: 4.2

###### Gtk.Window:hide-on-close

If this window should be hidden when the users clicks the close button.

###### Gtk.Window:icon-name

Specifies the name of the themed icon to use as the window icon.

###### Gtk.Window:is-active

Whether the toplevel is the currently active window.

###### Gtk.Window:maximized

Whether the window is maximized.

###### Gtk.Window:mnemonics-visible

Whether mnemonics are currently visible in this window.

###### Gtk.Window:modal

If `TRUE`, the window is modal.

###### Gtk.Window:resizable

If `TRUE`, users can resize the window.

###### Gtk.Window:startup-id

A write-only property for setting window’s startup notification identifier.

###### Gtk.Window:suspended

Whether the window is suspended.

unstable since: 4.12

###### Gtk.Window:title

The title of the window.

###### Gtk.Window:titlebar

The titlebar widget.

unstable since: 4.6

###### Gtk.Window:transient-for

The transient parent of the window.

##### 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-4.0.Accessible:accessible-role

The accessible role of the given `GtkAccessible` implementation.

#### Signals

###### Panel.DocumentWorkspace::add-widget

This signal is used to add a `PanelWidget` to the document workspace, generally in the document grid.

since: 1.4

###### Panel.DocumentWorkspace::create-frame

Creates a new `PanelFrame` to be added to the document grid.

since: 1.4

##### Signals inherited from GtkWindow (5)

###### GtkWindow::activate-default

Emitted when the user activates the default widget of `window`.

###### GtkWindow::activate-focus

Emitted when the user activates the currently focused widget of `window`.

###### GtkWindow::close-request

Emitted when the user clicks on the close button of the window.

###### GtkWindow::enable-debugging

Emitted when the user enables or disables interactive debugging.

###### GtkWindow::keys-changed

Emitted when the set of accelerators or mnemonics that are associated with `window` changes.

deprecated: 4.10

##### Signals inherited from GtkWidget (13)

###### GtkWidget::destroy

Signals that all holders of a reference to the widget should release the reference that they hold.

###### GtkWidget::direction-changed

Emitted when the text direction of a widget changes.

###### GtkWidget::hide

Emitted when `widget` is hidden.

###### GtkWidget::keynav-failed

Emitted if keyboard navigation fails.

###### GtkWidget::map

Emitted when `widget` is going to be mapped.

###### GtkWidget::mnemonic-activate

Emitted when a widget is activated via a mnemonic.

###### GtkWidget::move-focus

Emitted when the focus is moved.

###### GtkWidget::query-tooltip

Emitted when the widget’s tooltip is about to be shown.

###### GtkWidget::realize

Emitted when `widget` is associated with a `GdkSurface`.

###### GtkWidget::show

Emitted when `widget` is shown.

###### GtkWidget::state-flags-changed

Emitted when the widget state changes.

###### GtkWidget::unmap

Emitted when `widget` is going to be unmapped.

###### GtkWidget::unrealize

Emitted when the `GdkSurface` associated with `widget` is destroyed.

##### Signals inherited from GObject (1)

###### GObject::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.

##### Signals inherited from GActionGroup (4)

###### GActionGroup::action-added

Signals that a new action was just added to the group. This signal is emitted after the action has been added and is now visible.

unstable since: 2.28

###### GActionGroup::action-enabled-changed

Signals that the enabled status of the named action has changed.

unstable since: 2.28

###### GActionGroup::action-removed

Signals that an action is just about to be removed from the group. This signal is emitted before the action is removed, so the action is still visible and can be queried from the signal handler.

unstable since: 2.28

###### GActionGroup::action-state-changed

Signals that the state of the named action has changed.

unstable since: 2.28

#### Class structure

    struct PanelDocumentWorkspaceClass {
      PanelWorkspaceClass parent_class;
      PanelFrame* (* create_frame) (
        PanelDocumentWorkspace* self,
        PanelPosition* position
      );
      gboolean (* add_widget) (
        PanelDocumentWorkspace* self,
        PanelWidget* widget,
        PanelPosition* position
      );

    }

No description available.

###### Class members

`parent_class: PanelWorkspaceClass`
  No description available.
`create_frame: PanelFrame* (* create_frame) ( PanelDocumentWorkspace* self, PanelPosition* position )`
  No description available.
`add_widget: gboolean (* add_widget) ( PanelDocumentWorkspace* self, PanelWidget* widget, PanelPosition* position )`
  No description available.

#### Virtual methods

###### Panel.DocumentWorkspaceClass.add_widget

Requests the workspace add `widget` to the dock at `position`.

since: 1.4

###### Panel.DocumentWorkspaceClass.create_frame

No description available.