VectorScript Declaration:

FUNCTION   ws2AddMenuGroup

(   menuPath :DYNARRAY[] of CHAR;     newUnivName :DYNARRAY[] of CHAR;     newDisplayName :DYNARRAY[] of CHAR;     beforeIndex :INTEGER ) :BOOLEAN ;

Python:

def  vs.ws2AddMenuGroup(menuPath, newUnivName, newDisplayName, beforeIndex):

   return BOOLEAN

Description:

Workspace advanced APIs. Adds a new menu group (container) by universal name before the specified index (-1 for the end) inside the provided menu path. See 'ws2GetMenusCnt'.

説明

作業画面の高度なAPIです。指定したメニューパス内に、ユニバーサル名で新しいメニューグループ（コンテナ）を、指定するインデックス番号の前に追加します（-1が最後尾）。 ws2GetMenusCntも参照してください。

VectorScript Declaration:

FUNCTION   ws2AddMenuItem

(   menuPath :DYNARRAY[] of CHAR;     newMenuUnivName :DYNARRAY[] of CHAR;     beforeIndex :INTEGER ) :BOOLEAN ;

Python:

def  vs.ws2AddMenuItem(menuPath, newMenuUnivName, beforeIndex):

   return BOOLEAN

Description:

Workspace advanced APIs. Adds a new menu item by universal name before the specified index (-1 for the end) inside the provided menu path. See 'ws2GetMenusCnt'.

説明

作業画面の高度なAPIです。指定したメニューパス内に、ユニバーサル名で新しいメニュー項目を、指定するインデックス番号の前に追加します（-1が最後尾）。 ws2GetMenusCntも参照してください。

VectorScript Declaration:

PROCEDURE   ws2CommitChanges

(   restart :BOOLEAN;     reload :BOOLEAN ) ;

Python:

def  vs.ws2CommitChanges(restart, reload):

   return None

Description:

Workspace advanced APIs. Offers restart or reload of the workspace to commit the changes made by this APIs.

説明

作業画面の高度なAPIです。このAPIで作成した変更を作業画面に反映させるため、作業画面のリスタートまたはリロードを実行します。

VectorScript Declaration:

FUNCTION   ws2CreateTool

(   toolPath :DYNARRAY[] of CHAR;     univName :DYNARRAY[] of CHAR;     resourceID :INTEGER ) :BOOLEAN ;

Python:

def  vs.ws2CreateTool(toolPath, univName, resourceID):

   return BOOLEAN

Description:

Workspace advanced APIs. Create a new tool.

説明

作業画面の高度なAPIです。新しいツールを作成します。

VectorScript Declaration:

FUNCTION   ws2CreateToolPalette

(   univName :DYNARRAY[] of CHAR;     displayName :DYNARRAY[] of CHAR ) :BOOLEAN ;

Python:

def  vs.ws2CreateToolPalette(univName, displayName):

   return BOOLEAN

Description:

Workspace advanced APIs. Create a new tool palette if it doesn't exist.

説明

作業画面の高度なAPIです。無ければ新しいツールパレットを作成します。

VectorScript Declaration:

FUNCTION   ws2CreateToolSet

(   toolPath :DYNARRAY[] of CHAR;     univName :DYNARRAY[] of CHAR;     displayName :DYNARRAY[] of CHAR;     iconFullFilePath :DYNARRAY[] of CHAR ) :BOOLEAN ;

Python:

def  vs.ws2CreateToolSet(toolPath, univName, displayName, iconFullFilePath):

   return BOOLEAN

Description:

Workspace advanced APIs. Create a new tool set if it doesn't exist. Retina icon will be loaded automatically if it has the same name suffixed with @2x.png and resolution 26 by 20 pixels.

説明

作業画面の高度なAPIです。無ければ新しいツールセットを作成します。Retina用のアイコンは、解像度が26ｘ20ピクセルで、同じ名前の末尾に「@2x.png」が付いたファイルがあれば、自動で読み込まれます。

VectorScript Declaration:

FUNCTION   ws2DelMenu

( menuPath:DYNARRAY[] of CHAR ) :BOOLEAN ;

