Top | ![]() |
![]() |
![]() |
![]() |
IdeContext * | context | Read |
gboolean | disable-greeter | Read / Write / Construct Only |
IdePerspective * | visible-perspective | Read / Write |
gchar * | visible-perspective-name | Read / Write |
GObject ╰── GInitiallyUnowned ╰── GtkWidget ╰── GtkContainer ╰── GtkBin ╰── GtkWindow ╰── GtkApplicationWindow ╰── DzlApplicationWindow ╰── IdeWorkbench
IdeWorkbench implements AtkImplementorIface, GtkBuildable, GActionGroup and GActionMap.
void ide_workbench_open_project_async (IdeWorkbench *self
,GFile *file_or_directory
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
gboolean ide_workbench_open_project_finish (IdeWorkbench *self
,GAsyncResult *result
,GError **error
);
void ide_workbench_open_uri_async (IdeWorkbench *self
,IdeUri *uri
,const gchar *hint
,IdeWorkbenchOpenFlags flags
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
gboolean ide_workbench_open_uri_finish (IdeWorkbench *self
,GAsyncResult *result
,GError **error
);
void ide_workbench_open_files_async (IdeWorkbench *self
,GFile **files
,guint n_files
,const gchar *hint
,IdeWorkbenchOpenFlags flags
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Starts the process of loading the buffers for the given files
, possibly
creating an IdeEditorView for each depending on flags
.
self |
An IdeWorkbench. |
|
files |
An array of GFile objects to be opened. |
[array length=n_files] |
n_files |
The number of files given. |
|
hint |
The id of an IdeWorkbenchAddin that should be preferred as a loader. |
|
flags |
an IdeWorkbenchOpenFlags (if WORKBENCH_OPEN_FLAGS_BG is set, the buffer is loaded but not made visible in the UI). |
|
cancellable |
a GCancellable. |
[nullable] |
callback |
a GAsyncReadyCallback or |
[scope async][closure user_data] |
user_data |
User data for |
gboolean ide_workbench_open_files_finish (IdeWorkbench *self
,GAsyncResult *result
,GError **error
);
void ide_workbench_save_all_async (IdeWorkbench *self
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
gboolean ide_workbench_save_all_finish (IdeWorkbench *self
,GAsyncResult *result
,GError **error
);
IdeContext *
ide_workbench_get_context (IdeWorkbench *self
);
Gets the context associated with the workbench, or NULL
.
void ide_workbench_add_perspective (IdeWorkbench *self
,IdePerspective *perspective
);
void ide_workbench_remove_perspective (IdeWorkbench *self
,IdePerspective *perspective
);
IdePerspective * ide_workbench_get_perspective_by_name (IdeWorkbench *self
,const gchar *name
);
Gets the perspective by its registered name as defined in
ide_perspective_get_id()
.
IdePerspective *
ide_workbench_get_visible_perspective (IdeWorkbench *self
);
Gets the current perspective.
void ide_workbench_set_visible_perspective (IdeWorkbench *self
,IdePerspective *perspective
);
const gchar *
ide_workbench_get_visible_perspective_name
(IdeWorkbench *self
);
void ide_workbench_set_visible_perspective_name (IdeWorkbench *self
,const gchar *name
);
void ide_workbench_views_foreach (IdeWorkbench *self
,GtkCallback callback
,gpointer user_data
);
Executes callback
for every IdeLayoutView across all perspectives.
self |
An IdeWorkbench. |
|
callback |
The callback to execute. |
[scope call] |
user_data |
user data for |
IdeWorkbenchHeaderBar *
ide_workbench_get_headerbar (IdeWorkbench *self
);
Helper that is equivalent to calling gtk_window_get_titlebar()
and casting
to an IdeWorkbenchHeaderBar. This is convenience for plugins.
void ide_workbench_push_message (IdeWorkbench *self
,IdeWorkbenchMessage *message
);
gboolean ide_workbench_pop_message (IdeWorkbench *self
,const gchar *message_id
);
void ide_workbench_set_focus_mode (IdeWorkbench *self
,gboolean focus_mode
);
The IdeWorkbenchOpenFlags enumeration is used to specify how a document should be opened by the workbench. Plugins may want to have a bit of control over where the document is opened, and this provides a some control over that.
The IDE_WORKBENCH_OPEN_FLAGS_NO_VIEW
enum value was added in 3.26
Since: 3.24
“context”
property“context” IdeContext *
The “context” property contains the IdeContext for the loaded project. Loading a project consists of creating an IdeContext, so there is a 1:1 mapping between "loaded project" and an IdeContext.
The IdeContext contains many of the important components of a project. For example, it contains the IdeVcs representing the active version control system and an IdeBuildSystem representing the current build system.
The creation of IdeWorkbenchAddin addins are deferred until this property has been set.
Flags: Read
“disable-greeter”
property “disable-greeter” gboolean
This property is used internally by Builder to avoid creating the greeter when opening a new workspace that is only for loading a project.
This should not be used by application plugins.
Flags: Read / Write / Construct Only
Default value: FALSE
“visible-perspective”
property“visible-perspective” IdePerspective *
This property contains the IdePerspective that is currently selected. Connect to the "notify::visible-perspective" signal to be notified when the perspective has been changed.
Flags: Read / Write
“visible-perspective-name”
property “visible-perspective-name” gchar *
This property is just like “visible-perspective” except that it contains the name of the perspective as a string.
Flags: Read / Write
Default value: NULL
“action”
signalvoid user_function (IdeWorkbench *ideworkbench, gchar *arg1, gchar *arg2, gchar *arg3, gpointer user_data)
Flags: Action
“set-perspective”
signalvoid user_function (IdeWorkbench *self, gchar *name, gpointer user_data)
This signal is meant for keybindings to change the current perspective.
self |
An IdeWorkbench |
|
name |
the name of the perspective |
|
user_data |
user data set when the signal handler was connected. |
Flags: Action
“unload”
signalvoid user_function (IdeWorkbench *ideworkbench, IdeContext *arg1, gpointer user_data)
Flags: Run Last