CWndList.h

[詳解]

//=============================================================================
/// @file
/// ウィンドウリストクラスヘッダファイル
///
/// ウィンドウリストクラスヘッダファイルです。
///
/// $Id: CWndList.h 245 2019-03-20 15:03:41Z admin $
/// $Date: 2019-03-21 00:03:41 +0900 (2019/03/21 (木)) $
/// $Author: admin $
///
/// @attention なし

#pragma once
#pragma managed( push, off )

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

//=============================================================================
// ウィンドウライブラリ名前空間
namespace LibWindow {
    //=====================================================================
    // グローバル型定義
    using CWndElement = CWndPane; ///< エレメントウィンドウクラス型

    //=========================================================================
    /// ウィンドウリストクラス
    ///
    /// ウィンドウリストクラスです。
    ///
    /// @attention なし
    ///
    class LIB_WINDOW_API CWndList: public CArray< CWndElement* > {
        //=====================================================================
        // 構築子と解体子
    public:
        //---------------------------------------------------------------------
        /// コンストラクタ
        ///
        /// コンストラクタです。
        ///
        /// @param     なし
        /// @return    なし
        /// @attention なし
        ///
        explicit CWndList() noexcept;

        //---------------------------------------------------------------------
        /// ムーブコンストラクタ
        ///
        /// ムーブコンストラクタです。
        ///
        /// @param[in] rcInstance インスタンス左辺値参照
        /// @return    なし
        /// @attention なし
        ///
        explicit CWndList( CWndList&& rcInstance ) noexcept;

        //---------------------------------------------------------------------
        /// デストラクタ
        ///
        /// デストラクタです。
        ///
        /// @param     なし
        /// @return    なし
        /// @attention なし
        ///
        virtual ~CWndList() noexcept {}

        //=====================================================================
        // 公開関数
    public:
        //---------------------------------------------------------------------
        /// クリア関数
        ///
        /// クリア関数です。
        ///
        /// @param     なし
        /// @return    なし
        /// @attention オーバライド関数です。
        ///
        virtual void Clear() noexcept override;

        //---------------------------------------------------------------------
        /// エレメントウィンドウリスト作成関数
        ///
        /// エレメントウィンドウリスト作成関数です。
        ///
        /// @param[in] hParent 親ウィンドウハンドル
        /// @param[in] hMenu   メニューハンドル
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool CreateListWindow( HWND hParent = nullptr, HMENU hMenu = nullptr ) noexcept;

        //---------------------------------------------------------------------
        /// カレントインデックス取得関数
        ///
        /// カレントインデックス取得関数です。
        ///
        /// @param     なし
        /// @return    インデックス
        /// -          0以上 成功
        /// -          0未満 失敗
        /// @attention なし
        ///
        virtual int GetCurrentIndex() const noexcept;

        //---------------------------------------------------------------------
        /// カレントインデックス設定関数
        ///
        /// カレントインデックス取得関数です。
        ///
        /// @param[in] nIndex インデックス
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool SetCurrentIndex( int nIndex ) noexcept;

        //---------------------------------------------------------------------
        /// 表示状態カレントインデックス取得関数
        ///
        /// 表示状態カレントインデックス取得関数です。
        ///
        /// @param     なし
        /// @return    インデックス
        /// -          0以上 成功
        /// -          0未満 失敗
        /// @attention なし
        ///
        virtual int GetShowCurrentIndex() const noexcept;

        //---------------------------------------------------------------------
        /// 表示状態カレントエレメントウィンドウ取得関数
        ///
        /// 表示状態カレントエレメントウィンドウ取得関数です。
        ///
        /// @param     なし
        /// @return    エレメントウィンドウポインタ
        /// @attention なし
        ///
        virtual CWndElement* GetShowCurrentElement() const noexcept;

        //---------------------------------------------------------------------
        /// カレントエレメントウィンドウ取得関数
        ///
        /// カレントエレメントウィンドウ取得関数です。
        ///
        /// @param     なし
        /// @return    エレメントウィンドウポインタ
        /// @attention なし
        ///
        virtual CWndElement* GetCurrentElement() const noexcept;

        //---------------------------------------------------------------------
        /// カレントエレメントウィンドウ設定関数
        ///
        /// カレントエレメントウィンドウ設定関数です。
        ///
        /// @param[in] pcElement エレメントウィンドウポインタ
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool SetCurrentElement( CWndElement* pcElement ) noexcept { return SetCurrentIndex( Find( pcElement ) ); }

        //---------------------------------------------------------------------
        /// エレメントウィンドウ取得関数
        ///
        /// エレメントウィンドウ取得関数です。
        ///
        /// @param[in] hWnd ウィンドウハンドル
        /// @return    エレメントウィンドウポインタ
        /// @attention なし
        ///
        virtual CWndElement* GetElementWindow( HWND hWnd ) const noexcept;

        //---------------------------------------------------------------------
        /// エレメントウィンドウ削除関数
        ///
        /// エレメントウィンドウ削除関数です。
        ///
        /// @param[in] pcElement エレメントウィンドウポインタ
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool RemoveElementWindow( CWndElement* pcElement ) noexcept { return Remove( Find( pcElement ) ); }

        //---------------------------------------------------------------------
        /// エレメントウィンドウリスト構成情報初期化関数
        ///
        /// エレメントウィンドウリスト構成情報初期化関数です。
        ///
        /// @param[in] rcConfig         JSON構成ファイル参照
        /// @param[in] pfnCreateElement 新規エレメントウィンドウ作成関数ポインタ
        /// @param[in] pszElementName   エレメントウィンドウ名
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool InitElementListConfig( CJsonConfig& rcConfig, CWndElement* ( *pfnCreateElement )(), wchar_t const* pszElementName ) noexcept;

