# mouse.screenArea 库模块帮助文档

## mouse 成员列表 <a id="mouse" href="#mouse">&#x23;</a>

### mouse.screenArea <a id="mouse.screenArea" href="#mouse.screenArea">&#x23;</a>
屏幕选区工具

创建屏幕选区工具,  
如果已打开屏幕选区则返回 null

### mouse.screenArea() <a id="mouse.screenArea" href="#mouse.screenArea">&#x23;</a>
[返回对象:MouseScreenAreaObject](#MouseScreenAreaObject)

### mouse.screenArea(winform) <a id="mouse.screenArea" href="#mouse.screenArea">&#x23;</a>
参数 @1 指定父窗口

## MouseScreenAreaObject 成员列表 <a id="MouseScreenAreaObject" href="#MouseScreenAreaObject">&#x23;</a>

### MouseScreenAreaObject.close() <a id="MouseScreenAreaObject.close" href="#MouseScreenAreaObject.close">&#x23;</a>
关闭创建屏幕选区工具

### MouseScreenAreaObject.doModal(/*请指定所有者窗口\n可省略此参数*/) <a id="MouseScreenAreaObject.doModal" href="#MouseScreenAreaObject.doModal">&#x23;</a>
此函数创建屏幕选区工具并显示为模态对话框，  

模态对话框应是独立窗口，并显示在所有者窗口前面。  

模态对话框会自己创建自己的消息循环，  
并阻止调用模态对话框的代码继续向后运行 - 直到模态对话框被关闭。

### MouseScreenAreaObject.endModal(请指定模态对话框返回值) <a id="MouseScreenAreaObject.endModal" href="#MouseScreenAreaObject.endModal">&#x23;</a>
关闭模态对话框，  
调用 endModal 函数的参数会被设置为 doModal 函数的返回值。

### MouseScreenAreaObject.mask <a id="MouseScreenAreaObject.mask" href="#MouseScreenAreaObject.mask">&#x23;</a>
遮罩窗口，这是一个 plus 控件对象。  

[返回对象:uiCtrlPlusObject](https://www.aardio.com/zh-cn/doc/library-reference/win/ui/ctrl/plus.html#uiCtrlPlusObject)

### MouseScreenAreaObject.show(false) <a id="MouseScreenAreaObject.show" href="#MouseScreenAreaObject.show">&#x23;</a>
隐藏创建屏幕选区工具

### MouseScreenAreaObject.show(true) <a id="MouseScreenAreaObject.show" href="#MouseScreenAreaObject.show">&#x23;</a>
显示创建屏幕选区工具

## MouseScreenAreaObject 事件列表 <a id="MouseScreenAreaObjectEvent" href="#MouseScreenAreaObjectEvent">&#x23;</a>

### MouseScreenAreaObject.onBitmapReady(bitmap) <a id="MouseScreenAreaObject.onBitmapReady" href="#MouseScreenAreaObject.onBitmapReady">&#x23;</a>

```aardio
MouseScreenAreaObject.onBitmapReady = function(bitmap){
	/*bitmap 为表示当前选区截图得到的 gdip.bitmap 对象。  
只能定义 onBufferReady,onBufferReady,onSelectionChanged 其中一个回调函数。 */
	bitmap.dispose();
	owner.endModal(true);	
}
```

### MouseScreenAreaObject.onBufferReady(pngBuffer) <a id="MouseScreenAreaObject.onBufferReady" href="#MouseScreenAreaObject.onBufferReady">&#x23;</a>

```aardio
MouseScreenAreaObject.onBufferReady = function(pngBuffer){
	/*pngBuffer 为表示当前选区截图得到的 png 图像数据（buffer 对象）。  
只能定义 onBufferReady,onBufferReady,onSelectionChanged 其中一个回调函数。 */

	owner.endModal(true);	
}
```

### MouseScreenAreaObject.onSelectionChanged(rc) <a id="MouseScreenAreaObject.onSelectionChanged" href="#MouseScreenAreaObject.onSelectionChanged">&#x23;</a>

```aardio
MouseScreenAreaObject.onSelectionChanged = function(rc){
	/*rc 为表示当前选区的 ::RECT 结构体。  
只能定义 onBufferReady,onBufferReady,onSelectionChanged 其中一个回调函数。*/
	owner.endModal(true);
}
```

