CKeyboardManager クラス

[アーティクル]
10/12/2023

メインフレームウィンドウおよび子フレームウィンドウのショートカットキーのテーブルを管理します。

構文

class CKeyboardManager : public CObject

メンバー

パブリックコンストラクター

名前	説明
CKeyboardManager::CKeyboardManager	`CKeyboardManager` オブジェクトを構築します。

パブリックメソッド

名前	説明
CKeyboardManager::CleanUp	ショートカットキーテーブルをクリアします。
CKeyboardManager::FindDefaultAccelerator	指定したコマンドとウィンドウの既定のショートカットキーを取得します。
CKeyboardManager::IsKeyHandled	キーがアクセラレータテーブルによって処理されるかどうかを判断します。
CKeyboardManager::IsKeyPrintable	文字が印刷可能かどうかを示します。
CKeyboardManager::IsShowAllAccelerators	メニューにコマンドのすべてのショートカットキーを表示するか、既定のショートカットキーのみを表示するかを示します。
CKeyboardManager::LoadState	Windows レジストリからショートカットキーテーブルを読み込みます。
CKeyboardManager::ResetAll	アプリケーションリソースからショートカットキーテーブルを再読み込みします。
CKeyboardManager::SaveState	ショートカットキーテーブルを Windows レジストリに保存します。
CKeyboardManager::ShowAllAccelerators	フレームワークがすべてのコマンドのすべてのショートカットキーを表示するか、コマンドごとに 1 つのショートカットキーを表示するかを指定します。このメソッドは、ショートカットキーが 1 つだけ関連付けられているコマンドには影響しません。
CKeyboardManager::TranslateCharToUpper	文字を上位レジスタに変換します。
CKeyboardManager::UpdateAccelTable	ショートカットキーテーブルを新しいショートカットキーテーブルで更新します。

解説

このクラスのメンバーを使用すると、ショートカットキーテーブルを保存して Windows レジストリに読み込み、テンプレートを使用してショートカットキーテーブルを更新し、フレームウィンドウでコマンドの既定のショートカットキーを見つけることができます。さらに、 CKeyboardManager オブジェクトを使用すると、ショートカットキーをユーザーに表示する方法を制御できます。

CKeyboardManager オブジェクトは手動で作成しないでください。アプリケーションのフレームワークによって自動的に作成されます。ただし、アプリケーションの初期化プロセス中に CWinAppEx::InitKeyboardManager を呼び出す必要があります。アプリケーションのキーボードマネージャーへのポインターを取得するには、 CWinAppEx::GetKeyboardManager を呼び出します。

例

次の例では、CWinAppEx クラスからCKeyboardManager オブジェクトへのポインターを取得する方法と、メニューコマンドに関連付けられているすべてのショートカットキーを表示する方法を示します。このコードスニペットは、 Custom Pages サンプルの一部です。

// The GetKeyboardManager method is inherited from the CWinAppEx class.
CKeyboardManager *cKeyboardManager = GetKeyboardManager();
cKeyboardManager->ShowAllAccelerators();

継承階層

CObject

CKeyboardManager

要件

Header: afxkeyboardmanager.h

CKeyboardManager::CKeyboardManager

CKeyboardManager オブジェクトを構築します。

CKeyboardManager();

解説

ほとんどの場合、 CKeyboardManager を直接作成する必要はありません。既定では、フレームワークによって自動的に作成されます。 CKeyboardManagerへのポインターを取得するには、CWinAppEx::GetKeyboardManager を呼び出します。手動で作成する場合は、メソッド CWinAppEx::InitKeyboardManager を使用して初期化する必要があります。

CKeyboardManager::CleanUp

CKeyboardManagerリソースを解放し、すべてのショートカットキーマッピングをクリアします。

static void CleanUp();

解説

ショートカットキーの詳細については、「 Keyboard と Mouse Customization」を参照してください。

アプリケーションの終了時にフレームワークによって自動的に呼び出されるため、アプリケーションの終了時にこの関数を呼び出す必要はありません。

CKeyboardManager::FindDefaultAccelerator

指定したコマンドとウィンドウの既定のショートカットキーを取得します。

static BOOL FindDefaultAccelerator(
    UINT uiCmd,
    CString& str,
    CFrameWnd* pWndFrame,
    BOOL bIsDefaultFrame);

パラメーター

