dev_close_tooldev_close_toolDevCloseToolDevCloseTooldev_close_tool (Operator)
Name
dev_close_tooldev_close_toolDevCloseToolDevCloseTooldev_close_tool — Close the specified floating tool window.
Signature
dev_close_tool( : : ToolId : )
Herror dev_close_tool(const char* ToolId)
Herror T_dev_close_tool(const Htuple ToolId)
void DevCloseTool(const HTuple& ToolId)
def dev_close_tool(tool_id: HHandle) -> None
Description
dev_close_tooldev_close_toolDevCloseToolDevCloseToolDevCloseTooldev_close_tool closes the tool with the ToolIdToolIdToolIdToolIdtoolIdtool_id.
Instead of using the ToolIdToolIdToolIdToolIdtoolIdtool_id, given during opening the tool,
you can use the name that has to be used in dev_open_tooldev_open_toolDevOpenToolDevOpenToolDevOpenTooldev_open_tool.
In that case a arbitrary tool, which fits the parameter
ToolIdToolIdToolIdToolIdtoolIdtool_id, is used.
Attention
This operator only works for single floating tools, i.e.,
tools that are neither docked nor tabbed.
This operator is not supported for code export.
Parameters
ToolIdToolIdToolIdToolIdtoolIdtool_id (input_control) dev_tool → HTupleHHandleHTupleHtuple (string) (IntPtr) (HString) (char*)
Tool identifier.
Example (HDevelop)
dev_open_tool ('matching_assistant', 0, 0, 'default','default', ToolId)
dev_close_tool (ToolId)
Result
If the values of the specified parameters are correct,
dev_open_tooldev_open_toolDevOpenToolDevOpenToolDevOpenTooldev_open_tool returns 2 (H_MSG_TRUE). Otherwise, an
exception is raised and an error code returned.
Possible Predecessors
dev_set_tool_geometrydev_set_tool_geometryDevSetToolGeometryDevSetToolGeometryDevSetToolGeometrydev_set_tool_geometry,
dev_open_tooldev_open_toolDevOpenToolDevOpenToolDevOpenTooldev_open_tool
Possible Successors
dev_open_tooldev_open_toolDevOpenToolDevOpenToolDevOpenTooldev_open_tool
See also
dev_show_tooldev_show_toolDevShowToolDevShowToolDevShowTooldev_show_tool
Module
Foundation