ITfKeystrokeMgr

ITfKeystrokeMgr インターフェイスは TSF マネージャーによって実装され、アプリケーションやテキストサービスがキーボードマネージャーとやり取りするために使用します。

ITfKeystrokeMgr::AdviseKeyEventSink メソッド

このメソッドは次のいずれかの値を返します。

フォアグラウンドのキーイベントシンクは、すべてのキーボードイベントを受け取ります。フォアグラウンドではないキーイベントシンクは、予約キー (preserved key) と、そのクライアント識別子が所有するものとしてマークされたテキスト上で発生したキーイベントのみを受け取ります。

ITfKeystrokeMgr::UnadviseKeyEventSink メソッド

このメソッドは次のいずれかの値を返します。

ITfKeystrokeMgr::GetForeground メソッド

このメソッドは次のいずれかの値を返します。

ITfKeystrokeMgr::TestKeyDown メソッド

このメソッドは次のいずれかの値を返します。

アプリケーションはこのメソッドを使用して、キーイベントがキーストロークマネージャーによって処理されるかどうかを判定できます。このメソッドが成功し、pfEaten が TRUE を受け取った場合、アプリケーションは ITfKeystrokeMgr::KeyDown を呼び出す必要があります。このメソッドが S_OK を返さない場合、または pfEaten が FALSE を受け取った場合、アプリケーションは ITfKeystrokeMgr::KeyDown を呼び出してはいけません。以下は実装例です。

if(msg.message == WM_KEYDOWN)
{
    if( pKeyboardMgr->TestKeyDown(msg.wParam, msg.lParam, &fEaten) == S_OK 
        && fEaten 
        && pKeyboardMgr->KeyDown(msg.wParam, msg.lParam, &fEaten) == S_OK 
        && fEaten)
    {
        //The key was handled by the keystroke manager or a TSF text service. Do not pass the key to the application. 
        continue;
    }
    else
    {
        //Let the application process the key. 
    }
}

キーストロークマネージャーがキーイベントを処理しない場合、テキストサービスの ITfKeyEventSink::OnTestKeyDown メソッドを呼び出して、キーイベントを TSF テキストサービスへ渡します。

ITfKeystrokeMgr::TestKeyUp メソッド

このメソッドは次のいずれかの値を返します。

アプリケーションはこのメソッドを使用して、キーイベントがキーストロークマネージャーによって処理されるかどうかを判定できます。このメソッドが成功し、pfEaten が TRUE を受け取った場合、アプリケーションは ITfKeystrokeMgr::KeyUp を呼び出す必要があります。このメソッドが S_OK を返さない場合、または pfEaten が FALSE を受け取った場合、アプリケーションは ITfKeystrokeMgr::KeyUp を呼び出してはいけません。以下は実装例です。

if(msg.message == WM_KEYUP)
{
    if( pKeyboardMgr->TestKeyUp(msg.wParam, msg.lParam, &fEaten) == S_OK 
        && fEaten 
        && pKeyboardMgr->KeyUp(msg.wParam, msg.lParam, &fEaten) == S_OK 
        && fEaten)
    {
        The key was handled by the keystroke manager or a text service. Do not pass the key to the application.
        continue;
    }
    else
    {
        //Let the application process the key. 
    }
}

キーストロークマネージャーがキーイベントを処理しない場合、TSF テキストサービスの ITfKeyEventSink::OnTestKeyUp メソッドを呼び出して、キーイベントを TSF テキストサービスへ渡します。

ITfKeystrokeMgr::KeyDown メソッド

このメソッドは次のいずれかの値を返します。

このメソッドが成功し、pfEaten が TRUE を受け取った場合、アプリケーションはキーダウンイベントを処理してはいけません。このメソッドが S_OK を返さない場合、または pfEaten が FALSE を受け取った場合、アプリケーションはキーダウンイベントを処理する必要があります。以下は実装例です。

if(msg.message == WM_KEYDOWN)
{
    if( pKeyboardMgr->TestKeyDown(msg.wParam, msg.lParam, &fEaten) == S_OK 
        && fEaten 
        && pKeyboardMgr->KeyDown(msg.wParam, msg.lParam, &fEaten) == S_OK 
        && fEaten)
    {
        //The key was handled by the keystroke manager or a TSF text service. Do not pass the key to the application. 
        continue;
    }
    else
    {
        //Let the application process the key. 
    }
}

キーストロークマネージャーがキーイベントを処理しない場合、TSF テキストサービスの ITfKeyEventSink::OnKeyDown メソッドを呼び出して、キーイベントを TSF テキストサービスへ渡します。

ITfKeystrokeMgr::KeyUp メソッド

このメソッドは次のいずれかの値を返します。

このメソッドが成功し、pfEaten が TRUE を受け取った場合、アプリケーションはキーダウンイベントを処理してはいけません。このメソッドが S_OK を返さない場合、または pfEaten が FALSE を受け取った場合、アプリケーションはキーダウンイベントを処理する必要があります。以下は実装例です。

if(msg.message == WM_KEYUP)
{
    if( pKeyboardMgr->TestKeyUp(msg.wParam, msg.lParam, &fEaten) == S_OK 
        && fEaten 
        && pKeyboardMgr->KeyUp(msg.wParam, msg.lParam, &fEaten) == S_OK 
        && fEaten)
    {
        //The key was handled by the keystroke manager or a TSF text service. Do not pass the key to the application. 
        continue;
    }
    else
    {
        //Let the application process the key. 
    }
}

キーストロークマネージャーがキーイベントを処理しない場合、テキストサービスの ITfKeyEventSink::OnKeyUp メソッドを呼び出して、キーイベントをテキストサービスへ渡します。

ITfKeystrokeMgr::GetPreservedKey メソッド

このメソッドは次のいずれかの値を返します。

予約キーは TSF テキストサービスによって登録され、TSF テキストサービスが実装する一般的なコマンドへのキーボードショートカットを提供するために使用されます。

ITfKeystrokeMgr::IsPreservedKey メソッド

このメソッドは次のいずれかの値を返します。

予約キーは TSF テキストサービスによって登録され、TSF テキストサービスが実装する一般的なコマンドへのキーボードショートカットを提供します。

ITfKeystrokeMgr::PreserveKey メソッド

このメソッドは次のいずれかの値を返します。

予約キーは TSF テキストサービスによって登録され、TSF テキストサービスが実装する一般的なコマンドへのキーボードショートカットを提供します。

ITfKeystrokeMgr::UnpreserveKey メソッド

このメソッドは次のいずれかの値を返します。

予約キーは TSF テキストサービスによって登録され、TSF テキストサービスが実装する一般的なコマンドへのキーボードショートカットを提供します。

ITfKeystrokeMgr::SetPreservedKeyDescription メソッド

このメソッドは次のいずれかの値を返します。

予約キーは TSF テキストサービスによって登録され、TSF テキストサービスが実装する一般的なコマンドへのキーボードショートカットを提供します。

ITfKeystrokeMgr::GetPreservedKeyDescription メソッド

このメソッドは次のいずれかの値を返します。

予約キーは TSF テキストサービスによって登録され、TSF テキストサービスが実装する一般的なコマンドへのキーボードショートカットを提供します。

ITfKeystrokeMgr::SimulatePreservedKey メソッド

このメソッドは次のいずれかの値を返します。