WorkSpace(ID)

base classes — bpy_struct, ID

class bpy.types.WorkSpace(ID)

Workspace data-block, defining the working environment for the user

object_mode

Switch to this object mode when activating the workspace

  • OBJECT Object Mode.

  • EDIT Edit Mode.

  • POSE Pose Mode.

  • SCULPT Sculpt Mode.

  • VERTEX_PAINT Vertex Paint.

  • WEIGHT_PAINT Weight Paint.

  • TEXTURE_PAINT Texture Paint.

  • PARTICLE_EDIT Particle Edit.

  • EDIT_GPENCIL Grease Pencil Edit Mode, Edit Grease Pencil Strokes.

  • SCULPT_GPENCIL Grease Pencil Sculpt Mode, Sculpt Grease Pencil Strokes.

  • PAINT_GPENCIL Grease Pencil Draw, Paint Grease Pencil Strokes.

  • VERTEX_GPENCIL Grease Pencil Vertex Paint, Grease Pencil Vertex Paint Strokes.

  • WEIGHT_GPENCIL Grease Pencil Weight Paint, Grease Pencil Weight Paint Strokes.

Type

enum in [‘OBJECT’, ‘EDIT’, ‘POSE’, ‘SCULPT’, ‘VERTEX_PAINT’, ‘WEIGHT_PAINT’, ‘TEXTURE_PAINT’, ‘PARTICLE_EDIT’, ‘EDIT_GPENCIL’, ‘SCULPT_GPENCIL’, ‘PAINT_GPENCIL’, ‘VERTEX_GPENCIL’, ‘WEIGHT_GPENCIL’], default ‘OBJECT’

owner_ids
Type

wmOwnerIDs bpy_prop_collection of wmOwnerID, (readonly)

screens

Screen layouts of a workspace

Type

bpy_prop_collection of Screen, (readonly)

tools
Type

wmTools bpy_prop_collection of WorkSpaceTool, (readonly)

use_filter_by_owner

Filter the UI by tags

Type

boolean, default False

classmethod status_text_set_internal(text)

Set the status bar text, typically key shortcuts for modal operators

Parameters

text (string) – Text, New string for the status bar, None clears the text

status_text_set(text)

Set the status text or None to clear, When text is a function, this will be called with the (header, context) arguments.

classmethod bl_rna_get_subclass(id, default=None)
Parameters

id (string) – The RNA type identifier.

Returns

The RNA type or default when not found.

Return type

bpy.types.Struct subclass

classmethod bl_rna_get_subclass_py(id, default=None)
Parameters

id (string) – The RNA type identifier.

Returns

The class or default when not found.

Return type

type

Inherited Properties

Inherited Functions

References