#include <cstdlib>
#include <cstring>
#include <fmt/format.h>
#include "BLI_fileops.h"
#include "BLI_listbase.h"
#include "BLI_path_utils.hh"
#include "BLI_string.h"
#include "BLI_utildefines.h"
#include "BKE_appdir.hh"
#include "BKE_blendfile.hh"
#include "BKE_context.hh"
#include "BKE_layer.hh"
#include "BKE_lib_id.hh"
#include "BKE_main.hh"
#include "BKE_screen.hh"
#include "BKE_workspace.hh"
#include "BLO_readfile.hh"
#include "DNA_screen_types.h"
#include "DNA_windowmanager_types.h"
#include "DNA_workspace_types.h"
#include "ED_datafiles.h"
#include "ED_object.hh"
#include "ED_screen.hh"
#include "RNA_access.hh"
#include "RNA_define.hh"
#include "UI_interface.hh"
#include "UI_interface_layout.hh"
#include "UI_resources.hh"
#include "BLT_translation.hh"
#include "WM_api.hh"
#include "WM_types.hh"
#include "screen_intern.hh"

Functions
Workspace API
API for managing workspaces and their data.
WorkSpace *	ED_workspace_add (Main bmain, const char name)
static void	workspace_exit (WorkSpace workspace, wmWindow win)
static void	workspace_scene_pinning_update (WorkSpace workspace_new, const WorkSpace workspace_old, bContext *C)
static void	workspace_change_update (WorkSpace workspace_new, WorkSpace workspace_old, bContext C, wmWindowManager wm)
static WorkSpaceLayout *	workspace_change_get_new_layout (Main bmain, WorkSpace workspace_new, wmWindow *win)
bool	ED_workspace_change (WorkSpace workspace_new, bContext C, wmWindowManager wm, wmWindow win)
	Change the active workspace.
WorkSpace *	ED_workspace_duplicate (WorkSpace workspace_old, Main bmain, wmWindow *win)
bool	ED_workspace_delete (WorkSpace workspace, Main bmain, bContext C, wmWindowManager wm)
void	ED_workspace_scene_data_sync (WorkSpaceInstanceHook hook, Scene scene)
Workspace Operators
static WorkSpace *	workspace_context_get (bContext *C)
static bool	workspace_context_poll (bContext *C)
static wmOperatorStatus	workspace_new_exec (bContext C, wmOperator )
static void	WORKSPACE_OT_duplicate (wmOperatorType *ot)
static wmOperatorStatus	workspace_delete_exec (bContext C, wmOperator )
static void	WORKSPACE_OT_delete (wmOperatorType *ot)
static wmOperatorStatus	workspace_delete_all_others_exec (bContext C, wmOperator )
static void	WORKSPACE_OT_delete_all_others (wmOperatorType *ot)
static wmOperatorStatus	workspace_append_activate_exec (bContext C, wmOperator op)
static void	WORKSPACE_OT_append_activate (wmOperatorType *ot)
static WorkspaceConfigFileData *	workspace_config_file_read (const char *app_template)
static WorkspaceConfigFileData *	workspace_system_file_read (const char *app_template)
static void	workspace_append_button (uiLayout layout, wmOperatorType ot_append, const WorkSpace workspace, const Main from_main)
static void	workspace_add_menu (bContext , uiLayout layout, void *template_v)
static wmOperatorStatus	workspace_add_invoke (bContext C, wmOperator op, const wmEvent *)
static void	WORKSPACE_OT_add (wmOperatorType *ot)
static wmOperatorStatus	workspace_reorder_to_back_exec (bContext C, wmOperator )
static void	WORKSPACE_OT_reorder_to_back (wmOperatorType *ot)
static wmOperatorStatus	workspace_reorder_to_front_exec (bContext C, wmOperator )
static void	WORKSPACE_OT_reorder_to_front (wmOperatorType *ot)
static wmOperatorStatus	workspace_scene_pin_toggle_exec (bContext C, wmOperator )
static void	WORKSPACE_OT_scene_pin_toggle (wmOperatorType *ot)
void	ED_operatortypes_workspace ()

