open_textwindowopen_textwindowOpenTextwindowopen_textwindowOpenTextwindowOpenTextwindow (Operator)

Name

open_textwindowopen_textwindowOpenTextwindowopen_textwindowOpenTextwindowOpenTextwindow — Open a textual window.

Signature

Description

open_textwindowopen_textwindowOpenTextwindowopen_textwindowOpenTextwindowOpenTextwindow opens a new textual window, which can be used to perform textual input and output, as well as to perform output of images. All output (write_stringwrite_stringWriteStringwrite_stringWriteStringWriteString, read_stringread_stringReadStringread_stringReadStringReadString, disp_regiondisp_regionDispRegiondisp_regionDispRegionDispRegion, etc.) is redirected to this window, if the same logical window number WindowHandleWindowHandleWindowHandleWindowHandleWindowHandlewindowHandle is used.

Besides the mouse cursor textual windows possess also a textual cursor which indicates the current writing position (more exactly: the lower left corner of the output string without consideration of descenders). Its position is indicated through an underscore or another type (the indication of this position may also be disabled (= default setting); cf. set_tshapeset_tshapeSetTshapeset_tshapeSetTshapeSetTshape). You may set or query the position by calling the operators set_tpositionset_tpositionSetTpositionset_tpositionSetTpositionSetTposition or get_tpositionget_tpositionGetTpositionget_tpositionGetTpositionGetTposition.

After you opened a textual window the position of the cursor is set to (H,0). Whereby H significates the height of the default font less the descenders. But the cursor is not shown. Hence the output starts for writing in the upper left corner of the window.

You may query the colors of the background and the image edges by calling query_colorquery_colorQueryColorquery_colorQueryColorQueryColor. In the same way you may use query_colorquery_colorQueryColorquery_colorQueryColorQueryColor in a window of type 'invisible'. During output (write_stringwrite_stringWriteStringwrite_stringWriteStringWriteString) you may set the clipping of text out of the window edges by calling set_check(::'~text':). This disables the creation of error messages, if text passes over the edge of the window.

The origin of the coordinate system of the window resides in the upper left corner (coordinates: (0,0)). The row index grows downward (maximal: HeightHeightHeightHeightHeightheight-1), the column index grows to the right (maximal: WidthWidthWidthWidthWidthwidth-1).

The parameter MachineMachineMachineMachineMachinemachine indicates the name of the computer, which has to open the window. In case of a X-window, TCP-IP only sets the name, DEC-Net sets in addition a colon behind the name. The “server” or the “screen”, respectively, are not specified. If the empty string is passed the environment variable DISPLAY is used. It indicates the target computer. At this the name is indicated in common syntax <Host>:0.0.

For windows of type 'X-Window' and 'WIN32-Window' the parameter FatherWindowFatherWindowFatherWindowFatherWindowFatherWindowfatherWindow can be used to determine the father window for the window to be opened. In case the control 'father' is set via set_checkset_checkSetCheckset_checkSetCheckSetCheck, FatherWindowFatherWindowFatherWindowFatherWindowFatherWindowfatherWindow relates to the ID of a HALCON window, otherwise (set_check('~father')) it relates to the ID of an operating system window. If FatherWindowFatherWindowFatherWindowFatherWindowFatherWindowfatherWindow is passed the value 0 or 'root', then under Windows and Unix-like systems the desktop and the root window become the father window, respectively. In this case, the value of the control 'father' (set via set_checkset_checkSetCheckset_checkSetCheckSetCheck) is irrelevant.

Position and size of a window may change during runtime of a program. This may be achieved by calling set_window_extentsset_window_extentsSetWindowExtentsset_window_extentsSetWindowExtentsSetWindowExtents, but also through external interferences (window manager). In the latter case the operator set_window_extentsset_window_extentsSetWindowExtentsset_window_extentsSetWindowExtentsSetWindowExtents is provided.

Opening a window causes the assignment of a called default font. It is used in connection with operators like write_stringwrite_stringWriteStringwrite_stringWriteStringWriteString and you may overwrite it by performing set_fontset_fontSetFontset_fontSetFontSetFont after calling open_textwindowopen_textwindowOpenTextwindowopen_textwindowOpenTextwindowOpenTextwindow. On the other hand you have the possibility to specify a default font by calling set_system(::'default_font',<Fontname>:)set_system("default_font",<Fontname>)SetSystem("default_font",<Fontname>)set_system("default_font",<Fontname>)SetSystem("default_font",<Fontname>)SetSystem("default_font",<Fontname>) before opening a window (and all following windows; see also query_fontquery_fontQueryFontquery_fontQueryFontQueryFont).

