Use the tabs on the upper right to switch to a different programming language.

Use the tabs on the upper right to switch to a different programming language.

Use the tabs on the upper right to switch to a different programming language.

Use the tabs on the upper right to switch to a different programming language.

dev_open_tooldev_open_toolDevOpenToolDevOpenTooldev_open_tool (Operator)

Name

dev_open_tooldev_open_toolDevOpenToolDevOpenTooldev_open_tool — Open a HDevelop tool, a non-modal dialog, or assistant.

Signature

dev_open_tool( : : ToolName, Row, Column, Width, Height, GenParamName, GenParamValue : ToolId)

Herror dev_open_tool(const char* ToolName, const Hlong Row, const Hlong Column, const Hlong Width, const Hlong Height, const char* GenParamName, const char* GenParamValue, char* ToolId)

Herror T_dev_open_tool(const Htuple ToolName, const Htuple Row, const Htuple Column, const Htuple Width, const Htuple Height, const Htuple GenParamName, const Htuple GenParamValue, Htuple* ToolId)

void DevOpenTool(const HTuple& ToolName, const HTuple& Row, const HTuple& Column, const HTuple& Width, const HTuple& Height, const HTuple& GenParamName, const HTuple& GenParamValue, HTuple* ToolId)

static void HOperatorSet.DevOpenTool(HTuple toolName, HTuple row, HTuple column, HTuple width, HTuple height, HTuple genParamName, HTuple genParamValue, out HTuple toolId)

def dev_open_tool(tool_name: str, row: Union[int, str], column: Union[int, str], width: Union[int, str], height: Union[int, str], gen_param_name: MaybeSequence[str], gen_param_value: MaybeSequence[str]) -> HHandle

Description

dev_open_tooldev_open_toolDevOpenToolDevOpenToolDevOpenTooldev_open_tool opens a HDevelop tool, a non-modal dialog, or assistant. The parameter ToolNameToolNameToolNameToolNametoolNametool_name contains the name of the tool to be opened. This operator returns the ToolIdToolIdToolIdToolIdtoolIdtool_id of the newly created tool, which can be used by operators like dev_set_tool_geometrydev_set_tool_geometryDevSetToolGeometryDevSetToolGeometryDevSetToolGeometrydev_set_tool_geometry, dev_show_tooldev_show_toolDevShowToolDevShowToolDevShowTooldev_show_tool, dev_close_tooldev_close_toolDevCloseToolDevCloseToolDevCloseTooldev_close_tool to address a specific tool. The opened tool automatically becomes active.

The tool is closed by pressing the Close button of the window frame, or by calling dev_close_tooldev_close_toolDevCloseToolDevCloseToolDevCloseTooldev_close_tool.

The parameters GenParamNameGenParamNameGenParamNameGenParamNamegenParamNamegen_param_name and GenParamValueGenParamValueGenParamValueGenParamValuegenParamValuegen_param_value are optional. For certain ToolNameToolNameToolNameToolNametoolNametool_name they can be used to specify which page is displayed and more, see below. If they are set to [] the tool opens with default settings.

Following the supported tools are listed, whereby they are sorted thematically.

Concerning the Main Windows supported values for ToolNameToolNameToolNameToolNametoolNametool_name:

Concerning the Assistants supported ToolNameToolNameToolNameToolNametoolNametool_name:

Concerning the Tools supported values for ToolNameToolNameToolNameToolNametoolNametool_name:

Concerning the Dialogs supported values for ToolNameToolNameToolNameToolNametoolNametool_name:

The parameters RowRowRowRowrowrow and ColumnColumnColumnColumncolumncolumn can be used to open the tool at a specific position. Note that the offset values specified under Edit -> Preferences -> General Options -> General Options -> Window open offset are added to the row and the column index, respectively. For more information, see the chapter “Menu Edit” in the “HDevelop User's Guide”. In order to apply the standard behavior, that is in general opening the tool at the last position, 'default'"default""default""default""default""default" can be passed.

The parameters WidthWidthWidthWidthwidthwidth and HeightHeightHeightHeightheightheight can be used to open the tool with a specific size. In order to apply the standard behavior, that is in general opening the tool with the last size, 'default'"default""default""default""default""default" can be passed. If WidthWidthWidthWidthwidthwidth and HeightHeightHeightHeightheightheight are less than the minimum size of the tool the minimum size is used.

Attention

This operator is not supported for code export.

Parameters

ToolNameToolNameToolNameToolNametoolNametool_name (input_control)  string HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Name of the tool to be opened and additional parameters.