Function Documentation

◆ ED_operatortypes_workspace()

void ED_operatortypes_workspace ( )

Workspace key-maps.

Definition at line 707 of file workspace_edit.cc.

References WM_operatortype_append(), WORKSPACE_OT_add(), WORKSPACE_OT_append_activate(), WORKSPACE_OT_delete(), WORKSPACE_OT_delete_all_others(), WORKSPACE_OT_duplicate(), WORKSPACE_OT_reorder_to_back(), WORKSPACE_OT_reorder_to_front(), and WORKSPACE_OT_scene_pin_toggle().

Referenced by ED_spacetypes_init().

◆ ED_workspace_add()

WorkSpace * ED_workspace_add	(	Main *	bmain,
		const char *	name )

Definition at line 61 of file workspace_edit.cc.

References BKE_workspace_add(), and name.

Referenced by ED_workspace_duplicate().

◆ ED_workspace_change()

bool ED_workspace_change	(	WorkSpace *	workspace_new,
		bContext *	C,
		wmWindowManager *	wm,
		wmWindow *	win )

Change the active workspace.

Operator call, WM + Window + screen already existed before Pretty similar to ED_screen_change since changing workspace also changes screen.

Warning: Do NOT call in area/region queues!

Returns: if workspace changing was successful.

Definition at line 181 of file workspace_edit.cc.

References BKE_base_is_visible(), BKE_workspace_active_layout_set(), BKE_workspace_active_screen_get(), BKE_workspace_active_set(), BKE_workspace_layout_screen_get(), BLI_assert, C, CTX_data_active_base(), CTX_data_main(), CTX_wm_workspace(), Object::mode, blender::ed::object::mode_set(), OB_MODE_OBJECT, WorkSpace::object_mode, screen_change_prepare(), screen_change_update(), WorkSpaceInstanceHook::temp_layout_store, wmWindow::winid, WM_window_get_active_workspace(), workspace_change_get_new_layout(), workspace_change_update(), workspace_exit(), and wmWindow::workspace_hook.

Referenced by ED_workspace_delete(), and WM_window_set_active_workspace().

◆ ED_workspace_delete()

bool ED_workspace_delete	(	WorkSpace *	workspace,
		Main *	bmain,
		bContext *	C,
		wmWindowManager *	wm )

Returns: if succeeded.

Definition at line 265 of file workspace_edit.cc.

References BKE_id_free(), BKE_id_free_us(), BKE_id_ordered_list(), BLI_listbase_is_single(), C, ED_workspace_change(), blender::Vector< T, InlineBufferCapacity, Allocator >::first_index_of(), WorkSpace::id, WorkSpace::layouts, LISTBASE_FOREACH, wmWindowManager::windows, WM_window_get_active_workspace(), and Main::workspaces.

Referenced by wm_event_do_notifiers().

◆ ED_workspace_duplicate()

WorkSpace * ED_workspace_duplicate	(	WorkSpace *	workspace_old,
		Main *	bmain,
		wmWindow *	win )

Duplicate a workspace including its layouts. Does not activate the workspace, but it stores the screen-layout to be activated (BKE_workspace_temp_layout_store)

Definition at line 240 of file workspace_edit.cc.

References BKE_workspace_active_layout_get(), BLI_duplicatelist(), ED_workspace_add(), ED_workspace_layout_duplicate(), WorkSpace::flags, WorkSpace::id, WorkSpace::layouts, LISTBASE_FOREACH, ID::name, WorkSpace::object_mode, WorkSpace::order, WorkSpace::owner_ids, WorkSpace::pin_scene, WorkSpace::sequencer_scene, WorkSpaceInstanceHook::temp_layout_store, and wmWindow::workspace_hook.

Referenced by workspace_append_activate_exec(), and workspace_new_exec().

◆ ED_workspace_scene_data_sync()

