Skip to content

get_iconGetIconGetIconget_iconT_get_icon🔗

Short description🔗

get_iconGetIconGetIconget_iconT_get_icon — Query the icon for region output

Signature🔗

get_icon( out region Icon, window WindowHandle )void GetIcon( HObject* Icon, const HTuple& WindowHandle )static void HOperatorSet.GetIcon( out HObject icon, HTuple windowHandle )def get_icon( window_handle: HHandle ) -> HObject

Herror T_get_icon( Hobject* Icon, const Htuple WindowHandle )

void HRegion::GetIcon( const HWindow& WindowHandle )

HRegion HWindow::GetIcon( ) const

void HRegion.GetIcon( HWindow windowHandle )

HRegion HWindow.GetIcon( )

Description🔗

get_iconGetIcon queries the icon that was set with set_iconSetIcon.

Execution information🔗

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🔗

Iconiconicon (output_object) region → objectHObjectHRegionHObjectHobject *

Icon for the regions center of gravity.

WindowHandlewindowHandlewindow_handle (input_control) window → (handle)HTuple (HHandle)HWindow, HTuple (IntPtr)HHandleHtuple (handle)

Window handle.

Example🔗

(C)

/* draw a region and an icon.  */
/* set it and get it again.    */
T_draw_region(&Region,WindowHandle)\;
T_draw_region(&Icon,WindowHandle)\;
set_icon(Icon)\;
create_tuple_s(&icon,"icon")\;
T_set_shape(WindowHandle,icon)\;
destroy_tuple(icon)\;
T_disp_region(Region,WindowHandle)\;
get_icon(&OldIcon)\;
T_disp_region(OldIcon,WindowHandle)\;

Result🔗

get_iconGetIcon always returns 2 (H_MSG_TRUE).

Combinations with other operators🔗

Combinations

Possible predecessors

set_iconSetIcon

Possible successors

disp_regionDispRegion

Module🔗

Foundation