dev_open_tooldev_open_toolDevOpenTooldev_open_toolDevOpenToolDevOpenTool (Operator)

Name

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

Signature

dev_open_tool( : : ToolName, Row, Column, Width, Height, GenParamNames, GenParamValues : ToolId)

Description

dev_open_tooldev_open_toolDevOpenTooldev_open_toolDevOpenToolDevOpenTool opens a HDevelop tool, a non-modal dialog, or assistant. The parameter ToolNameToolNameToolNameToolNameToolNametoolName contains the name of the tool which should be opened. This operator returns the ToolIdToolIdToolIdToolIdToolIdtoolId of the newly created tool, which can be used by operators like dev_set_tool_geometrydev_set_tool_geometryDevSetToolGeometrydev_set_tool_geometryDevSetToolGeometryDevSetToolGeometry, dev_show_tooldev_show_toolDevShowTooldev_show_toolDevShowToolDevShowTool, dev_close_tooldev_close_toolDevCloseTooldev_close_toolDevCloseToolDevCloseTool to address a specific tool. The opened tool automatically becomes active.

For the ToolNameToolNameToolNameToolNameToolNametoolName.'halcon_news'"halcon_news""halcon_news""halcon_news""halcon_news""halcon_news" an empty ToolIdToolIdToolIdToolIdToolIdtoolId is returned, because this simply should view the news page.

With GenParamNamesGenParamNamesGenParamNamesGenParamNamesGenParamNamesgenParamNames and GenParamValuesGenParamValuesGenParamValuesGenParamValuesGenParamValuesgenParamValues it can be specified which page is displayed and more. See below. The use of GenParamNamesGenParamNamesGenParamNamesGenParamNamesGenParamNamesgenParamNames and GenParamValuesGenParamValuesGenParamValuesGenParamValuesGenParamValuesgenParamValues is optional. If they are set to [] the tool opens with default settings.

The following tools, are supported:

ToolNameToolNameToolNameToolNameToolNametoolName                          Main Windows
--------------------------------------------------------
'graphics_window'"graphics_window""graphics_window""graphics_window""graphics_window""graphics_window"                 Graphics Window                    
'operator_window'"operator_window""operator_window""operator_window""operator_window""operator_window"                 Operator Window                    
'program_listing'"program_listing""program_listing""program_listing""program_listing""program_listing"                 Program Listing                    
'variable_view'"variable_view""variable_view""variable_view""variable_view""variable_view"                   Variable Window                    

ToolNameToolNameToolNameToolNameToolNametoolName                          Assistants
--------------------------------------------------------
'calibration_assistant'"calibration_assistant""calibration_assistant""calibration_assistant""calibration_assistant""calibration_assistant"           Camera Calibration Assistant
'image_acquisition_assistant'"image_acquisition_assistant""image_acquisition_assistant""image_acquisition_assistant""image_acquisition_assistant""image_acquisition_assistant"     Image Aquisition Assistant         
'matching_assistant'"matching_assistant""matching_assistant""matching_assistant""matching_assistant""matching_assistant"              Matching Assistant                 
'measure1d_assistant'"measure1d_assistant""measure1d_assistant""measure1d_assistant""measure1d_assistant""measure1d_assistant"             Measure Assistant                  
'ocr_assistant'"ocr_assistant""ocr_assistant""ocr_assistant""ocr_assistant""ocr_assistant"                   OCR Assistant                      

ToolNameToolNameToolNameToolNameToolNametoolName                           Tools
--------------------------------------------------------
'call_stack'"call_stack""call_stack""call_stack""call_stack""call_stack"                       Call Stack                         
'feature_histogram'"feature_histogram""feature_histogram""feature_histogram""feature_histogram""feature_histogram"                Feature Histogram                  
'feature_inspection'"feature_inspection""feature_inspection""feature_inspection""feature_inspection""feature_inspection"               Feature Inspection                 
'gray_histogram'"gray_histogram""gray_histogram""gray_histogram""gray_histogram""gray_histogram"                   Gray Histogram                     
'line_profile'"line_profile""line_profile""line_profile""line_profile""line_profile"                     Line Profile                       
'zoom_window'"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"        OCR Training File Browser          

