LibWindowUtility.cpp

[詳解]

//=============================================================================
/// @file
/// ウィンドウユーティリティライブラリ実装ファイル
///
/// ウィンドウユーティリティライブラリ実装ファイルです。
///
/// $Id: LibWindowUtility.cpp 245 2019-03-20 15:03:41Z admin $
/// $Date: 2019-03-21 00:03:41 +0900 (2019/03/21 (木)) $
/// $Author: admin $
///
/// @attention なし

#pragma managed( push, off )

//=============================================================================
// インクルードファイル
#include <LibWindowUtility.h>

//=============================================================================
// ウィンドウライブラリ名前空間
namespace LibWindow {
    //=========================================================================
    // グローバル関数
    //-------------------------------------------------------------------------
    // メニューコマンド項目情報取得関数
    bool GetMenuCommandItem( HMENU hMenu, UINT uId, HMENU* phMenu, MENUITEMINFOW* psItem, UINT uMask ) noexcept {
        // 処理ブロック
        bool result = false;
        do {
            // メニューハンドルを調べる
            if ( nullptr == hMenu ) {
                // 失敗！
                break;
            }
            // 巡回する
            else for ( int nIndex = 0, nCount = ::GetMenuItemCount( hMenu ); nCount > nIndex; ++nIndex ) {
                // メニュー項目情報を取得する
                MENUITEMINFOW sItem = { sizeof( MENUITEMINFOW ) };
                sItem.fMask = ( MIIM_ID | MIIM_SUBMENU | uMask );
                if ( 0 != ::GetMenuItemInfoW( hMenu, nIndex, true, &sItem ) ) {
                    // サブメニューハンドルを調べる
                    if ( nullptr != sItem.hSubMenu ) {
                        // メニューコマンド項目情報を取得する
                        if ( GetMenuCommandItem( sItem.hSubMenu, uId, phMenu, psItem, uMask ) ) {
                            // 成功！
                            result = true;
                            break;
                        }
                    }
                    // コマンドIDを調べる
                    else if ( uId == sItem.wID ) {
                        // メニューハンドルポインタを調べる
                        if ( nullptr != phMenu ) {
                            // メニューハンドルを取得する
                            *phMenu = hMenu;
                        }

                        // メニュー項目情報構造体ポインタを調べる
                        if ( nullptr != psItem ) {
                            // メニュー項目情報を取得する
                            *psItem = sItem;
                        }

                        // 成功！
                        result = true;
                        break;
                    }
                }
            }
        } while ( false );

        // 実行結果を返す
        return result;
    }

    //-------------------------------------------------------------------------
    // メニューコマンド項目情報設定関数
    bool SetMenuCommandItem( HMENU hMenu, UINT uId, MENUITEMINFOW const* psItem ) noexcept {
        // 処理ブロック
        bool result = false;
        do {
            // メニューハンドルを調べる
            if ( nullptr == hMenu ) {
                // 失敗！
                break;
            }
            // メニュー項目情報構造体ポインタを調べる
            else if ( nullptr == psItem ) {
                // 失敗！
                break;
            }
            // 巡回する
            else for ( int nIndex = 0, nCount = ::GetMenuItemCount( hMenu ); nCount > nIndex; ++nIndex ) {
                // メニュー項目情報を取得する
                MENUITEMINFOW sItem = { sizeof( MENUITEMINFOW ) };
                sItem.fMask = ( MIIM_ID | MIIM_SUBMENU );
                if ( 0 != ::GetMenuItemInfoW( hMenu, nIndex, true, &sItem ) ) {
                    // サブメニューハンドルを調べる
                    if ( nullptr != sItem.hSubMenu ) {
                        // メニューコマンド項目情報を設定する
                        if ( SetMenuCommandItem( sItem.hSubMenu, uId, psItem ) ) {
                            // 成功！
                            result = true;
                            break;
                        }
                    }
                    // コマンドIDを調べる
                    else if ( uId == sItem.wID ) {
                        // メニュー項目情報を設定する
                        if ( 0 != ::SetMenuItemInfoW( hMenu, nIndex, true, psItem ) ) {
                            // 成功！
                            result = hMenu;
                        }
                        break;
                    }
                }
            }
        } while ( false );

        // 実行結果を返す
        return result;
    }

