Skip to content

query_shapeQueryShapeQueryShapequery_shapeT_query_shape🔗

Short description🔗

query_shapeQueryShapeQueryShapequery_shapeT_query_shape — Query the region display modes.

Signature🔗

query_shape( out string DisplayShape )void QueryShape( HTuple* DisplayShape )static void HOperatorSet.QueryShape( out HTuple displayShape )def query_shape( ) -> Sequence[str]

Herror T_query_shape( Htuple* DisplayShape )

static HTuple HInfo::QueryShape( )

static HTuple HInfo.QueryShape( )

Description🔗

query_shapeQueryShape returns the names of all region display modes (e.g., ‘original’, ‘circle’, ‘rectangle1’, ‘rectangle2’, ‘ellipse’, etc.) for the window. They are used by set_shapeSetShape.

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🔗

DisplayShapedisplayShapedisplay_shape (output_control) string-array → (string)HTuple (HString)HTuple (string)Sequence[str]Htuple (char*)

region display mode names.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible successors

get_shapeGetShape, set_shapeSetShape, disp_regionDispRegion

See also

set_shapeSetShape, get_shapeGetShape, disp_regionDispRegion

Module🔗

Foundation