CWndContainer.h

[詳解]

//=============================================================================
/// @file
/// コンテナウィンドウクラスヘッダファイル
///
/// コンテナウィンドウクラスヘッダファイルです。
///
/// $Id: CWndContainer.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 <CWndList.h>

//=============================================================================
// ウィンドウライブラリ名前空間
namespace LibWindow {
    //=========================================================================
    /// コンテナウィンドウクラス
    ///
    /// コンテナウィンドウクラスです。
    ///
    /// @attention 抽象クラスです。
    ///
    class LIB_WINDOW_API CWndContainer abstract: public CWndPane {
        //=====================================================================
        // 構築子と解体子
    public:
        //---------------------------------------------------------------------
        /// コンストラクタ
        ///
        /// コンストラクタです。
        ///
        /// @param[in] pfnCreateElement 新規エレメントウィンドウ作成関数ポインタ
        /// @param[in] pszElementName   エレメントウィンドウ名
        /// @return    なし
        /// @attention なし
        ///
        explicit CWndContainer( CWndElement* ( *pfnCreateElement )(), wchar_t const* pszElementName ) noexcept;

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

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

        //=====================================================================
        // インライン公開関数
    public:
        //---------------------------------------------------------------------
        /// エレメントウィンドウリスト取得関数
        ///
        /// エレメントウィンドウリスト取得関数です。
        ///
        /// @param     なし
        /// @return    エレメントウィンドウリストポインタ
        /// @attention なし
        ///
        inline virtual CWndList* GetElementList() noexcept { return &m_cElementList; }

        //=====================================================================
        // 公開関数
    public:
        //---------------------------------------------------------------------
        /// ウィンドウ作成関数
        ///
        /// ウィンドウ作成関数です。
        ///
        /// @param[in] hParent 親ウィンドウハンドル
        /// @param[in] hMenu   メニューハンドル
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention オーバライド関数です。
        ///
        virtual bool Create( HWND hParent = nullptr, HMENU hMenu = nullptr ) noexcept override;

        //---------------------------------------------------------------------
        /// 各種メッセージ処理関数
        ///
        /// 各種メッセージ処理関数です。
        ///
        /// @param     なし
        /// @return    メッセージ終了コード
        /// @attention オーバライド関数です。
        ///
        virtual LRESULT WmSetFocus() noexcept override;

        //---------------------------------------------------------------------
        /// ユーザ定義メッセージ処理関数
        ///
        /// ユーザ定義メッセージ処理関数です。
        ///
        /// @param     なし
        /// @return    メッセージ終了コード
        /// @attention オーバライド関数です。
        ///
        virtual LRESULT WmNotifyChildSetFocus() noexcept override;

        //---------------------------------------------------------------------
        /// ウィンドウ構成情報初期化関数
        ///
        /// ウィンドウ構成情報初期化関数です。
        ///
        /// @param[in] rcConfig JSON構成ファイル参照
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention オーバライド関数です。
        ///
        virtual bool InitConfig( CJsonConfig& rcConfig ) noexcept override;

        //---------------------------------------------------------------------
        /// ウィンドウ構成情報復元関数
        ///
        /// ウィンドウ構成情報復元関数です。
        ///
        /// @param[in] rcConfig JSON構成ファイル参照
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention オーバライド関数です。
        ///
        virtual bool ResumeConfig( CJsonConfig& rcConfig ) noexcept override;

        //---------------------------------------------------------------------
        /// ウィンドウ構成情報保存関数
        ///
        /// ウィンドウ構成情報保存関数です。
        ///
        /// @param[in] rcConfig JSON構成ファイル参照
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention オーバライド関数です。
        ///
        virtual bool SaveConfig( CJsonConfig& rcConfig ) noexcept override;

        //---------------------------------------------------------------------
        /// 子ペインウィンドウ情報取得関数
        ///
        /// 子ペインウィンドウ情報取得関数です。
        ///
        /// @param[in] rsChildInfo 子ペインウィンドウ情報構造体参照
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention オーバライド関数です。
        ///
        virtual bool GetChildPaneInfo( SChildPaneInfo& rsChildInfo ) noexcept override;