    //-------------------------------------------------------------------------
    // メニューコマンド検索関数
    HMENU FindMenuCommand( HMENU hMenu, UINT uId ) noexcept {
        // 処理ブロック
        HMENU result = nullptr;
        do {
            // メニューコマンド項目情報を取得する
            if ( !GetMenuCommandItem( hMenu, uId, &hMenu ) ) {
                // 失敗！
                break;
            }

            // 成功！
            result = hMenu;
        } while ( false );

        // 実行結果を返す
        return result;
    }

    //-------------------------------------------------------------------------
    // メニューコマンドデータ取得関数
    bool GetMenuCommandData( HMENU hMenu, UINT uId, ULONG_PTR& ruData ) noexcept {
        // 処理ブロック
        bool result = false;
        do {
            // メニューコマンド項目情報を取得する
            MENUITEMINFOW sItem;
            if ( !GetMenuCommandItem( hMenu, uId, nullptr, &sItem, MIIM_DATA ) ) {
                // 失敗！
                break;
            }

            // コマンドデータを取得する
            ruData = sItem.dwItemData;

            // 成功！
            result = true;
        } while ( false );

        // 実行結果を返す
        return result;
    }

    //-------------------------------------------------------------------------
    // メニューコマンドデータ設定関数
    bool SetMenuCommandData( HMENU hMenu, UINT uId, ULONG_PTR uData ) noexcept {
        // 処理ブロック
        bool result = false;
        do {
            // メニュー項目情報を作成する
            MENUITEMINFOW sItem = { sizeof( MENUITEMINFOW ) };
            sItem.fMask      = MIIM_DATA;
            sItem.dwItemData = uData;

            // メニューコマンド項目情報を設定する
            if ( !SetMenuCommandItem( hMenu, uId, &sItem ) ) {
                // 失敗！
                break;
            }

            // 成功！
            result = true;
        } while ( false );

        // 実行結果を返す
        return result;
    }

    //-------------------------------------------------------------------------
    // メニューコマンド有効状態取得関数
    bool IsEnableMenuCommand( HMENU hMenu, UINT uId ) noexcept {
        // 処理ブロック
        bool result = false;
        do {
            // メニューコマンドを検索する
            hMenu = FindMenuCommand( hMenu, uId );
            if ( nullptr == hMenu ) {
                // 失敗！
                break;
            }

            // メニュー項目フラグを取得する
            UINT uState = ::GetMenuState( hMenu, uId, MF_BYCOMMAND );

            // メニュー項目有効状態を調べる
            result = ( MF_ENABLED == ( uState & ( MF_GRAYED | MF_DISABLED ) ) );
        } while ( false );

        // 実行結果を返す
        return result;
    }

    //-------------------------------------------------------------------------
    // メニューコマンド有効状態設定関数
    bool EnableMenuCommand( HMENU hMenu, UINT uId, bool bEnable ) noexcept {
        // 処理ブロック
        bool result = false;
        do {
            // メニューコマンドを検索する
            hMenu = FindMenuCommand( hMenu, uId );
            if ( nullptr == hMenu ) {
                // 失敗！
                break;
            }
            // メニュー項目有効状態を設定する
            else if ( 0 == ::EnableMenuItem( hMenu, uId, ( MF_BYCOMMAND | ( bEnable? MFS_ENABLED: MFS_DISABLED ) ) ) ) {
                // 失敗！
                break;
            }

            // 成功！
            result = true;
        } while ( false );

        // 実行結果を返す
        return result;
    }