List of values: 'bookmarks_dialog'"bookmarks_dialog""bookmarks_dialog""bookmarks_dialog""bookmarks_dialog""bookmarks_dialog", 'breakpoints_dialog'"breakpoints_dialog""breakpoints_dialog""breakpoints_dialog""breakpoints_dialog""breakpoints_dialog", 'browse_examples_dialog'"browse_examples_dialog""browse_examples_dialog""browse_examples_dialog""browse_examples_dialog""browse_examples_dialog", 'calibration_assistant'"calibration_assistant""calibration_assistant""calibration_assistant""calibration_assistant""calibration_assistant", 'call_stack'"call_stack""call_stack""call_stack""call_stack""call_stack", 'canvas'"canvas""canvas""canvas""canvas""canvas", 'create_procedure_dialog'"create_procedure_dialog""create_procedure_dialog""create_procedure_dialog""create_procedure_dialog""create_procedure_dialog", 'edit_procedure_interface_dialog'"edit_procedure_interface_dialog""edit_procedure_interface_dialog""edit_procedure_interface_dialog""edit_procedure_interface_dialog""edit_procedure_interface_dialog", 'feature_histogram'"feature_histogram""feature_histogram""feature_histogram""feature_histogram""feature_histogram", 'feature_inspection'"feature_inspection""feature_inspection""feature_inspection""feature_inspection""feature_inspection", 'find_replace_dialog'"find_replace_dialog""find_replace_dialog""find_replace_dialog""find_replace_dialog""find_replace_dialog", 'graphics_window'"graphics_window""graphics_window""graphics_window""graphics_window""graphics_window", 'gray_histogram'"gray_histogram""gray_histogram""gray_histogram""gray_histogram""gray_histogram", 'halcon_news'"halcon_news""halcon_news""halcon_news""halcon_news""halcon_news", 'help'"help""help""help""help""help", 'image_acquisition_assistant'"image_acquisition_assistant""image_acquisition_assistant""image_acquisition_assistant""image_acquisition_assistant""image_acquisition_assistant", 'invalid_lines_dialog'"invalid_lines_dialog""invalid_lines_dialog""invalid_lines_dialog""invalid_lines_dialog""invalid_lines_dialog", 'line_profile'"line_profile""line_profile""line_profile""line_profile""line_profile", 'matching_assistant'"matching_assistant""matching_assistant""matching_assistant""matching_assistant""matching_assistant", 'measure1d_assistant'"measure1d_assistant""measure1d_assistant""measure1d_assistant""measure1d_assistant""measure1d_assistant", 'ocr_assistant'"ocr_assistant""ocr_assistant""ocr_assistant""ocr_assistant""ocr_assistant", 'ocr_training_file_browser'"ocr_training_file_browser""ocr_training_file_browser""ocr_training_file_browser""ocr_training_file_browser""ocr_training_file_browser", 'operator_window'"operator_window""operator_window""operator_window""operator_window""operator_window", 'output_console'"output_console""output_console""output_console""output_console""output_console", 'preferences'"preferences""preferences""preferences""preferences""preferences", 'program_window'"program_window""program_window""program_window""program_window""program_window", 'quick_navigation'"quick_navigation""quick_navigation""quick_navigation""quick_navigation""quick_navigation", 'variable_window'"variable_window""variable_window""variable_window""variable_window""variable_window", 'visualization_parameters_dialog'"visualization_parameters_dialog""visualization_parameters_dialog""visualization_parameters_dialog""visualization_parameters_dialog""visualization_parameters_dialog", 'zoom_window'"zoom_window""zoom_window""zoom_window""zoom_window""zoom_window"

RowRowRowRowrowrow (input_control)  rectangle.origin.y HTupleUnion[int, str]HTupleHtuple (integer / string) (int / long / string) (Hlong / HString) (Hlong / char*)

Row index of upper left corner.

Default value: 'default' "default" "default" "default" "default" "default"

Minimum increment: 1

Recommended increment: 1

ColumnColumnColumnColumncolumncolumn (input_control)  rectangle.origin.x HTupleUnion[int, str]HTupleHtuple (integer / string) (int / long / string) (Hlong / HString) (Hlong / char*)

Column index of upper left corner.

Default value: 'default' "default" "default" "default" "default" "default"

Minimum increment: 1

Recommended increment: 1

WidthWidthWidthWidthwidthwidth (input_control)  rectangle.extent.x HTupleUnion[int, str]HTupleHtuple (integer / string) (int / long / string) (Hlong / HString) (Hlong / char*)

Width of the tool.

Default value: 'default' "default" "default" "default" "default" "default"

Minimum increment: 1

Recommended increment: 1

Restriction: Width > 0

HeightHeightHeightHeightheightheight (input_control)  rectangle.extent.y HTupleUnion[int, str]HTupleHtuple (integer / string) (int / long / string) (Hlong / HString) (Hlong / char*)

Height of the tool.

Default value: 'default' "default" "default" "default" "default" "default"

Minimum increment: 1

Recommended increment: 1

Restriction: Height > 0

GenParamNameGenParamNameGenParamNameGenParamNamegenParamNamegen_param_name (input_control)  attribute.name(-array) HTupleMaybeSequence[str]HTupleHtuple (string) (string) (HString) (char*)

Names of the generic parameters.

Default value: []

GenParamValueGenParamValueGenParamValueGenParamValuegenParamValuegen_param_value (input_control)  attribute.value(-array) HTupleMaybeSequence[str]HTupleHtuple (string) (string) (HString) (char*)

Values of the generic parameters.

Default value: []

ToolIdToolIdToolIdToolIdtoolIdtool_id (output_control)  dev_tool HTupleHHandleHTupleHtuple (string) (IntPtr) (HString) (char*)

Tool identifier.

Example (HDevelop)

dev_open_tool ('zoom_window',0, 0, Width, Height, [], [], 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 Successors

dev_set_tool_geometrydev_set_tool_geometryDevSetToolGeometryDevSetToolGeometryDevSetToolGeometrydev_set_tool_geometry, dev_show_tooldev_show_toolDevShowToolDevShowToolDevShowTooldev_show_tool, dev_close_tooldev_close_toolDevCloseToolDevCloseToolDevCloseTooldev_close_tool

Module

Foundation