CBaseTabbedPane クラス

[アーティクル]
10/12/2023

CDockablePane Class の機能を拡張して、タブ付きウィンドウの作成をサポートします。

構文

class CBaseTabbedPane : public CDockablePane

メンバー

パブリックコンストラクター

名前	説明
`CBaseTabbedPane::CBaseTabbedPane`	既定のコンストラクターです。

パブリックメソッド

名前	説明
CBaseTabbedPane::AddTab	タブ付きペインに新しいタブを追加します。
CBaseTabbedPane::AllowDestroyEmptyTabbedPane	空のタブ付きペインを破棄できるかどうかを指定します。
CBaseTabbedPane::ApplyRestoredTabInfo	レジストリから読み込まれるタブ設定をタブ付きペインに適用します。
CBaseTabbedPane::CanFloat	ペインを浮動可能にするかどうかを指定します。 (オーバーライド CBasePane::CanFloat.)
CBaseTabbedPane::CanSetCaptionTextToTabName	タブ付きペインのキャプションに、アクティブなタブと同じテキストを表示するかどうかを指定します。
CBaseTabbedPane::ConvertToTabbedDocument	(オーバーライド CDockablePane::ConvertToTabbedDocument.)
CBaseTabbedPane::D etachPane	1 つ以上のドッキング可能なペインを MDI タブ付きドキュメントに変換します。
CBaseTabbedPane::EnableSetCaptionTextToTabName	タブ付きウィンドウの機能を有効または無効にして、アクティブなタブのラベルテキストとキャプションテキストを同期します。
CBaseTabbedPane::FillDefaultTabsOrderArray	内部タブオーダーを既定の状態に戻します。
CBaseTabbedPane::FindBarByTabNumber	タブが 0 から始まるタブインデックスで識別される場合に、タブ内に存在するペインを返します。
CBaseTabbedPane::FindPaneByID	ペイン ID で識別されるペインを返します。
CBaseTabbedPane::FloatTab	現在ペインが切り離し可能なタブに存在する場合のみ、そのペインを切り離して表示します。
CBaseTabbedPane::GetDefaultTabsOrder	ウィンドウ内のタブの既定の順序を返します。
CBaseTabbedPane::GetFirstVisibleTab	最初に表示されるタブへのポインターを取得します。
CBaseTabbedPane::GetMinSize	ウィンドウの最小許容サイズを取得します。 (オーバーライド CPane::GetMinSize.)
CBaseTabbedPane::GetPaneIcon	ウィンドウアイコンへのハンドルを返します。 (オーバーライド CBasePane::GetPaneIcon.)
CBaseTabbedPane::GetPaneList	タブ付きペインに含まれるペインの一覧を返します。
CBaseTabbedPane::GetTabArea	上部と下部のタブ領域の外接する四角形を返します。
CBaseTabbedPane::GetTabsNum	タブウィンドウ内のタブの数を返します。
CBaseTabbedPane::GetUnderlyingWindow	基になる (ラップされた) タブウィンドウを取得します。
CBaseTabbedPane::GetVisibleTabsNum	表示されているタブの数を返します。
CBaseTabbedPane::HasAutoHideMode	タブ付きペインを自動非表示モードに切り替えることができるかどうかを指定します。
CBaseTabbedPane::IsHideSingleTab	タブが 1 つだけ表示されている場合に、タブ付きペインを非表示にするかどうかを指定します。
`CBaseTabbedPane::LoadSiblingPaneIDs`	シリアル化中に内部的に使用されます。
CBaseTabbedPane::RecalcLayout	ウィンドウのレイアウト情報を再計算します。 (オーバーライド CPane::RecalcLayout.)
CBaseTabbedPane::RemovePane	タブ付きペインからペインを削除します。
`CBaseTabbedPane::SaveSiblingBarIDs`	シリアル化中に内部的に使用されます。
`CBaseTabbedPane::Serialize`	(オーバーライド CDockablePane::Serialize.)
`CBaseTabbedPane::SerializeTabWindow`	シリアル化中に内部的に使用されます。
CBaseTabbedPane::SetAutoDestroy	タブ付きコントロールバーを自動的に破棄するかどうかを指定します。
CBaseTabbedPane::SetAutoHideMode	ドッキングウィンドウを表示モードと自動非表示モードの間で切り替えます。 (オーバーライド CDockablePane::SetAutoHideMode.)
CBaseTabbedPane::ShowTab	タブを表示または非表示にします。

解説

このクラスは抽象クラスであり、インスタンス化することはできません。これは、すべての種類のタブ付きペインに共通するサービスを実装します。

