keyhac
Window Class Reference

ウインドウを表すクラス More...

Public Member Functions

def getText (self)
 ウインドウのタイトル文字列を取得する More...
 
def getClassName (self)
 ウインドウのクラス名を取得する More...
 
def getProcessName (self)
 ウインドウの所属するプロセスの名前を取得する More...
 
def getProcessPath (self)
 ウインドウの所属するプロセスの実行ファイル名を取得する More...
 
def getHWND (self)
 ウインドウハンドルを取得する More...
 
def getRect (self)
 ウインドウの左上と右下の座標をスクリーン座標で取得する More...
 
def getClientRect (self)
 ウインドウのクライアント領域の矩形を取得する More...
 
def clientToScreen (self, x, y)
 ウインドウのクライアント領域の座標をスクリーン座標に変換する More...
 
def setRect (self, rect)
 ウインドウの領域をスクリーン座標で設定する More...
 
def getFirstChild (self)
 Zオーダーが最初の子ウインドウを取得する More...
 
def getLastChild (self)
 Zオーダーが最後の子ウインドウを取得する More...
 
def getPrevious (self)
 Zオーダーが1つ手前の兄弟ウインドウを取得する More...
 
def getNext (self)
 Zオーダーが1つ奥の兄弟ウインドウを取得する More...
 
def getParent (self)
 親ウインドウを取得する More...
 
def getOwner (self)
 オーナーウインドウを取得する More...
 
def getLastActivePopup (self)
 所有するポップアップウインドウの中で最後にアクティブだったウインドウを取得する More...
 
def isVisible (self)
 表示状態を調べる More...
 
def isEnabled (self)
 有効か無効か(マウスやキーボードの入力を受け付ける状態であるか)を調べる More...
 
def isMinimized (self)
 最小化状態であるかどうかを調べる More...
 
def isMaximized (self)
 最大化状態であるかどうかを調べる More...
 
def minimize (self)
 最小化状態にする More...
 
def maximize (self)
 最大化状態にする More...
 
def restore (self)
 最小化状態および最大化状態を解除する More...
 
def getCheck (self)
 ラジオボタンやチェックボックスのチェック状態を取得する More...
 
def setCheck (self, status)
 ラジオボタンやチェックボックスのチェック状態を設定する More...
 
def getImeStatus (self)
 ウインドウのIMEの状態を取得する More...
 
def setImeStatus (self, status)
 ウインドウのIMEの状態を設定する More...
 
def postMessage (self, msg, wparam=0, lparam=0)
 ウインドウのメッセージキューに、メッセージをポストする More...
 
def sendMessage (self, msg, wparam=0, lparam=0)
 ウインドウにメッセージを送信する More...
 
def setForeground (self, force=False)
 ウインドウをフォアグラウンドにする More...
 
def setActive (self)
 ウインドウをアクティブにする More...
 
def getImage (self)
 ウインドウの画面イメージを取得する More...
 

Static Public Member Functions

def getForeground ()
 (static method) フォアグラウンドウインドウを取得する More...
 
def getFocus ()
 (static method) フォーカスされているウインドウを取得する More...
 
def getCaret ()
 (static method) キャレットの情報を取得する More...
 
def find (class_name, text)
 (static method) 指定されたクラス名とタイトルを持つトップレベルウインドウを取得する More...
 
def enum (callable, arg)
 (static method) トップレベルウインドウを列挙する More...
 
def getDesktop ()
 (static method) デスクトップウインドウを取得する More...
 
def fromHWND (hwnd)
 (static method) ウインドウハンドルからWindowオブジェクトを作成する More...
 
def getMonitorInfo (hwnd)
 (static method) モニター情報を取得する More...
 

Detailed Description

ウインドウを表すクラス

Member Function Documentation

◆ getText()

def getText (   self)

ウインドウのタイトル文字列を取得する

Parameters
self-
Returns
ウインドウのタイトル文字列

◆ getClassName()

def getClassName (   self)

ウインドウのクラス名を取得する

Parameters
self-
Returns
ウインドウのクラス名

◆ getProcessName()

def getProcessName (   self)

ウインドウの所属するプロセスの名前を取得する

Parameters
self-
Returns
ウインドウの所属するプロセスの名前 (実行ファイルのディレクトリを除いたファイル名)

◆ getProcessPath()

def getProcessPath (   self)

ウインドウの所属するプロセスの実行ファイル名を取得する

Parameters
self-
Returns
ウインドウの所属するプロセスの実行ファイル名

◆ getHWND()

def getHWND (   self)

ウインドウハンドルを取得する