You may set the color of the font (write_stringwrite_stringWriteStringwrite_stringWriteStringWriteString, read_stringread_stringReadStringread_stringReadStringReadString) by calling set_colorset_colorSetColorset_colorSetColorSetColor, set_rgbset_rgbSetRgbset_rgbSetRgbSetRgb, set_hsiset_hsiSetHsiset_hsiSetHsiSetHsi, set_grayset_graySetGrayset_graySetGraySetGray or set_pixelset_pixelSetPixelset_pixelSetPixelSetPixel. Calling set_insertset_insertSetInsertset_insertSetInsertSetInsert specifies how the text or the graphics, respectively, is combined with the content of the image repeat memory. So you may achieve by calling, e.g., set_insertset_insertSetInsertset_insertSetInsertSetInsert(::'not':) to eliminate the font after writing text twice at the same position.

Normally every output (e.g., write_stringwrite_stringWriteStringwrite_stringWriteStringWriteString, disp_regiondisp_regionDispRegiondisp_regionDispRegionDispRegion, disp_circledisp_circleDispCircledisp_circleDispCircleDispCircle, etc.) in a window is terminated by a “flush”. This causes the data to be fully visible on the display after termination of the output operator. But this is not necessary in all cases, in particular if there are permanently output tasks or there is a mouse procedure active. Therefore it is more favorable (i.e., more rapid) to store the data until sufficient data is available. You may stop this behavior by calling set_system(::'flush_graphic','false':)set_system("flush_graphic","false")SetSystem("flush_graphic","false")set_system("flush_graphic","false")SetSystem("flush_graphic","false")SetSystem("flush_graphic","false").

The content of windows is saved (in case it is supported by special driver software); i.e., it is preserved, also if the window is hidden by other windows. But this is not necessary in all cases: If you use a textual window, e.g., as a parent window for other windows, you may suppress the security mechanism for it and save the necessary memory at the same moment. You achieve this before opening the window by calling set_system(::'backing_store','false':)set_system("backing_store","false")SetSystem("backing_store","false")set_system("backing_store","false")SetSystem("backing_store","false")SetSystem("backing_store","false").

Difference: graphical window - textual window

• In contrast to graphical windows (open_windowopen_windowOpenWindowopen_windowOpenWindowOpenWindow) you may specify more parameters (color, edge) for a textual window while opening it.

• You may use textual windows only for input of user data (read_stringread_stringReadStringread_stringReadStringReadString).

• Using textual windows, the output of images, regions and graphics is “clipped” at the edges. Whereas during the use of graphical windows the edges are “zoomed”.

• The coordinate system (e.g., with get_mbuttonget_mbuttonGetMbuttonget_mbuttonGetMbuttonGetMbutton or get_mpositionget_mpositionGetMpositionget_mpositionGetMpositionGetMposition) consists of display coordinates independently of image size. The maximum coordinates are equal to the size of the window minus 1. In contrast to this, graphical windows (open_windowopen_windowOpenWindowopen_windowOpenWindowOpenWindow) use always a coordinate system, which corresponds to the image format.

The parameter ModeModeModeModeModemode specifies the mode of the window. It can have following values:

'visible':

Normal mode for textual windows: The window is created according to the parameters and all inputs and outputs are possible.

'invisible':

Invisible windows are not displayed in the display. Parameters like RowRowRowRowRowrow, ColumnColumnColumnColumnColumncolumn, BorderWidthBorderWidthBorderWidthBorderWidthBorderWidthborderWidth, BorderColorBorderColorBorderColorBorderColorBorderColorborderColor, BackgroundColorBackgroundColorBackgroundColorBackgroundColorBackgroundColorbackgroundColor and FatherWindowFatherWindowFatherWindowFatherWindowFatherWindowfatherWindow do not have any meaning. Output to these windows has no effect. Input (read_stringread_stringReadStringread_stringReadStringReadString, mouse, etc.) is not possible. You may use these windows to query representation parameter for an output device without opening a (visible) window. General queries are, e.g., query_colorquery_colorQueryColorquery_colorQueryColorQueryColor and get_string_extentsget_string_extentsGetStringExtentsget_string_extentsGetStringExtentsGetStringExtents.

'transparent':

These windows are transparent: the window itself is not visible (edge and background), but all the other operations are possible and all output is displayed. Parameters like BorderColorBorderColorBorderColorBorderColorBorderColorborderColor and BackgroundColorBackgroundColorBackgroundColorBackgroundColorBackgroundColorbackgroundColor do not have any meaning. A common use for this mode is the creation of mouse sensitive regions.

'buffer':