現在、ライブラリには、CTabbedPane クラスと CMFCOutlookBar クラスという 2 つの派生タブ付きペインクラスが含まれています。

オブジェクトはCBaseTabbedPane、CMFCBaseTabCtrl クラスオブジェクトへのポインターをラップします。 CMFCBaseTabCtrl クラスは、タブ付きペインの子ウィンドウになります。

タブ付きペインを作成する方法の詳細については、「CDockablePane クラス、CTabbedPane クラス、および CMFCOutlookBar クラス」を参照してください。

継承階層

CBaseTabbedPane

必要条件

ヘッダー: afxBaseTabbedPane.h

CBaseTabbedPane::AddTab

タブ付きペインに新しいタブを追加します。

virtual BOOL AddTab(
    CWnd* pNewBar,
    BOOL bVisible = TRUE,
    BOOL bSetActive = TRUE,
    BOOL bDetachable = TRUE);

パラメーター

pNewBar
[入力、出力]追加するペインへのポインター。このメソッドを呼び出すと、このポインターが無効になる可能性があります。詳細については、「解説」を参照してください。

bVisible
[in]タブを表示する場合は TRUE。それ以外の場合は FAL Standard Edition。

bSetActive
[in]TRUE タブをアクティブなタブにします。それ以外の場合は FAL Standard Edition。

bDetachable
[in]タブをデタッチ可能にする場合は TRUE。それ以外の場合は FAL Standard Edition。

戻り値

ウィンドウがタブとして正常に追加され、プロセスで破棄されなかった場合は TRUE。 FAL Standard Edition追加するペインが型CBaseTabbedPaneのオブジェクトである場合は a0/>。詳細については、「解説」を参照してください。

解説

このメソッドを呼び出して、タブ付きペインの新しいタブとしてペインを追加します。 pNewBar が型CBaseTabbedPaneのオブジェクトを指している場合、そのすべてのタブがタブ付きペインにコピーされ、pNewBar が破棄されます。したがって、 pNewBar は無効なポインターになり、使用しないでください。

CBaseTabbedPane::AllowDestroyEmptyTabbedPane

空のタブ付きペインを破棄できるかどうかを指定します。

virtual BOOL AllowDestroyEmptyTabbedPane() const;

戻り値

空のタブ付きペインを破棄できる場合は TRUE。それ以外の場合は FAL Standard Edition。既定の実装では常に TRUE が返されます。

解説

空のタブ付きペインを破棄できない場合、フレームワークは代わりにペインを非表示にします。

CBaseTabbedPane::ApplyRestoredTabInfo

レジストリからタブ設定を読み込み、タブ付きペインに適用します。

virtual void ApplyRestoredTabInfo(BOOL bUseTabIndexes = FALSE);

パラメーター

bUseTabIndexes
[in]このパラメーターは、フレームワークによって内部的に使用されます。

解説

このメソッドは、レジストリからドッキング状態情報を再読み込みするときにフレームワークによって呼び出されます。このメソッドは、タブ付きペインのタブオーダーとタブ名に関する情報を取得します。

CBaseTabbedPane::CanFloat

タブ付きペインを浮動可能にするかどうかを指定します。

virtual BOOL CanFloat() const;

戻り値

ペインが浮動可能な場合は TRUE。それ以外の場合は FAL Standard Edition。

CBaseTabbedPane::CanSetCaptionTextToTabName

タブ付きペインのキャプションに、アクティブなタブと同じテキストを表示するかどうかを指定します。

virtual BOOL CanSetCaptionTextToTabName() const;

戻り値

タブ付きペインのキャプションテキストがアクティブなタブのテキストに設定されている場合は TRUE、それ以外の場合は FAL Standard Edition。

解説

このメソッドは、タブ付きウィンドウに表示されるテキストキャプションアクティブなタブのラベルと重複するかどうかを判断するために使用されます。この機能を有効または無効にするには、CBaseTabbedPane::EnableSetCaptionTextToTabName を呼び出します。

CBaseTabbedPane::ConvertToTabbedDocument

1 つ以上のドッキング可能なペインを MDI タブ付きドキュメントに変換します。

virtual void ConvertToTabbedDocument(BOOL bActiveTabOnly = TRUE);

パラメーター

bActiveTabOnly
[in]タブ付きペインを変換する場合は、アクティブなタブのみを変換するように TRUE を指定します。FAL Standard Edition を指定して、ウィンドウ内のすべてのタブを変換します。

CBaseTabbedPane::D etachPane

タブ付きペインからペインをデタッチします。

virtual BOOL DetachPane(
    CWnd* pBar,
    BOOL bHide = FALSE);

パラメーター

