set_coloredT_set_coloredSetColoredSetColoredset_colored (Operator)

Name

set_coloredT_set_coloredSetColoredSetColoredset_colored — Set multiple output colors.

Signature

set_colored( : : WindowHandle, NumberOfColors : )

Herror T_set_colored(const Htuple WindowHandle, const Htuple NumberOfColors)

void SetColored(const HTuple& WindowHandle, const HTuple& NumberOfColors)

void HWindow::SetColored(Hlong NumberOfColors) const

static void HOperatorSet.SetColored(HTuple windowHandle, HTuple numberOfColors)

void HWindow.SetColored(int numberOfColors)

def set_colored(window_handle: HHandle, number_of_colors: int) -> None

Description

set_coloredset_coloredSetColoredSetColoredSetColoredset_colored is a shortcut for certain set_colorset_colorSetColorSetColorSetColorset_color calls. It allows the user to display a region set in different colors. NumberOfColorsNumberOfColorsNumberOfColorsNumberOfColorsnumberOfColorsnumber_of_colors defines the number of colors that are used. Valid values for NumberOfColorsNumberOfColorsNumberOfColorsNumberOfColorsnumberOfColorsnumber_of_colors can be queried with query_coloredquery_coloredQueryColoredQueryColoredQueryColoredquery_colored.

Execution Information

Parameters

WindowHandleWindowHandleWindowHandleWindowHandlewindowHandlewindow_handle (input_control)  window HWindow, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Window handle.

NumberOfColorsNumberOfColorsNumberOfColorsNumberOfColorsnumberOfColorsnumber_of_colors (input_control)  integer HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Number of output colors.

Default value: 12

List of values: 3, 6, 12

Result

set_coloredset_coloredSetColoredSetColoredSetColoredset_colored returns TRUE if NumberOfColorsNumberOfColorsNumberOfColorsNumberOfColorsnumberOfColorsnumber_of_colors is correct and the window is valid. Otherwise an exception is raised.

Possible Predecessors

query_coloredquery_coloredQueryColoredQueryColoredQueryColoredquery_colored, set_colorset_colorSetColorSetColorSetColorset_color

Possible Successors

disp_regiondisp_regionDispRegionDispRegionDispRegiondisp_region

See also

query_coloredquery_coloredQueryColoredQueryColoredQueryColoredquery_colored, set_colorset_colorSetColorSetColorSetColorset_color, disp_regiondisp_regionDispRegionDispRegionDispRegiondisp_region

Module

Foundation