        //---------------------------------------------------------------------
        /// ペインウィンドウオーダー番号取得関数
        ///
        /// ペインウィンドウオーダー番号取得関数です。
        ///
        /// @param[in]     pcPane  ペインウィンドウポインタ
        /// @param[in,out] pnOrder オーダー番号ポインタ
        /// @return        オーダー番号
        /// -              0以上 成功
        /// -              0未満 失敗
        /// @attention     オーバライド関数です。
        ///
        virtual int GetOrderIndex( CWndPane* pcPane = nullptr, int* pnOrder = nullptr ) noexcept override;

        //---------------------------------------------------------------------
        /// オーダー番号ペインウィンドウ取得関数
        ///
        /// オーダー番号ペインウィンドウ取得関数です。
        ///
        /// @param[in,out] pnOrder オーダー番号ポインタ
        /// @return        ペインウィンドウポインタ
        /// @attention     オーバライド関数です。
        ///
        virtual CWndPane* GetOrderPane( int* pnOrder ) noexcept override;

        //---------------------------------------------------------------------
        /// 子ウィンドウ削除関数
        ///
        /// 子ウィンドウ削除関数です。
        ///
        /// @param[in] pcChild ペインウィンドウポインタ
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention オーバライド関数です。
        ///
        virtual bool DeleteChildWindow( CWndPane* pcChild ) noexcept override;

        //---------------------------------------------------------------------
        /// 全子ウィンドウ表示関数
        ///
        /// 全子ウィンドウ表示関数です。
        ///
        /// @param[in] bShow ウィンドウ表示フラグ
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention オーバライド関数です。
        ///
        virtual bool ShowChildAll( bool bShow ) noexcept override;

        //---------------------------------------------------------------------
        /// 全子ウィンドウ削除関数
        ///
        /// 全子ウィンドウ削除関数です。
        ///
        /// @param     なし
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention オーバライド関数です。
        ///
        virtual bool DeleteChildAll() noexcept override;

        //---------------------------------------------------------------------
        /// 全ウィンドウクライアント領域更新関数
        ///
        /// 全ウィンドウクライアント領域更新関数です。
        ///
        /// @param     なし
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention オーバライド関数です。
        ///
        virtual bool UpdateClientRectAll() noexcept override;

        //---------------------------------------------------------------------
        /// メニューコマンド実行関数
        ///
        /// メニューコマンド実行関数です。
        ///
        /// @param[in] wId   コマンドID
        /// @param[in] wCode 通知コード
        /// @param[in] hCtrl コントロールハンドル
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention オーバライド関数です。
        ///
        virtual bool ExecMenuCommand( WORD wId, WORD wCode, HWND hCtrl ) noexcept override;

        //---------------------------------------------------------------------
        /// デバッグメニュー追加関数
        ///
        /// デバッグメニュー追加関数です。
        ///
        /// @param[in] hMenu メニューハンドル
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention オーバライド関数です。
        ///
        virtual bool AppendDebugMenu( HMENU hMenu ) noexcept override;

        //---------------------------------------------------------------------
        /// 新規エレメントウィンドウ追加関数
        ///
        /// 新規エレメントウィンドウ追加関数です。
        ///
        /// @param     なし
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool AppendNewElementWindow() noexcept;

        //=====================================================================
        // 限定公開変数
    protected:
        CWndList        m_cElementList;         ///< エレメントウィンドウリスト
        CWndElement* ( *m_pfnCreateElement )(); ///< 新規エレメントウィンドウ作成関数ポインタ
        wchar_t const*  m_pszElementName;       ///< エレメントウィンドウ名
        bool            m_bFocusElement;        ///< エレメントウィンドウフォーカス有効フラグ

        //=====================================================================
        // 静的限定公開文字列定数
    protected:
        static wchar_t const* const KEY_FOCUS_ELEMENT; ///< エレメントウィンドウフォーカス有効状態キー文字列

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

#pragma managed( pop )