CBaseTabbedPane クラス
CDockablePane Class の機能を拡張して、タブ付きウィンドウの作成をサポートします。
構文
class CBaseTabbedPane : public CDockablePane
メンバー
パブリック コンストラクター
| 名前 | 説明 |
|---|---|
CBaseTabbedPane::CBaseTabbedPane |
既定のコンストラクターです。 |
パブリック メソッド
解説
このクラスは抽象クラスであり、インスタンス化することはできません。 これは、すべての種類のタブ付きペインに共通するサービスを実装します。
現在、ライブラリには、 CTabbedPane クラス と CMFCOutlookBar クラスの 2 つの派生タブ付きペイン クラスが含まれています。
CBaseTabbedPane オブジェクトは、CMFCBaseTabCtrl クラス オブジェクトへのポインターをラップします。 CMFCBaseTabCtrl クラス タブ付きウィンドウの子ウィンドウになります。
タブ付きペインを作成する方法の詳細については、「 CDockablePane クラス、 CTabbedPane クラス、および CMFCOutlookBar クラスを参照してください。
継承階層
CBaseTabbedPane
要件
Header: afxBaseTabbedPane.h
CBaseTabbedPane::AddTab
タブ付きペインに新しいタブを追加します。
virtual BOOL AddTab(
CWnd* pNewBar,
BOOL bVisible = TRUE,
BOOL bSetActive = TRUE,
BOOL bDetachable = TRUE);
パラメーター
pNewBar
[入力、出力]追加するペインへのポインター。 このメソッドを呼び出すと、このポインターが無効になる可能性があります。 詳細については、「解説」を参照してください。
bVisible
[in]タブを表示する場合は TRUE。それ以外の場合は FALSE。
bSetActive
[in]TRUE タブをアクティブなタブにします。それ以外の場合は FALSE。
bDetachable
[in]タブをデタッチ可能にする場合は TRUE。それ以外の場合は FALSE。
戻り値
ウィンドウがタブとして正常に追加され、プロセスで破棄されなかった場合は TRUE。 追加するペインが CBaseTabbedPane型のオブジェクトである場合は FALSE。 詳細については、「解説」を参照してください。
解説
このメソッドを呼び出して、タブ付きペインの新しいタブとしてペインを追加します。 pNewBarがCBaseTabbedPane型のオブジェクトを指している場合、そのすべてのタブがタブ付きペインにコピーされ、pNewBarが破棄されます。 したがって、 pNewBar は無効なポインターになり、使用しないでください。
CBaseTabbedPane::AllowDestroyEmptyTabbedPane
空のタブ付きペインを破棄できるかどうかを指定します。
virtual BOOL AllowDestroyEmptyTabbedPane() const;
戻り値
空のタブ付きペインを破棄できる場合は TRUE。それ以外の場合は FALSE。 既定の実装では常に TRUE が返されます。
解説
空のタブ付きペインを破棄できない場合、フレームワークは代わりにペインを非表示にします。
CBaseTabbedPane::ApplyRestoredTabInfo
レジストリからタブ設定を読み込み、タブ付きペインに適用します。
virtual void ApplyRestoredTabInfo(BOOL bUseTabIndexes = FALSE);
パラメーター
bUseTabIndexes
[in]このパラメーターは、フレームワークによって内部的に使用されます。
解説
このメソッドは、レジストリからドッキング状態情報を再読み込みするときにフレームワークによって呼び出されます。 このメソッドは、タブ付きペインのタブ オーダーとタブ名に関する情報を取得します。
CBaseTabbedPane::CanFloat
タブ付きペインを浮動可能にするかどうかを指定します。
virtual BOOL CanFloat() const;
戻り値
ペインが浮動可能な場合は TRUE。それ以外の場合は FALSE。
CBaseTabbedPane::CanSetCaptionTextToTabName
タブ付きペインのキャプションに、アクティブなタブと同じテキストを表示するかどうかを指定します。
virtual BOOL CanSetCaptionTextToTabName() const;
戻り値
TRUE の場合、タブ付きウィンドウのキャプション テキストがアクティブなタブのテキストに設定されています。それ以外の場合は FALSE。
解説
このメソッドは、タブ付きペインのキャプションに表示されるテキストがアクティブなタブのラベルと重複しているかどうかを判断するために使用されます。この機能を有効または無効にするには、 CBaseTabbedPane::EnableSetCaptionTextToTabName を呼び出します。
CBaseTabbedPane::ConvertToTabbedDocument
1 つ以上のドッキング可能なペインを MDI タブ付きドキュメントに変換します。
virtual void ConvertToTabbedDocument(BOOL bActiveTabOnly = TRUE);
パラメーター
bActiveTabOnly
[in]タブ付きペインを変換する場合は、アクティブなタブのみを変換するように TRUE を指定します。ウィンドウ内のすべてのタブを変換するには、FALSE を指定します。
CBaseTabbedPane::D etachPane
タブ付きペインからペインをデタッチします。
virtual BOOL DetachPane(
CWnd* pBar,
BOOL bHide = FALSE);
パラメーター
pBar
[in]デタッチするペインへのポインター。
bHide
[in]デタッチ後にフレームワークがペインを非表示にするかどうかを指定するブール型パラメーター。
戻り値
フレームワークがウィンドウを正常にデタッチした場合は TRUE。 pBar が NULL の場合、またはタブ付きペインにないペインを参照する場合は FALSE。
解説
可能な場合、フレームワークはデタッチされたウィンドウを浮動します。 詳細については、「 CBasePane::CanFloat」を参照してください。
CBaseTabbedPane::EnableSetCaptionTextToTabName
タブ付きウィンドウの機能を有効または無効にして、アクティブなタブのラベル テキストとキャプション テキストを同期します。
virtual void EnableSetCaptionTextToTabName(BOOL bEnable);
パラメーター
bEnable
[in]TRUE の場合、タブ付きペインのキャプションをアクティブなタブ キャプションと同期します。それ以外の場合は FALSE。
CBaseTabbedPane::FillDefaultTabsOrderArray
内部タブ オーダーを既定の状態に戻します。
void FillDefaultTabsOrderArray();
解説
このメソッドは、フレームワークが Outlook バーを初期状態に復元するときに呼び出されます。
CBaseTabbedPane::FindPaneByID
ペイン ID で識別されるペインを返します。
virtual CWnd* FindPaneByID(UINT uBarID);
パラメーター
uBarID
[in]検索するペインの ID を指定します。
戻り値
ペインが見つかった場合のペインへのポインター。それ以外の場合は NULL。
解説
このメソッドは、ペイン内のすべてのタブを比較し、 uBarID パラメーターで指定された ID を持つタブを返します。
CBaseTabbedPane::FindBarByTabNumber
タブ内にあるペインを返します。
virtual CWnd* FindBarByTabNumber(
int nTabNum,
BOOL bGetWrappedBar = FALSE);
パラメーター
nTabNum
[in]取得するタブの 0 から始まるインデックスを指定します。
bGetWrappedBar
[in]ペイン自体ではなく、ペインの基になる (ラップされた) ウィンドウを返す場合は TRUE。それ以外の場合は FALSE。 これは、 CDockablePaneAdapter から派生したペインにのみ適用されます。
戻り値
ペインが見つかった場合は、検索対象のペインへの有効なポインターが返されます。それ以外の場合は NULL。
解説
このメソッドを呼び出して、 nTabNum パラメーターで指定されたタブに存在するペインを取得します。
CBaseTabbedPane::FloatTab
現在ペインが切り離し可能なタブに存在する場合のみ、そのペインを切り離して表示します。
virtual BOOL FloatTab(
CWnd* pBar,
int nTabID,
AFX_DOCK_METHOD dockMethod,
BOOL bHide = FALSE);
パラメーター
pBar
[入力、出力]浮動するペインへのポインター。
nTabID
[in]浮動するタブの 0 から始まるインデックスを指定します。
dockMethod
[in]ペインを浮動にするのに使用するメソッドを指定します。 詳細については、「解説」を参照してください。
bHide
[in]浮動する前にペインを非表示にする場合は TRUE。それ以外の場合は FALSE。
戻り値
ペインが浮動している場合は TRUE。それ以外の場合は FALSE。
解説
このメソッドを呼び出して、現在デタッチ可能なタブに存在するペインを浮動します。
プログラムでウィンドウをデタッチする場合は、 dockMethod パラメーターにDM_SHOWを指定します。 前に浮動したのと同じ位置にペインを浮動させる場合は、 dockMethod パラメーターとしてDM_DBL_CLICKを指定します。
CBaseTabbedPane::GetDefaultTabsOrder
ウィンドウ内のタブの既定の順序を返します。
const CArray<int,int>& GetDefaultTabsOrder();
戻り値
ウィンドウ内のタブの既定の順序を指定する CArray オブジェクト。
解説
フレームワークは、Outlook バーが初期状態にリセットされたときに、このメソッドを呼び出します。
CBaseTabbedPane::GetFirstVisibleTab
最初に表示されるタブへのポインターを取得します。
virtual CWnd* GetFirstVisibleTab(int& iTabNum);
パラメーター
iTabNum
[in]整数への参照。 このメソッドは、最初に表示されたタブの 0 から始まるインデックスをこのパラメーターに書き込みます。表示されたタブが見つからない場合は -1 を書き込みます。
戻り値
成功した場合は、最初に表示されたタブへのポインター。それ以外の場合は NULL。
CBaseTabbedPane::GetMinSize
ウィンドウの最小許容サイズを取得します。
virtual void GetMinSize(CSize& size) const;
パラメーター
size
[out]許容される最小サイズで埋められた CSize オブジェクト。
解説
最小ウィンドウ サイズの一貫した処理がアクティブ ( CPane::m_bHandleMinSize) の場合、 size はアクティブなタブで許可されている最小サイズで塗りつぶされます。それ以外の場合は、 size には CPane::GetMinSize の戻り値が入力されます。
CBaseTabbedPane::GetPaneIcon
ウィンドウの最小許容サイズを取得します。
virtual void GetMinSize(CSize& size) const;
パラメーター
size
[out]許容される最小サイズで埋められた CSize オブジェクト。
解説
最小ウィンドウ サイズの一貫した処理がアクティブ ( CPane::m_bHandleMinSize) の場合、 size はアクティブなタブで許可されている最小サイズで塗りつぶされます。それ以外の場合は、 size には CPane::GetMinSize の戻り値が入力されます。
CBaseTabbedPane::GetPaneList
タブ付きペインに含まれるペインの一覧を返します。
virtual void GetPaneList(
CObList& lst,
CRuntimeClass* pRTCFilter = NULL);
パラメーター
上陸用舟艇
[out]タブ付きペインに含まれるペインで塗りつぶされる CObList 。
pRTCFilter
[in]NULL でない場合、返されるリストには、指定されたランタイム クラスのペインのみが含まれます。
CBaseTabbedPane::GetTabArea
上部と下部のタブ領域の外接する四角形を返します。
virtual void GetTabArea(
CRect& rectTabAreaTop,
CRect& rectTabAreaBottom) const = 0;
パラメーター
rectTabAreaTop
[out]上部タブ領域の画面座標を受け取ります。
rectTabAreaBottom
[out]下部タブ領域の画面座標を受け取ります。
解説
このメソッドを呼び出して、上下のタブ領域の外接する四角形を画面座標で決定します。
CBaseTabbedPane::GetTabsNum
タブ ウィンドウ内のタブの数を返します。
virtual int GetTabsNum() const;
戻り値
タブ付きペイン内のタブの数。
CBaseTabbedPane::GetUnderlyingWindow
基になる (ラップされた) タブ ウィンドウを取得します。
virtual CMFCBaseTabCtrl* GetUnderlyingWindow();
戻り値
基になるタブ ウィンドウへのポインター。
CBaseTabbedPane::GetVisibleTabsNum
表示されているタブの数を返します。
virtual int GetVisibleTabsNum() const;
戻り値
表示されるタブの数。0 以上になります。
解説
このメソッドを呼び出して、タブ付きペインに表示されるタブの数を決定します。
CBaseTabbedPane::HasAutoHideMode
タブ付きペインを AutoHide モードに切り替えられるかどうかを判断します。
virtual BOOL HasAutoHideMode() const;
戻り値
ウィンドウを自動非表示モードに切り替えることができる場合は TRUE。それ以外の場合は FALSE。
解説
自動非表示モードが無効になっている場合、タブ付きペインのキャプションにピン ボタンは表示されません。
CBaseTabbedPane::IsHideSingleTab
タブが 1 つだけ表示されている場合に、タブ付きペインを非表示にするかどうかを指定します。
virtual BOOL IsHideSingleTab() const;
戻り値
表示されるタブが 1 つしかないときにタブ ウィンドウが表示されない場合は TRUE。それ以外の場合は FALSE。
解説
1 つのタブのみが開いているためにペインが表示されない場合は、このメソッドを呼び出して、タブ付きペインが正しく動作しているかどうかを判断できます。
CBaseTabbedPane::RemovePane
タブ付きペインからペインを削除します。
virtual BOOL RemovePane(CWnd* pBar);
パラメーター
pBar
[入力、出力]タブ付きペインから削除するペインへのポインター。
戻り値
TRUE の場合は、ウィンドウが正常にタブ付きペインから削除され、タブ付きペインがまだ有効な場合。 最後のペインがタブ付きペインから削除され、タブ付きペインが破棄されようとしている場合は FALSE。 戻り値が FALSE の場合は、タブ付きペインをこれ以上使用しないでください。
解説
このメソッドを呼び出して、タブ付きペインから pBar パラメーターで指定されたペインを削除します。
CBaseTabbedPane::SetAutoDestroy
タブ付きコントロール バーを自動的に破棄するかどうかを指定します。
void SetAutoDestroy(BOOL bAutoDestroy = TRUE);
パラメーター
bAutoDestroy
[in]タブ付きペインが動的に作成され、その有効期間を制御していない場合は TRUE。それ以外の場合は FALSE。
解説
タブ付きペインを動的に作成し、その有効期間を制御していない場合は、自動破棄モードを TRUE に設定します。 自動破棄モードが TRUE の場合、タブ付きウィンドウはフレームワークによって自動的に破棄されます。
CBaseTabbedPane::ShowTab
タブを表示または非表示にします。
virtual BOOL ShowTab(
CWnd* pBar,
BOOL bShow,
BOOL bDelay,
BOOL bActivate);
パラメーター
pBar
[in]表示または非表示にするペインへのポインター。
bShow
[in]ウィンドウを表示する場合は TRUE。ペインを非表示にする場合は FALSE。
bDelay
[in]タブ レイアウトの調整を遅らせる場合は TRUE。それ以外の場合は FALSE。
bActivate
[in]TRUE タブをアクティブなタブにします。それ以外の場合は FALSE。
戻り値
タブが正常に表示または非表示にされた場合は TRUE。それ以外の場合は FALSE。
解説
このメソッドを呼び出すと、 bShow パラメーターの値に応じてペインが表示または非表示になります。 タブを非表示にし、基になるタブ ウィンドウの最後に表示されるタブである場合、タブ付きペインは非表示になります。 以前にタブが表示されていないときにタブを表示すると、タブ付きペインが表示されます。
CBaseTabbedPane::RecalcLayout
ウィンドウのレイアウト情報を再計算します。
virtual void RecalcLayout();
解説
ウィンドウが浮動状態の場合、このメソッドは、ウィンドウのサイズをミニフレームの現在のサイズに変更するようフレームワークに通知します。
ペインがドッキングされている場合、このメソッドは何も行いません。
CBaseTabbedPane::SetAutoHideMode
タブ付きペインのデタッチ可能ペインの自動非表示モードを設定します。
virtual CMFCAutoHideToolBar* SetAutoHideMode(
BOOL bMode,
DWORD dwAlignment,
CMFCAutoHideToolBar* pCurrAutoHideBar = NULL,
BOOL bUseTimer = TRUE);
パラメーター
bMode
[in]自動非表示モードを有効にする場合は TRUE。通常のドッキング モードを有効にする場合は FALSE。
dwAlignment
[in]作成する自動非表示ペインの配置を指定します。 使用可能な値の一覧については、「 CPane::MoveByAlignmentを参照してください。
pCurrAutoHideBar
[入力、出力]現在の自動非表示ツール バーへのポインター。 NULL にすることができます。
bUseTimer
[in]ユーザーがペインを自動非表示モードに切り替えたときに自動非表示効果を使用するか、ペインをすぐに非表示にするかを指定します。
戻り値
自動非表示モードに切り替えるときに作成される自動非表示ツール バーへのポインター。ツール バーが作成されていない場合は NULL。
解説
フレームワークは、ユーザーがピン ボタンを選択してタブ付きウィンドウを自動非表示モードまたは通常のドッキング モードに切り替えるときに、このメソッドを呼び出します。
自動非表示モードは、タブ付きペインのデタッチ可能ウィンドウごとに設定されます。 デタッチできないペインは無視されます。 詳細については、「 CMFCBaseTabCtrl::EnableTabDetachを参照してください。
このメソッドを呼び出して、タブ付きウィンドウをプログラムで自動非表示モードに切り替えます。 ウィンドウはメイン フレーム ウィンドウ ( CDockablePane::GetDefaultPaneDivider CPaneDivider への有効なポインターを返す必要があります) にドッキングする必要があります。