pBar
[in]デタッチするペインへのポインター。

bHide
[in]デタッチ後にフレームワークがペインを非表示にするかどうかを指定するブール型パラメーター。

戻り値

フレームワークがウィンドウを正常にデタッチした場合は TRUE。FAL Standard Edition pBar が NULL の場合、またはタブ付きペインにないペインを参照している場合。

解説

可能な場合、フレームワークはデタッチされたウィンドウを浮動します。詳細については、「CBasePane::CanFloat」を参照してください。

CBaseTabbedPane::EnableSetCaptionTextToTabName

タブ付きウィンドウの機能を有効または無効にして、アクティブなタブのラベルテキストとキャプションテキストを同期します。

virtual void EnableSetCaptionTextToTabName(BOOL bEnable);

パラメーター

bEnable
[in]タブ付きペインのキャプションをアクティブなタブキャプションと同期する場合は TRUE。それ以外の場合は FAL Standard Edition。

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。それ以外の場合は FAL Standard Edition。これは、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。それ以外の場合は FAL Standard Edition。

戻り値

ペインが浮動している場合は TRUE。それ以外の場合は FAL Standard Edition。

解説

このメソッドを呼び出して、現在デタッチ可能なタブに存在するペインを浮動します。

プログラムでウィンドウをデタッチする場合は、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)、サイズにはアクティブなタブで許可されている最小サイズが入力されます。それ以外の場合、サイズには CPane::GetMinSize の戻り値が入力されます。

CBaseTabbedPane::GetPaneIcon

ウィンドウの最小許容サイズを取得します。

virtual void GetMinSize(CSize& size) const;

パラメーター

size
[out] CSize 許容される最小サイズで塗りつぶされたオブジェクト。

解説

CBaseTabbedPane::GetPaneList

タブ付きペインに含まれるペインの一覧を返します。

virtual void GetPaneList(
    CObList& lst,
    CRuntimeClass* pRTCFilter = NULL);

パラメーター

