CWndPane.h

[詳解]

//=============================================================================
/// @file
/// ペインウィンドウクラスヘッダファイル
///
/// ペインウィンドウクラスヘッダファイルです。
///
/// $Id: CWndPane.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 <CWndBase.h>
#include <CJsonConfig.h>

//=============================================================================
// ウィンドウライブラリ名前空間
namespace LibWindow {
    //=========================================================================
    // グローバル定数
    //-------------------------------------------------------------------------
    // ユーザ定義メッセージID
    constexpr UINT const WM_NOTIFY_CHILD_SET_FOCUS   = ( WM_APP + 1 ); ///< 子ウィンドウフォーカス取得通知
    constexpr UINT const WM_NOTIFY_CHILD_KILL_FOCUS  = ( WM_APP + 2 ); ///< 子ウィンドウフォーカス喪失通知
    constexpr UINT const WM_NOTIFY_CHILD_LBUTTONDOWN = ( WM_APP + 3 ); ///< 子ウィンドウ左ボタンダウン通知
    constexpr UINT const WM_NOTIFY_CHILD_LBUTTONUP   = ( WM_APP + 4 ); ///< 子ウィンドウ左ボタンアップ通知
    constexpr UINT const WM_NOTIFY_CHILD_COMMAND     = ( WM_APP + 5 ); ///< 子ウィンドウコマンド実行通知

    //=========================================================================
    // グローバル型定義
    //-------------------------------------------------------------------------
    /// 子ペインウィンドウ情報構造体
    ///
    /// 子ペインウィンドウ情報構造体です。
    ///
    /// @attention なし
    ///
    struct SChildPaneInfo {
        int m_nCount;     ///< 子ウィンドウ数
        int m_nShow;      ///< 表示状態子ウィンドウ数
        int m_nHide;      ///< 非表示状態子ウィンドウ数
        int m_nHideable;  ///< 非表示可能子ウィンドウ数
        int m_nDeletable; ///< 削除可能子ウィンドウ数
    };

    //-------------------------------------------------------------------------
    /// パーティション配置位置種別列挙体
    ///
    /// パーティション配置位置種別列挙体です。
    ///
    /// @attention なし
    ///
    enum class EPartitionPos {
        Invalid, ///< 無効値
        Left,    ///< 左側
        Top,     ///< 上側
        Right,   ///< 右側
        Bottom,  ///< 下側
        Size     ///< 列挙体サイズ
    };

    //=========================================================================
    /// ペインウィンドウクラス
    ///
    /// ペインウィンドウクラスです。
    ///
    /// @attention なし
    ///
    class LIB_WINDOW_API CWndPane: public CWndBase {
        //=====================================================================
        // 構築子と解体子
    public:
        //---------------------------------------------------------------------
        /// コンストラクタ
        ///
        /// コンストラクタです。
        ///
        /// @param     なし
        /// @return    なし
        /// @attention なし
        ///
        explicit CWndPane() noexcept;

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

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

        //=====================================================================
        // インライン公開関数
    public:
        //---------------------------------------------------------------------
        /// セクション名取得関数
        ///
        /// セクション名取得関数です。
        ///
        /// @param     なし
        /// @return    文字列ポインタ
        /// @attention なし
        ///
        inline virtual wchar_t const* GetSectionName() const noexcept { return L"ペインウィンドウ"; }

        //---------------------------------------------------------------------
        /// クライアント描画領域背景色取得関数
        ///
        /// クライアント描画領域背景色取得関数です。
        ///
        /// @param     なし
        /// @return    カラーコード
        /// @attention なし
        ///
        inline virtual COLORREF GetBackColor() const noexcept { return ::GetSysColor( COLOR_APPWORKSPACE ); }

        //---------------------------------------------------------------------
        /// クライアント描画領域文字色取得関数
        ///
        /// クライアント描画領域文字色取得関数です。
        ///
        /// @param     なし
        /// @return    カラーコード
        /// @attention なし
        ///
        inline virtual COLORREF GetTextColor() const noexcept { return ::GetSysColor( COLOR_WINDOWTEXT ); }

        //---------------------------------------------------------------------
        /// フォーカス所有文字色取得関数
        ///
        /// フォーカス所有文字色取得関数です。
        ///
        /// @param     なし
        /// @return    カラーコード
        /// @attention なし
        ///
        inline virtual COLORREF GetFocusTextColor() const noexcept { return RGB( 240, 0, 0 ); }

        //---------------------------------------------------------------------
        /// フォーカスウィンドウ文字色取得関数
        ///
        /// フォーカスウィンドウ文字色取得関数です。
        ///
        /// @param     なし
        /// @return    カラーコード
        /// @attention なし
        ///
        inline virtual COLORREF GetFocusWindowTextColor() const noexcept { return RGB( 0, 0, 192 ); }

        //---------------------------------------------------------------------
        /// 表示フラグ取得関数
        ///
        /// 表示フラグ取得関数です。
        ///
        /// @param[in] hWnd ウィンドウハンドル
        /// @return    ペインウィンドウハンドル
        /// @attention なし
        ///
        inline virtual CWndPane* GetPaneWindow( HWND hWnd ) const noexcept { return reinterpret_cast< CWndPane* >( GetBaseWindow( hWnd ) ); }

