Need python access to workspace tab order (workspace.order)

jeske · May 2, 2019, 5:55pm

I was experimenting with a pie-menu for workspace selection, and realized there is currently no way in Python to access the Workspace.order field which tells me which order the workspaces are placed in the tabs on the top.

I think there are some straightforward ways to do this. I would submit a patch, but I don’t have a current Blender build up.

One method is to simply expose the Workspace.order struct element to Python. This would have the negative consequence of letting python set the number, which is not a good thing to do, but it would be quick and simple. Another option is to might be to make a new Python API to get the workspaces in a properly ordered list.

Here are links to where the Workspace order field is… and where the python RNA is built for this structure.

github.com

dfelinto/blender/blob/master/source/blender/makesdna/DNA_workspace_types.h#L136


  /** Type is different for each space-type. */
  char tools_mode;
  char _pad[2];


  int object_mode;


  /** Enum eWorkSpaceFlags. */
  int flags;


  /* Number for workspace tab reordering in the UI. */
  int order;


  /* Info text from modal operators (runtime). */
  char *status_text;
} WorkSpace;


/**
 * Generic (and simple/primitive) struct for storing a history of assignments/relations
 * of workspace data to non-workspace data in a listbase inside the workspace.
 *
 * Using this we can restore the old state of a workspace if the user switches back to it.

github.com

dfelinto/blender/blob/master/source/blender/makesrna/intern/rna_workspace.c#L337


  RNA_def_function_return(func, parm);


  func = RNA_def_function(srna, "from_space_node", "rna_WorkSpace_tools_from_space_node");
  RNA_def_function_ui_description(func, "");
  RNA_def_boolean(func, "create", false, "Create", "");
  /* return type */
  parm = RNA_def_pointer(func, "result", "WorkSpaceTool", "", "");
  RNA_def_function_return(func, parm);
}


static void rna_def_workspace(BlenderRNA *brna)
{
  StructRNA *srna;
  PropertyRNA *prop;


  srna = RNA_def_struct(brna, "WorkSpace", "ID");
  RNA_def_struct_sdna(srna, "WorkSpace");
  RNA_def_struct_ui_text(
      srna, "Workspace", "Workspace data-block, defining the working environment for the user");
  /* TODO: real icon, just to show something */
  RNA_def_struct_ui_icon(srna, ICON_WORKSPACE);

RomboutVersluijs · January 21, 2022, 3:28am

Have you found a solution to this? I also made an addon and now im in need to for this. When i loop over the workspaces they are in alphabetic order. Something somewhere decides this order.

this was my approach to a quick switch addon

Download

What's New

Blender Studio

Manual

Developers Blog

Documentation

Benchmark

Blender Conference

Development Fund

One-time Donations

Need python access to workspace tab order (workspace.order)