These are also not visible windows. The output of images, regions and graphics is not visible on the display, but is stored in memory. Parameters like RowRowRowRowRowrow, ColumnColumnColumnColumnColumncolumn, BorderWidthBorderWidthBorderWidthBorderWidthBorderWidthborderWidth, BorderColorBorderColorBorderColorBorderColorBorderColorborderColor, BackgroundColorBackgroundColorBackgroundColorBackgroundColorBackgroundColorbackgroundColor and FatherWindowFatherWindowFatherWindowFatherWindowFatherWindowfatherWindow do not have any meaning. You may use buffer windows, if you prepare output (in the background) and copy it finally with copy_rectanglecopy_rectangleCopyRectanglecopy_rectangleCopyRectangleCopyRectangle in a visible window. Another usage might be the rapid processing of image regions during interactive manipulations. Textual input and mouse interaction are not possible in this mode.

Attention

You have to keep in mind that parameters like RowRowRowRowRowrow, ColumnColumnColumnColumnColumncolumn, WidthWidthWidthWidthWidthwidth and HeightHeightHeightHeightHeightheight are restricted by the output device. Is a father window (FatherWindowFatherWindowFatherWindowFatherWindowFatherWindowfatherWindow <> 'root') specified, then the coordinates are relative to this window.

Parallelization

• Multithreading type: reentrant (runs in parallel with non-exclusive operators).
• Multithreading scope: local (may only be called from the same thread in which the window, model, or tool instance was created).
• Processed without parallelization.

Parameters

open_textwindow(0,0,900,600,1,'black','slate blue','root','visible', \
                '',WindowHandle)
open_textwindow(10,10,300,580,3,'red','blue',Father,'visible', \
                '',WindowHandle)
open_window(10,320,570,580,Father,'visible','',WindowHandle)
set_color(WindowHandle,'red')
read_image(Image,'monkey')
disp_image(Image,WindowHandle)
repeat
get_mposition(WindowHandle,Row,Column,Button)
get_grayval(Image,Row,Column,Gray)
write_string(WindowHandle,['  Position (',Row,',',Column,')  '])
write_string(WindowHandle,['Gray value (',Gray,')  '])
new_line(WindowHandle)
until(Button == 4)
close_window(WindowHandle)
clear_obj(Image)

open_textwindow(0,0,900,600,1,"black","slate blue","root","visible",
                "",&WindowHandle1) ;
open_textwindow(10,10,300,580,3,"red","blue",Father,"visible",
                "",&WindowHandle2) ;
open_window(10,320,570,580,Father,"visible","",&WindowHandle) ;
set_color(WindowHandle,"red") ;
read_image(&Image,"monkey") ;
disp_image(Image,WindowHandle) ;
create_tuple(&String,1) ;
do {
  get_mposition(WindowHandle,&Row,&Column,&Button) ;
  get_grayval(Image,Row,Column,&Gray) ;
  sprintf(buf,"Position( %d,%d ) ",Row,Column) ;
  set_s(String,buf,0) ;
  T_fwrite_string(String) ;
  new_line(WindowHandle) ;
}
while(Button < 4) ;
close_window(WindowHandle) ;
clear_obj(Image) ;

open_textwindow(0,0,900,600,1,'black','slate blue','root','visible', \
                '',WindowHandle)
open_textwindow(10,10,300,580,3,'red','blue',Father,'visible', \
                '',WindowHandle)
open_window(10,320,570,580,Father,'visible','',WindowHandle)
set_color(WindowHandle,'red')
read_image(Image,'monkey')
disp_image(Image,WindowHandle)
repeat
get_mposition(WindowHandle,Row,Column,Button)
get_grayval(Image,Row,Column,Gray)
write_string(WindowHandle,['  Position (',Row,',',Column,')  '])
write_string(WindowHandle,['Gray value (',Gray,')  '])
new_line(WindowHandle)
until(Button == 4)
close_window(WindowHandle)
clear_obj(Image)

open_textwindow(0,0,900,600,1,'black','slate blue','root','visible', \
                '',WindowHandle)
open_textwindow(10,10,300,580,3,'red','blue',Father,'visible', \
                '',WindowHandle)
open_window(10,320,570,580,Father,'visible','',WindowHandle)
set_color(WindowHandle,'red')
read_image(Image,'monkey')
disp_image(Image,WindowHandle)
repeat
get_mposition(WindowHandle,Row,Column,Button)
get_grayval(Image,Row,Column,Gray)
write_string(WindowHandle,['  Position (',Row,',',Column,')  '])
write_string(WindowHandle,['Gray value (',Gray,')  '])
new_line(WindowHandle)
until(Button == 4)
close_window(WindowHandle)
clear_obj(Image)

