disp_textT_disp_textDispTextDispText (Operator)

Name

disp_textT_disp_textDispTextDispText — Display text in a window.

Signature

Description

disp_textdisp_textDispTextDispTextDispText displays text in the graphics window WindowHandleWindowHandleWindowHandleWindowHandlewindowHandle at the position (RowRowRowRowrow,ColumnColumnColumnColumncolumn).

If only a single position is defined, one text line is displayed for each element of StringStringStringStringstringVal. Also, '\n'"\n""\n""\n""\n" will be interpreted as a newline character, i.e., a line break is performed.

If multiple positions are defined, only a single string or one string for each position is allowed in StringStringStringStringstringVal. In this case, line breaks have to be forced with '\n'"\n""\n""\n""\n".

Newlines ('\n'"\n""\n""\n""\n") at the end of StringStringStringStringstringVal are ignored.

The position of the text may be specified in window coordinates (CoordSystemCoordSystemCoordSystemCoordSystemcoordSystem = 'window'"window""window""window""window") or in image coordinates (CoordSystemCoordSystemCoordSystemCoordSystemcoordSystem = 'image'"image""image""image""image"), which is useful when using zoomed images.

In addition to supplying (RowRowRowRowrow,ColumnColumnColumnColumncolumn) coordinates, it is also possible to pass predefined values to RowRowRowRowrow and ColumnColumnColumnColumncolumn to display the text at a fixed Position in the window (only if CoordSystemCoordSystemCoordSystemCoordSystemcoordSystem = 'window'"window""window""window""window").:

The parameter ColorColorColorColorcolor also accepts tuples of values. In that case, the specified colors are used cyclically for every new text position or for every new textline if a single position is used.

Generic Parameters

disp_textdisp_textDispTextDispTextDispText may display the StringStringStringStringstringVal within a box (default). This behavior and the look of the box are defined with the generic parameters in GenParamNameGenParamNameGenParamNameGenParamNamegenParamName and GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue.

'box'

If 'box'"box""box""box""box" is set to 'true'"true""true""true""true", the text is written within a box. The look of the box and its optional shadow can be configured with the generic parameters below.

possible values: 'true'"true""true""true""true" and 'false'"false""false""false""false"

default value: 'true'"true""true""true""true"

'box_color'

Sets the color of the box.

possible values: a string containing the color name (e.g. 'white'"white""white""white""white", 'red'"red""red""red""red", or '#aa00bba0'"#aa00bba0""#aa00bba0""#aa00bba0""#aa00bba0")

default value: '#fce9d4'"#fce9d4""#fce9d4""#fce9d4""#fce9d4" (which is a light orange)

'shadow'

If 'shadow'"shadow""shadow""shadow""shadow" is set to 'true'"true""true""true""true", an additional shadow is displayed beneath the box (if 'box'"box""box""box""box" is 'true'"true""true""true""true").

possible values: 'true'"true""true""true""true" and 'false'"false""false""false""false"

default value: 'true'"true""true""true""true" if 'box_color'"box_color""box_color""box_color""box_color" is set to a color without alpha value, 'false'"false""false""false""false" otherwise

'shadow_color'

Sets the color of the shadow if 'shadow'"shadow""shadow""shadow""shadow" is 'true'"true""true""true""true".

possible values: a string containing the color name (e.g. 'black'"black""black""black""black", 'red'"red""red""red""red", or '#aa00bba0'"#aa00bba0""#aa00bba0""#aa00bba0""#aa00bba0")

default value: '#f28d26'"#f28d26""#f28d26""#f28d26""#f28d26" (which is a darker orange) if 'box_color'"box_color""box_color""box_color""box_color" is not set, 'white'"white""white""white""white" otherwise

'border_radius'

Controls the roundness of the box's corners. For sharp corners set it to 0, for smoother corners to higher values.

possible values: positive real numbers or 0

default value: 2

'box_padding'

Controls to which amount in pixels the box is extended around the text.

possible values: positive real number

default value: 0

'shadow_sigma'

Controls to which amount the shadow beneath the box is blurred. Set it to 0 for a sharp shadow.

possible values: positive real number or 0

default value: 1.5

'shadow_dx' and 'shadow_dy'

Controls the offset of the shadow in column ('shadow_dx'"shadow_dx""shadow_dx""shadow_dx""shadow_dx") and row ('shadow_dy'"shadow_dy""shadow_dy""shadow_dy""shadow_dy") direction in pixels.

possible values: any real number

default_value: 2

Attention

disp_textdisp_textDispTextDispTextDispText depends on the library libcanvas, which might not be available on embedded systems.

Execution Information

• Multithreading type: reentrant (runs in parallel with non-exclusive operators).
• Multithreading scope: global (may be called from any thread).
• Processed without parallelization.

Parameters

Example (HDevelop)

dev_open_window (0, 0, 512, 512, 'black', WindowHandle)
disp_text (WindowHandle, 'Display some text in a box', 'window', 12, 12, \
           'black', [], [])

Possible Predecessors

open_windowopen_windowOpenWindowOpenWindowOpenWindow, set_fontset_fontSetFontSetFontSetFont, get_string_extentsget_string_extentsGetStringExtentsGetStringExtentsGetStringExtents

Alternatives

write_stringwrite_stringWriteStringWriteStringWriteString

See also

get_string_extentsget_string_extentsGetStringExtentsGetStringExtentsGetStringExtents, set_fontset_fontSetFontSetFontSetFont

Module

Foundation