Class

IdeWorkspace

Description

abstract class Ide.Workspace : Dazzle.ApplicationWindow {
  parent_instance: DzlApplicationWindow
}
No description available.

Hierarchy

hierarchy this IdeWorkspace implements_0 AtkImplementorIface this--implements_0 implements_1 GActionGroup this--implements_1 implements_2 GActionMap this--implements_2 implements_3 GtkBuildable this--implements_3 ancestor_0 DzlApplicationWindow ancestor_0--this ancestor_1 GtkApplicationWindow ancestor_1--ancestor_0 ancestor_2 GtkWindow ancestor_2--ancestor_1 ancestor_3 GtkBin ancestor_3--ancestor_2 ancestor_4 GtkContainer ancestor_4--ancestor_3 ancestor_5 GtkWidget ancestor_5--ancestor_4 ancestor_6 GInitiallyUnowned ancestor_6--ancestor_5 ancestor_7 GObject ancestor_7--ancestor_6

Ancestors

  • DzlApplicationWindow
  • GtkApplicationWindow
  • GtkWindow
  • GtkBin
  • GtkContainer
  • GtkWidget
  • GInitiallyUnowned
  • GObject

Implements

  • AtkImplementorIface
  • GActionGroup
  • GActionMap
  • GtkBuildable

Instance methods

ide_workspace_add_surface

Adds a new IdeSurface to the workspace.

Available since: 3.32

ide_workspace_addin_find_by_module_name

Finds the addin (if any) matching the plugin’s module_name.

Available since: 3.40

ide_workspace_foreach_page

Calls callback for each IdePage found within the workspace.

Available since: 3.32

ide_workspace_foreach_surface

Calls callback for every IdeSurface based GtkWidget that is registered in the workspace.

Available since: 3.32

ide_workspace_get_cancellable

Gets a cancellable for a window. This is useful when you want operations to be cancelled if a window is closed.

Available since: 3.32

ide_workspace_get_context

Gets the IdeContext for the IdeWorkspace, which is set when the workspace joins an IdeWorkbench.

Available since: 3.32

ide_workspace_get_header_bar

Gets the headerbar for the workspace, if it is an IdeHeaderBar. Also works around Gtk giving back a GtkStack for the header bar.

Available since: 3.32

ide_workspace_get_most_recent_page

Gets the most recently focused IdePage.

Available since: 3.32

ide_workspace_get_overlay

Gets a GtkOverlay that contains all of the primary contents of the window (everything except the headerbar). This can be used by plugins to draw above the workspace contents.

Available since: 3.32

ide_workspace_get_surface_by_name

Locates an IdeSurface that has been added to the workspace by the name that was registered for the widget using gtk_widget_set_name().

Available since: 3.32

ide_workspace_get_visible_surface

Gets the currently visible IdeSurface, or NULL.

Available since: 3.32

ide_workspace_set_visible_surface

Sets the IdeWorkspace:visible-surface property which is the currently visible IdeSurface in the workspace.

Available since: 3.32

ide_workspace_set_visible_surface_name

Sets the visible surface based on the name of the surface. The name of the surface comes from gtk_widget_get_name(), which should be set when creating the surface using gtk_widget_set_name().

Available since: 3.32

Properties

Ide.Workspace:context

The “context” property is the IdeContext for the workspace. This is set when the workspace joins a workbench.

Available since: 3.32

Ide.Workspace:visible-surface

The “visible-surface” property contains the currently foremost surface in the workspaces stack of surfaces. Usually, this is the editor surface, but may be other surfaces such as build preferences, profiler, etc.

Available since: 3.32

Signals

Ide.Workspace::surface-set

The “surface-set” signal is emitted when the current surface changes within the workspace.

Available since: 3.32

Class structure

struct IdeWorkspaceClass {
  DzlApplicationWindowClass parent_class;
  const gchar* kind;
  void (* context_set) (
    IdeWorkspace* self,
    IdeContext* context
  );
  void (* foreach_page) (
    IdeWorkspace* self,
    GtkCallback callback,
    gpointer user_data
  );
  void (* surface_set) (
    IdeWorkspace* self,
    IdeSurface* surface
  );
  
}
Class members
parent_class
DzlApplicationWindowClass
  No description available.
kind
const gchar*
  No description available.
context_set
void (* context_set) (
    IdeWorkspace* self,
    IdeContext* context
  )
  No description available.
foreach_page
void (* foreach_page) (
    IdeWorkspace* self,
    GtkCallback callback,
    gpointer user_data
  )
  No description available.
surface_set
void (* surface_set) (
    IdeWorkspace* self,
    IdeSurface* surface
  )
  No description available.

Virtual methods

Ide.WorkspaceClass.context_set
No description available.
Ide.WorkspaceClass.foreach_page

Calls callback for each IdePage found within the workspace.

Available since: 3.32

Ide.WorkspaceClass.surface_set
No description available.

Class methods

ide_workspace_class_set_kind

Sets the shorthand name for the kind of workspace. This is used to limit what IdeWorkspaceAddin may load within the workspace.

Available since: 3.32