        //---------------------------------------------------------------------
        /// 表示フラグ取得関数
        ///
        /// 表示フラグ取得関数です。
        ///
        /// @param     なし
        /// @return    実行結果
        /// -          true  表示
        /// -          false 非表示
        /// @attention なし
        ///
        inline virtual bool IsShow() noexcept { return m_bShow; }

        //---------------------------------------------------------------------
        /// 表示状態設定関数
        ///
        /// 表示状態設定関数です。
        ///
        /// @param[in] bShow ウィンドウ表示フラグ
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        inline virtual bool SetShow( bool bShow ) noexcept { m_bShow = bShow; return true; }

        //---------------------------------------------------------------------
        /// サイズバーコントロール取得関数
        ///
        /// サイズバーコントロール取得関数です。
        ///
        /// @param     なし
        /// @return    コントロールハンドル
        /// @attention なし
        ///
        inline virtual HWND GetSizeBar() const noexcept { return nullptr; }

        //---------------------------------------------------------------------
        /// パーティションウィンドウ判別関数
        ///
        /// パーティションウィンドウ判別関数です。
        ///
        /// @param     なし
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        inline virtual bool IsPartition() const noexcept { return false; }

        //---------------------------------------------------------------------
        /// パーティション配置位置取得関数
        ///
        /// パーティション配置位置取得関数です。
        ///
        /// @param     なし
        /// @return    パーティション配置位置種別
        /// @attention なし
        ///
        inline virtual EPartitionPos GetPartitionPos() const noexcept { return EPartitionPos::Invalid; }

        //---------------------------------------------------------------------
        /// パーティションサイズ取得関数
        ///
        /// パーティションサイズ取得関数です。
        ///
        /// @param     なし
        /// @return    パーティションサイズ
        /// @attention なし
        ///
        inline virtual int GetPartitionSize() const noexcept { return 0; }

        //---------------------------------------------------------------------
        /// パーティションサイズ設定関数
        ///
        /// パーティションサイズ設定関数です。
        ///
        /// @param[in] nSize パーティションサイズ
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        inline virtual bool SetPartitionSize( int nSize ) noexcept { return false; }

        //=====================================================================
        // 公開関数
    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 DWORD GetCreateStyle() noexcept override { return ( WS_VISIBLE | WS_CHILD | WS_CLIPSIBLINGS | WS_CLIPCHILDREN ); }

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

        //---------------------------------------------------------------------
        /// ユーザ定義メッセージ処理関数
        ///
        /// ユーザ定義メッセージ処理関数です。
        ///
        /// @param     なし
        /// @return    メッセージ終了コード
        /// @attention なし
        ///
        virtual LRESULT WmNotifyChildSetFocus()    noexcept;
        virtual LRESULT WmNotifyChildKillFocus()   noexcept;
        virtual LRESULT WmNotifyChildLButtonDown() noexcept { return 0; }
        virtual LRESULT WmNotifyChildLButtonUp()   noexcept { return 0; }
        virtual LRESULT WmNotifyChildCommand()     noexcept;

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

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

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

        //---------------------------------------------------------------------
        /// 親ペインウィンドウ取得関数
        ///
        /// 親ペインウィンドウ取得関数です。
        ///
        /// @param     なし
        /// @return    ペインウィンドウポインタ
        /// @attention なし
        ///
        virtual CWndPane* GetParentPane() noexcept;

        //---------------------------------------------------------------------
        /// 最上位ペインウィンドウ取得関数
        ///
        /// 最上位ペインウィンドウ取得関数です。
        ///
        /// @param     なし
        /// @return    ペインウィンドウポインタ
        /// @attention なし
        ///
        virtual CWndPane* GetTopLevelPane() noexcept;

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

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

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

        //---------------------------------------------------------------------
        /// 子ペインウィンドウ数取得関数
        ///
        /// 子ペインウィンドウ数取得関数です。
        ///
        /// @param     なし
        /// @return    ウィンドウ数
        /// @attention なし
        ///
        virtual int GetChildCount() noexcept;

        //---------------------------------------------------------------------
        /// 表示状態子ペインウィンドウ数取得関数
        ///
        /// 表示状態子ペインウィンドウ数取得関数です。
        ///
        /// @param     なし
        /// @return    ウィンドウ数
        /// @attention なし
        ///
        virtual int GetShowChildCount() noexcept;

        //---------------------------------------------------------------------
        /// 非表示状態子ペインウィンドウ数取得関数
        ///
        /// 非表示状態子ペインウィンドウ数取得関数です。
        ///
        /// @param     なし
        /// @return    ウィンドウ数
        /// @attention なし
        ///
        virtual int GetHideChildCount() noexcept;

        //---------------------------------------------------------------------
        /// 非表示可能子ペインウィンドウ数取得関数
        ///
        /// 非表示可能子ペインウィンドウ数取得関数です。
        ///
        /// @param     なし
        /// @return    ウィンドウ数
        /// @attention なし
        ///
        virtual int GetHideableChildCount() noexcept;