Lst
[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。それ以外の場合は FAL Standard Edition。

解説

自動非表示モードが無効になっている場合、タブ付きペインのキャプションにピンボタンは表示されません。

CBaseTabbedPane::IsHideSingleTab

タブが 1 つだけ表示されている場合に、タブ付きペインを非表示にするかどうかを指定します。

virtual BOOL IsHideSingleTab() const;

戻り値

表示されるタブが 1 つしかないときにタブウィンドウが表示されない場合は TRUE。それ以外の場合は FAL Standard Edition。

解説

1 つのタブのみが開いているためにペインが表示されない場合は、このメソッドを呼び出して、タブ付きペインが正しく動作しているかどうかを判断できます。

CBaseTabbedPane::RemovePane

タブ付きペインからペインを削除します。

virtual BOOL RemovePane(CWnd* pBar);

パラメーター

pBar
[入力、出力]タブ付きペインから削除するペインへのポインター。

戻り値

TRUE の場合は、ウィンドウが正常にタブ付きペインから削除され、タブ付きペインがまだ有効な場合。 FAL Standard Editionタブ付きペインから最後のペインが削除され、タブ付きペインが破棄されようとしている場合。戻り値が FAL Standard Edition の場合は、タブ付きペインをこれ以上使用しないでください。

解説

このメソッドを呼び出して、タブ付きペインから pBar パラメーターで指定されたペインを削除します。

CBaseTabbedPane::SetAutoDestroy

タブ付きコントロールバーを自動的に破棄するかどうかを指定します。

void SetAutoDestroy(BOOL bAutoDestroy = TRUE);

パラメーター

bAutoDestroy
[in]タブ付きペインが動的に作成され、その有効期間を制御していない場合は TRUE。それ以外の場合は FAL Standard Edition。

解説

タブ付きペインを動的に作成し、その有効期間を制御していない場合は、自動破棄モードを TRUE に設定します。自動破棄モードが TRUE の場合、タブ付きウィンドウはフレームワークによって自動的に破棄されます。

CBaseTabbedPane::ShowTab

タブを表示または非表示にします。

virtual BOOL ShowTab(
    CWnd* pBar,
    BOOL bShow,
    BOOL bDelay,
    BOOL bActivate);

パラメーター

pBar
[in]表示または非表示にするペインへのポインター。

bShow
[in]ウィンドウを表示する場合は TRUE。FAL Standard Edition ウィンドウを非表示にします。

bDelay
[in]タブレイアウトの調整を遅らせる場合は TRUE。それ以外の場合は FAL Standard Edition。

bActivate
[in]TRUE タブをアクティブなタブにします。それ以外の場合は FAL Standard Edition。

戻り値

タブが正常に表示または非表示にされた場合は TRUE。それ以外の場合は FAL Standard Edition。

解説

このメソッドを呼び出すと、bShow パラメーターの値に応じてペインが表示または非表示になります。タブを非表示にし、基になるタブウィンドウの最後に表示されるタブである場合、タブ付きペインは非表示になります。以前にタブが表示されていないときにタブを表示すると、タブ付きペインが表示されます。

CBaseTabbedPane::RecalcLayout

ウィンドウのレイアウト情報を再計算します。

virtual void RecalcLayout();

解説

ウィンドウが浮動状態の場合、このメソッドは、ウィンドウのサイズをミニフレームの現在のサイズに変更するようフレームワークに通知します。

ペインがドッキングされている場合、このメソッドは何も行いません。

CBaseTabbedPane::SetAutoHideMode

タブ付きペインのデタッチ可能ペインの自動非表示モードを設定します。

virtual CMFCAutoHideToolBar* SetAutoHideMode(
    BOOL bMode,
    DWORD dwAlignment,
    CMFCAutoHideToolBar* pCurrAutoHideBar = NULL,
    BOOL bUseTimer = TRUE);

パラメーター

bMode
[in]自動非表示モードを有効にする場合は TRUE。FAL Standard Edition 通常のドッキングモードを有効にします。

dwAlignment
[in]作成する自動非表示ペインの配置を指定します。使用可能な値の一覧については、「CPane::MoveByAlignment」を参照してください。

pCurrAutoHideBar
[入力、出力]現在の自動非表示ツールバーへのポインター。 NULL にすることができます。

bUseTimer
[in]ユーザーがペインを自動非表示モードに切り替えたときに自動非表示効果を使用するか、ペインをすぐに非表示にするかを指定します。

戻り値

自動非表示モードに切り替えるときに作成される自動非表示ツールバーへのポインター。ツールバーが作成されていない場合は NULL。

解説

フレームワークは、ユーザーがピンボタンを選択してタブ付きウィンドウを自動非表示モードまたは通常のドッキングモードに切り替えるときに、このメソッドを呼び出します。

自動非表示モードは、タブ付きペインのデタッチ可能ウィンドウごとに設定されます。デタッチできないペインは無視されます。詳細については、「CMFCBaseTabCtrl::EnableTabDetach」を参照してください。

このメソッドを呼び出して、タブ付きウィンドウをプログラムで自動非表示モードに切り替えます。ウィンドウは、メインフレームウィンドウにドッキングする必要があります (CDockablePane::GetDefaultPaneDivider は、CPaneDivider への有効なポインターを返す必要があります)。

Share via

CBaseTabbedPane クラス

構文

メンバー

パブリック コンストラクター

パブリック メソッド

解説

継承階層

必要条件

CBaseTabbedPane::AddTab

パラメーター

戻り値

解説

CBaseTabbedPane::AllowDestroyEmptyTabbedPane

戻り値

解説

CBaseTabbedPane::ApplyRestoredTabInfo

パラメーター

解説

CBaseTabbedPane::CanFloat

戻り値

CBaseTabbedPane::CanSetCaptionTextToTabName

戻り値

解説

CBaseTabbedPane::ConvertToTabbedDocument

パラメーター

CBaseTabbedPane::D etachPane

パラメーター

戻り値

解説

CBaseTabbedPane::EnableSetCaptionTextToTabName

パラメーター

CBaseTabbedPane::FillDefaultTabsOrderArray

解説

CBaseTabbedPane::FindPaneByID

パラメーター

戻り値

解説

CBaseTabbedPane::FindBarByTabNumber

パラメーター

戻り値

解説

CBaseTabbedPane::FloatTab

パラメーター

戻り値

解説

CBaseTabbedPane::GetDefaultTabsOrder

戻り値

解説

CBaseTabbedPane::GetFirstVisibleTab

パラメーター

戻り値

CBaseTabbedPane::GetMinSize

パラメーター

解説

CBaseTabbedPane::GetPaneIcon

パラメーター

解説

CBaseTabbedPane::GetPaneList

パラメーター

CBaseTabbedPane::GetTabArea

パラメーター

解説

CBaseTabbedPane::GetTabsNum

戻り値

CBaseTabbedPane::GetUnderlyingWindow

戻り値

CBaseTabbedPane::GetVisibleTabsNum

戻り値

解説

CBaseTabbedPane::HasAutoHideMode

戻り値

解説

CBaseTabbedPane::IsHideSingleTab

戻り値

解説

CBaseTabbedPane::RemovePane

パラメーター

戻り値

解説

パブリックコンストラクター

パブリックメソッド