Operator Reference

set_window_extentsT_set_window_extentsSetWindowExtentsSetWindowExtentsset_window_extents (Operator)

set_window_extentsT_set_window_extentsSetWindowExtentsSetWindowExtentsset_window_extents — Modify position and size of a window.

Signature

set_window_extents( : : WindowHandle, Row, Column, Width, Height : )

Herror T_set_window_extents(const Htuple WindowHandle, const Htuple Row, const Htuple Column, const Htuple Width, const Htuple Height)

void SetWindowExtents(const HTuple& WindowHandle, const HTuple& Row, const HTuple& Column, const HTuple& Width, const HTuple& Height)

void HWindow::SetWindowExtents(Hlong Row, Hlong Column, Hlong Width, Hlong Height) const

static void HOperatorSet.SetWindowExtents(HTuple windowHandle, HTuple row, HTuple column, HTuple width, HTuple height)

void HWindow.SetWindowExtents(int row, int column, int width, int height)

def set_window_extents(window_handle: HHandle, row: int, column: int, width: int, height: int) -> None

Description

set_window_extentsset_window_extentsSetWindowExtentsSetWindowExtentsset_window_extents positions the upper left corner of the output window at (RowRowRowrowrow,ColumnColumnColumncolumncolumn) and changes the size of the window to WidthWidthWidthwidthwidth and HeightHeightHeightheightheight at the same time. Negative values for WidthWidthWidthwidthwidth and HeightHeightHeightheightheight are ignored.

Adapting the size of the window to the size of the image part to be displayed will prevent slowing down the display due to necessary interpolations. Thus, the window preferably has the same size as the image part to be displayed, or otherwise half its size, quarter its size, etc.

Attention

Modifying the size of the window does not automatically redraw the window contents. This has to be done by the program by redisplaying the desired data.

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

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

Window handle.

RowRowRowrowrow (input_control)  rectangle.origin.y HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Row index of upper left corner in target position.

Default: 0

Value range: Row Row Row row row (lin)

Minimum increment: 1

Recommended increment: 1

ColumnColumnColumncolumncolumn (input_control)  rectangle.origin.x HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Column index of upper left corner in target position.

Default: 0

Value range: Column Column Column column column (lin)

Minimum increment: 1

Recommended increment: 1

WidthWidthWidthwidthwidth (input_control)  rectangle.extent.x HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Width of the window.

Default: 512

Value range: Width Width Width width width (lin)

Minimum increment: 1

Recommended increment: 1

HeightHeightHeightheightheight (input_control)  rectangle.extent.y HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Height of the window.

Default: 512

Value range: Height Height Height height height (lin)

Minimum increment: 1

Recommended increment: 1

Result

If the window is valid and the parameters are correct set_window_extentsset_window_extentsSetWindowExtentsSetWindowExtentsset_window_extents returns 2 ( H_MSG_TRUE) . If necessary an exception is raised.

Possible Predecessors

open_windowopen_windowOpenWindowOpenWindowopen_window

See also

get_window_extentsget_window_extentsGetWindowExtentsGetWindowExtentsget_window_extents, open_windowopen_windowOpenWindowOpenWindowopen_window

Module

Foundation