        //---------------------------------------------------------------------
        /// 削除可能子ペインウィンドウ数取得関数
        ///
        /// 削除可能子ペインウィンドウ数取得関数です。
        ///
        /// @param     なし
        /// @return    ウィンドウ数
        /// @attention なし
        ///
        virtual int GetDeletableChildCount() noexcept;

        //---------------------------------------------------------------------
        /// 子ウィンドウ非表示可能状態取得関数
        ///
        /// 子ウィンドウ非表示可能状態取得関数です。
        ///
        /// @param[in] pcChild ペインウィンドウポインタ
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool CanHideChildWindow( CWndPane* pcChild ) noexcept { return true; }

        //---------------------------------------------------------------------
        /// 子ウィンドウ削除可能状態取得関数
        ///
        /// 子ウィンドウ削除可能状態取得関数です。
        ///
        /// @param[in] pcChild ペインウィンドウポインタ
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool CanDeleteChildWindow( CWndPane* pcChild ) noexcept { return true; }

        //---------------------------------------------------------------------
        /// 子ウィンドウ表示状態設定関数
        ///
        /// 子ウィンドウ表示状態設定関数です。
        ///
        /// @param[in] pcChild ペインウィンドウポインタ
        /// @param[in] bShow   ウィンドウ表示フラグ
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool ShowChildWindow( CWndPane* pcChild, bool bShow ) noexcept;

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

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

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

        //---------------------------------------------------------------------
        /// クライアント領域更新関数
        ///
        /// クライアント領域更新関数です。
        ///
        /// @param     なし
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool UpdateClientRect() noexcept;

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

        //---------------------------------------------------------------------
        /// クライアント描画領域取得関数
        ///
        /// クライアント描画領域取得関数です。
        ///
        /// @param[out] rsRect 矩形領域参照
        /// @return     実行結果
        /// -           true  成功
        /// -           false 失敗
        /// @attention  なし
        ///
        virtual bool GetPaintRect( RECT& rsRect ) noexcept;

        //---------------------------------------------------------------------
        /// クライアント領域描画関数
        ///
        /// クライアント領域描画関数です。
        ///
        /// @param[in] hDc    デバイスコンテキストハンドル
        /// @param[in] rsRect ゼロ基点描画領域
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool DrawPaintRect( HDC hDc, RECT& rsRect ) noexcept;

        //---------------------------------------------------------------------
        /// 最小水平サイズ取得関数
        ///
        /// 最小水平サイズ取得関数です。
        ///
        /// @param     なし
        /// @return    水平サイズ
        /// @attention なし
        ///
        virtual int GetMinWidth() noexcept { return MIN_WIDTH; }

        //---------------------------------------------------------------------
        /// 最小垂直サイズ取得関数
        ///
        /// 最小垂直サイズ取得関数です。
        ///
        /// @param     なし
        /// @return    垂直サイズ
        /// @attention なし
        ///
        virtual int GetMinHeight() noexcept { return MIN_HEIGHT; }

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

        //---------------------------------------------------------------------
        /// コンテキストメニュー作成関数
        ///
        /// コンテキストメニュー作成関数です。
        ///
        /// @param     なし
        /// @return    メニューハンドル
        /// @attention なし
        ///
        virtual HMENU CreateContextMenu() noexcept;

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

        //---------------------------------------------------------------------
        /// 表示削除メニュー追加関数
        ///
        /// 表示削除メニュー追加関数です。
        ///
        /// @param[in] hMenu メニューハンドル
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool AppendShowDeleteMenu( HMENU hMenu ) noexcept;

        //=====================================================================
        // 限定公開変数
    protected:
        bool m_bShow; ///< ウィンドウ表示フラグ

        //=====================================================================
        // 静的限定公開変数
    protected:
        static bool  s_bShowDebugInfo;           ///< デバッグ情報表示フラグ
        static bool  s_bDrawDoubleBuffer;        ///< ダブルバッファリング描画フラグ
        static bool  s_bResizePartitionRealTime; ///< リアルタイムパーティションサイズ変更フラグ
        static HMENU s_hContextMenu;             ///< コンテキストメニューハンドル
        static HWND  s_hFocus;                   ///< フォーカスウィンドウ保存ハンドル

        //=====================================================================
        // 静的限定公開定数
    protected:
        static int const MIN_WIDTH  = 24; ///< 最小水平サイズ
        static int const MIN_HEIGHT = 24; ///< 最小垂直サイズ

        //=====================================================================
        // 静的限定公開文字列定数
    protected:
        static wchar_t const* const KEY_WINDOW_TITLE; ///< ウィンドウタイトルキー文字列
        static wchar_t const* const KEY_SHOW;         ///< ウィンドウ表示フラグキー文字列
        static wchar_t const* const KEY_FOCUS_ORDER;  ///< フォーカスウィンドウオーダー番号キー文字列

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

#pragma managed( pop )