    //-------------------------------------------------------------------------
    // メニューコマンドチェック状態取得関数
    bool IsCheckMenuCommand( HMENU hMenu, UINT uId ) noexcept {
        // 処理ブロック
        bool result = false;
        do {
            // メニューコマンドを検索する
            hMenu = FindMenuCommand( hMenu, uId );
            if ( nullptr == hMenu ) {
                // 失敗！
                break;
            }

            // メニュー項目フラグを取得する
            UINT uState = ::GetMenuState( hMenu, uId, MF_BYCOMMAND );

            // メニュー項目チェック状態を調べる
            result = ( MF_CHECKED == ( uState & MF_CHECKED ) );
        } while ( false );

        // 実行結果を返す
        return result;
    }

    //-------------------------------------------------------------------------
    // メニューコマンドチェック状態設定関数
    bool CheckMenuCommand( HMENU hMenu, UINT uId, bool bCheck ) noexcept {
        // 処理ブロック
        bool result = false;
        do {
            // メニューコマンドを検索する
            hMenu = FindMenuCommand( hMenu, uId );
            if ( nullptr == hMenu ) {
                // 失敗！
                break;
            }
            // メニュー項目チェック状態を設定する
            else if ( 0 == ::CheckMenuItem( hMenu, uId, ( MF_BYCOMMAND | ( bCheck? MFS_CHECKED: MFS_UNCHECKED ) ) ) ) {
                // 失敗！
                break;
            }

            // 成功！
            result = true;
        } while ( false );

        // 実行結果を返す
        return result;
    }

    //-------------------------------------------------------------------------
    // メニューコマンド有効数取得関数
    int GetEnableMenuCommandCount( HMENU hMenu ) noexcept {
        // 処理ブロック
        int result = 0;
        do {
            // 巡回する
            for ( int nIndex = 0, nCount = ::GetMenuItemCount( hMenu ); nCount > nIndex; ++nIndex ) {
                // メニュー項目情報を取得する
                MENUITEMINFOW sItem = { sizeof( MENUITEMINFOW ) };
                sItem.fMask = ( MIIM_STATE | MIIM_ID | MIIM_SUBMENU );
                if ( 0 != ::GetMenuItemInfoW( hMenu, nIndex, true, &sItem ) ) {
                    // サブメニューハンドルを調べる
                    if ( nullptr != sItem.hSubMenu ) {
                        // メニューコマンド有効数を加算する
                        result += GetEnableMenuCommandCount( sItem.hSubMenu );
                    }
                    // メニュー項目有効状態を調べる
                    else if ( MF_ENABLED == ( ( MF_GRAYED | MF_DISABLED ) & sItem.fState ) ) {
                        // 有効コマンド数をインクリメントする
                        ++result;
                    }
                }
            }
        } while ( false );

        // 実行結果を返す
        return result;
    }

    //-------------------------------------------------------------------------
    // 親またはオーナーウィンドウ取得関数
    HWND GetParentOrOwner( HWND hWnd ) noexcept {
        // 処理ブロック
        HWND result = nullptr;
        do {
            // 親ウィンドウを取得する
            HWND hParent = ::GetParent( hWnd );
            if ( nullptr == hParent ) {
                // オーナーウィンドウを取得する
                hParent = ::GetWindow( hWnd, GW_OWNER );
                if ( nullptr == hParent ) {
                    // 失敗！
                    break;
                }
            }

            // 成功！
            result = hParent;
        } while ( false );

        // 実行結果を返す
        return result;
    }

    //-------------------------------------------------------------------------
    // 自分または子ウィンドウ判定関数
    bool IsOwnOrChild( HWND hWnd, HWND hChild ) noexcept {
        // 処理ブロック
        bool result = false;
        do {
            // 自分自身か、または子ウィンドウか調べる
            if ( ( hChild == hWnd ) || ( 0 != ::IsChild( hWnd, hChild ) ) ) {
                // 成功！
                result = true;
            }
        } while ( false );

        // 実行結果を返す
        return result;
    }
}

#pragma managed( pop )