uiCmd
[入力] コマンド ID。

str
[out] CString オブジェクトへの参照。

pWndFrame
[in] フレームウィンドウへのポインター。

bIsDefaultFrame
[in]フレームウィンドウが既定のフレームウィンドウかどうかを指定します。

戻り値

ショートカットが見つかった場合は 0 以外。それ以外の場合は 0。

解説

このメソッドは、 uiCmd で指定されたコマンドを検索し、既定のショートカットキーを取得します。次に、このメソッドは、このショートカットキーに関連付けられている文字列を受け取り、 str パラメーターに値を書き込みます。

CKeyboardManager::IsKeyHandled

指定したキーが CKeyboardManager クラスによって処理されるかどうかを判断します。

static BOOL __stdcall IsKeyHandled(
    WORD nKey,
    BYTE fVirt,
    CFrameWnd* pWndFrame,
    BOOL bIsDefaultFrame);

パラメーター

nKey
[in]確認するキー。

fVirt
[in]ショートカットキーの動作を指定します。使用可能な値の一覧については、「 ACCEL 構造体」を参照してください。

pWndFrame
[in]フレームウィンドウ。このメソッドは、このフレームでショートカットキーを処理するかどうかを決定します。

bIsDefaultFrame
[in] pWndFrame が既定のフレームウィンドウかどうかを示すブール型パラメーター。

戻り値

ショートカットキーが処理される場合は TRUE。キーが処理されない場合、または pWndFrame が NULL の場合は FALSE。

解説

入力パラメーターは、ショートカットキーが pWndFrame で処理されるかどうかを判断するために、nKey と fVirt の両方のアクセラレータテーブル内のエントリと一致する必要があります。

CKeyboardManager::IsKeyPrintable

文字が印刷可能かどうかを示します。

static BOOL __stdcall IsKeyPrintable(const UINT nChar);

パラメーター

nChar
[in]このメソッドがチェックする文字。

戻り値

文字が印刷可能な場合は 0 以外、印刷できない場合は 0。

解説

このメソッドは、 GetKeyboardState の呼び出しが失敗した場合に失敗します。

CKeyboardManager::IsShowAllAccelerators

メニューコマンドに関連付けられているすべてのショートカットキーをメニューに表示するか、既定のショートカットキーのみを表示するかを示します。

static BOOL IsShowAllAccelerators();

戻り値

アプリケーションがメニューコマンドのすべてのショートカットキーを一覧表示する場合は 0 以外。アプリケーションに既定のショートカットキーのみが表示される場合は 0。

解説

アプリケーションには、メニューバーのメニューコマンドのショートカットキーが一覧表示されます。関数 CKeyboardManager::ShowAllAccelerators を使用して、アプリケーションですべてのショートカットキーを一覧表示するか、既定のショートカットキーだけを一覧表示するかを制御します。

CKeyboardManager::LoadState

Windows レジストリからショートカットキーテーブルを読み込みます。

BOOL LoadState(
    LPCTSTR lpszProfileName = NULL,
    CFrameWnd* pDefaultFrame = NULL);

パラメーター

lpszProfileName
[in] CKeyboardManager データが保存されるレジストリパス。

pDefaultFrame
[in]既定のウィンドウとして使用するフレームウィンドウへのポインター。

戻り値

状態が正常に読み込まれた場合は 0 以外、それ以外の場合は 0。

解説

lpszProfileName パラメーターが NULL の場合、このメソッドは既定のレジストリの場所でCKeyboardManager データをチェックします。既定のレジストリの場所は、 CWinAppEx クラスによって指定されます。データは、前にメソッド CKeyboardManager::SaveState を使用して書き込む必要があります。

既定のウィンドウを指定しない場合は、アプリケーションのメインフレームウィンドウが使用されます。

CKeyboardManager::ResetAll

アプリケーションリソースからショートカットキーテーブルを再読み込みします。

void ResetAll();

解説

この関数は、 CKeyboardManager インスタンスに格納されているショートカットをクリアします。その後、アプリケーションリソースからキーボードマネージャーの状態が再読み込みされます。

CKeyboardManager::SaveState

ショートカットキーテーブルを Windows レジストリに保存します。

BOOL SaveState(
    LPCTSTR lpszProfileName = NULL,
    CFrameWnd* pDefaultFrame = NULL);

パラメーター