ToolNameToolNameToolNameToolNameToolNametoolName                           Dialogs
--------------------------------------------------------
'browse_examples_dialog'"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"          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"  Edit Procedure Interface Dialog    
'find_replace_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"                   Output Console                     
'program_line_view'"program_line_view""program_line_view""program_line_view""program_line_view""program_line_view"                Program Line View Dialog           
'breakpoints_dialog'"breakpoints_dialog""breakpoints_dialog""breakpoints_dialog""breakpoints_dialog""breakpoints_dialog"               Program Line View Dialog/ Breakpoints
'bookmarks_dialog'"bookmarks_dialog""bookmarks_dialog""bookmarks_dialog""bookmarks_dialog""bookmarks_dialog"                 Program Line View Dialog/ Bookmarks
'invalid_lines_dialog'"invalid_lines_dialog""invalid_lines_dialog""invalid_lines_dialog""invalid_lines_dialog""invalid_lines_dialog"             Program Line View Dialog/ Invalid Lines
'visualization_parameters_dialog'"visualization_parameters_dialog""visualization_parameters_dialog""visualization_parameters_dialog""visualization_parameters_dialog""visualization_parameters_dialog"  Visualization Parameters Dialog    

ToolNameToolNameToolNameToolNameToolNametoolName
--------------------------------------------------------
'help'"help""help""help""help""help"                             Help Browser.......................
'preferences'"preferences""preferences""preferences""preferences""preferences"                      Preferences Dialog .....           
'halcon_news'"halcon_news""halcon_news""halcon_news""halcon_news""halcon_news"                      HALCON News website............

Further settings with GenParamNamesGenParamNamesGenParamNamesGenParamNamesGenParamNamesgenParamNames and GenParamValuesGenParamValuesGenParamValuesGenParamValuesGenParamValuesgenParamValues are available for the following tools:

'calibration_assistant'"calibration_assistant""calibration_assistant""calibration_assistant""calibration_assistant""calibration_assistant" - Camera Calibration Assistant:

'page'"page""page""page""page""page":

Page which should be displayed.

Value                      Page
-------------------------------------------
'setup'"setup""setup""setup""setup""setup"                    Setup                      
'calibration'"calibration""calibration""calibration""calibration""calibration"              Calibration                
'results'"results""results""results""results""results"                  Results                    
'code_generation'"code_generation""code_generation""code_generation""code_generation""code_generation"          Code Generation

For example: dev_open_tool ( 'calibration_assistant',..., 'page', 'results',...) opens the calibration assistant and shows the result tab card.

quad

'image_acquisition_assistant'"image_acquisition_assistant""image_acquisition_assistant""image_acquisition_assistant""image_acquisition_assistant""image_acquisition_assistant" - Image Aquisition Assistant:

'page'"page""page""page""page""page":

Page which should be displayed.

Value                      Page
-------------------------------------------
'source'"source""source""source""source""source"                   Source                     
'connection'"connection""connection""connection""connection""connection"               Connection                 
'parameters'"parameters""parameters""parameters""parameters""parameters"               Parameters                
'code_generation'"code_generation""code_generation""code_generation""code_generation""code_generation"          Code Generation

For example: dev_open_tool ( 'image_acquisition',..., 'page', 'source',...) opens the image acquisition assistant and shows the source tab card.

'matching_assistant'"matching_assistant""matching_assistant""matching_assistant""matching_assistant""matching_assistant" - Matching Assistant:

'page'"page""page""page""page""page":

Page which should be displayed.

