# WorkSpaceTool(bpy_struct)

base class — `bpy_struct`

class `bpy.types.``WorkSpaceTool`(bpy_struct)
  `has_datablock`

    Type: | boolean, default False, (readonly)

  `idname`

    Type: | string, default “”, (never None)

  `idname_fallback`

    Type: | string, default “”, (never None)

  `index`

    Type: | int in [-inf, inf], default 0, (readonly)

  `mode`

    Type: | enum in [‘DEFAULT’], default ‘DEFAULT’, (readonly)

  `space_type`
    - `EMPTY` Empty.
    - `VIEW_3D` 3D Viewport, Manipulate objects in a 3D environment.
    - `IMAGE_EDITOR` UV/Image Editor, View and edit images and UV Maps.
    - `NODE_EDITOR` Node Editor, Editor for node-based shading and compositing tools.
    - `SEQUENCE_EDITOR` Video Sequencer, Video editing tools.
    - `CLIP_EDITOR` Movie Clip Editor, Motion tracking tools.
    - `DOPESHEET_EDITOR` Dope Sheet, Adjust timing of keyframes.
    - `GRAPH_EDITOR` Graph Editor, Edit drivers and keyframe interpolation.
    - `NLA_EDITOR` Nonlinear Animation, Combine and layer Actions.
    - `TEXT_EDITOR` Text Editor, Edit scripts and in-file documentation.
    - `CONSOLE` Python Console, Interactive programmatic console for advanced editing and script development.
    - `INFO` Info, Log of operations, warnings and error messages.
    - `TOPBAR` Top Bar, Global bar at the top of the screen for global per-window settings.
    - `STATUSBAR` Status Bar, Global bar at the bottom of the screen for general status information.
    - `OUTLINER` Outliner, Overview of scene graph and all available data-blocks.
    - `PROPERTIES` Properties, Edit properties of active object and related data-blocks.
    - `FILE_BROWSER` File Browser, Browse for files and assets.
    - `PREFERENCES` Preferences, Edit persistent configuration settings.

    Type: | enum in [‘EMPTY’, ‘VIEW_3D’, ‘IMAGE_EDITOR’, ‘NODE_EDITOR’, ‘SEQUENCE_EDITOR’, ‘CLIP_EDITOR’, ‘DOPESHEET_EDITOR’, ‘GRAPH_EDITOR’, ‘NLA_EDITOR’, ‘TEXT_EDITOR’, ‘CONSOLE’, ‘INFO’, ‘TOPBAR’, ‘STATUSBAR’, ‘OUTLINER’, ‘PROPERTIES’, ‘FILE_BROWSER’, ‘PREFERENCES’], default ‘EMPTY’, (readonly)

  `widget`

    Type: | string, default “”, (readonly, never None)

  `setup`(idname, cursor='DEFAULT', keymap="", gizmo_group="", data_block="", operator="", index=0, idname_fallback="", keymap_fallback="")

    Set the tool settings

    Parameters: | idname (string, (never None)) – Identifier cursor (enum in ['DEFAULT', 'NONE', 'WAIT', 'CROSSHAIR', 'MOVE_X', 'MOVE_Y', 'KNIFE', 'TEXT', 'PAINT_BRUSH', 'PAINT_CROSS', 'DOT', 'ERASER', 'HAND', 'SCROLL_X', 'SCROLL_Y', 'SCROLL_XY', 'EYEDROPPER'], (optional)) – cursor keymap (string, (optional, never None)) – Key Map gizmo_group (string, (optional, never None)) – Gizmo Group data_block (string, (optional, never None)) – Data Block operator (string, (optional, never None)) – Operator index (int in [-inf, inf], (optional)) – Index idname_fallback (string, (optional, never None)) – Fallback Identifier keymap_fallback (string, (optional, never None)) – Fallback Key Map

  `operator_properties`(operator)

    operator_properties

    Return type: | `OperatorProperties`, (never None)

  `gizmo_group_properties`(group)

    gizmo_group_properties

    Return type: | `GizmoGroupProperties`, (never None)

  `refresh_from_context`()

    refresh_from_context

  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

`bpy_struct.id_data` |

Inherited Functions

`bpy_struct.as_pointer` `bpy_struct.driver_add` `bpy_struct.driver_remove` `bpy_struct.get` `bpy_struct.is_property_hidden` `bpy_struct.is_property_overridable_library` `bpy_struct.is_property_readonly` `bpy_struct.is_property_set` `bpy_struct.items` `bpy_struct.keyframe_delete` | `bpy_struct.keyframe_insert` `bpy_struct.keys` `bpy_struct.path_from_id` `bpy_struct.path_resolve` `bpy_struct.pop` `bpy_struct.property_overridable_library_set` `bpy_struct.property_unset` `bpy_struct.type_recast` `bpy_struct.values`

References

`WorkSpace.tools` `wmTools.from_space_image_mode` | `wmTools.from_space_node` `wmTools.from_space_view3d_mode`