        //---------------------------------------------------------------------
        /// エレメントウィンドウリスト構成情報復元関数
        ///
        /// エレメントウィンドウリスト構成情報復元関数です。
        ///
        /// @param[in] rcConfig       JSON構成ファイル参照
        /// @param[in] pszElementName エレメントウィンドウ名
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool ResumeElementListConfig( CJsonConfig& rcConfig, wchar_t const* pszElementName ) noexcept;

        //---------------------------------------------------------------------
        /// エレメントウィンドウリスト構成情報保存関数
        ///
        /// エレメントウィンドウリスト構成情報保存関数です。
        ///
        /// @param[in] rcConfig       JSON構成ファイル参照
        /// @param[in] pszElementName エレメントウィンドウ名
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool SaveElementListConfig( CJsonConfig& rcConfig, wchar_t const* pszElementName ) noexcept;

        //---------------------------------------------------------------------
        /// 子エレメントウィンドウリスト情報取得関数
        ///
        /// 子エレメントウィンドウリスト情報取得関数です。
        ///
        /// @param[in] pcParent    親ペインウィンドウポインタ
        /// @param[in] rsChildInfo 子ペインウィンドウ情報構造体参照
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool GetChildElementListInfo( CWndPane* pcParent, SChildPaneInfo& rsChildInfo ) noexcept;

        //---------------------------------------------------------------------
        /// エレメントウィンドウリストオーダー番号取得関数
        ///
        /// エレメントウィンドウリストオーダー番号取得関数です。
        ///
        /// @param[in]     pcPane  ペインウィンドウポインタ
        /// @param[in,out] pnOrder オーダー番号ポインタ
        /// @return        オーダー番号
        /// -              0以上 成功
        /// -              0未満 失敗
        /// @attention     なし
        ///
        virtual int GetElementListOrderIndex( CWndPane* pcPane, int* pnOrder ) noexcept;

        //---------------------------------------------------------------------
        /// エレメントウィンドウリストオーダー番号ペインウィンドウ取得関数
        ///
        /// エレメントウィンドウリストオーダー番号ペインウィンドウ取得関数です。
        ///
        /// @param[in,out] pnOrder オーダー番号ポインタ
        /// @return        ペインウィンドウポインタ
        /// @attention     なし
        ///
        virtual CWndPane* GetElementListOrderPane( int* pnOrder ) noexcept;

        //---------------------------------------------------------------------
        /// 全エレメントウィンドウリスト表示関数
        ///
        /// 全エレメントウィンドウリスト表示関数です。
        ///
        /// @param[in] pcParent 親ペインウィンドウポインタ
        /// @param[in] bShow    ウィンドウ表示フラグ
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool ShowElementListAll( CWndPane* pcParent, bool bShow ) noexcept;

        //---------------------------------------------------------------------
        /// 全エレメントウィンドウリスト削除関数
        ///
        /// 全エレメントウィンドウリスト削除関数です。
        ///
        /// @param[in] pcParent 親ペインウィンドウポインタ
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool DeleteElementListAll( CWndPane* pcParent ) noexcept;

        //---------------------------------------------------------------------
        /// エレメントウィンドウ追加関数
        ///
        /// エレメントウィンドウ追加関数です。
        ///
        /// @param[in] hParent   親ウィンドウハンドル
        /// @param[in] pcElement エレメントウィンドウポインタ
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool AppendElementWindow( HWND hParent, CWndElement* pcElement ) noexcept;

        //---------------------------------------------------------------------
        /// 新規エレメントウィンドウ追加関数
        ///
        /// 新規エレメントウィンドウ追加関数です。
        ///
        /// @param[in] hParent          親ウィンドウハンドル
        /// @param[in] pfnCreateElement 新規エレメントウィンドウ作成関数ポインタ
        /// @return    エレメントウィンドウポインタ
        /// @attention なし
        ///
        virtual CWndElement* AppendNewElementWindow( HWND hParent, CWndElement* ( *pfnCreateElement )() ) noexcept;

        //---------------------------------------------------------------------
        /// エレメントウィンドウリストデバッグサブメニュー追加関数
        ///
        /// エレメントウィンドウリストデバッグサブメニュー追加関数です。
        ///
        /// @param[in] hMenu          メニューハンドル
        /// @param[in] pcParent       親ペインウィンドウポインタ
        /// @param[in] pszElementName エレメントウィンドウ名
        /// @param[in] wIdNew         新規作成コマンドID
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool AppendElementListDebugSubMenu( HMENU hMenu, CWndPane* pcParent, wchar_t const* pszElementName, WORD wIdNew ) noexcept;

        //=====================================================================
        // 限定公開変数
    protected:
        int m_nCurrent; ///< カレントインデックス

        //=====================================================================
        // 静的限定公開文字列定数
    protected:
        static wchar_t const* const SECTION_ELEMENT_INFO; ///< エレメントウィンドウ情報セクション文字列
        static wchar_t const* const KEY_ELEMENT_COUNT;    ///< エレメントウィンドウ数キー文字列
        static wchar_t const* const KEY_CURRENT_INDEX;    ///< カレントインデックスキー文字列

        //=====================================================================
        // 削除関数
    private:
        CWndList( CWndList const& ) = delete;
        CWndList& operator=( CWndList const& ) = delete;
    };
}

#pragma managed( pop )