query_shapeT_query_shapeQueryShapeQueryShapequery_shape (Operator)
Name
query_shapeT_query_shapeQueryShapeQueryShapequery_shape — Query the region display modes.
Signature
def query_shape() -> Sequence[str]
Description
query_shapequery_shapeQueryShapeQueryShapeQueryShapequery_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_shapeSetShapeSetShapeSetShapeset_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
DisplayShapeDisplayShapeDisplayShapeDisplayShapedisplayShapedisplay_shape (output_control) string-array → HTupleSequence[str]HTupleHtuple (string) (string) (HString) (char*)
region display mode names.
Result
query_shapequery_shapeQueryShapeQueryShapeQueryShapequery_shape returns 2 (H_MSG_TRUE), if the window is valid.
Otherwise an exception is raised.
Possible Successors
get_shapeget_shapeGetShapeGetShapeGetShapeget_shape,
set_shapeset_shapeSetShapeSetShapeSetShapeset_shape,
disp_regiondisp_regionDispRegionDispRegionDispRegiondisp_region
See also
set_shapeset_shapeSetShapeSetShapeSetShapeset_shape,
get_shapeget_shapeGetShapeGetShapeGetShapeget_shape,
disp_regiondisp_regionDispRegionDispRegionDispRegiondisp_region
Module
Foundation