void ED_workspace_scene_data_sync	(	WorkSpaceInstanceHook *	hook,
		Scene *	scene )

Some editor data may need to be synced with scene data (3D View camera and layers). This function ensures data is synced for editors in active layout of workspace.

Definition at line 294 of file workspace_edit.cc.

References BKE_screen_view3d_scene_sync(), and BKE_workspace_active_screen_get().

Referenced by WM_windows_scene_data_sync().

◆ workspace_add_invoke()

wmOperatorStatus workspace_add_invoke	(	bContext *	C,
		wmOperator *	op,
		const wmEvent *	)

static

Definition at line 584 of file workspace_edit.cc.

References app_template, BKE_appdir_app_templates(), BLI_freelistN(), BLI_path_to_display_name(), BLT_I18NCONTEXT_OPERATOR_DEFAULT, C, CTX_IFACE_, FILE_MAX, IFACE_, LISTBASE_FOREACH, uiLayout::menu_fn(), uiLayout::menu_fn_argN_free(), wmOperatorType::name, uiLayout::op(), OPERATOR_INTERFACE, uiLayout::separator(), wmOperator::type, UI_popup_menu_begin(), UI_popup_menu_end(), UI_popup_menu_layout(), and workspace_add_menu().

Referenced by WORKSPACE_OT_add().

◆ workspace_add_menu()

void workspace_add_menu	(	bContext *	,
		uiLayout *	layout,
		void *	template_v )

static

Definition at line 537 of file workspace_edit.cc.

References app_template, BKE_blendfile_workspace_config_data_free(), BLI_findstring(), LISTBASE_FOREACH, WorkspaceConfigFileData::main, name, offsetof, uiLayout::row(), uiLayout::separator(), WM_operatortype_find(), workspace_append_button(), workspace_config_file_read(), workspace_system_file_read(), and WorkspaceConfigFileData::workspaces.

Referenced by workspace_add_invoke().

◆ workspace_append_activate_exec()

wmOperatorStatus workspace_append_activate_exec	(	bContext *	C,
		wmOperator *	op )

static

◆ workspace_append_button()

void workspace_append_button	(	uiLayout *	layout,
		wmOperatorType *	ot_append,
		const WorkSpace *	workspace,
		const Main *	from_main )

static

Definition at line 513 of file workspace_edit.cc.

References BLI_assert, BLO_EMBEDDED_STARTUP_BLEND, BLT_I18NCONTEXT_ID_WORKSPACE, CTX_DATA_, blender::wm::ExecDefault, Main::filepath, WorkSpace::id, wmOperatorType::idname, ID::name, uiLayout::op(), RNA_string_set(), STREQ, and UI_ITEM_NONE.

Referenced by workspace_add_menu().

◆ workspace_change_get_new_layout()

WorkSpaceLayout * workspace_change_get_new_layout	(	Main *	bmain,
		WorkSpace *	workspace_new,
		wmWindow *	win )

static

Definition at line 158 of file workspace_edit.cc.

References BKE_workspace_active_layout_for_workspace_get(), ED_workspace_screen_change_ensure_unused_layout(), ListBase::first, WorkSpace::layouts, WorkSpaceInstanceHook::temp_layout_store, WorkSpaceInstanceHook::temp_workspace_store, WM_window_get_active_layout(), and wmWindow::workspace_hook.

Referenced by ED_workspace_change().

◆ workspace_change_update()

void workspace_change_update	(	WorkSpace *	workspace_new,
		WorkSpace *	workspace_old,
		bContext *	C,
		wmWindowManager *	wm )

static

Changes the object mode (if needed) to the one set in workspace_new. Object mode is still stored on object level. In future it should all be workspace level instead.

Definition at line 139 of file workspace_edit.cc.

References C, CTX_data_active_object(), blender::ed::object::mode_set(), WorkSpace::object_mode, UNUSED_VARS, and workspace_scene_pinning_update().

Referenced by ED_workspace_change().