Operator Reference

query_insertT_query_insertQueryInsertQueryInsertquery_insert (Operator)

query_insertT_query_insertQueryInsertQueryInsertquery_insert — Query the possible graphic modes.

Warning

query_insertquery_insertQueryInsertQueryInsertquery_insert is obsolete and is only provided for reasons of backward compatibility.

Signature

query_insert( : : WindowHandle : Mode)

Herror T_query_insert(const Htuple WindowHandle, Htuple* Mode)

void QueryInsert(const HTuple& WindowHandle, HTuple* Mode)

HTuple HWindow::QueryInsert() const

static void HOperatorSet.QueryInsert(HTuple windowHandle, out HTuple mode)

HTuple HWindow.QueryInsert()

def query_insert(window_handle: HHandle) -> Sequence[str]

Description

query_insertquery_insertQueryInsertQueryInsertquery_insert returns the possible modes pixels can be displayed in the output window. New pixels may e.g., overwrite old ones. In most of the cases there is a functional relationship between old and new values.

Possible display functions:

'copy'"copy""copy""copy""copy":

overwrite displayed pixels

'xor'"xor""xor""xor""xor":

display old “xor” new pixels

'complement'"complement""complement""complement""complement":

complement displayed pixels

“copy” is always available.

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.

ModeModeModemodemode (output_control)  string-array HTupleSequence[str]HTupleHtuple (string) (string) (HString) (char*)

Display function name.

Result

query_insertquery_insertQueryInsertQueryInsertquery_insert returns 2 ( H_MSG_TRUE) , if the window is valid. Otherwise an exception is raised.

Possible Successors

set_insertset_insertSetInsertSetInsertset_insert, disp_regiondisp_regionDispRegionDispRegiondisp_region

See also

set_insertset_insertSetInsertSetInsertset_insert, get_insertget_insertGetInsertGetInsertget_insert

Module

Foundation