Operator Reference

query_shapeT_query_shapeQueryShapeQueryShapequery_shape (Operator)

query_shapeT_query_shapeQueryShapeQueryShapequery_shape — Query the region display modes.

Signature

query_shape( : : : DisplayShape)

Herror T_query_shape(Htuple* DisplayShape)

void QueryShape(HTuple* DisplayShape)

static HTuple HInfo::QueryShape()

static void HOperatorSet.QueryShape(out HTuple displayShape)

static HTuple HInfo.QueryShape()

def query_shape() -> Sequence[str]

Description

query_shapequery_shapeQueryShapeQueryShapequery_shape returns the names of all region display modes (e.g., 'original', 'circle', 'rectangle1', 'rectangle2', 'ellipse', etc.) for the window. They are used by set_shapeset_shapeSetShapeSetShapeset_shape.

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

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

region display mode names.

Result

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

Possible Successors

get_shapeget_shapeGetShapeGetShapeget_shape, set_shapeset_shapeSetShapeSetShapeset_shape, disp_regiondisp_regionDispRegionDispRegiondisp_region

See also

set_shapeset_shapeSetShapeSetShapeset_shape, get_shapeget_shapeGetShapeGetShapeget_shape, disp_regiondisp_regionDispRegionDispRegiondisp_region

Module

Foundation