Value                      Page   
-------------------------------------------
'model_creation'"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 Parameter             
'model_use'"model_use""model_use""model_use""model_use""model_use"                Model Use                  
'inspect'"inspect""inspect""inspect""inspect""inspect"                  Inspect                    
'code_generation'"code_generation""code_generation""code_generation""code_generation""code_generation"          Code Generation

For example: dev_open_tool ( 'matching_assistant',..., 'page', 'inspect',...) opens the matching assistant and shows the inspect tab card.

'measure1d_assistant'"measure1d_assistant""measure1d_assistant""measure1d_assistant""measure1d_assistant""measure1d_assistant" - Measure Assistant:

'page'"page""page""page""page""page":

Page which should be displayed.

Value                      Page
-------------------------------------------
'input'"input""input""input""input""input"                    Input                      
'edges'"edges""edges""edges""edges""edges"                    Edges                      
'fuzzy'"fuzzy""fuzzy""fuzzy""fuzzy""fuzzy"                    Fuzzy   
'results'"results""results""results""results""results"                  Results                      
'code_generation'"code_generation""code_generation""code_generation""code_generation""code_generation"          Code Generation

For example: dev_open_tool ( 'measure1d_assistant',..., 'page', 'edges',...) opens the measure assistant and shows the edges tab card.

'program_line_view'"program_line_view""program_line_view""program_line_view""program_line_view""program_line_view": - Program Line View Dialog

'page'"page""page""page""page""page":

Page which should be displayed.

Value                      Page
-------------------------------------------
'invalid_lines'"invalid_lines""invalid_lines""invalid_lines""invalid_lines""invalid_lines"            Invalid Lines              
'find_all'"find_all""find_all""find_all""find_all""find_all"                 Find All                   
'breakpoints'"breakpoints""breakpoints""breakpoints""breakpoints""breakpoints"              Breakpoints                
'bookmarks'"bookmarks""bookmarks""bookmarks""bookmarks""bookmarks"                Bookmarks

For example: dev_open_tool ( 'program_line_view',..., 'page', 'breakpoints',...) opens the program line view dialog and and shows the breakpoints tab card.

'help'"help""help""help""help""help" - Help Browser:

Possible entries for GenParamNamesGenParamNamesGenParamNamesGenParamNamesGenParamNamesgenParamNames are 'page'"page""page""page""page""page", 'operator'"operator""operator""operator""operator""operator", 'manual'"manual""manual""manual""manual""manual".

'page'"page""page""page""page""page":

Page which should be displayed.

Value                      Page
-------------------------------------------
'contents'"contents""contents""contents""contents""contents"                 Contents                   
'operator'"operator""operator""operator""operator""operator"                 Operator                  
'search'"search""search""search""search""search"                   Search                     
'index'"index""index""index""index""index"                    Index                      
'bookmarks'"bookmarks""bookmarks""bookmarks""bookmarks""bookmarks"                Bookmarks

For example: dev_open_tool ( 'help',...,'page', 'search',...) opens the help tool and selects the search tab card.

'operator'"operator""operator""operator""operator""operator":

Operator which html page should be displayed.

