CWndPartition.h

[詳解]

//=============================================================================
/// @file
/// パーティションウィンドウクラスヘッダファイル
///
/// パーティションウィンドウクラスヘッダファイルです。
///
/// $Id: CWndPartition.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 <CWndContainer.h>
#include <CWndDocumentTab.h>

//=============================================================================
// ウィンドウライブラリ名前空間
namespace LibWindow {
    //=========================================================================
    /// パーティションウィンドウクラス
    ///
    /// パーティションウィンドウクラスです。
    ///
    /// @attention 抽象クラスです。
    ///
    class LIB_WINDOW_API CWndPartition abstract: public CWndContainer {
        //=====================================================================
        // 静的公開定数
    public:
        static EPartitionPos const PARTITION_POS  = EPartitionPos::Left; ///< パーティション配置位置デフォルト値
        static int const           PARTITION_SIZE = 200;                 ///< パーティションサイズデフォルト値

        //=====================================================================
        // 静的公開文字列定数
    public:
        static wchar_t const* const KEY_PARTITION_POS;  ///< パーティション配置位置キー文字列
        static wchar_t const* const KEY_PARTITION_SIZE; ///< パーティションサイズキー文字列

        //=====================================================================
        // 構築子と解体子
    public:
        //---------------------------------------------------------------------
        /// コンストラクタ
        ///
        /// コンストラクタです。
        ///
        /// @param[in] pfnCreateElement 新規エレメントウィンドウ作成関数ポインタ
        /// @param[in] pszElementName   エレメントウィンドウ名
        /// @return    なし
        /// @attention なし
        ///
        explicit CWndPartition( CWndElement* ( *pfnCreateElement )(), wchar_t const* pszElementName ) noexcept;

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

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

        //---------------------------------------------------------------------
        /// ドキュメントタブウィンドウ取得関数
        ///
        /// ドキュメントタブウィンドウ取得関数です。
        ///
        /// @param     なし
        /// @return    ドキュメントタブウィンドウポインタ
        /// @attention なし
        ///
        inline virtual CWndDocumentTab* GetDocumentTab() noexcept { return nullptr; }

        //=====================================================================
        // 公開関数
    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 WmSize()      noexcept override;
        virtual LRESULT WmSetFocus()  noexcept override;
        virtual LRESULT WmDrawItem()  noexcept override;
        virtual LRESULT WmSetCursor() noexcept override;
        virtual LRESULT StnClicked()  noexcept override;
        virtual LRESULT WmLButtonUp() noexcept override;
        virtual LRESULT WmKeyDown()   noexcept override;
        virtual LRESULT WmMouseMove() 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] bShow ウィンドウ表示フラグ
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention オーバライド関数です。
        ///
        virtual bool ShowChildAll( bool bShow ) noexcept override;

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

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

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

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

        //---------------------------------------------------------------------
        /// 最小水平サイズ取得関数
        ///
        /// 最小水平サイズ取得関数です。
        ///
        /// @param     なし
        /// @return    水平サイズ
        /// @attention オーバライド関数です。
        ///
        virtual int GetMinWidth() noexcept override;

        //---------------------------------------------------------------------
        /// 最小垂直サイズ取得関数
        ///
        /// 最小垂直サイズ取得関数です。
        ///
        /// @param     なし
        /// @return    垂直サイズ
        /// @attention オーバライド関数です。
        ///
        virtual int GetMinHeight() noexcept override;

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

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

        //---------------------------------------------------------------------
        /// 最小サイズ取得関数
        ///
        /// 最小サイズ取得関数です。
        ///
        /// @param[out] rsSize サイズ構造体参照
        /// @param[in]  nStart 開始インデックス
        /// @return     実行結果
        /// -           true  成功
        /// -           false 失敗
        /// @attention  なし
        ///
        virtual bool GetMinSize( SIZE& rsSizen, int nStart = 0 ) noexcept;

        //---------------------------------------------------------------------
        /// 最小パーティション表示領域サイズ取得関数
        ///
        /// 最小パーティション表示領域サイズ取得関数です。
        ///
        /// @param[out] rsSize サイズ構造体参照
        /// @return     実行結果
        /// -           true  成功
        /// -           false 失敗
        /// @attention  なし
        ///
        virtual bool GetMinPartitionSize( SIZE& rsSize ) noexcept;

        //---------------------------------------------------------------------
        /// パーティション配置位置取得関数
        ///
        /// パーティション配置位置取得関数です。
        ///
        /// @param[in] pcElement エレメントウィンドウポインタ
        /// @return    パーティション配置位置種別
        /// @attention なし
        ///
        virtual EPartitionPos GetPartitionPos( CWndElement* pcElement ) noexcept;

        //---------------------------------------------------------------------
        /// サイズバー移動開始関数
        ///
        /// サイズバー移動開始関数です。
        ///
        /// @param[in] pcElement エレメントウィンドウポインタ
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool BeginMoveSizeBar( CWndElement* pcElement ) noexcept;

        //---------------------------------------------------------------------
        /// サイズバー移動中止関数
        ///
        /// サイズバー移動中止関数です。
        ///
        /// @param     なし
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool CancelMoveSizeBar() noexcept;

        //---------------------------------------------------------------------
        /// サイズバー移動関数
        ///
        /// サイズバー移動関数です。
        ///
        /// @param     なし
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool MoveSizeBar() noexcept;

        //---------------------------------------------------------------------
        /// サイズバー移動終了関数
        ///
        /// サイズバー移動終了関数です。
        ///
        /// @param     なし
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool EndMoveSizeBar() noexcept;

        //---------------------------------------------------------------------
        /// サイズバーイメージコントロール作成関数
        ///
        /// サイズバーイメージコントロール作成関数です。
        ///
        /// @param     なし
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool CreateSizeBarImageControl() noexcept;

        //---------------------------------------------------------------------
        /// サイズバーコントロール描画関数
        ///
        /// サイズバーコントロール描画関数です。
        ///
        /// @param[in] lpDraw 描画アイテム構造体ポインタ
        /// @param[in] ePos   パーティション配置位置
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool DrawSizeBar( LPDRAWITEMSTRUCT lpDraw, EPartitionPos ePos ) noexcept;

        //=====================================================================
        // 静的公開関数
    public:
        //---------------------------------------------------------------------
        /// サイズバーコントロール作成関数
        ///
        /// サイズバーコントロール作成関数です。
        ///
        /// @param[in] hParent 親ウィンドウハンドル
        /// @return    コントロールハンドル
        /// @attention なし
        ///
        static HWND CreateSizeBar( HWND hParent ) noexcept;

        //=====================================================================
        // 限定公開変数
    protected:
        HWND         m_hSizeBarImage; ///< サイズバーイメージコントロールハンドル
        POINT        m_sPoint;        ///< カーソル座標
        CWndElement* m_pcElement;     ///< エレメントウィンドウポインタ
        int          m_nSize;         ///< 保存パーティションサイズ
        int          m_nMinSize;      ///< 最小パーティションサイズ
        int          m_nMaxSize;      ///< 最大パーティションサイズ

        //=====================================================================
        // 静的限定公開定数
    protected:
        static BYTE const     TRANS_SIZEBAR_IMAGE  = 96;                   ///< サイズバーイメージ透明度
        static int const      SIZEBAR_THICK        = 4;                    ///< サイズバー太さ
        static COLORREF const COLOR_SIZEBAR        = RGB( 240, 240, 240 ); ///< サイズバー色
        static COLORREF const COLOR_SIZEBAR_BORDER = RGB( 108,  94,  79 ); ///< サイズバーボーダー色

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

#pragma managed( pop )