Parameters
self-
Returns
ウインドウハンドル

ウインドウオブジェクトに関連付けられているウインドウハンドルを取得します。

◆ getRect()

def getRect (   self)

ウインドウの左上と右下の座標をスクリーン座標で取得する

Parameters
self-
Returns
ウインドウの左上と右下の座標 (left,top,right,bottom)

スクリーン座標とは、画面の左上端を(0,0)とし右下方向を正とする、ピクセル単位の座標系です。

◆ getClientRect()

def getClientRect (   self)

ウインドウのクライアント領域の矩形を取得する

Parameters
self-
Returns
ウインドウのクライアント領域の矩形 (left,top,right,bottom)

◆ clientToScreen()

def clientToScreen (   self,
  x,
  y 
)

ウインドウのクライアント領域の座標をスクリーン座標に変換する

Parameters
self-
xクライアント領域のx座標
yクライアント領域のy座標
Returns
変換されたスクリーン座標

◆ setRect()

def setRect (   self,
  rect 
)

ウインドウの領域をスクリーン座標で設定する

Parameters
self-
rectウインドウの左上と右下の座標 (left,top,right,bottom)
Returns
-

スクリーン座標とは、画面の左上端を(0,0)とし右下方向を正とする、ピクセル単位の座標系です。

◆ getFirstChild()

def getFirstChild (   self)

Zオーダーが最初の子ウインドウを取得する

Parameters
self-
Returns
Zオーダーが最初の子ウインドウ

ウインドウが子ウインドウを一つも持たない場合はNoneが返ります。

◆ getLastChild()

def getLastChild (   self)

Zオーダーが最後の子ウインドウを取得する

Parameters
self-
Returns
Zオーダーが最後の子ウインドウ

ウインドウが子ウインドウを一つも持たない場合はNoneが返ります。

◆ getPrevious()

def getPrevious (   self)

Zオーダーが1つ手前の兄弟ウインドウを取得する

Parameters
self-
Returns
Zオーダーが1つ手前の兄弟ウインドウ

ウインドウが兄弟の中で最も手前のウインドウである場合はNoneが返ります。

◆ getNext()

def getNext (   self)

Zオーダーが1つ奥の兄弟ウインドウを取得する

Parameters
self-
Returns
Zオーダーが1つ奥の兄弟ウインドウ

ウインドウが兄弟の中で最も奥のウインドウである場合はNoneが返ります。

◆ getParent()

def getParent (   self)

親ウインドウを取得する

Parameters
self-
Returns
親ウインドウ

ウインドウがトップレベルウインドウである場合はNoneが返ります。

◆ getOwner()

def getOwner (   self)

オーナーウインドウを取得する

Parameters
self-
Returns
オーナーウインドウ

オーナーが存在しない場合はNoneが返ります。

◆ getLastActivePopup()

def getLastActivePopup (   self)

所有するポップアップウインドウの中で最後にアクティブだったウインドウを取得する

Parameters
self-
Returns
最後にアクティブだったウインドウ

◆ isVisible()

def isVisible (   self)

表示状態を調べる

Parameters
self-
Returns
True:表示 False:非表示

◆ isEnabled()

def isEnabled (   self)

有効か無効か(マウスやキーボードの入力を受け付ける状態であるか)を調べる

Parameters
self-
Returns
True:有効 False:無効

◆ isMinimized()

def isMinimized (   self)

最小化状態であるかどうかを調べる

Parameters
self-
Returns
True:最小化されている False:最小化されていない

◆ isMaximized()

def isMaximized (   self)

最大化状態であるかどうかを調べる

Parameters
self-
Returns
True:最大化されている False:最大化されていない

◆ minimize()

def minimize (   self)

最小化状態にする

Parameters
self-
Returns
-

◆ maximize()

def maximize (   self)

最大化状態にする

Parameters
self-
Returns
-

◆ restore()

def restore (   self)

最小化状態および最大化状態を解除する

Parameters
self-
Returns
-

◆ getCheck()

def getCheck (   self)

ラジオボタンやチェックボックスのチェック状態を取得する

Parameters
self-
Returns
0:チェックされていない 1:チェックされている 2:不確定(3ステートのボタンのときのみ)

◆ setCheck()

def setCheck (   self,
  status 
)

ラジオボタンやチェックボックスのチェック状態を設定する

Parameters
self-
status0:チェックされていない 1:チェックされている 2:不確定(3ステートのボタンのときのみ)
Returns
-

◆ getImeStatus()

def getImeStatus (   self)

ウインドウのIMEの状態を取得する

Parameters
self-
Returns
0:OFF 1:ON