Python:

def  vs.ws2DelMenu(menuPath):

   return BOOLEAN

Description:

Workspace advanced APIs. Delete the menu at the specified menu path. See 'ws2GetMenusCnt'.

説明

作業画面の高度なAPIです。指定したメニューパスのメニューを削除します。ws2GetMenusCntも参照してください。

VectorScript Declaration:

FUNCTION   ws2DelMenuAt

(   menuPath :DYNARRAY[] of CHAR;     index :INTEGER ) :BOOLEAN ;

Python:

def  vs.ws2DelMenuAt(menuPath, index):

   return BOOLEAN

Description:

Workspace advanced APIs. Delete the menu at the specified index and menu path. See 'ws2GetMenusCnt'.

説明

作業画面の高度なAPIです。指定したインデックスとメニューパスのメニューを削除します。ws2GetMenusCntも参照してください。

VectorScript Declaration:

FUNCTION   ws2DelTool

( toolPath:DYNARRAY[] of CHAR ) :BOOLEAN ;

Python:

def  vs.ws2DelTool(toolPath):

   return BOOLEAN

Description:

Workspace advanced APIs. Delete the tool, tool set, or tool palette at the specified menu path. See 'ws2GetMenusCnt'.

説明

作業画面の高度なAPIです。指定したメニューパスのツール、ツールセット、またはツールパレットを削除します。ws2GetMenusCntも参照してください。

VectorScript Declaration:

FUNCTION   ws2FindMenuIndex

(   menuPath :DYNARRAY[] of CHAR;     findMenuUnivName :DYNARRAY[] of CHAR ) :INTEGER ;

Python:

def  vs.ws2FindMenuIndex(menuPath, findMenuUnivName):

   return INTEGER

Description:

Workspace advanced APIs. Return the indx of the specified universal name inside the provided menu path. Return -1 if not found. See 'ws2GetMenusCnt'.

説明

作業画面の高度なAPIです。指定したメニューパス内にある指定したユニバーサル名のインデックス番号を返します。見つからなかった場合は、-1を返します。ws2GetMenusCntも参照してください。

VectorScript Declaration:

FUNCTION   ws2FindToolIndex

(   toolPath :DYNARRAY[] of CHAR;     findUnivName :DYNARRAY[] of CHAR ) :INTEGER ;

Python:

def  vs.ws2FindToolIndex(toolPath, findUnivName):

   return INTEGER

Description:

Workspace advanced APIs. Return the named tool index at the specified path. See 'ws2GetToolsCnt'.

説明

作業画面の高度なAPIです。指定したパスにある指定したユニバーサル名のツールのインデックス番号を返します。ws2GetToolsCntも参照してください。

VectorScript Declaration:

FUNCTION   ws2GetMenuAt

(   menuPath :DYNARRAY[] of CHAR;     index :INTEGER ) :DYNARRAY[] of CHAR ;

Python:

def  vs.ws2GetMenuAt(menuPath, index):

   return DYNARRAY of CHAR

Description:

Workspace advanced APIs. Return the universal name of the specified index inside the provided menu path See 'ws2GetMenusCnt'.

説明

作業画面の高度なAPIです。指定したメニューパス内にある指定したインデックスのユニバーサル名を返します。ws2GetMenusCntも参照してください。

VectorScript Declaration:

FUNCTION   ws2GetMenuInfo

(   menuPath :DYNARRAY[] of CHAR;   VAR  outHasShortcutKey :BOOLEAN;   VAR  outShortcutKey :CHAR;   VAR  outShortcutKeyModifier :INTEGER ) :DYNARRAY[] of CHAR ;

Python:

def  vs.ws2GetMenuInfo(menuPath):

   return (DYNARRAY of CHAR, outHasShortcutKey, outShortcutKey, outShortcutKeyModifier)

Description:

Workspace advanced APIs. Return the localized (if any) name, and shortkey combinations (if any) of the specified index inside the provided menu path. See 'ws2GetMenusCnt'.

説明

作業画面の高度なAPIです。指定したメニューパス内にある指定したインデックスのローカライズ名（あれば）とショートカットキー（あれば）を返します。ws2GetMenusCntも参照してください。

