Product Documentation
Cadence SKILL Development Reference
Product Version IC23.1, June 2023

ilgSetHighlight

ilgSetHighlight( 
l_location_begin
l_location_end
t_color
[ ?fullWidth g_fullWidth ]
[ w_tab ]
) 
=> l_highlightID / nil

Description

Highlights the area within l_location_begin and l_location_end in the color specified by t_color.

Arguments

l_location_begin

Begin location (x_column x_row) of the area to be highlighted.

l_location_end

End location (x_column x_row) of the area to be highlighted.

t_color

A string representing the color name, which can either be a predefined color (for Examples, Highlight[1-5]) set by ilgSetColor or a color value understood by QT.

?fullWidth g_fullWidth

When set to t, the entire line is highlighted. The default value is nil.

w_tab

The window ID of the SKILL IDE editor window.

The default is the current tab window.

Value Returned

l_highlightID

A list representing the highlight operation; this value can be passed to ilgResetHighlight().

nil

The highlight operation fails.

Examples

ilgSetHighlight('(4 11) '(18 12) "orange")
=> (nil l1 (4 11) l2 (18 12)
color "orange" fullWidth nil)
;highlights the area between (4 11) and (18 12)
ilgSetHighlight('(5 22) '(15 24) "forest green" ?fullWidth t)
=> (nil l1 (5 22) l2 (15 24)
color “forest green” fullWidth t
)
;highlights the entire line starting at (5 22)

Related Topics

SKILL IDE Functions


Return to top
 ⠀
X