dev_open_tooldev_open_toolDevOpenToolDevOpenTooldev_open_tool (Operator)
dev_open_tooldev_open_toolDevOpenToolDevOpenTooldev_open_tool
— Open a HDevelop tool, a non-modal dialog, or assistant.
Signature
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)
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_toolDevOpenToolDevOpenTooldev_open_tool
opens a HDevelop tool, a non-modal dialog, or
assistant. The parameter ToolNameToolNameToolNametoolNametool_name
contains the name of the tool
to be opened.
This operator returns the ToolIdToolIdToolIdtoolIdtool_id
of the newly created tool, which
can be used by operators like dev_set_tool_geometrydev_set_tool_geometryDevSetToolGeometryDevSetToolGeometrydev_set_tool_geometry
,
dev_show_tooldev_show_toolDevShowToolDevShowTooldev_show_tool
, dev_close_tooldev_close_toolDevCloseToolDevCloseTooldev_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_toolDevCloseToolDevCloseTooldev_close_tool
.
The parameters GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name
and GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value
are optional.
For certain ToolNameToolNameToolNametoolNametool_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 ToolNameToolNameToolNametoolNametool_name
:
-
'graphics_window'"graphics_window""graphics_window""graphics_window""graphics_window": Graphics Window
-
'operator_window'"operator_window""operator_window""operator_window""operator_window": Operator Window
-
'program_window'"program_window""program_window""program_window""program_window": Program Window
-
'variable_window'"variable_window""variable_window""variable_window""variable_window": Variable Window
Concerning the Assistants supported ToolNameToolNameToolNametoolNametool_name
:
-
'calibration_assistant'"calibration_assistant""calibration_assistant""calibration_assistant""calibration_assistant": Camera Calibration Assistant
Supported values for GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name
:
-
'page'"page""page""page""page": Page to be displayed.
Supported values for GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value
:
-
'setup'"setup""setup""setup""setup": Setup
-
'calibration'"calibration""calibration""calibration""calibration": Calibration
-
'result'"result""result""result""result": Results
-
'code_generation'"code_generation""code_generation""code_generation""code_generation": Code Generation
Example:
dev_open_tool('calibration_assistant', ..., 'page', 'result', ...)dev_open_tool("calibration_assistant", ..., "page", "result", ...)DevOpenTool("calibration_assistant", ..., "page", "result", ...)DevOpenTool("calibration_assistant", ..., "page", "result", ...)dev_open_tool("calibration_assistant", ..., "page", "result", ...)
opens the calibration assistant and shows the tab card Results
.
-
'image_acquisition_assistant'"image_acquisition_assistant""image_acquisition_assistant""image_acquisition_assistant""image_acquisition_assistant": Image Acquisition Assistant
Supported values for GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name
:
-
'page'"page""page""page""page": Page to be displayed.
Supported values for GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value
:
-
'source'"source""source""source""source": Source
-
'connection'"connection""connection""connection""connection": Connection
-
'parameters'"parameters""parameters""parameters""parameters": Parameters
-
'code_generation'"code_generation""code_generation""code_generation""code_generation": Code Generation
Example:
dev_open_tool('image_acquisition', ...,'page', 'source', ...)dev_open_tool("image_acquisition", ...,"page", "source", ...)DevOpenTool("image_acquisition", ...,"page", "source", ...)DevOpenTool("image_acquisition", ...,"page", "source", ...)dev_open_tool("image_acquisition", ...,"page", "source", ...)
opens the image acquisition assistant and shows the tab card
Source
.
-
'matching_assistant'"matching_assistant""matching_assistant""matching_assistant""matching_assistant": Matching Assistant
Supported values for GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name
:
-
'page'"page""page""page""page": Page to be displayed.
Supported values for GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value
:
-
'model_creation'"model_creation""model_creation""model_creation""model_creation": Model Creation
-
'model_parameter'"model_parameter""model_parameter""model_parameter""model_parameter": Model Parameter
-
'model_use'"model_use""model_use""model_use""model_use": Model Use
-
'inspect'"inspect""inspect""inspect""inspect": Inspect
-
'code_generation'"code_generation""code_generation""code_generation""code_generation" & Code Generation
Example:
dev_open_tool('matching_assistant', ...,'page', 'inspect', ...)dev_open_tool("matching_assistant", ...,"page", "inspect", ...)DevOpenTool("matching_assistant", ...,"page", "inspect", ...)DevOpenTool("matching_assistant", ...,"page", "inspect", ...)dev_open_tool("matching_assistant", ...,"page", "inspect", ...)
opens the matching assistant and shows the tab card Inspect
.
-
'measure1d_assistant'"measure1d_assistant""measure1d_assistant""measure1d_assistant""measure1d_assistant": Measure Assistant
Supported values for GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name
:
-
'page'"page""page""page""page": Page to be displayed.
Supported values for GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value
:
-
'input'"input""input""input""input": Input
-
'edges'"edges""edges""edges""edges": Edges
-
'fuzzy'"fuzzy""fuzzy""fuzzy""fuzzy": Fuzzy
-
'result'"result""result""result""result": Results
-
'code_generation'"code_generation""code_generation""code_generation""code_generation"& Code Generation
Example:
dev_open_tool('measure1d_assistant', ..., 'page', 'edges', ...)dev_open_tool("measure1d_assistant", ..., "page", "edges", ...)DevOpenTool("measure1d_assistant", ..., "page", "edges", ...)DevOpenTool("measure1d_assistant", ..., "page", "edges", ...)dev_open_tool("measure1d_assistant", ..., "page", "edges", ...)
opens the measure assistant and shows the tab card Edges
.
-
'ocr_assistant'"ocr_assistant""ocr_assistant""ocr_assistant""ocr_assistant": OCR Assistant
Concerning the Tools supported values for ToolNameToolNameToolNametoolNametool_name
:
-
'call_stack'"call_stack""call_stack""call_stack""call_stack": Call Stack
-
'canvas'"canvas""canvas""canvas""canvas": Canvas Window
-
'feature_histogram'"feature_histogram""feature_histogram""feature_histogram""feature_histogram": Feature Histogram
-
'feature_inspection'"feature_inspection""feature_inspection""feature_inspection""feature_inspection": Feature Inspection
-
'gray_histogram'"gray_histogram""gray_histogram""gray_histogram""gray_histogram": Gray Histogram
-
'line_profile'"line_profile""line_profile""line_profile""line_profile": Line Profile
-
'zoom_window'"zoom_window""zoom_window""zoom_window""zoom_window": Zoom Window
-
'ocr_training_file_browser'"ocr_training_file_browser""ocr_training_file_browser""ocr_training_file_browser""ocr_training_file_browser": OCR Training File Browser
Concerning the Dialogs supported values for ToolNameToolNameToolNametoolNametool_name
:
-
'browse_examples_dialog'"browse_examples_dialog""browse_examples_dialog""browse_examples_dialog""browse_examples_dialog": Browse Examples Dialog
-
'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
-
'find_replace_dialog'"find_replace_dialog""find_replace_dialog""find_replace_dialog""find_replace_dialog": Find Replace Dialog
-
'output_console'"output_console""output_console""output_console""output_console": Output Console
-
'quick_navigation'"quick_navigation""quick_navigation""quick_navigation""quick_navigation": Quick Navigation
Supported values for GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name
:
-
'page'"page""page""page""page": Page to be displayed.
Supported values for GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value
:
-
'invalid_lines'"invalid_lines""invalid_lines""invalid_lines""invalid_lines": Invalid Lines
-
'find_results'"find_results""find_results""find_results""find_results": Find Results
-
'breakpoints'"breakpoints""breakpoints""breakpoints""breakpoints": Breakpoints
-
'bookmarks'"bookmarks""bookmarks""bookmarks""bookmarks": Bookmarks
Example:
dev_open_tool('quick_navigation', ..., 'page', 'breakpoints', ...)dev_open_tool("quick_navigation", ..., "page", "breakpoints", ...)DevOpenTool("quick_navigation", ..., "page", "breakpoints", ...)DevOpenTool("quick_navigation", ..., "page", "breakpoints", ...)dev_open_tool("quick_navigation", ..., "page", "breakpoints", ...)
opens the quick navigation window and shows the tab card
Breakpoints
.
-
'breakpoints_dialog'"breakpoints_dialog""breakpoints_dialog""breakpoints_dialog""breakpoints_dialog": Quick Navigation / Breakpoints
-
'bookmarks_dialog'"bookmarks_dialog""bookmarks_dialog""bookmarks_dialog""bookmarks_dialog": Quick Navigation / Bookmarks
-
'invalid_lines_dialog'"invalid_lines_dialog""invalid_lines_dialog""invalid_lines_dialog""invalid_lines_dialog": Quick Navigation / Invalid Lines
-
'visualization_parameters_dialog'"visualization_parameters_dialog""visualization_parameters_dialog""visualization_parameters_dialog""visualization_parameters_dialog": Visualization Parameters Dialog
-
'help'"help""help""help""help": Help Browser
Supported values for GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name
:
-
'page'"page""page""page""page": Page to be displayed.
Supported values for GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value
:
-
'contents'"contents""contents""contents""contents": Contents
-
'operator'"operator""operator""operator""operator": Operator
-
'search'"search""search""search""search": Search
-
'index'"index""index""index""index": Index
-
'bookmarks'"bookmarks""bookmarks""bookmarks""bookmarks": Bookmarks
Example:
dev_open_tool('help', ..., 'page', 'search', ...)dev_open_tool("help", ..., "page", "search", ...)DevOpenTool("help", ..., "page", "search", ...)DevOpenTool("help", ..., "page", "search", ...)dev_open_tool("help", ..., "page", "search", ...)
opens the help tool and selects the tab card Search
.
-
'operator'"operator""operator""operator""operator": Operator whose HTML page should be displayed.
Supported values for GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value
: Operator names
(written in snake case).
Example:
dev_open_tool('help', ...,['page','operator'], ['search','read_image'], ...)dev_open_tool("help", ...,["page","operator"], ["search","read_image"], ...)DevOpenTool("help", ...,["page","operator"], ["search","read_image"], ...)DevOpenTool("help", ...,["page","operator"], ["search","read_image"], ...)dev_open_tool("help", ...,["page","operator"], ["search","read_image"], ...)
opens the help tool, selects the tab card Search
and displays
the description of the operator read_imageread_imageReadImageReadImageread_image
.
-
'manual'"manual""manual""manual""manual":
Manual whose HTML page should be displayed.
Supported values for GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value
: Manual names
(including their path, both written in snake case).
Example:
dev_open_tool('help', 'default', 'default', 'default', 'default', 'manual', 'hdevelop_users_guide/hdevelop_users_guide_0000', ToolId)dev_open_tool("help", "default", "default", "default", "default", "manual", "hdevelop_users_guide/hdevelop_users_guide_0000", ToolId)DevOpenTool("help", "default", "default", "default", "default", "manual", "hdevelop_users_guide/hdevelop_users_guide_0000", ToolId)DevOpenTool("help", "default", "default", "default", "default", "manual", "hdevelop_users_guide/hdevelop_users_guide_0000", ToolId)dev_open_tool("help", "default", "default", "default", "default", "manual", "hdevelop_users_guide/hdevelop_users_guide_0000", ToolId)
opens the manual “HDevelop User's Guide”
.
-
'preferences'"preferences""preferences""preferences""preferences": Preferences Dialog
Supported values for GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name
:
-
'page'"page""page""page""page": Page to be displayed.
Supported values for GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value
are listed in groups of menu
items.
For the menu User Interface
supported values for
GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value
:
-
'user_interface/program_window'"user_interface/program_window""user_interface/program_window""user_interface/program_window""user_interface/program_window": Program Window
-
'user_interface/fonts'"user_interface/fonts""user_interface/fonts""user_interface/fonts""user_interface/fonts": Fonts
-
'user_interface/language'"user_interface/language""user_interface/language""user_interface/language""user_interface/language": Language
-
'user_interface/themes'"user_interface/themes""user_interface/themes""user_interface/themes""user_interface/themes": Themes
For the menu Procedures
supported values for
GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value
:
-
'procedures/directories'"procedures/directories""procedures/directories""procedures/directories""procedures/directories": Directories
-
'procedures/external_procedures'"procedures/external_procedures""procedures/external_procedures""procedures/external_procedures""procedures/external_procedures": External Procedures
-
'procedures/manage_procedure_libraries'"procedures/manage_procedure_libraries""procedures/manage_procedure_libraries""procedures/manage_procedure_libraries""procedures/manage_procedure_libraries": Manage Procedure
Libraries
-
'procedures/manage_passwords'"procedures/manage_passwords""procedures/manage_passwords""procedures/manage_passwords""procedures/manage_passwords": Manage Passwords
-
'procedures/procedure_use'"procedures/procedure_use""procedures/procedure_use""procedures/procedure_use""procedures/procedure_use": Procedure Use
-
'procedures/unresolved_procedure_calls'"procedures/unresolved_procedure_calls""procedures/unresolved_procedure_calls""procedures/unresolved_procedure_calls""procedures/unresolved_procedure_calls": Unresolved
Procedure Calls
For the menu General Options
supported values for
GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value
:
-
'general_options/general_options'"general_options/general_options""general_options/general_options""general_options/general_options""general_options/general_options": General Options
-
'general_options/experienced_user'"general_options/experienced_user""general_options/experienced_user""general_options/experienced_user""general_options/experienced_user": Experienced User
For the menu Visualization Settings
, supported values for
GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value
:
-
'visualization_settings/pen'"visualization_settings/pen""visualization_settings/pen""visualization_settings/pen""visualization_settings/pen": Pen
-
'visualization_settings/lut'"visualization_settings/lut""visualization_settings/lut""visualization_settings/lut""visualization_settings/lut": LUT
-
'visualization_settings/paint'"visualization_settings/paint""visualization_settings/paint""visualization_settings/paint""visualization_settings/paint": Paint
For the menu Runtime Settings
supported values for
GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value
:
-
'runtime_settings/runtime_settings'"runtime_settings/runtime_settings""runtime_settings/runtime_settings""runtime_settings/runtime_settings""runtime_settings/runtime_settings": Runtime Settings
-
'runtime_settings/override_operator_behavior'"runtime_settings/override_operator_behavior""runtime_settings/override_operator_behavior""runtime_settings/override_operator_behavior""runtime_settings/override_operator_behavior":
Override Operator Behavior
For the menu Telemetry Settings
supported values for
GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value
:
Example:
dev_open_tool('preferences', ..., 'page', 'user_interface/language', ...)dev_open_tool("preferences", ..., "page", "user_interface/language", ...)DevOpenTool("preferences", ..., "page", "user_interface/language", ...)DevOpenTool("preferences", ..., "page", "user_interface/language", ...)dev_open_tool("preferences", ..., "page", "user_interface/language", ...)
shows the page language
from the group User Interface
.
-
'halcon_news'"halcon_news""halcon_news""halcon_news""halcon_news": HALCON News website - an empty ToolIdToolIdToolIdtoolIdtool_id
is returned because this simply opens the news page.
The parameters RowRowRowrowrow
and ColumnColumnColumncolumncolumn
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" can be passed.
The parameters WidthWidthWidthwidthwidth
and HeightHeightHeightheightheight
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" can
be passed. If WidthWidthWidthwidthwidth
and HeightHeightHeightheightheight
are less than the
minimum size of the tool the minimum size is used.
Attention
This operator is not supported for code export.
Parameters
ToolNameToolNameToolNametoolNametool_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", '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", 'calibration_assistant'"calibration_assistant""calibration_assistant""calibration_assistant""calibration_assistant", 'call_stack'"call_stack""call_stack""call_stack""call_stack", 'canvas'"canvas""canvas""canvas""canvas", '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", 'feature_histogram'"feature_histogram""feature_histogram""feature_histogram""feature_histogram", '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", 'graphics_window'"graphics_window""graphics_window""graphics_window""graphics_window", 'gray_histogram'"gray_histogram""gray_histogram""gray_histogram""gray_histogram", 'halcon_news'"halcon_news""halcon_news""halcon_news""halcon_news", 'help'"help""help""help""help", '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", 'line_profile'"line_profile""line_profile""line_profile""line_profile", 'matching_assistant'"matching_assistant""matching_assistant""matching_assistant""matching_assistant", 'measure1d_assistant'"measure1d_assistant""measure1d_assistant""measure1d_assistant""measure1d_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", 'operator_window'"operator_window""operator_window""operator_window""operator_window", 'output_console'"output_console""output_console""output_console""output_console", 'preferences'"preferences""preferences""preferences""preferences", 'program_window'"program_window""program_window""program_window""program_window", 'quick_navigation'"quick_navigation""quick_navigation""quick_navigation""quick_navigation", '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", 'zoom_window'"zoom_window""zoom_window""zoom_window""zoom_window"
RowRowRowrowrow
(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:
'default'
"default"
"default"
"default"
"default"
Minimum increment:
1
Recommended increment:
1
ColumnColumnColumncolumncolumn
(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:
'default'
"default"
"default"
"default"
"default"
Minimum increment:
1
Recommended increment:
1
WidthWidthWidthwidthwidth
(input_control) rectangle.extent.x →
HTupleUnion[int, str]HTupleHtuple (integer / string) (int / long / string) (Hlong / HString) (Hlong / char*)
Width of the tool.
Default:
'default'
"default"
"default"
"default"
"default"
Minimum increment:
1
Recommended increment:
1
Restriction:
Width > 0
HeightHeightHeightheightheight
(input_control) rectangle.extent.y →
HTupleUnion[int, str]HTupleHtuple (integer / string) (int / long / string) (Hlong / HString) (Hlong / char*)
Height of the tool.
Default:
'default'
"default"
"default"
"default"
"default"
Minimum increment:
1
Recommended increment:
1
Restriction:
Height > 0
GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name
(input_control) attribute.name(-array) →
HTupleMaybeSequence[str]HTupleHtuple (string) (string) (HString) (char*)
Names of the generic parameters.
Default:
[]
GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value
(input_control) attribute.value(-array) →
HTupleMaybeSequence[str]HTupleHtuple (string) (string) (HString) (char*)
Values of the generic parameters.
Default:
[]
ToolIdToolIdToolIdtoolIdtool_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_toolDevOpenToolDevOpenTooldev_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_geometryDevSetToolGeometryDevSetToolGeometrydev_set_tool_geometry
,
dev_show_tooldev_show_toolDevShowToolDevShowTooldev_show_tool
,
dev_close_tooldev_close_toolDevCloseToolDevCloseTooldev_close_tool
Module
Foundation