LibWindowUtility.h

[詳解]

//=============================================================================
/// @file
/// ウィンドウユーティリティライブラリヘッダファイル
///
/// ウィンドウユーティリティライブラリヘッダファイルです。
///
/// $Id: LibWindowUtility.h 253 2019-03-24 21:00:30Z admin $
/// $Date: 2019-03-25 06:00:30 +0900 (2019/03/25 (月)) $
/// $Author: admin $
///
/// @attention なし

#pragma once
#pragma managed( push, off )

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

//=============================================================================
// ウィンドウライブラリ名前空間
namespace LibWindow {
    //=========================================================================
    // グローバル関数
    //-------------------------------------------------------------------------
    /// メニューコマンド項目情報取得関数
    ///
    /// メニューコマンド項目情報取得関数です。
    ///
    /// @param[in] hMenu  メニューハンドル
    /// @param[in] uId    コマンドID
    /// @param[in] phMenu メニューハンドルポインタ
    /// @param[in] psItem メニュー項目情報構造体ポインタ
    /// @param[in] uMask  メニュー項目情報マスク
    /// @return    実行結果
    /// -          true  成功
    /// -          false 失敗
    /// @attention なし
    ///
    LIB_WINDOW_API bool GetMenuCommandItem( HMENU hMenu, UINT uId, HMENU* phMenu = nullptr, MENUITEMINFOW* psItem = nullptr, UINT uMask = 0 ) noexcept;

    //-------------------------------------------------------------------------
    /// メニューコマンド項目情報設定関数
    ///
    /// メニューコマンド項目情報設定関数です。
    ///
    /// @param[in] hMenu  メニューハンドル
    /// @param[in] uId    コマンドID
    /// @param[in] psItem メニュー項目情報構造体ポインタ
    /// @return    実行結果
    /// -          true  成功
    /// -          false 失敗
    /// @attention なし
    ///
    LIB_WINDOW_API bool SetMenuCommandItem( HMENU hMenu, UINT uId, MENUITEMINFOW const* psItem ) noexcept;

    //-------------------------------------------------------------------------
    /// メニューコマンド検索関数
    ///
    /// メニューコマンド検索関数です。
    ///
    /// @param[in] hMenu メニューハンドル
    /// @param[in] uId   コマンドID
    /// @return    メニューハンドル
    /// @attention なし
    ///
    LIB_WINDOW_API HMENU FindMenuCommand( HMENU hMenu, UINT uId ) noexcept;

    //-------------------------------------------------------------------------
    /// メニューコマンドデータ取得関数
    ///
    /// メニューコマンドデータ取得関数です。
    ///
    /// @param[in]  hMenu  メニューハンドル
    /// @param[in]  uId    コマンドID
    /// @param[out] ruData コマンドデータ参照
    /// @return     実行結果
    /// -           true  成功
    /// -           false 失敗
    /// @attention  なし
    ///
    LIB_WINDOW_API bool GetMenuCommandData( HMENU hMenu, UINT uId, ULONG_PTR& ruData ) noexcept;

    //-------------------------------------------------------------------------
    /// メニューコマンドデータ設定関数
    ///
    /// メニューコマンドデータ設定関数です。
    ///
    /// @param[in] hMenu メニューハンドル
    /// @param[in] uId   コマンドID
    /// @param[in] uData コマンドデータ
    /// @return    実行結果
    /// -          true  成功
    /// -          false 失敗
    /// @attention なし
    ///
    LIB_WINDOW_API bool SetMenuCommandData( HMENU hMenu, UINT uId, ULONG_PTR uData ) noexcept;

    //-------------------------------------------------------------------------
    /// メニューコマンド有効状態取得関数
    ///
    /// メニューコマンド有効状態取得関数です。
    ///
    /// @param[in] hMenu メニューハンドル
    /// @param[in] uId   コマンドID
    /// @return    実行結果
    /// -          true  有効
    /// -          false 無効
    /// @attention なし
    ///
    LIB_WINDOW_API bool IsEnableMenuCommand( HMENU hMenu, UINT uId ) noexcept;

    //-------------------------------------------------------------------------
    /// メニューコマンド有効状態設定関数
    ///
    /// メニューコマンド有効状態設定関数です。
    ///
    /// @param[in] hMenu   メニューハンドル
    /// @param[in] uId     コマンドID
    /// @param[in] bEnable 有効フラグ
    /// @return    実行結果
    /// -          true  成功
    /// -          false 失敗
    /// @attention なし
    ///
    LIB_WINDOW_API bool EnableMenuCommand( HMENU hMenu, UINT uId, bool bEnable ) noexcept;

    //-------------------------------------------------------------------------
    /// メニューコマンドチェック状態取得関数
    ///
    /// メニューコマンドチェック状態取得関数です。
    ///
    /// @param[in] hMenu メニューハンドル
    /// @param[in] uId   コマンドID
    /// @return    実行結果
    /// -          true  チェック状態
    /// -          false 非チェック状態
    /// @attention なし
    ///
    LIB_WINDOW_API bool IsCheckMenuCommand( HMENU hMenu, UINT uId ) noexcept;

    //-------------------------------------------------------------------------
    /// メニューコマンドチェック状態設定関数
    ///
    /// メニューコマンドチェック状態設定関数です。
    ///
    /// @param[in] hMenu  メニューハンドル
    /// @param[in] uId    コマンドID
    /// @param[in] bCheck チェックフラグ
    /// @return    実行結果
    /// -          true  成功
    /// -          false 失敗
    /// @attention なし
    ///
    LIB_WINDOW_API bool CheckMenuCommand( HMENU hMenu, UINT uId, bool bCheck ) noexcept;

    //-------------------------------------------------------------------------
    /// メニューコマンド有効数取得関数
    ///
    /// メニューコマンド有効数取得関数です。
    ///
    /// @param[in] hMenu メニューハンドル
    /// @return    実行結果
    /// -          true  有効
    /// -          false 無効
    /// @attention なし
    ///
    LIB_WINDOW_API int GetEnableMenuCommandCount( HMENU hMenu ) noexcept;

    //-------------------------------------------------------------------------
    /// 親またはオーナーウィンドウ取得関数
    ///
    /// 親またはオーナーウィンドウ取得関数です。
    ///
    /// @param[in]  hWnd ウィンドウハンドル
    /// @return     ウィンドウハンドル
    /// @attention  なし
    ///
    LIB_WINDOW_API HWND GetParentOrOwner( HWND hWnd ) noexcept;

    //-------------------------------------------------------------------------
    /// 自分または子ウィンドウ判定関数
    ///
    /// 自分または子ウィンドウ判定関数です。
    ///
    /// @param[in] hWnd   ウィンドウハンドル
    /// @param[in] hChild 子ウィンドウハンドル
    /// @return    ウィンドウハンドル
    /// @attention なし
    ///
    LIB_WINDOW_API bool IsOwnOrChild( HWND hWnd, HWND hChild ) noexcept;
}

#pragma managed( pop )