FormIt.Configuration API

Description

Functions
json	FormIt.Configuration.GetToolGroupUUIDs ()
	Returns a vector of UUIDs (as string) for the tool groups currently configured Parameters: In: Out: vector of tool group UUIDs.
json	FormIt.Configuration.GetContextMenuToolUUIDs ()
	Returns a vector of UUIDs (as string) for the tools in the context menu currently configured Parameters: In: Out: vector of tool UUIDs
json	FormIt.Configuration.GetContextMenuToolUUIDFromActionId (actionId)
	Returns the tool UUID from a context menu action Parameters: In: action id Out: tool UUID
json	FormIt.Configuration.GetContextMenuActionIdFromToolUUID (toolUUID)
	Returns the tool UUID from a context menu action Parameters: In: tool UUID Out: action id
json	FormIt.Configuration.GetToolGroupInfo (toolGroupUUID)
	Returns the info for a tool group, that the UI can use currently configured Parameters: In: UUID of tool group Out: vector of tool UUIDs, icon and other info
json	FormIt.Configuration.GetToolInfo (toolUUID)
	Returns the info for a tool, that the UI can use Parameters: In: UUID of tool Out: tool name, tool icon, tool tip, formit tool type
json	FormIt.Configuration.IsPaletteConfigured (paletteUUID)
	Returns whether a palette should appear in the UI Parameters: In: UUID of palette Out: true/false
json	FormIt.Configuration.IsProjectBarConfigured (projectBarUUID)
	Returns whether a project bar item should appear in the UI Parameters: In: UUID of project bar item Out: true/false
json	FormIt.Configuration.ConfigureFromJSON (configurationJSON)
	Configure the UI from the given JSON Data Parameters: In: JSON string Out: True, if configuration was successful
json	FormIt.Configuration.GetAllPalettes ()
	Get the names and ids of all palettes Parameters: In: Out: vector of id - name pairs
json	FormIt.Configuration.GetAllProjectBarItems ()
	Get the names and ids of all project bar items Parameters: In: Out: vector of id - name pairs
json	FormIt.Configuration.GetAllToolGroups ()
	Get the names and ids of all main tools Parameters: In: Out: vector of id - name pairs
json	FormIt.Configuration.GetAllToolGroupTools (toolGroupUUID)
	Get the names and ids of all tools for a given tool group Parameters: In: Out: vector of id - name pairs
json	FormIt.Configuration.GetAllContextMenuTools ()
	Get the names and ids of all context menu tools Parameters: In: Out: vector of id - name pairs .
json	FormIt.Configuration.GetAllImplicitTools ()
	Get all formit native implicit tools ids and names Parameters: In: Out: vector of id - name pairs
json	FormIt.Configuration.IsShortcutCommandConfigured (commandName)
	Returns whether a shortcut command is configured Parameters: In: command name Out: true/false

Function Documentation

ConfigureFromJSON()

json FormIt.Configuration.ConfigureFromJSON

(

configurationJSON

)

Configure the UI from the given JSON Data Parameters: In: JSON string Out: True, if configuration was successful

Parameters

[in]

configurationJSON

String

Returns

result

GetAllContextMenuTools()

json FormIt.Configuration.GetAllContextMenuTools

(

)

Get the names and ids of all context menu tools Parameters: In: Out: vector of id - name pairs .

Returns

{...}

GetAllImplicitTools()

json FormIt.Configuration.GetAllImplicitTools

(

)

Get all formit native implicit tools ids and names Parameters: In: Out: vector of id - name pairs

Returns

{...}

GetAllPalettes()

json FormIt.Configuration.GetAllPalettes

(

)

Get the names and ids of all palettes Parameters: In: Out: vector of id - name pairs

Returns

{...}

GetAllProjectBarItems()

json FormIt.Configuration.GetAllProjectBarItems

(

)

Get the names and ids of all project bar items Parameters: In: Out: vector of id - name pairs

Returns

{...}

GetAllToolGroups()

json FormIt.Configuration.GetAllToolGroups

(

)

Get the names and ids of all main tools Parameters: In: Out: vector of id - name pairs

Returns

{...}

GetAllToolGroupTools()

json FormIt.Configuration.GetAllToolGroupTools

(

toolGroupUUID

)

Get the names and ids of all tools for a given tool group Parameters: In: Out: vector of id - name pairs

Parameters

[in]

toolGroupUUID

String

Returns

{...}

GetContextMenuActionIdFromToolUUID()

json FormIt.Configuration.GetContextMenuActionIdFromToolUUID

(

toolUUID

)

Returns the tool UUID from a context menu action Parameters: In: tool UUID Out: action id

Parameters

[in]

toolUUID

String

Returns

{...}

GetContextMenuToolUUIDFromActionId()

json FormIt.Configuration.GetContextMenuToolUUIDFromActionId

(

actionId

)

Returns the tool UUID from a context menu action Parameters: In: action id Out: tool UUID

Parameters

[in]

actionId

FormIt.ContextMenuAction

Returns

{...}

GetContextMenuToolUUIDs()

json FormIt.Configuration.GetContextMenuToolUUIDs

(

)

Returns a vector of UUIDs (as string) for the tools in the context menu currently configured Parameters: In: Out: vector of tool UUIDs

Returns

{...}

GetToolGroupInfo()

json FormIt.Configuration.GetToolGroupInfo

(

toolGroupUUID

)

Returns the info for a tool group, that the UI can use currently configured Parameters: In: UUID of tool group Out: vector of tool UUIDs, icon and other info

Parameters

[in]

toolGroupUUID

String

Returns

{ { "Result" , to_json(result) }, { "Name" , to_json(name) }, { "Icon" , to_json(iconName) }, { "ToolTip" , to_json(toolTip) }, { "Tools" , to_json(toolUUIDs) }, { "IsForMainToolsMenu" , to_json(isForMainToolsMenu) } };

GetToolGroupUUIDs()

json FormIt.Configuration.GetToolGroupUUIDs

(

)

Returns a vector of UUIDs (as string) for the tool groups currently configured Parameters: In: Out: vector of tool group UUIDs.

Returns

{...}

GetToolInfo()

json FormIt.Configuration.GetToolInfo

(

toolUUID

)

Returns the info for a tool, that the UI can use Parameters: In: UUID of tool Out: tool name, tool icon, tool tip, formit tool type

Parameters

[in]

toolUUID

String

Returns

{ { "Result" , to_json(result) }, { "Name" , to_json(toolName) }, { "Icon" , to_json(iconName) }, { "ToolTip" , to_json(toolTip) }, { "ToolType" , to_json(toolType) } };

IsPaletteConfigured()

json FormIt.Configuration.IsPaletteConfigured

(

paletteUUID

)

Returns whether a palette should appear in the UI Parameters: In: UUID of palette Out: true/false

Parameters

[in]

paletteUUID

String

Returns

{...}

IsProjectBarConfigured()

json FormIt.Configuration.IsProjectBarConfigured

(

projectBarUUID

)

Returns whether a project bar item should appear in the UI Parameters: In: UUID of project bar item Out: true/false

Parameters

[in]

projectBarUUID

String

Returns

{...}

IsShortcutCommandConfigured()

json FormIt.Configuration.IsShortcutCommandConfigured

(

commandName

)

Returns whether a shortcut command is configured Parameters: In: command name Out: true/false

Parameters

[in]

commandName

String

Returns

{...}