VectorScript Declaration:

FUNCTION   ws2GetMenusCnt

( menuPath:DYNARRAY[] of CHAR ) :INTEGER ;

Python:

def  vs.ws2GetMenusCnt(menuPath):

   return INTEGER

Description:

Workspace advanced APIs. Return the number of menu items at the speicfied path. Use '/' for path delimiter of universal menu names.

説明

作業画面の高度なAPIです。指定したパスにあるメニュー項目の数を返します。ユニバーサルメニュー名のパスの区切りには「/」を使用してください。

VectorScript Declaration:

FUNCTION   ws2GetToolAt

(   toolPath :DYNARRAY[] of CHAR;     index :INTEGER ) :DYNARRAY[] of CHAR ;

Python:

def  vs.ws2GetToolAt(toolPath, index):

   return DYNARRAY of CHAR

Description:

Workspace advanced APIs. Return the tool univ name at the specified index of the parent tool or tool set at the specified path. See 'ws2GetToolsCnt'.

説明

作業画面の高度なAPIです。指定したパスにある指定したインデックスの親ツールまたはツールセットのツールのユニバーサル名を返します。ws2GetToolsCntも参照してください。

VectorScript Declaration:

FUNCTION   ws2GetToolInfo

(   toolPath :DYNARRAY[] of CHAR;   VAR  outDisplayName :DYNARRAY[] of CHAR;   VAR  outShortcutKey :CHAR;   VAR  outShortcutKeyModifier :INTEGER;   VAR  outResourceID :INTEGER ) :BOOLEAN ;

Python:

def  vs.ws2GetToolInfo(toolPath):

   return (BOOLEAN, outDisplayName, outShortcutKey, outShortcutKeyModifier, outResourceID)

Description:

Workspace advanced APIs. Return the tool information at the specified index of the parent tool at the specified path. See 'ws2GetToolsCnt'.

説明

作業画面の高度なAPIです。指定したパスにある指定したインデックスの親ツールにあるツール情報を返します。ws2GetToolsCntも参照してください。

VectorScript Declaration:

FUNCTION   ws2GetToolsCnt

( toolPath:DYNARRAY[] of CHAR ) :INTEGER ;

Python:

def  vs.ws2GetToolsCnt(toolPath):

   return INTEGER

Description:

Workspace advanced APIs. Return the number of tools at the specified path composed of universal names <tool palette>/<tool set>. See 'ws2GetMenusCnt'.

説明

作業画面の高度なAPIです。ユニバーサル名から構成される指定したパス（<ツールパレット>/<ツールセット>）にあるツールの数を返します。ws2GetMenusCntも参照してください。

VectorScript Declaration:

PROCEDURE   ws2SetMenuInfo

(   menuPath :DYNARRAY[] of CHAR;     displayName :DYNARRAY[] of CHAR;     hasShortcutKey :BOOLEAN;     shortcutKey :CHAR;     shortcutKeyModifier :INTEGER ) ;

Python:

def  vs.ws2SetMenuInfo(menuPath, displayName, hasShortcutKey, shortcutKey, shortcutKeyModifier):

   return None

Description:

Workspace advanced APIs. Set the localized (if any) name, and shortkey combinations (if any) of the specified index inside the provided menu path. See 'ws2GetMenusCnt'.

説明

作業画面の高度なAPIです。指定したメニューパス内にある指定したインデックスのローカライズ名（あれば）とショートカットキー（あれば）を設定します。ws2GetMenusCntも参照してください。

VectorScript Declaration:

PROCEDURE   ws2SetToolInfo

(   toolPath :DYNARRAY[] of CHAR;     displayName :DYNARRAY[] of CHAR;     shortcutKey :CHAR;     shortcutKeyModifier :INTEGER;     resourceID :INTEGER ) ;

Python:

def  vs.ws2SetToolInfo(toolPath, displayName, shortcutKey, shortcutKeyModifier, resourceID):

   return None

Description:

Workspace advanced APIs. Set the tool information at the specified index of the parent tool at the specified path. See 'ws2GetToolsCnt'.