lpszProfileName
[in] CKeyboardManager 状態を保存するためのレジストリパス。

pDefaultFrame
[in]既定のウィンドウになるフレームウィンドウへのポインター。

戻り値

キーボードマネージャーの状態が正常に保存された場合は 0 以外、それ以外の場合は 0。

解説

lpszProfileName パラメーターが NULL の場合、このメソッドは CWinAppEx クラスで指定された既定の場所にCKeyboardManager状態を書き込みます。場所を指定する場合は、後でメソッド CKeyboardManager::LoadState を使用してデータを読み込むことができます。

既定のウィンドウを指定しない場合は、メインフレームウィンドウが既定のウィンドウとして使用されます。

CKeyboardManager::ShowAllAccelerators

メニューコマンドに関連付けられているすべてのショートカットキーを表示します。

static void ShowAllAccelerators(
    BOOL bShowAll = TRUE,
    LPCTSTR lpszDelimiter = _afxDefaultAcceleratorDelimiter);

パラメーター

bShowAll
[in]TRUE の場合、すべてのショートカットキーが表示されます。 FALSE の場合、最初のショートカットキーのみが表示されます。

lpszDelimiter
[in]ショートカットキー間に挿入する文字列。この区切り記号は、ショートカットキーが 1 つだけ表示されている場合は影響しません。

解説

既定では、コマンドに複数のショートカットキーが関連付けられている場合、最初のショートカットキーのみが表示されます。この関数を使用すると、すべてのコマンドに関連付けられているすべてのショートカットキーを一覧表示できます。

メニューバーのコマンドの横にショートカットキーが表示されます。すべてのショートカットキーが表示されている場合、 lpszDelimiter によって提供される文字列は、個々のショートカットキーを区切ります。

CKeyboardManager::TranslateCharToUpper

文字を上位レジスタに変換します。

static UINT TranslateCharToUpper(const UINT nChar);

パラメーター

nChar
[in]変換する文字。

戻り値

入力パラメーターの上位レジスタである文字。

CKeyboardManager::UpdateAccelTable

ショートカットキーテーブルを新しいショートカットキーテーブルで更新します。

BOOL UpdateAccelTable(
    CMultiDocTemplate* pTemplate,
    LPACCEL lpAccel,
    int nSize,
    CFrameWnd* pDefaultFrame = NULL);

BOOL UpdateAccelTable(
    CMultiDocTemplate* pTemplate,
    HACCEL hAccelNew,
    CFrameWnd* pDefaultFrame = NULL);

パラメーター

pTemplate
[in]ドキュメントテンプレートへのポインター。

lpAccel
[in]新しいショートカットキーへのポインター。

nSize
[in]新しいショートカットテーブルのサイズ。

pDefaultFrame
[in]既定のフレームウィンドウへのポインター。

hAccelNew
[in]新しいショートカットテーブルへのハンドル。

戻り値

メソッドが成功した場合は 0 以外。それ以外の場合は 0。

解説

この関数を使用して、既存のショートカットテーブルを複数のフレームウィンドウオブジェクトの新しいショートカットキーに置き換えます。この関数は、指定されたドキュメントテンプレートに接続されているすべてのフレームウィンドウオブジェクトへのアクセスを取得するためのパラメーターとしてドキュメントテンプレートを受け取ります。

次の方法で共有

CKeyboardManager クラス

構文

メンバー

パブリック コンストラクター

パブリック メソッド

解説

例

継承階層

要件

CKeyboardManager::CKeyboardManager

解説

CKeyboardManager::CleanUp

解説

CKeyboardManager::FindDefaultAccelerator

パラメーター

戻り値

解説

CKeyboardManager::IsKeyHandled

パラメーター

戻り値

解説

CKeyboardManager::IsKeyPrintable

パラメーター

戻り値

解説

CKeyboardManager::IsShowAllAccelerators

戻り値

解説

CKeyboardManager::LoadState

パラメーター

戻り値

解説

CKeyboardManager::ResetAll

解説

CKeyboardManager::SaveState

パラメーター

戻り値

解説

CKeyboardManager::ShowAllAccelerators

パラメーター

解説

CKeyboardManager::TranslateCharToUpper

パラメーター

戻り値

CKeyboardManager::UpdateAccelTable

パラメーター

戻り値

解説

関連項目

フィードバック

その他のリソース

パブリックコンストラクター

パブリックメソッド