CDockablePane クラス
ドッキング サイトにドッキングできる、またはタブ付きペインに含めることができるペインを実装します。
class CDockablePane : public CPane
メンバー
.gif "Bb984433.collapse_all(ja-jp,VS.110).gif")
パブリック コンストラクター
名前 |
説明 |
|---|---|
CDockablePane オブジェクトを構築し、初期化します。 |
パブリック メソッド
名前 |
説明 |
|---|---|
ペインを別のペインにアタッチします。これによって、タブ付きペインが作成されます。 |
|
ウィンドウ四角形のサイズを返します。 |
|
指定がミニフレーム ウィンドウにドッキングできるかどうかを判定します。 |
|
別のペインを現在のペインにドッキングできるかどうかを調べます。 |
|
ペインが自動非表示モードをサポートするかどうかを判定します。(CBasePane::CanAutoHide をオーバーライドします。) |
|
現在のペインを別のペインにドッキングできるかどうかを判定します。 |
|
MDI タブ付きドキュメントに一つ以上のドッキング可能なペインを変換します。 |
|
ドッキングできるペインの状態をコピーします。 |
|
Windows コントロールを作成し、それを CDockablePane オブジェクトにアタッチします。 |
|
フレーム ウィンドウにドッキングされるようにウィンドウの既定の区分線を作成します。 |
|
Windows コントロールを作成し、それを CDockablePane オブジェクトにアタッチします。 |
|
現在のペインからタブ付きペインを作成します。 |
|
ウィンドウにコンテナーをドッキングします。 |
|
アウトラインの (標準) を使用してドッキング ペインをドッキングします。 |
|
CDockablePane::DockToFrameWindow |
内部使用。ペインをドッキングするには、CPane::DockPane か CDockablePane::DockToWindowを使用します。 |
格納されている最新のドッキング位置にペインをドッキングします。 |
|
ドッキング ペインを別のドッキング ペインにドッキングします。 |
|
コンテナー内の他のペインとともにこのペインの自動非表示モードを有効または無効にします。 |
|
キャプション (グリップ) を表示または非表示にします。 |
|
表示されていた場合、自動非表示モードのペインの位置を指定します。 |
|
ペインの自動非表示のスライド モードを取得します。 |
|
CDockablePane::GetAutoHideButton |
内部使用。 |
CDockablePane::GetAutoHideToolBar |
内部使用。 |
現在のキャプションの高さを返します。 |
|
ペインのコンテナーの既定のペイン区分線を返します。 |
|
指定されたポインター位置に基づいてドッキングされるペインの機能を判断します。 |
|
ドッキング ペインのドラッグ感度を返します。 |
|
ウィンドウがコンテナー内で占有空間の割合を取得します。 |
|
ウィンドウのタブ領域を取得します。 |
|
別のペインが現在のペインにドッキングされたときに作成されるタブ付きウィンドウに関するランタイム クラス情報を返します。 |
|
ドッキング ペインが自動非表示モードに切り替えることができるかどうかを指定します。 |
|
ペイン内でユーザーがマウスをクリックした特定の位置を指定します。 |
|
CDockablePane::IsAccessibilityCompatible |
内部使用。 |
ドッキング ペインとコンテナー内の他のすべてのペインを自動非表示モードに設定できるかどうかを示します。 |
|
ペインが自動非表示モードにあるかどうかを判定します。 |
|
CDockablePane::IsChangeState |
内部使用。 |
現在のペインがドッキングされているかどうかを判定します。 |
|
ShowPaneを呼び出して、(表示または非表示にされます) 自動非表示モードのペインの動作を決定します。 |
|
ウィンドウが複数のウィンドウ フレーム ウィンドウにあるかどうかを指定します。 |
|
ウィンドウのサイズを変更できるかどうかを指定します。 |
|
タブがウィンドウの上部または下部にあるかどうかを指定します。 |
|
ユーザーがペインをドラッグするかどうかを指定します。 |
|
現在のペインの表示状態を判定します。 |
|
内部使用。 |
|
ペインの親が変更されたときに、フレームワークによって呼び出されます。(CPane::OnAfterChangeParent をオーバーライドします。) |
|
フリーのドッキング バーがフレーム ウィンドウにドッキングされるときに、フレームワークによって呼び出されます。 |
|
ペインの親が変更される直前に、フレームワークによって呼び出されます。(CPane::OnBeforeChangeParent をオーバーライドします。) |
|
ペインがフローティング状態になる直前に、フレームワークによって呼び出されます (CPane::OnBeforeFloat をオーバーライドします)。 |
|
フレームワークは、ペインをドッキング解除されるときにこのメソッドを呼び出します。 |
|
特定のウィンドウでウィンドウを置き換えます。 |
|
フレームワークは既定のペイン区分線を復元するためにウィンドウが逆シリアル化するときにこのメソッドを呼び出します。 |
|
CDockablePane::SaveState |
内部使用。 |
CDockablePane::Serialize |
ウィンドウをシリアル化します。(CBasePane::Serialize をオーバーライドします。) |
表示モードと自動非表示のドッキング ペインの表示と非表示を切り替えます。 |
|
ペインの自動非表示ボタンと自動非表示ツール バーを設定します。 |
|
CDockablePane::SetDefaultPaneDivider |
内部使用。 |
ウィンドウがコンテナー内で占有空間の割合を設定します。 |
|
CDockablePane::SetResizeMode |
内部使用。 |
復元された既定のペイン区分線を設定します。 |
|
2 つのペインがドッキングされるときに作成されるタブ付きウィンドウのランタイム クラス情報を設定します。 |
|
ペインの表示と非表示を切り替えます。 |
|
ペインが自動非表示モードの場合にのみ表示するスライド アニメーションを持つウィンドウを表示または非表示にします。 |
|
自動非表示モードに切り替えます。 (CPane::ToggleAutoHide をオーバーライドします。) |
|
メイン フレーム ウィンドウまたはミニフレーム ウィンドウ コンテナーからペインをドッキング解除します。 |
|
CDockablePane::UnSetAutoHideMode |
内部使用。自動非表示モードを設定するには、CDockablePane::SetAutoHideModeを使用します。 |
プロテクト メソッド
名前 |
説明 |
|---|---|
ドッキング ペインが非表示かどうかを判断します (自動非表示モードに)。 |
|
自動非表示のドッキング ペインがスライドをいつ停止するかを判断します。 |
|
ドッキング ペイン キャプション (グリップ) を描画します。 |
|
ユーザーが AFX_HTCLOSE ボタンと AFX_HTMAXBUTTON ボタン以外のキャプション ボタンを押したときに呼び出されます。 |
|
ペインが表示または非表示にするときの自動非表示のスライド効果を表示するために、フレームワークによって呼び出されます。 |
データ メンバー
名前 |
説明 |
|---|---|
ドッキング可能なペインの自動非表示アニメーションを無効にするかどうかを指定します。 |
|
ペインが自動非表示モードのときのペインの動作を決定します。 |
|
これを自動非表示モードにと表示または非表示にされているときのペインのアニメーション速度を指定します。 |
解説
CDockablePane は次の機能を実装します。
メイン フレーム ウィンドウへのペインのドッキング。
ペインの自動非表示モードの切り替え。
タブ付きウィンドウへのペインのアタッチ。
ミニフレームウィンドウでのペインの切り離し。
ミニフレーム ウィンドウにおける浮動ペインの、別のペインへのドッキング。
ペインのサイズ変更。
ドッキング ペインの状態の読み込みと保存。
[!メモ]
状態情報は、Windows レジストリに保存されます。
キャプション付きまたはキャプションなしのペインの作成。キャプションには、テキスト ラベルを設定できます。また、キャプションをグラデーションの色で塗りつぶすことができます。
ペインのコンテンツ表示中のペインのドラッグ。
ドラッグ四角形の表示中のペインのドラッグ。
アプリケーションでドッキング ペインを使用するには、CDockablePane クラスからペイン クラスを派生します。派生オブジェクトをメイン フレーム ウィンドウ オブジェクトまたはペインのインスタンスを制御するウィンドウ オブジェクトに埋め込みます。次に、メイン フレーム ウィンドウで WM_CREATE メッセージを処理するときに、CDockablePane::Create メソッドまたは CDockablePane::CreateEx メソッドを呼び出します。最後に、CBasePane::EnableDocking、CBasePane::DockPane、または CDockablePane::AttachToTabWnd を呼び出してペイン オブジェクトを設定します。
カスタマイズのヒント
次のヒントは CDockablePane オブジェクトに適用されます。
タブ付きではない 2 つのドッキング可能ペインに CDockablePane::AttachToTabWnd を呼び出した場合、タブ付きウィンドウへのポインターが ppTabbedControlBar パラメーターに返されます。このパラメーターを使用することにより、続けてタブ付きウィンドウにタブを追加できます。
CDockablePane::AttachToTabWnd により作成されるタブ付きペインの種類は、pTabControlBarAttachTo パラメーターの CDockablePane オブジェクトにより決まります。CDockablePane::SetTabbedPaneRTC を呼び出して、CDockablePane が作成するタブ付きペインの種類を設定できます。既定の型は、最初に CDockablePane を作成するときに CDockablePane::Create の dwTabbedStyle により決まります。dwTabbedStyle が AFX_CBRS_OUTLOOK_TABS の場合、既定の型は CMFCOutlookBar クラス です。dwTabbedStyle が AFX_CBRS_REGULAR_TABS の場合、既定の型は CTabbedPane クラス です。
ドッキング可能ペインを別のドッキング可能ペインにドッキングするには、CDockablePane::DockToWindow メソッドを呼び出します。このメソッドを呼び出す前に、元のペインをどこかにドッキングする必要があります。
メンバー変数 CDockablePane::m_bHideInAutoHideMode は、CDockablePane::ShowPane を呼び出したときにドッキング可能ペインが自動非表示モードでどのように動作するかを制御します。このメンバー変数が TRUE に設定されている場合、ドッキング可能ペインとその自動非表示ボタンは非表示になります。それ以外の場合は、スライド インおよびスライド アウトします。
CDockablePane::m_bDisableAnimation のメンバーを TRUEに設定することで、自動非表示アニメーションを無効にできます。
使用例
CDockablePane クラスのさまざまなメソッドを使用して CDockablePane オブジェクトを構成する方法を次の例に示します。例では、自動非表示のドッキングできるペインのすべての機能を有効にし、キャプションまたはグリッパーを有効にし、自動非表示モードを有効にし、ウィンドウの表示、自動非表示モードのペインをアニメーション化する方法を示します。このコード スニペットは Visual Studio のデモのサンプルの一部です。
// GetOwner is an inherited method.
CDockablePane* pParentBar = DYNAMIC_DOWNCAST(CDockablePane, GetOwner());
...
pParentBar->EnableAutohideAll();
pParentBar->EnableGripper(true);
pParentBar->SetAutoHideMode(true, CBRS_ALIGN_LEFT);
pParentBar->ShowPane(true,false,true);
pParentBar->Slide(true);
継承階層
必要条件
ヘッダー : afxDockablePane.h