説明

作業画面の高度なAPIです。指定したパスにある指定したインデックスの親ツールにツール情報を設定します。ws2GetToolsCntも参照してください。

VectorScript Declaration:

PROCEDURE   wsDelete

(   companyName :STRING;     restart :BOOLEAN;     reload :BOOLEAN ) ;

Python:

def  vs.wsDelete(companyName, restart, reload):

   return None

Description:

Delete all menu commands and tools under the specified 'companyName' added with 'wsEditBegin'.

説明

wsEditBeginで追加されている指定したcompanyName直下にあるすべてのメニューコマンドとツールを削除します。

VectorScript Declaration:

PROCEDURE   wsEditAddMenu

( menuPath:STRING ) ;

Python:

def  vs.wsEditAddMenu(menuPath):

   return None

Description:

Add a menu under Tools -> Third-party. Use dot as a delimiter for sub menus in 'commandName'.

説明

[ツール] -> [サードパーティ] の下にメニューを追加します。 サブメニューの区切りとしてコマンド名にドットを使用します。

VectorScript Declaration:

PROCEDURE   wsEditAddTool

(   toolName :STRING;     toolType :INTEGER ) ;

Python:

def  vs.wsEditAddTool(toolName, toolType):

   return None

Description:

Add a menu under Third-party palette and companyName tool set.

説明

サードパーティのパレットおよびツールセットの下ににメニューを追加します。

VectorScript Declaration:

PROCEDURE   wsEditAddTool2

(   toolName :STRING;     underToolName :STRING;     toolType :INTEGER ) ;

Python:

def  vs.wsEditAddTool2(toolName, underToolName, toolType):

   return None

Description:

Add a menu under Third-party palette and companyName tool set. The menu is added underneath another existing tool in the tool set.

説明

サードパーティのパレットおよびツールセットの下ににメニューを追加します。ツールセット内の指定したメニューの下に追加されます。

VectorScript Declaration:

PROCEDURE   wsEditBegin

( companyName:STRING ) ;

Python:

def  vs.wsEditBegin(companyName):

   return None

Description:

Begin workspace edit. Use the other wsEdit* calls and must end with a call to wsEditEnd.

説明

作業画面の編集を開始します。 他の作業画面を編集している場合、workspaceEditEndを呼び出して編集を終了しておく必要があります。

VectorScript Declaration:

PROCEDURE   wsEditBeginN

(   companyName :STRING;     companyToolSetIconFilePath :STRING ) ;

Python:

def  vs.wsEditBeginN(companyName, companyToolSetIconFilePath):

   return None

Description:

Begin workspace edit. Use the other wsEdit* calls and must end with a call to wsEditEnd.

説明

作業画面の編集を開始します。他のwsEdit*呼び出しを使用し、必ず最後はwsEditEndの呼び出しで終了してください。

VectorScript Declaration:

FUNCTION   wsEditEnd

( restart:BOOLEAN ) :BOOLEAN ;

Python:

def  vs.wsEditEnd(restart):

   return BOOLEAN

Description:

Finishes workspace edit started with wsEditBegin.

説明

作業画面の編集を終了します。workspaceEditBeginとセットで使用します。

VectorScript Declaration:

PROCEDURE   wsInstallCanceled

( canceled:BOOLEAN ) ;

Python:

def  vs.wsInstallCanceled(canceled):

   return None

Description:

This function must be called inside 'add_to_workspace' script and it will mark the install as canceled, interrupting the install.

説明

必ずadd_to_workspaceスクリプト内で呼び出す必要があります。この関数はインストールを遮断し、キャンセルしたとマークします。

VectorScript Declaration:

PROCEDURE   wsInstallFailed

( failed:BOOLEAN ) ;

Python:

def  vs.wsInstallFailed(failed):

   return None

Description:

This function must be called inside 'add_to_workspace' script and it will mark the install as failed, showing an alert dialog at the end.

説明

必ずadd_to_workspaceスクリプト内で呼び出す必要があります。この関数はインストールを失敗したとマークし、最後にアラートダイアログボックスを表示します。