open_textwindow(0,0,900,600,1,'black','slate blue','root','visible', \
                '',WindowHandle)
open_textwindow(10,10,300,580,3,'red','blue',Father,'visible', \
                '',WindowHandle)
open_window(10,320,570,580,Father,'visible','',WindowHandle)
set_color(WindowHandle,'red')
read_image(Image,'monkey')
disp_image(Image,WindowHandle)
repeat
get_mposition(WindowHandle,Row,Column,Button)
get_grayval(Image,Row,Column,Gray)
write_string(WindowHandle,['  Position (',Row,',',Column,')  '])
write_string(WindowHandle,['Gray value (',Gray,')  '])
new_line(WindowHandle)
until(Button == 4)
close_window(WindowHandle)
clear_obj(Image)

open_textwindow(0,0,900,600,1,'black','slate blue','root','visible', \
                '',WindowHandle)
open_textwindow(10,10,300,580,3,'red','blue',Father,'visible', \
                '',WindowHandle)
open_window(10,320,570,580,Father,'visible','',WindowHandle)
set_color(WindowHandle,'red')
read_image(Image,'monkey')
disp_image(Image,WindowHandle)
repeat
get_mposition(WindowHandle,Row,Column,Button)
get_grayval(Image,Row,Column,Gray)
write_string(WindowHandle,['  Position (',Row,',',Column,')  '])
write_string(WindowHandle,['Gray value (',Gray,')  '])
new_line(WindowHandle)
until(Button == 4)
close_window(WindowHandle)
clear_obj(Image)

Result

If the values of the specified parameters are correct open_textwindowopen_textwindowOpenTextwindowopen_textwindowOpenTextwindowOpenTextwindow returns 2 (H_MSG_TRUE). If necessary an exception is raised.

Possible Predecessors

reset_obj_dbreset_obj_dbResetObjDbreset_obj_dbResetObjDbResetObjDb

Possible Successors

set_colorset_colorSetColorset_colorSetColorSetColor, query_window_typequery_window_typeQueryWindowTypequery_window_typeQueryWindowTypeQueryWindowType, get_window_typeget_window_typeGetWindowTypeget_window_typeGetWindowTypeGetWindowType, set_window_typeset_window_typeSetWindowTypeset_window_typeSetWindowTypeSetWindowType, get_mpositionget_mpositionGetMpositionget_mpositionGetMpositionGetMposition, set_tpositionset_tpositionSetTpositionset_tpositionSetTpositionSetTposition, set_tshapeset_tshapeSetTshapeset_tshapeSetTshapeSetTshape, set_window_extentsset_window_extentsSetWindowExtentsset_window_extentsSetWindowExtentsSetWindowExtents, get_window_extentsget_window_extentsGetWindowExtentsget_window_extentsGetWindowExtentsGetWindowExtents, query_colorquery_colorQueryColorquery_colorQueryColorQueryColor, set_checkset_checkSetCheckset_checkSetCheckSetCheck, set_systemset_systemSetSystemset_systemSetSystemSetSystem

Alternatives

open_windowopen_windowOpenWindowopen_windowOpenWindowOpenWindow

See also

write_stringwrite_stringWriteStringwrite_stringWriteStringWriteString, read_stringread_stringReadStringread_stringReadStringReadString, new_linenew_lineNewLinenew_lineNewLineNewLine, get_string_extentsget_string_extentsGetStringExtentsget_string_extentsGetStringExtentsGetStringExtents, get_tpositionget_tpositionGetTpositionget_tpositionGetTpositionGetTposition, set_colorset_colorSetColorset_colorSetColorSetColor, query_window_typequery_window_typeQueryWindowTypequery_window_typeQueryWindowTypeQueryWindowType, get_window_typeget_window_typeGetWindowTypeget_window_typeGetWindowTypeGetWindowType, set_window_typeset_window_typeSetWindowTypeset_window_typeSetWindowTypeSetWindowType, get_mpositionget_mpositionGetMpositionget_mpositionGetMpositionGetMposition, set_tpositionset_tpositionSetTpositionset_tpositionSetTpositionSetTposition, set_tshapeset_tshapeSetTshapeset_tshapeSetTshapeSetTshape, set_window_extentsset_window_extentsSetWindowExtentsset_window_extentsSetWindowExtentsSetWindowExtents, get_window_extentsget_window_extentsGetWindowExtentsget_window_extentsGetWindowExtentsGetWindowExtents, query_colorquery_colorQueryColorquery_colorQueryColorQueryColor, set_checkset_checkSetCheckset_checkSetCheckSetCheck, set_systemset_systemSetSystemset_systemSetSystemSetSystem

Module

Foundation