xbot.win32.Image
この記事の内容
画像の表示/消失の待機、画像のクリック、画像上へのマウスカーソルの移動など、画像に対する一般的な処理を行います。
メソッド
wait_appear()
現在の画面で、画像ライブラリと一致する画像が表示されるまで待機します。
wait_appear(image_selectors , wait_all=False, timeout=20)
入力パラメータ
image_selectors:画像セレクターです。次の形式に対応しています。
- 'img' または package.image_selector('img')
- ['img1', 'img2'] または [package.image_selector('img1'),package.image_selector('img2')]
注 :上記の 'img'、'img1'、'img2' は、いずれも画像ライブラリ内の画像の名称です。
wait_all:対象のすべての画像が表示されるまで待機してから実行するかどうかを指定します。デフォルト値はFalseです(すべての画像が表示されるまで待機しません)。
timeout:対象画像の表示を待機する際のタイムアウト時間です。デフォルトの待機時間は20sです。
戻り値
bool:指定した待機時間内に対象要素が表示された場合はTrueを返し、それ以外の場合はFalseを返します。
例1
from xbot import win32
def main(args):
appear = win32.image.wait_appear("图像1")
この例の実行ロジック: 現在の画面で、画像セレクター 图像1 と一致する画像が表示されるまで待機します。
wait_appear_from_window()
現在アクティブなウィンドウで、画像セレクターと一致する画像が表示されるまで待機します。
wait_appear_from_window(hWnd, image_selectors, wait_all=False, timeout=20)
入力パラメータ
hWnd:対象ウィンドウのハンドルです。
image_selectors:画像セレクターです。次の形式に対応しています。
- 'img' または package.image_selector('img')
- ['img1', 'img2'] または [package.image_selector('img1'),package.image_selector('img2')]
注 :上記の 'img'、'img1'、'img2' は、いずれも画像ライブラリ内の画像の名称です。
wait_all:対象のすべての画像が表示されるまで待機してから実行するかどうかを指定します。デフォルト値はFalseです(すべての画像が表示されるまで待機しません)。
timeout:対象画像の表示を待機する際のタイムアウト時間です。デフォルトの待機時間は20sです。
戻り値
bool:指定した待機時間内に対象要素が表示された場合はTrueを返し、それ以外の場合はFalseを返します。
例1
from xbot import win32
from . import package
def main(args):
hWnd = win32.get('新建文本').hWnd
appear = win32.image.wait_appear_from_window(hWnd, "图像1")
この例の実行ロジック: ウィンドウタイトルが 新建文本 のウィンドウハンドルを取得します --> 現在の画面で、画像セレクター 图像1 と一致する画像が表示されるまで待機します。
wait_disappear()
現在の画面で、画像セレクターと一致する画像が消失するまで待機します。
wait_disappear(image_selectors , wait_all=False, timeout=20)
入力パラメータ
image_selectors:画像セレクターです。次の形式に対応しています。
- 'img' または package.image_selector('img')
- ['img1', 'img2'] または [package.image_selector('img1'),package.image_selector('img2')]
注 :上記の 'img'、'img1'、'img2' は、いずれも画像ライブラリ内の画像の名称です。
wait_all:対象のすべての画像が消失するまで待機してから実行するかどうかを指定します。デフォルト値はFalseです(すべての画像が表示されるまで待機しません)。
timeout:対象画像の消失を待機する際のタイムアウト時間です。デフォルトの待機時間は20sです。
戻り値
bool:指定した待機時間内に対象要素が消失した場合はTrueを返し、それ以外の場合はFalseを返します。
例1
現在の画面で、画像セレクター 图像1 と一致する画像が消失するまで待機します。
from xbot import win32
def main(args):
appear = win32.image.wait_disappear('图像1')
この例の実行ロジック: 現在の画面で、画像セレクター 图像1 と一致する画像が消失するまで待機します。
wait_disappear_from_window()
現在アクティブなウィンドウで、画像セレクターと一致する画像が消失するまで待機します。
wait_disappear_from_window(hWnd, image_selectors, wait_all=False , timeout=20)
入力パラメータ
hWnd:対象ウィンドウのハンドルです。
image_selectors:画像セレクターです。次の形式に対応しています。
- 'img' または package.image_selector('img')
- ['img1', 'img2'] または [package.image_selector('img1'),package.image_selector('img2')]
注 :上記の 'img'、'img1'、'img2' は、いずれも画像ライブラリ内の画像の名称です。
wait_all:対象のすべての画像が消失するまで待機してから実行するかどうかを指定します。デフォルト値はFalseです(すべての画像が表示されるまで待機しません)。
timeout:対象画像の消失を待機する際のタイムアウト時間です。デフォルトの待機時間は20sです。
戻り値
bool:指定した待機時間内に対象要素が消失した場合はTrueを返し、それ以外の場合はFalseを返します。
例1
現在アクティブなウィンドウで、画像セレクター 图像1 と一致する画像が消失するまで待機します。
from xbot import win32
def main(args):
hWnd = win32.get('新建文本').hWnd
appear = win32.image.wait_disappear_from_window(hWnd, "图像1")
この例の実行ロジック: ウィンドウタイトルが 新建文本 のウィンドウハンドルを取得します --> 現在の画面で、画像セレクター 图像1 と一致する画像が表示されるまで待機します。
hover()
現在の画面で、画像セレクターと一致する画像を検索し、その上にマウスカーソルをホバーさせます。
hover(image_selectors , anchor=None)
入力パラメータ
image_selectors:画像セレクターです。次の形式に対応しています。
- 'img' または package.image_selector('img')
- ['img1', 'img2'] または [package.image_selector('img1'),package.image_selector('img2')]
注 :上記の 'img'、'img1'、'img2' は、いずれも画像ライブラリ内の画像の名称です。
anchor:アンカーです。マウスで要素をクリックする位置とオフセットを表すタプルで、Noneを指定できます。デフォルト値はNoneです(対象の中心をオフセットなしでクリックします)。パラメータの構造は次のとおりです。
sudoku_part:マウスカーソルをホバーさせる位置です。デフォルトでは中心にホバーさせます。
|パラメータの内容|説明|
|:---|:---|
|'topLeft'|左上隅にホバーさせます|
|'topCenter'|上部中央にホバーさせます|
|'topRight'|右上隅にホバーさせます|
|'middleLeft'|左側中央にホバーさせます|
|'middleCenter'|中心にホバーさせます|
|'middleRight'|右側中央にホバーさせます|
|'bottomLeft'|左下隅にホバーさせます|
|'bottomCenter'|下部中央にホバーさせます|
|'bottomRight'|右下隅にホバーさせます|
offset_x:マウスカーソル位置の水平方向のオフセットです。
offset_y:マウスカーソル位置の垂直方向のオフセットです。
戻り値
なし
例1
from xbot import win32
def main(args):
win32.image.hover('图像1', anchor=('middleCenter', 100, 100))
この例の実行ロジック: 現在の画面に表示された、画像セレクター 图像1 と一致する画像を検索し、対象画像の中央にマウスカーソルをホバーさせます。マウス座標の水平方向と垂直方向のオフセットはいずれも100です。
hover_on_window()
現在の画面で、画像セレクターと一致する画像を検索し、その上にマウスカーソルをホバーさせます。
hover_on_window(hWnd, image_selectors , anchor=None)
入力パラメータ
hWnd:対象ウィンドウのハンドルです。
image_selectors:画像セレクターです。次の形式に対応しています。
- 'img' または package.image_selector('img')
- ['img1', 'img2'] または [package.image_selector('img1'),package.image_selector('img2')]
注 :上記の 'img'、'img1'、'img2' は、いずれも画像ライブラリ内の画像の名称です。
anchor:アンカーです。マウスで要素をクリックする位置とオフセットを表すタプルで、Noneを指定できます。デフォルト値はNoneです(対象の中心をオフセットなしでクリックします)。パラメータの構造は次のとおりです。
sudoku_part:マウスカーソルをホバーさせる位置です。デフォルトでは中心にホバーさせます。
|パラメータの内容|説明|
|:---|:---|
|'topLeft'|左上隅にホバーさせます|
|'topCenter'|上部中央にホバーさせます|
|'topRight'|右上隅にホバーさせます|
|'middleLeft'|左側中央にホバーさせます|
|'middleCenter'|中心にホバーさせます|
|'middleRight'|右側中央にホバーさせます|
|'bottomLeft'|左下隅にホバーさせます|
|'bottomCenter'|下部中央にホバーさせます|
|'bottomRight'|右下隅にホバーさせます|
offset_x:マウスカーソル位置の水平方向のオフセットです。
offset_y:マウスカーソル位置の垂直方向のオフセットです。
戻り値
なし
例1
from xbot import win32
def main(args):
hWnd = win32.get('新建文本').hWnd
win32.image.hover_on_window(hWnd, '图像1', anchor=('middleCenter', 100, 100))
この例の実行ロジック: ウィンドウタイトルが 新建文本 のウィンドウハンドルを取得します --> 現在アクティブなウィンドウに表示された、画像セレクター 图像1 と一致する画像を検索し、対象画像の中央にマウスカーソルをホバーさせます。マウス座標の水平方向と垂直方向のオフセットはいずれも100です。
click()
現在の画面で、画像セレクターに類似する画像を検索し、シングルクリックします。
click(image_selectors , anchor=None, button='left', keys='none', move_mouse=True)
入力パラメータ
image_selectors:画像セレクターです。次の形式に対応しています。
- 'img' または package.image_selector('img')
- ['img1', 'img2'] または [package.image_selector('img1'),package.image_selector('img2')]
anchor:アンカーです。マウスで要素をクリックする位置とオフセットを表すタプルで、Noneを指定できます。デフォルト値はNoneです(対象の中心をオフセットなしでクリックします)。パラメータの構造は次のとおりです。
sudoku_part:マウスカーソルをホバーさせる位置です。デフォルトでは中心にホバーさせます。
|パラメータの内容|説明|
|:---|:---|
|'topLeft'|左上隅にホバーさせます|
|'topCenter'|上部中央にホバーさせます|
|'topRight'|右上隅にホバーさせます|
|'middleLeft'|左側中央にホバーさせます|
|'middleCenter'|中心にホバーさせます|
|'middleRight'|右側中央にホバーさせます|
|'bottomLeft'|左下隅にホバーさせます|
|'bottomCenter'|下部中央にホバーさせます|
|'bottomRight'|右下隅にホバーさせます|
offset_x:マウスカーソル位置の水平方向のオフセットです。
offset_y:マウスカーソル位置の垂直方向のオフセットです。
button:シングルクリック時に押下するマウスのボタンです。'left'(マウスの左ボタン)または 'right'(マウスの右ボタン)を指定できます。デフォルトは 'left' です。
keys:マウスクリック時の修飾キー入力です。使用できる修飾キーの指定値はnone、alt、ctrl、shift、winです。デフォルトは 'none' です。
move_mouse:マウスの移動軌跡を表示するかどうかを指定します。デフォルト値はTrueです(マウスの移動軌跡を表示します)。
戻り値
なし
例1
from xbot import win32
def main(args):
win32.image.click('图像1', anchor=('middleCenter', 100, 100),
button='left', keys='alt', move_mouse=True)
この例の実行ロジック: 現在の画面に表示された、画像セレクター 图像1 と一致する画像を検索し、マウスの左ボタンで画像の中央をクリックします。マウスクリック座標の水平方向と垂直方向のオフセットはいずれも100です。クリックと同時に修飾キーの Alt キーを押下し、マウスの移動軌跡を表示します。
click_on_window()
現在アクティブなウィンドウで、画像セレクターに類似する画像を検索し、シングルクリックします。
click_on_window(hWnd, image_selectors, anchor=None, button='left', keys='none', move_mouse=True)
入力パラメータ
hWnd:対象ウィンドウのハンドルです。
image_selectors:画像セレクターです。次の形式に対応しています。
- 'img' または package.image_selector('img')
- ['img1', 'img2'] または [package.image_selector('img1'),package.image_selector('img2')]
anchor:アンカーです。マウスで要素をクリックする位置とオフセットを表すタプルで、Noneを指定できます。デフォルト値はNoneです(対象の中心をオフセットなしでクリックします)。パラメータの構造は次のとおりです。
sudoku_part:マウスカーソルをホバーさせる位置です。デフォルトでは中心にホバーさせます。
|パラメータの内容|説明|
|:---|:---|
|'topLeft'|左上隅にホバーさせます|
|'topCenter'|上部中央にホバーさせます|
|'topRight'|右上隅にホバーさせます|
|'middleLeft'|左側中央にホバーさせます|
|'middleCenter'|中心にホバーさせます|
|'middleRight'|右側中央にホバーさせます|
|'bottomLeft'|左下隅にホバーさせます|
|'bottomCenter'|下部中央にホバーさせます|
|'bottomRight'|右下隅にホバーさせます|
offset_x:マウスカーソル位置の水平方向のオフセットです。
offset_y:マウスカーソル位置の垂直方向のオフセットです。
button:シングルクリック時に押下するマウスのボタンです。'left'(マウスの左ボタン)または 'right'(マウスの右ボタン)を指定できます。デフォルトは 'left' です。
keys:マウスクリック時の修飾キー入力です。使用できる修飾キーの指定値はnone、alt、ctrl、shift、winです。デフォルトは 'none' です。
戻り値
なし
例1
from xbot import win32
from .package import *
def main(args):
hWnd = win32.get('新建文本').hWnd
win32.image.click_on_window(hWnd, '图像1', anchor=('middleCenter', 100, 100),
button='left', keys='alt', move_mouse=True)
この例の実行ロジック: ウィンドウタイトルが 新建文本 のウィンドウハンドルを取得します --> 現在アクティブなウィンドウに表示された、画像セレクター 图像1 と一致する画像を検索し、マウスの左ボタンで画像の中央をクリックします。マウスクリック座標の水平方向と垂直方向のオフセットはいずれも100です。クリックと同時に修飾キーの Alt キーを押下し、マウスの移動軌跡を表示します。
dblclick()
現在の画面で、画像セレクターに類似する画像を検索し、ダブルクリックします。
dblclick(image_selectors , anchor=None, move_mouse=True)
入力パラメータ
image_selectors:画像セレクターです。次の形式に対応しています。
- 'img' または package.image_selector('img')
- ['img1', 'img2'] または [package.image_selector('img1'),package.image_selector('img2')]
anchor:アンカーです。マウスで要素をクリックする位置とオフセットを表すタプルで、Noneを指定できます。デフォルト値はNoneです(対象の中心をオフセットなしでクリックします)。パラメータの構造は次のとおりです。
sudoku_part:マウスカーソルをホバーさせる位置です。デフォルトでは中心にホバーさせます。
|パラメータの内容|説明|
|:---|:---|
|'topLeft'|左上隅にホバーさせます|
|'topCenter'|上部中央にホバーさせます|
|'topRight'|右上隅にホバーさせます|
|'middleLeft'|左側中央にホバーさせます|
|'middleCenter'|中心にホバーさせます|
|'middleRight'|右側中央にホバーさせます|
|'bottomLeft'|左下隅にホバーさせます|
|'bottomCenter'|下部中央にホバーさせます|
|'bottomRight'|右下隅にホバーさせます|
offset_x:マウスカーソル位置の水平方向のオフセットです。
offset_y:マウスカーソル位置の垂直方向のオフセットです。
move_mouse:マウスの移動軌跡を表示するかどうかを指定します。デフォルト値はTrueです(マウスの移動軌跡を表示します)。
戻り値
なし
例1
from xbot import win32
def main(args):
win32.image.dblclick('图像1', anchor=('middleCenter', 100, 100), move_mouse=True)
この例の実行ロジック: 現在の画面に表示された、画像セレクター 图像1 と一致する画像を検索し、マウスで画像の中央をダブルクリックします。マウスのダブルクリック座標の水平方向と垂直方向のオフセットはいずれも100です。マウスの移動軌跡を表示します。
dblclick_on_window()
現在アクティブなウィンドウで、画像セレクターに類似する画像を検索し、ダブルクリックします。
dblclick_on_window(hWnd, image_selectors, * , anchor=None, move_mouse=True)
入力パラメータ
hWnd:対象ウィンドウのハンドルです。
image_selectors:画像セレクターです。次の形式に対応しています。
- 'img' または package.image_selector('img')
- ['img1', 'img2'] または [package.image_selector('img1'),package.image_selector('img2')]
anchor:アンカーです。マウスで要素をクリックする位置とオフセットを表すタプルで、Noneを指定できます。デフォルト値はNoneです(対象の中心をオフセットなしでクリックします)。パラメータの構造は次のとおりです。
sudoku_part:マウスカーソルをホバーさせる位置です。デフォルトでは中心にホバーさせます。
|パラメータの内容|説明|
|:--|:---|
|'topLeft'|左上隅にホバーさせます|
|'topCenter'|上部中央にホバーさせます|
|'topRight'|右上隅にホバーさせます|
|'middleLeft'|左側中央にホバーさせます|
|'middleCenter'|中心にホバーさせます|
|'middleRight'|右側中央にホバーさせます|
|'bottomLeft'|左下隅にホバーさせます|
|'bottomCenter'|下部中央にホバーさせます|
|'bottomRight'|右下隅にホバーさせます|
offset_x:マウスカーソル位置の水平方向のオフセットです。
offset_y:マウスカーソル位置の垂直方向のオフセットです。
move_mouse:マウスの移動軌跡を表示するかどうかを指定します。デフォルト値はTrueです(マウスの移動軌跡を表示します)。
戻り値
なし
例1
from xbot import win32
def main(args):
hWnd = win32.get('新建文件').hWnd
win32.image.dblclick_on_window(hWnd, '图像1', anchor=('middleCenter', 100, 100),
move_mouse=True)
この例の実行ロジック: ウィンドウタイトルが 新建文本 のウィンドウハンドルを取得します --> 現在アクティブなウィンドウに表示された、画像セレクター 图像1 と一致する画像を検索し、マウスで画像の中央をダブルクリックします。マウスのダブルクリック座標の水平方向と垂直方向のオフセットはいずれも100です。マウスの移動軌跡を表示します。