MouseModeAPI.setSelectRectMode

 

void setSelectRectMode(bool isSynchronous)

This method sets the state of the SDM such that the user can click and drag a rectangle.

The client using isSynchronous = TRUE must test for completion of the operation (as described in the discussion Synchronous vs. Asynchronous Response). When isSynchronousOpComplete returns TRUE, the client must call getSWx, getSWy, getNEx, and getNEy to obtain the coordinates of the Southwest and Northeast corners of the rectangle.

The client using isSynchronous = FALSE, must have previously identified itself to the MouseModeAPI object and exposed the method receiveUserRect (see Synchronous vs. Asynchronous Response), to which the rectangle is provided via arguments.

Migration note for v2.5 developers: setSelectRectMode corresponds to getUserRect or setSendUserRect when used synchronously or asynchronously, respectively