For example: dev_open_tool ( 'help',..., '['page','operator'],['search','read_image'] ...) opens the help tool, selects the search tab card and displays the description of the operator read_image.

'manual'"manual""manual""manual""manual""manual":

Manual which html page should be displayed.

'preferences'"preferences""preferences""preferences""preferences""preferences" - Preferences Dialog:

'page'"page""page""page""page""page":

Where the displayed page is a combination of two values. The selection on the group and the tab card in that group. The both values must be separated by '/'. See the example below.

For example: dev_open_tool ( 'preferences',..., 'page','user_interface/language', ...) shows the page 'language'"language""language""language""language""language" from the group 'user_interface'"user_interface""user_interface""user_interface""user_interface""user_interface".

Possible Groups are:

Value                      Group
-------------------------------------------------------------
'user_interface'"user_interface""user_interface""user_interface""user_interface""user_interface"           User Interface             
'procedures'"procedures""procedures""procedures""procedures""procedures"               Procedures                  
'general_options'"general_options""general_options""general_options""general_options""general_options"          General Options            
'visualization_settings'"visualization_settings""visualization_settings""visualization_settings""visualization_settings""visualization_settings"   Visualization Settings     
'runtime_settings'"runtime_settings""runtime_settings""runtime_settings""runtime_settings""runtime_settings"         Runtime Settings

'user_interface'"user_interface""user_interface""user_interface""user_interface""user_interface":

Group which should be displayed.

Value                            Page
-------------------------------------------------------------
'user_interface/program_listing'"user_interface/program_listing""user_interface/program_listing""user_interface/program_listing""user_interface/program_listing""user_interface/program_listing" Program Listing            
'user_interface/fonts'"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""user_interface/language"        Language                   
'user_interface/layout'"user_interface/layout""user_interface/layout""user_interface/layout""user_interface/layout""user_interface/layout"          Layout

'procedure'"procedure""procedure""procedure""procedure""procedure":

Group which should be displayed.

Value                                  Page
-------------------------------------------------------------
'procedures/directories'"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""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""procedures/manage_procedure_libraries" Manage Procedure Libraries 
'procedures/manage_passwords'"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""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""procedures/unresolved_procedure_calls" Unresolved Procedure Calls

'general_options'"general_options""general_options""general_options""general_options""general_options":

Group which should be displayed.

Value                              Page
-------------------------------------------------------------
'general_options/general_options'"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""general_options/experienced_user" Experienced User

'visualization_settings'"visualization_settings""visualization_settings""visualization_settings""visualization_settings""visualization_settings":

Group which should be displayed.

Value                           Page
-------------------------------------------------------------
'visualization_settings/pen'"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""visualization_settings/lut"    LUT                        
'visualization_settings/paint'"visualization_settings/paint""visualization_settings/paint""visualization_settings/paint""visualization_settings/paint""visualization_settings/paint"  Paint

'runtime_settings'"runtime_settings""runtime_settings""runtime_settings""runtime_settings""runtime_settings":

Group which should be displayed.

Value                                           Page
-------------------------------------------------------------------------
'runtime_settings/runtime_settings'"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""runtime_settings/override_operator_behavior" Override Operator Behavior

The parameters RowRowRowRowRowrow and ColumnColumnColumnColumnColumncolumn can be used to open the tool at a specific position. In order to apply the standard behaviour, 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 behaviour, 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.

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

Attention

This operator is not supported for code export.

Parameters

ToolNameToolNameToolNameToolNameToolNametoolName (input_control) string → (string)

Name of the tool which should be opened and additional parameters.

RowRowRowRowRowrow (input_control) rectangle.origin.y → (integer / string)

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 → (integer / string)

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 → (integer / string)

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 → (integer / string)

Height of the tool.

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

Minimum increment: 1

Recommended increment: 1

Restriction: Height > 0

GenParamNamesGenParamNamesGenParamNamesGenParamNamesGenParamNamesgenParamNames (input_control) attribute.name(-array) → (string)

Names of the generic parameters.

Default value: []

GenParamValuesGenParamValuesGenParamValuesGenParamValuesGenParamValuesgenParamValues (input_control) attribute.value(-array) → (string)

Values of the generic parameters.

Default value: []

ToolIdToolIdToolIdToolIdToolIdtoolId (output_control) dev_tool → (string)

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_toolDevOpenTooldev_open_toolDevOpenToolDevOpenTool returns 2 (H_MSG_TRUE). Otherwise an exception is raised and an error code returned.

Possible Successors

dev_set_tool_geometrydev_set_tool_geometryDevSetToolGeometrydev_set_tool_geometryDevSetToolGeometryDevSetToolGeometry, dev_show_tooldev_show_toolDevShowTooldev_show_toolDevShowToolDevShowTool, dev_close_tooldev_close_toolDevCloseTooldev_close_toolDevCloseToolDevCloseTool

Module

Foundation