◆ setImeStatus()

def setImeStatus (   self,
  status 
)

ウインドウのIMEの状態を設定する

Parameters
self-
status0:OFF 1:ON
Returns
-

◆ postMessage()

def postMessage (   self,
  msg,
  wparam = 0,
  lparam = 0 
)

ウインドウのメッセージキューに、メッセージをポストする

Parameters
self-
msgメッセージの種別
wparamメッセージ特有の追加情報1
lparamメッセージ特有の追加情報2
Returns
-

postMessageは、メッセージをポストしてから、そのメッセージが処理されるのを待たずに返ります。

◆ sendMessage()

def sendMessage (   self,
  msg,
  wparam = 0,
  lparam = 0 
)

ウインドウにメッセージを送信する

Parameters
self-
msgメッセージの種別
wparamメッセージ特有の追加情報1
lparamメッセージ特有の追加情報2
Returns
-

sendMessageは、メッセージがウインドウプロシージャによって処理されるのを待ってから制御を返します。

◆ setForeground()

def setForeground (   self,
  force = False 
)

ウインドウをフォアグラウンドにする

Parameters
self-
forceスレッドのインプット状態を切り替えるか否か
Returns
-

引数 force に True を与えると、スレッドのインプット状態を切り替えてから、ウインドウをフォアグラウンド化します。ウインドウをフォアグラウンドにしても、タスクバーのボタンが点滅する場合は、引数 force に True を与えてみてください。

◆ setActive()

def setActive (   self)

ウインドウをアクティブにする

Parameters
self-
Returns
-

◆ getImage()

def getImage (   self)

ウインドウの画面イメージを取得する

Parameters
self-
Returns
ウインドウの画面イメージを表すImageクラスのオブジェクト

このメソッドを使用して取得した画面イメージを調査して、ウインドウの状態を特定することができます。

◆ getForeground()

def getForeground ( )
static

(static method) フォアグラウンドウインドウを取得する

Returns
フォアグラウンドウインドウ

フォアグラウンドウインドウが存在しない場合はNoneが返ります。

◆ getFocus()

def getFocus ( )
static

(static method) フォーカスされているウインドウを取得する

Returns
フォーカスされているウインドウ

フォーカスされているウインドウが存在しない場合はNoneが返ります。

◆ getCaret()

def getCaret ( )
static

(static method) キャレットの情報を取得する

Returns
キャレットを保持しているウインドウとキャレットの矩形 ( wnd, (left,top,right,bottom) )

キャレットを保持しているウインドウが存在しない場合は None, (0,0,0,0) が返ります。

◆ find()

def find (   class_name,
  text 
)
static

(static method) 指定されたクラス名とタイトルを持つトップレベルウインドウを取得する

Parameters
class_nameクラス名
textタイトル
Returns
ウインドウ

引数textにNoneを渡した場合は、あらゆるタイトルが該当するものとみなされます。

◆ enum()

def enum (   callable,
  arg 
)
static

(static method) トップレベルウインドウを列挙する

Parameters
callable呼び出し可能オブジェクト
arg任意の引数
Returns
-

すべてのトップレベルウインドウに関して、引数callableに渡したオブジェクトが呼び出されます。 callableには、第1引数にウインドウオブジェクト、第2引数に引数argがそのまま渡されます。 callableは列挙を続行する場合はTrueを返してください。列挙を中止する場合はFalseを返してください。

◆ getDesktop()

def getDesktop ( )
static

(static method) デスクトップウインドウを取得する

Returns
デスクトップウインドウ

◆ fromHWND()

def fromHWND (   hwnd)
static

(static method) ウインドウハンドルからWindowオブジェクトを作成する

Parameters
hwndウインドウハンドル
Returns
引数hwndに関連付けられたWindowオブジェクト

ウインドウハンドルを受け取り、そのウインドウハンドルに関連付けられたWindowオブジェクトを返します。 ほかのライブラリがウインドウハンドルを ウインドウハンドルを返すライブラリを使用する際に、このメソッドを使用します。

◆ getMonitorInfo()

def getMonitorInfo (   hwnd)
static

(static method) モニター情報を取得する

Returns
モニターの矩形,モニターの作業領域の矩形(タスクバーを除いた領域),プライマリモニターであるか [ [ monitor_rect, work_rect, flag ], ... ]

ウインドウハンドルを受け取り、そのウインドウハンドルに関連付けられたWindowオブジェクトを返します。 ほかのライブラリがウインドウハンドルを ウインドウハンドルを返すライブラリを使用する際に、このメソッドを使用します。