wapi.shelf#

Use this module to interact with the wizard project shelf.

wapi.shelf.create_shelf_tool(name, script, help, only_subprocess=0, icon=vars.ressources._default_script_shelf_icon_)#

Create a new script tool in the project shelf.

Parameters:
  • name (str) – The tool name

  • script (str) – The script

  • help (str) – A short help text

  • only_subprocess (bool or int) – Execute the script only as subprocess

  • icon (str) – An icon file as string ( Optionnal )

Returns:

The success.

Return type:

bool

wapi.shelf.create_separator()#

Create a new separator in the project shelf.

Returns:

The success.

Return type:

bool