CMFCBaseTabCtrl クラス
タブ付きウィンドウの基本的な機能を実装します。 詳細については、Visual Studio のインストールの VC\atlmfc\src\mfc フォルダーにあるソース コードを参照してください。
構文
class CMFCBaseTabCtrl : public CWnd
メンバー
パブリック メソッド
保護メソッド
| 名前 | 説明 |
|---|---|
| CMFCBaseTabCtrl::CreateWrapper | から派生しているのではない CWnd CDockablePaneから派生したオブジェクトのラッパーを作成します。 CMFCBaseTabCtrl オブジェクトをドッキングするには、埋め込まれた各コントロールがドッキング ラッパーを持つか、 CDockablePaneから派生する必要があります。SetDockingBayWrapperRTCを使用して、ラッパーのクラスを設定します。 |
データ メンバー
| 名前 | 説明 |
|---|---|
| CMFCBaseTabCtrl::m_bActivateTabOnRightClick | タブを選択する場合にマウスの左クリックを使用するのか右クリックを使用するのかを指定します。 |
| CMFCBaseTabCtrl::m_bAutoDestroyWindow | タブに含まれているウィンドウを自動的に破棄するかどうかを指定します。 |
解説
CMFCBaseTabCtrl クラスは抽象クラスです。 したがって、インスタンス化できません。 タブ付きウィンドウを作成するには、 CMFCBaseTabCtrlからクラスを派生する必要があります。 MFC ライブラリには派生クラスの例がいくつか含まれており、そのうちの 2 つは CMFCTabCtrl Class と CMFCOutlookBarTabCtrl Classです。
Visual Studio 2015 以降では、このクラスは Microsoft Active Accessibility をサポートします。
カスタマイズのヒント
以下のヒントは、 CMFCBaseTabCtrl Class 、およびそこから継承するクラスに関連するものです。
切り離し可能なタブを有効にした場合は、ポインターがタブ付きウィンドウを指したままにしないでください。 これらの切り離し可能なタブは、動的に作成および破棄できます。 したがって、ポインターは無効になる場合があります。
マウスを使用することによってユーザーがタブ コントロールでタブを動的に移動できるように、タブ コントロールを構成できます。 この機能は、
CMFCBaseTabCtrlクラスに組み込まれています。 有効にするには、 CMFCBaseTabCtrl::EnableTabSwapを呼び出します。既定では、タブは、タブ コントロールに追加するときに切り離し可能です。 CMFCBaseTabCtrl::AddTabを使用すると、切り離し不可能なタブを追加することもできます。 パラメーター
bDetachableをFALSEに設定した場合、タブは切り離し可能になりません。 メソッド CMFCBaseTabCtrl::EnableTabDetachを呼び出すことで、タブが切り離し可能であるかどうかを変更することもできます。CWnd Class から派生したオブジェクトは、ドッキング可能なコントロール バーまたはドッキング可能なタブに配置できます。ドッキングするコントロール全体に対して、
CWndオブジェクトをドッキング可能にする必要があります。 これを実現するために、MFC ではラッパー クラスを使用します。 このラッパー クラスは CDockablePaneAdapter Classです。 ドッキング可能なコントロール バーまたはドッキング可能なタブに追加されたCWndオブジェクトはいずれも、CDockablePaneAdapterオブジェクト内で折り返されます。m_bEnableWrappingオブジェクトのパラメーターCMFCBaseTablCtrlをFALSEに設定すると、自動折り返しを無効にできます。 メソッド CMFCBaseTabCtrl::SetDockingBarWrapperRTCを使用すると、アプリケーションでラッパーとして使用されるクラスを変更することもできます。
継承階層
要件
ヘッダー: afxbasetabctrl.h
CMFCBaseTabCtrl::AddIcon
保護された CMap m_mapAddedIcons メンバーのアイコンのリストにアイコンを追加します。
void AddIcon(
HICON hIcon,
int iIcon);
パラメーター
hIcon
[in] 追加されるアイコンへのハンドル。
iIcon
[in] 保護された CImageList m_Images メンバー内のアイコンの 0 から始まるインデックス。
解説
CMFCBaseTabCtrl::AddTab
新しいタブをタブ コントロールに追加します。
virtual void AddTab(
CWnd* pTabWnd,
LPCTSTR lpszTabLabel,
UINT uiImageId = (UINT)-1,
BOOL bDetachable = TRUE);
virtual void AddTab(
CWnd* pTabWnd,
UINT uiResTabLabel,
UINT uiImageId = (UINT)-1,
BOOL bDetachable = TRUE);
パラメーター
pTabWnd
[in] このメソッドが新しいタブとして表すウィンドウへのポインター。
lpszTabLabel
[in] 新しいタブのラベルを含む文字列。
uiImageId
[in] 画像リストの画像 ID。 タブ コントロールは、この画像を新しいタブのアイコンとして使います。
uiResTabLabel
[in] ラベルのリソース ID。
bDetachable
[in] 新しいタブが切り離し可能かどうかを指定するブール値のパラメーター。
解説
pTabWnd が CDockablePane クラスから派生していないオブジェクトを指しており、bDetachable が TRUE の場合、フレームワークは pTabWnd オブジェクトのラッパーを自動的に作成します。 ラッパーでは、pTabWnd オブジェクトは切り離し可能になります。 既定では、ラッパーは CDockablePaneAdapter クラスのインスタンスです。 既定のラッパーによって提供される機能が受け入れられない場合は、CMFCBaseTabCtrl::SetDockingBarWrapperRTC メソッドを使って別のラッパーを指定します。
CMFCBaseTabCtrl::ApplyRestoredTabInfo
virtual void ApplyRestoredTabInfo(BOOL bUseTabIndexes = FALSE);
パラメーター
[in] bUseTabIndexes
解説
CMFCBaseTabCtrl::AutoDestroyWindow
void AutoDestroyWindow(BOOL bAutoDestroy = TRUE);
パラメーター
[in] bAutoDestroy
解説
CMFCBaseTabCtrl::CalcRectEdit
virtual void CalcRectEdit(CRect& rectEdit);
パラメーター
[in] rectEdit
解説
CMFCBaseTabCtrl::CleanUp
virtual void CleanUp();
解説
CMFCBaseTabCtrl::ClearImageList
virtual void ClearImageList();
解説
CMFCBaseTabCtrl::CreateWrapper
CWnd クラスから派生しているが、CDockablePane クラスから派生していないフレーム ウィンドウのラッパーを作成します。
virtual CWnd* CreateWrapper(
CWnd* pWndToWrap,
LPCTSTR lpszTabLabel,
BOOL bDetachable);
パラメーター
pWndToWrap
[in] ラップされるフレーム ウィンドウへのポインター。
lpszTabLabel
[in] ウィンドウのラベルを含む文字列。
bDetachable
[in] ウィンドウが切り離し可能かどうかを示すブール値パラメーター。
戻り値
CreateWrapper が pWndToWrap のラッパー クラスを正常に作成した場合、CDockablePane クラスから派生したラッパーへのポインター。 メソッドが失敗すると、pWndToWrap が返されます。
解説
タブ付きウィンドウには、CWnd から派生した任意のオブジェクトをドッキングできます。 ただし、CMFCBaseTabCtrl Class オブジェクトをドッキング可能にするには、CMFCBaseTabCtrl 上の各オブジェクトが切り離し可能である必要があります。 そのため、CMFCBaseTabCtrl は、CDockablePane から派生していないオブジェクトを自動的にラップします。
既定では、CMFCBaseTabCtrl は CDockablePaneAdapter クラスのインスタンスを作成します。 ラッパーの既定のクラスを変更するには、CMFCBaseTabCtrl::SetDockingBarWrapperRTC を呼び出します。
pWndToWrap が CDockablePane から派生している場合、このメソッドはラッパーを作成しません。 代わりに、失敗して pWndToWrap が返されます。
CMFCBaseTabCtrl::DetachTab
フレームワークはこのメソッドを呼び出して、タブ コントロールからタブをデタッチします。
virtual BOOL DetachTab(
AFX_DOCK_METHOD dockMethod,
int nTabNum = -1,
BOOL bHide = FALSE);
パラメーター
dockMethod
[in] CBasePane クラスによって提供される列挙データ型。 このデータ型は、タブをデタッチするために使われたメソッドを指定します。
nTabNum
[in] デタッチされるタブの 0 から始まるインデックス。
bHide
[in] フレームワークがデタッチされたタブを非表示にするかどうかを示すブール値パラメーター。
戻り値
正常終了した場合は 0 以外を返します。それ以外の場合は 0 を返します。
解説
nTabNum で指定されたタブが切り離し可能でない場合、この関数は失敗し、FALSE を返します。
CMFCBaseTabCtrl::EnableActivateLastActive
void EnableActivateLastActive(BOOL bLastActive = TRUE);
パラメーター
[in] bLastActive
解説
CMFCBaseTabCtrl::EnableAutoColor
フレームワークがタブを描画するときに自動設定の背景色を使うかどうかを制御します。
void EnableAutoColor(BOOL bEnable = TRUE);
パラメーター
bEnable
[in] フレームワークが自動設定の色を使うかどうかを指定するブール値パラメーター。
解説
タブ コントロールには、いくつかの定義済みの色の配列があります。 フレームワークが自動設定の色を使う場合、一連のタブの各タブには、この配列の次の色が割り当てられます。
既定では、自動設定の色はライブラリ定義の色によって決まります。 CMFCBaseTabCtrl::SetAutoColors を呼び出して、色のカスタム配列を指定できます。
CMFCBaseTabCtrl::EnableCustomToolTips
タブ コントロールのカスタム ヒントを有効にします。
BOOL EnableCustomToolTips(BOOL bEnable = TRUE);
パラメーター
bEnable
[in] カスタム ヒントを使うかどうかを指定するブール値。
戻り値
成功した場合は TRUE、それ以外の場合は FALSE。
解説
カスタム ヒントが有効な場合、タブ コントロールは AFX_WM_ON_GET_TAB_TOOLTIP メッセージをメイン フレームに送信します。 アプリケーションでカスタム ヒントをサポートする場合は、メイン フレーム ウィンドウがこのメソッドを処理し、カスタム ヒント テキストを提供する必要があります。 カスタム ヒント テキストの提供の詳細については、「CMFCTabToolTipInfo 構造体」を参照してください。
CMFCBaseTabCtrl::EnableInPlaceEdit
ユーザーによるタブ ラベルの直接編集を可能にします。
virtual void EnableInPlaceEdit(BOOL bEnable) = 0;
パラメーター
bEnable
[in] タブ ラベルの直接編集を有効にするかどうかを指定するブール値パラメーター。
解説
既定では、タブ コントロールのタブ ラベルの直接編集は無効になっています。
タブ コントロール上のタブのサブセットに対して直接編集を有効にできます。 これを行うには、メソッド CMFCBaseTabCtrl::StartRenameTab をオーバーライドします。 StartRenameTab は、タブ ラベルの直接編集をサポートするすべてのタブに対してゼロ以外の値を返す必要があります。
CMFCBaseTabCtrl Class では、このメソッドは純粋仮想関数であり、実装はありません。 CMFCBaseTabCtrl からクラスを派生する場合は、この関数を実装する必要があります。
CMFCBaseTabCtrl::EnableTabDetach
切り離し可能なタブを有効にします。
virtual BOOL EnableTabDetach(
int iTab,
BOOL bEnable);
パラメーター
iTab
[in] タブの 0 から始まるインデックス。
bEnable
[in] タブを切り離し可能にするかどうかを示すブール値。
戻り値
成功した場合は TRUE、それ以外の場合は FALSE。
CMFCBaseTabCtrl::EnableTabSwap
ユーザーがマウスを使ってタブの順序を変更できるようにします。
void EnableTabSwap(BOOL bEnable);
パラメーター
bEnable
[in] タブの入れ替えを有効にするかどうかを示すブール値。
解説
タブの入れ替えが有効な場合、ユーザーはタブをドラッグして、タブ コントロール内での相対位置を変更できます。
CMFCBaseTabCtrl::EnsureVisible
指定したタブが表示されるまでタブをスクロールします。
virtual BOOL EnsureVisible(int iTab);
パラメーター
iTab
[in] タブの 0 から始まるインデックス。
戻り値
正常終了した場合は 0 以外を返します。それ以外の場合は 0 を返します。
解説
iTab で示されるタブが既に表示されている場合、このメソッドによる影響はありません。
既定では、このメソッドは CMFCBaseTabCtrl Class でサポートされていません。 カスタム タブ コントロールがタブ スクロールをサポートしている場合は、CMFCBaseTabCtrl から派生したカスタム クラスにこの関数を実装する必要があります。 このメソッドは、CMFCTabCtrl クラスによってサポートされています。
CMFCBaseTabCtrl::EnterDragMode
void EnterDragMode();
解説
CMFCBaseTabCtrl::FindTargetWnd
指定された点を含むペインを特定します。
virtual CWnd* FindTargetWnd(const CPoint& pt) = 0;
パラメーター
pt
[in] CMFCBaseTabCtrl オブジェクトのクライアント領域座標を使って定義される点。
戻り値
成功した場合は、CWnd オブジェクトへのポインター。それ以外の場合は NULL。
解説
CMFCBaseTabCtrl クラスでは、このメソッドは純粋仮想関数です。CMFCBaseTabCtrl からクラスを派生する場合に実装する必要があります。
CMFCBaseTabCtrl::FireChangeActiveTab
virtual void FireChangeActiveTab(int nNewTab);
パラメーター
[in] nNewTab
解説
CMFCBaseTabCtrl::FireChangingActiveTab
virtual BOOL FireChangingActiveTab(int nNewTab);
パラメーター
[in] nNewTab
戻り値
解説
CMFCBaseTabCtrl::GetActiveTab
現在アクティブなタブのインデックスを取得します。
virtual int GetActiveTab() const;
戻り値
アクティブなタブの 0 から始まるインデックス。アクティブなタブがない場合は -1 です。
CMFCBaseTabCtrl::GetActiveTabColor
現在アクティブなタブの背景色を取得します。
virtual COLORREF GetActiveTabColor() const;
戻り値
アクティブなタブの背景色を指定する COLORREF 値。
解説
既定では、アクティブなタブの背景色は COLOR_WINDOW です。 アクティブなタブの背景色を変更するには、メソッド CMFCBaseTabCtrl::SetActiveTabColor を使います。
CMFCBaseTabCtrl::GetActiveTabTextColor
アクティブなタブのテキストの色を取得します。
virtual COLORREF GetActiveTabTextColor() const;
戻り値
アクティブなタブのテキストの色を指定する COLORREF 値。
解説
既定では、アクティブなタブのテキストの色は COLOR_WINDOWTEXT です。 メソッド CMFCBaseTabCtrl::SetActiveTabTextColor を使ってテキストの色を変更できます。
CMFCBaseTabCtrl::GetActiveWnd
現在アクティブなタブ ウィンドウへのポインターを取得します。
virtual CWnd* GetActiveWnd() const;
戻り値
ウィンドウへのポインター。
CMFCBaseTabCtrl::GetAutoColors
自動色分けに使われる色の配列を取得します。
const CArray<COLORREF,COLORREF>& GetAutoColors() const;
戻り値
CMFCBaseTabCtrl オブジェクトがタブの自動色付けに使う COLORREF 値の配列への参照。
解説
既定では、フレームワークにより、色の配列はライブラリ定義の色に初期化されます。 メソッド CMFCBaseTabCtrl::SetAutoColors を呼び出して、色のカスタム配列を指定できます。
CMFCBaseTabCtrl::GetFirstVisibleTab
最初に表示されるタブへのポインターを取得します。
virtual CWnd* GetFirstVisibleTab(int& iTabNum);
virtual CWnd* GetFirstVisibleTab(
int iStartFrom,
int& iTabNum);
パラメーター
iTabNum
[out] 整数への参照。 このメソッドを使うと、最初に表示されるタブの 0 から始まるインデックスがこのパラメーターに書き込まれます。
iStartFrom
[in] 確認する最初のタブの 0 から始まるインデックス。
戻り値
成功した場合は、最初に表示されるタブへのポインター。それ以外の場合は NULL。
解説
このメソッドが失敗した場合、値 -1 が iStartFrom に書き込まれます。
iStartFrom がタブ コントロールのタブ数以上である場合、GetFirstVisibleTab は自動的に失敗します。
CMFCBaseTabCtrl::GetFirstVisibleTabNum
virtual int GetFirstVisibleTabNum() const;
戻り値
解説
CMFCBaseTabCtrl::GetHighlightedTab
現在選択されているタブのインデックスを取得します。
int GetHighlightedTab() const;
戻り値
選択されているタブの 0 から始まるインデックス。
CMFCBaseTabCtrl::GetImageList
virtual const CImageList* GetImageList() const;
戻り値
解説
CMFCBaseTabCtrl::GetImageSize
virtual CSize GetImageSize() const;
戻り値
解説
CMFCBaseTabCtrl::GetLastVisibleTab
virtual CWnd* GetLastVisibleTab(int& iTabNum);
パラメーター
[in] iTabNum
戻り値
解説
CMFCBaseTabCtrl::GetLocation
タブ コントロールのタブ領域部分の位置を取得します。
Location GetLocation() const;
戻り値
タブ領域の位置。
解説
指定できるタブ領域の位置の値は LOCATION_BOTTOM と LOCATION_TOP です。
CMFCBaseTabCtrl::GetMaxWindowSize
virtual CSize GetMaxWindowSize() const;
戻り値
解説
CMFCBaseTabCtrl::GetTabArea
タブ コントロールのタブ領域のサイズと位置を取得します。
virtual void GetTabArea(
CRect& rectTabAreaTop,
CRect& rectTabAreaBottom) const = 0;
パラメーター
rectTabAreaTop
[入力] CRect オブジェクトへの参照 GetTabArea は、このオブジェクトを使って、上部タブ領域のサイズと位置を保存します。
rectTabAreaBottom
[入力] CRect オブジェクトへの参照 GetTabArea は、このオブジェクトを使って、下部タブ領域のサイズと位置を保存します。
解説
GetTabArea が戻った後、CRect パラメーターには、タブ コントロールのクライアント座標におけるタブ領域のサイズと位置が格納されています。 タブ コントロールの上部または下部にタブ領域がない場合、rectTabAreaTop または rectTabAreaBottom は空になります。
CMFCBaseTabCtrl Class では、このメソッドは純粋仮想関数であり、実装はありません。 CMFCBaseTabCtrl からクラスを派生する場合は、この関数を実装する必要があります。
CMFCBaseTabCtrl::GetTabBkColor
指定したタブの背景色を取得します。
virtual COLORREF GetTabBkColor(int iTab) const;
パラメーター
iTab
[in] タブの 0 から始まるインデックス。
戻り値
指定したタブの背景色を示す COLORREF 値。iTab が範囲外の場合は -1。
CMFCBaseTabCtrl::GetTabBorderSize
タブ コントロールにおけるタブ境界線のサイズを取得します。
virtual int GetTabBorderSize() const;
戻り値
タブの境界線のサイズ (ピクセル単位)。
解説
タブの境界線の既定のサイズは 3 ピクセルです。 この境界線のサイズは、メソッド CMFCBaseTabCtrl::SetTabBorderSize を使って変更できます。
CMFCBaseTabCtrl::GetTabByID
タブ ID に基づいてタブのインデックスを取得します。
virtual int GetTabByID(int id) const;
パラメーター
id
[in] タブ ID。
戻り値
タブが見つかった場合は、その 0 から始まるインデックス。タブ ID が見つからない場合は -1。
解説
タブ ID は、タブ コントロールにタブが追加されるときに自動的に割り当てられます。
CMFCBaseTabCtrl::GetTabCloseButton
CRect GetTabCloseButton() const;
戻り値
解説
CMFCBaseTabCtrl::GetTabFromHwnd
指定した HWND オブジェクトを含むタブのインデックスを取得します。
virtual int GetTabFromHwnd(HWND hwnd) const;
パラメーター
hwnd
[in] ウィンドウへのハンドル。
戻り値
成功した場合はタブの 0 から始まるインデックス。hwnd を含むタブがない場合は -1。
CMFCBaseTabCtrl::GetTabFromPoint
指定したポイントを含むタブを取得します。
virtual int GetTabFromPoint(CPoint& pt) const;
パラメーター
pt
[in] タブ コントロールのクライアント座標の点。
戻り値
pt を含むタブのインデックス。pt を含むタブがない場合は -1。
CMFCBaseTabCtrl::GetTabFullWidth
virtual int GetTabFullWidth(int iTab) const;
パラメーター
[in] iTab
戻り値
解説
CMFCBaseTabCtrl::GetTabHicon
指定したタブに関連付けられた HICON を返します。
virtual HICON GetTabHicon(int iTab) const;
パラメーター
iTab
[in] タブの 0 から始まるインデックス。
戻り値
成功した場合は、タブ ラベルに関連付けられた HICON。HICON がない場合、またはメソッドが失敗した場合は NULL。
CMFCBaseTabCtrl::GetTabIcon
指定したタブに関連付けられたアイコンを取得します。
virtual UINT GetTabIcon(int iTab) const;
パラメーター
iTab
[in] タブの 0 から始まるインデックス。
戻り値
成功した場合は、指定したタブのアイコン ID。インデックスが無効な場合は -1。
解説
CMFCBaseTabCtrl オブジェクトは、内部の CImageList オブジェクトにアイコンを格納します。
CMFCBaseTabCtrl::GetTabID
タブ インデックスで指定したタブの ID を取得します。
int GetTabID(int iTab) const;
パラメーター
iTab
[in] タブの 0 から始まるインデックス。
戻り値
タブの ID。iTab が範囲外の場合は -1。
CMFCBaseTabCtrl::GetTabLabel
タブ ラベルのテキストを取得します。
virtual BOOL GetTabLabel(
int iTab,
CString& strLabel) const;
パラメーター
iTab
[in] タブの 0 から始まるインデックス。
strLabel
[out] CString オブジェクトへの参照。 このメソッドを実行すると、このパラメーターにタブのラベルが格納されます。
戻り値
成功した場合は TRUE。それ以外の場合は FALSE。
解説
インデックス iTab が無効な場合、このメソッドは失敗します。
タブの作成時にタブのラベルを設定するには、CMFCBaseTabCtrl::AddTab を使います。 また、作成後にラベルを変更するには、メソッド CMFCBaseTabCtrl::SetTabLabel を使います。
CMFCBaseTabCtrl::GetTabRect
指定したタブのサイズと位置を取得します。
virtual BOOL GetTabRect(
int iTab,
CRect& rect) const;
パラメーター
iTab
[in] タブの 0 から始まるインデックス。
rect
[out] CRect オブジェクトへの参照。 このメソッドを実行すると、タブのサイズと位置がこのパラメーターに格納されます。
戻り値
成功した場合は TRUE。タブ インデックスが無効な場合は FALSE。
CMFCBaseTabCtrl::GetTabsHeight
virtual int GetTabsHeight() const;
戻り値
解説
CMFCBaseTabCtrl::GetTabsNum
タブ コントロール内のタブ数を取得します。
virtual int GetTabsNum() const;
戻り値
タブ コントロールのタブ数。
CMFCBaseTabCtrl::GetTabsRect
virtual void GetTabsRect(CRect& rect) const;
パラメーター
[in] rect
解説
CMFCBaseTabCtrl::GetTabTextColor
指定したタブのテキストの色を取得します。
virtual COLORREF GetTabTextColor(int iTab) const;
パラメーター
iTab
[in] タブの 0 から始まるインデックス。
戻り値
指定したタブのテキストの色を示す COLORREF パラメーター。iTab が範囲外の場合は -1。
CMFCBaseTabCtrl::GetTabWnd
指定したタブ上に存在するペインへのポインターを返します。
virtual CWnd* GetTabWnd(int iTab) const;
パラメーター
iTab
[in] タブの 0 から始まるインデックス。
戻り値
iTab に指定されたタブ上にある CWnd オブジェクトへのポインター。 iTab が無効な場合は NULL。
解説
返されるオブジェクトは、アプリケーションが CMFCBaseTabCtrl::AddTab または CMFCBaseTabCtrl::InsertTab を呼び出したときに追加したものです。
タブ上のオブジェクトにラッパーがある場合、このメソッドはオブジェクトのラッパーを返します。 ラッパーの詳細については、「CMFCBaseTabCtrl::CreateWrapper」を参照してください。 ラッパーを使わずに直接オブジェクトへのポインターにアクセスする場合は、メソッド CMFCBaseTabCtrl::GetTabWndNoWrapper を使います。
CMFCBaseTabCtrl::GetTabWndNoWrapper
コントロールにラッパーがある場合でも、タブ上にあるコントロールへのポインターを返します。
virtual CWnd* GetTabWndNoWrapper(int iTab) const;
パラメーター
iTab
[in] タブの 0 から始まるインデックス。
戻り値
指定したタブにある CWnd オブジェクトへのポインター。iTab が無効な場合は NULL。
解説
このメソッドは、メソッド CMFCBaseTabCtrl::AddTab または CMFCBaseTabCtrl::InsertTab のいずれかを使って追加した CWnd オブジェクトへの直接ポインターを取得します。 GetTabWndNoWrapper は、フレームワークがオブジェクトのラッパーを追加した場合でも、追加された CWnd へのポインターを取得します。 ラッパーと CMFCBaseTabCtrl クラスの詳細については、「CMFCBaseTabCtrl::CreateWrapper」を参照してください。
ラッパー クラスを無視したくない場合は、メソッド CMFCBaseTabCtrl::GetTabWnd を使います。
CMFCBaseTabCtrl::GetToolTipCtrl
ヒント コントロールへの参照を取得します。
CToolTipCtrl& GetToolTipCtrl() const;
戻り値
ヒント コントロールへの参照。
CMFCBaseTabCtrl::GetVisibleTabsNum
現在表示されているタブ数を取得します。
virtual int GetVisibleTabsNum() const;
戻り値
表示されているタブ数。
CMFCBaseTabCtrl::HasImage
virtual BOOL HasImage(int iTab) const;
パラメーター
[in] iTab
戻り値
解説
CMFCBaseTabCtrl::HideSingleTab
表示されているタブが 1 つある場合に、タブ コントロールのタブを非表示にするオプションを設定します。
virtual void HideSingleTab(BOOL bHide = TRUE);
パラメーター
bHide
[in] 単一タブの非表示を有効にするかどうかを指定するブール値。
解説
1 つのタブを非表示にするようにアプリケーションが構成されている場合、2 つ目のタブがタブ コントロールに追加されると、フレームワークによって自動的にタブが表示されます。
CMFCBaseTabCtrl::InsertTab
タブ コントロールにタブを挿入します。
Virtual void InsertTab(
CWnd* pNewWnd,
LPCTSTR lpszTabLabel,
int nInsertAt,
UINT uiImageId = (UINT)-1,
BOOL bDetachable = TRUE);
virtual void InsertTab(
CWnd* pNewWnd,
UINT uiResTabLabel,
int nInsertAt,
UINT uiImageId = (UINT)-1,
BOOL bDetachable = TRUE);
パラメーター
pNewWnd
[in] このメソッドが新しいタブとして追加するウィンドウへのポインター。
lpszTabLabel
[in] 新しいタブのラベルを含む文字列。
nInsertAt
[in] 新しいタブの 0 から始まるインデックス。
uiImageId
[in] 画像リストの画像 ID。 タブ コントロールは、この画像を新しいタブのアイコンとして使います。
bDetachable
[in] 新しいタブが切り離し可能かどうかを指定するブール値のパラメーター。
uiResTabLabel
[in] ラベルのリソース ID。
解説
pNewWnd で示されるオブジェクトが CDockablePane クラスから派生したものではなく、bDetachable パラメーターが TRUE の場合、フレームワークにより、その新しいタブ用の特別なラッパーが作成されます。既定では、ラッパーは CDockablePaneAdapter クラスのインスタンスです。 CMFCBaseTabCtrl::SetDockingBarWrapperRTC メソッドを使って別のラッパー クラスを作成します。 カスタム ラッパー クラスは CDockablePaneAdapterから派生する必要があります。
CMFCBaseTabCtrl::InvalidateTab
void InvalidateTab(int iTab);
パラメーター
[in] iTab
解説
CMFCBaseTabCtrl::IsActiveTabCloseButton
virtual BOOL IsActiveTabCloseButton() const;
戻り値
解説
CMFCBaseTabCtrl::IsAutoColor
タブ コントロールが自動色設定モードかどうかを指定します。
BOOL IsAutoColor() const;
戻り値
タブ コントロールが自動色設定モードの場合は TRUE。それ以外の場合は FALSE。
解説
CMFCBaseTabCtrl::EnableAutoColor メソッドを使って、自動色設定モードを有効または無効にすることができます。
CMFCBaseTabCtrl::IsAutoDestroyWindow
BOOL IsAutoDestroyWindow() const;
戻り値
解説
CMFCBaseTabCtrl::IsColored
virtual BOOL IsColored() const;
戻り値
解説
CMFCBaseTabCtrl::IsDialogControl
BOOL IsDialogControl() const;
戻り値
解説
CMFCBaseTabCtrl::IsDrawNoPrefix
BOOL IsDrawNoPrefix() const;
戻り値
解説
CMFCBaseTabCtrl::IsFlatFrame
タブ コントロールのフレームがフラット スタイルでレンダリングされるか、3D スタイルでレンダリングされるかを示します。
virtual BOOL IsFlatFrame() const;
戻り値
タブ コントロールのフレームがフラット スタイルでレンダリングされる場合は TRUE。フレームが 3D スタイルでレンダリングされる場合は FALSE。
解説
タブ コントロールのフレームのスタイルを変更するには、CMFCTabCtrl::SetFlatFrame を使います。
Outlook スタイルを使うタブ コントロールは、フラット フレームを使ってレンダリングできません。 これには、CMFCOutlookBarTabCtrl クラスとそのクラスから派生したクラスが含まれます。
CMFCBaseTabCtrl::IsFlatTab
virtual BOOL IsFlatTab() const;
戻り値
解説
CMFCBaseTabCtrl::IsHideSingleTab
タブが 1 つしかない場合に、タブ コントロールでタブ ラベルを非表示にするかどうかを指定します。
virtual BOOL IsHideSingleTab() const;
戻り値
タブ コントロールにタブが 1 つある場合にタブ ラベルを非表示にする場合は TRUE。それ以外の場合は FALSE。
解説
タブが 1 つのみの場合にタブ ラベルを非表示にするには、メソッド CMFCBaseTabCtrl::HideSingleTab を使います。
CMFCBaseTabCtrl::IsIconAdded
BOOL IsIconAdded(
HICON hIcon,
int& iIcon);
パラメーター
[in] hIcon
[in] iIcon
戻り値
解説
CMFCBaseTabCtrl::IsInPlaceEdit
ユーザーがタブ ラベルを動的に変更できるようにタブ コントロールが構成されているかどうかを示します。
virtual BOOL IsInPlaceEdit() const;
戻り値
インプレース編集が有効な場合は 0 以外。それ以外の場合は 0。
解説
インプレース編集を有効または無効にするには、メソッド CMFCBaseTabCtrl::EnableInPlaceEdit を呼び出します。
CMFCBaseTabCtrl::IsLeftRightRounded
virtual BOOL IsLeftRightRounded() const;
戻り値
解説
CMFCBaseTabCtrl::IsMDITab
BOOL IsMDITab() const;
戻り値
解説
CMFCBaseTabCtrl::IsOneNoteStyle
タブを Microsoft OneNote のスタイルで表示するかどうかを指定します。
virtual BOOL IsOneNoteStyle() const;
戻り値
タブが Microsoft OneNote のスタイルで表示される場合は TRUE。それ以外の場合は FALSE。
解説
Microsoft OneNote のスタイルを有効にするには、CMDIFrameWndEx::EnableMDITabs メソッドを呼び出します。 CMFCTabCtrl クラスのインスタンスを作成するときにこのスタイルを有効にすることもできます。スタイル STYLE_3D_ONENOTE をメソッド CMFCTabCtrl::Create に渡すだけです。
既定では、Microsoft OneNote スタイルは CMFCBaseTabCtrl Class から派生したカスタム クラスではサポートされていません。 ただし、CMFCTabCtrl クラスではサポートされています。
CMFCBaseTabCtrl::IsPtInTabArea
ポイントがタブ領域内にあるかどうかを指定します。
virtual BOOL IsPtInTabArea(CPoint point) const = 0;
パラメーター
point
[入力] テストするポイント。
戻り値
ポイントがタブ領域内にある場合は 0 以外。それ以外の場合は 0。
解説
CMFCBaseTabCtrl Class では、このメソッドは純粋仮想関数であり、実装はありません。 CMFCBaseTabCtrl からクラスを派生する場合は、この関数を実装する必要があります。
CMFCBaseTabCtrl::IsTabCloseButtonHighlighted
BOOL IsTabCloseButtonHighlighted() const;
戻り値
解説
CMFCBaseTabCtrl::IsTabCloseButtonPressed
BOOL IsTabCloseButtonPressed() const;
戻り値
解説
CMFCBaseTabCtrl::IsTabDetachable
タブが切り離し可能であるかどうかを指定します。
virtual BOOL IsTabDetachable(int iTab) const;
パラメーター
iTab
[in] 確認するタブの 0 から始まるインデックス。
戻り値
タブがデタッチ可能な場合は TRUE。それ以外の場合は FALSE。
解説
タブをデタッチ可能にするには、メソッド CMFCBaseTabCtrl::EnableTabDetach を使います。
CMFCBaseTabCtrl::IsTabIconOnly
タブ ラベルにアイコンのみを含み、テキストを含まないかどうかを指定します。
virtual BOOL IsTabIconOnly(int iTab) const;
パラメーター
iTab
[in] タブの 0 から始まるインデックス。
戻り値
タブ ラベルがアイコンのみの場合は TRUE。それ以外の場合は FALSE。
解説
アイコンのみを表示するようにアプリケーションのタブを設定するには、メソッド CMFCBaseTabCtrl::SetTabIconOnly を呼び出します。
CMFCBaseTabCtrl::IsTabSwapEnabled
ユーザーがマウスを使ってタブ位置を変更することをタブ コントロールで許可するかどうかを指定します。
BOOL IsTabSwapEnabled() const;
戻り値
ユーザーがタブ位置を変更できる場合は 0 以外。それ以外の場合は 0。
解説
既定では、ユーザーはタブ コントロールのタブの順序を変更できません。 この機能を有効にするには、CMFCBaseTabCtrl::EnableTabSwap メソッドを使います。
CMFCBaseTabCtrl::IsTabVisible
指定したタブが表示されるかどうかを示します。
virtual BOOL IsTabVisible(int iTab) const;
パラメーター
iTab
[in] 確認するタブの 0 から始まるインデックス。
戻り値
指定したタブが表示されている場合は 0 以外。それ以外の場合は 0。
CMFCBaseTabCtrl::IsVS2005Style
virtual BOOL IsVS2005Style() const;
戻り値
解説
CMFCBaseTabCtrl::m_bActivateTabOnRightClick
m_bActivateTabOnRightClick を使って、ユーザーがマウスの右ボタンを使ってタブ ラベルをクリックしたときに、タブにフォーカスがあったかどうかを判断します。
BOOL m_bActivateTabOnRightClick;
解説
このデータ メンバーの既定値は FALSE です。
CMFCBaseTabCtrl::m_bAutoDestroyWindow
m_bAutoDestroyWindow を使って、タブが削除されたときに、タブ上のオブジェクトをフレームワークで自動的に破棄するかどうかを指定します。
BOOL m_bAutoDestroyWindow;
解説
既定では、このメンバーは FALSE です。
CMFCBaseTabCtrl::MoveTab
virtual void MoveTab(
int nSource,
int nDest);
パラメーター
[in] nSource
[in] nDest
解説
CMFCBaseTabCtrl::OnChangeTabs
タブ コントロールのタブ数が変更されると、フレームワークによってこのメソッドが呼び出されます。
virtual void OnChangeTabs();
解説
既定では、このメソッドは何も実行しません。 タブ コントロールのタブ数が変更されたときにカスタム コードを実行するには、このメソッドをオーバーライドします。
CMFCBaseTabCtrl::OnDrop
virtual BOOL OnDrop(
COleDataObject*,
DROPEFFECT,
CPoint);
パラメーター
[in] COleDataObject*
[in] DROPEFFECT
[in] CPoint
戻り値
解説
CMFCBaseTabCtrl::OnDragOver
virtual DROPEFFECT OnDragOver(
COleDataObject*,
DWORD,
CPoint);
パラメーター
[in] COleDataObject*
[in] DWORD
[in] CPoint
戻り値
解説
CMFCBaseTabCtrl::OnDragLeave
virtual void OnDragLeave();
解説
CMFCBaseTabCtrl::OnDragEnter
virtual DROPEFFECT OnDragEnter(
COleDataObject*,
DWORD,
CPoint);
パラメーター
[in] COleDataObject*
[in] DWORD
[in] CPoint
戻り値
解説
CMFCBaseTabCtrl::OnRenameTab
virtual BOOL OnRenameTab(int, CString&);
パラメーター
[in] int
[in] CString&
戻り値
解説
CMFCBaseTabCtrl::PreTranslateMessage
virtual BOOL PreTranslateMessage(MSG* pMsg);
パラメーター
[入力] pMsg
戻り値
解説
CMFCBaseTabCtrl::RecalcLayout
タブ コントロールの内部レイアウトを再計算します。
virtual void RecalcLayout() = 0;
解説
CMFCBaseTabCtrl Class では、このメソッドは純粋な仮想関数です。 CMFCBaseTabCtrl からクラスを派生する場合は、この関数を実装する必要があります。
CMFCBaseTabCtrl::RemoveAllTabs
タブ コントロールからすべてのタブを削除します。
virtual void RemoveAllTabs();
解説
CMFCBaseTabCtrl::m_bAutoDestroyWindow が TRUE の場合、削除されたタブにアタッチされているすべての CWnd オブジェクトはフレームワークによって削除されます。
CMFCBaseTabCtrl::RemoveTab
タブ コントロールからタブを削除します。
virtual BOOL RemoveTab(
int iTab,
BOOL bRecalcLayout = TRUE);
パラメーター
iTab
[in] タブの 0 から始まるインデックス。
bRecalcLayout
[in] タブのレイアウトを再計算するかどうかを指定するブール型パラメーター。
戻り値
メソッドによってタブが正常に削除された場合は TRUE。それ以外の場合は FALSE。
解説
CMFCBaseTabCtrl::m_bAutoDestroyWindow が TRUE の場合、指定したタブに関連付けられた CWnd オブジェクトは RemoveTab によって破棄されます。
CMFCBaseTabCtrl::RenameTab
virtual BOOL RenameTab();
戻り値
解説
CMFCBaseTabCtrl::ResetImageList
CMFCBaseTabCtrl クラスのインスタンスの画像リストをリセットします。
void ResetImageList();
CMFCBaseTabCtrl::Serialize
virtual void Serialize(CArchive& ar);
パラメーター
[in] ar
解説
CMFCBaseTabCtrl::SetActiveTab
指定したタブをアクティブにします。
virtual BOOL SetActiveTab(int iTab) = 0;
パラメーター
iTab
[in] タブの 0 から始まるインデックス。SetActiveTab を指定すると、このインデックスを持つタブがアクティブになります。
戻り値
成功した場合は TRUE、それ以外の場合は FALSE。
解説
CMFCBaseTabCtrl Class では、このメソッドは純粋な仮想関数です。 CMFCBaseTabCtrl からクラスを派生する場合は、この関数を実装する必要があります。
CMFCBaseTabCtrl::SetActiveTabColor
アクティブなタブの背景色を設定します。
virtual void SetActiveTabColor(COLORREF clr);
パラメーター
clr
[in] 新しい背景色を指定します。
解説
フレームワークは、GetSysColor メソッドからアクティブなタブの既定の背景色を取得します。
CMFCBaseTabCtrl::SetActiveTabTextColor
アクティブなタブのテキストの色を設定します。
virtual void SetActiveTabTextColor(COLORREF clr);
パラメーター
clr
[in] 新しいテキストの色を指定する COLORREF パラメーター。
解説
既定では、フレームワークは GetSysColor からテキストの色を取得します。 SetActiveTabTextColor メソッドを使って、この既定の色をオーバーライドします。
CMFCBaseTabCtrl::SetAutoColors
フレームワークが自動色設定モードで使うタブ コントロールの色を設定します。
void SetAutoColors(const CArray<COLORREF,COLORREF>& arColors);
パラメーター
arColors
[in] RGB 色の配列。
解説
色のカスタム配列を指定した場合、既定の色の配列は無視されます。 パラメーター arColors が空の場合、フレームワークは既定の色の配列に戻ります。
自動色設定モードを有効にするには、CMFCBaseTabCtrl::EnableAutoColor メソッドを使います。
CMFCBaseTabCtrl::SetDockingBarWrapperRTC
CDockablePane Classから派生しているのではない任意のオブジェクトに使用するラッパー クラスを設定します。
void SetDockingBarWrapperRTC(CRuntimeClass* pRTC);
パラメーター
pRTC
[in] 新しいラッパー クラスのランタイム クラス情報。
解説
タブ コントロールにタブを追加するには、メソッド CMFCBaseTabCtrl::AddTab と CMFCBaseTabCtrl::InsertTab を使います。 タブを追加するときは、そのタブの各コントロールをドッキング可能にする必要があります。 CDockablePane から派生していないオブジェクトはすべてラップする必要があります。 AddTab と InsertTab を使って、これらのオブジェクトのラッパーを作成します。 既定のラッパー クラスは CDockablePaneAdapter クラスです。 SetDockingBarWrapperRTC メソッドを使うと、ラッパー クラスとして使われるクラスを変更できます。 指定するラッパー クラスは、CDockablePaneAdapter から派生している必要があります。
CMFCBaseTabCtrl::SetDrawNoPrefix
タブ ラベルのプレフィックス文字の処理を有効または無効にします。
void SetDrawNoPrefix(
BOOL bNoPrefix,
BOOL bRedraw = TRUE);
パラメーター
bNoPrefix
[in] プレフィックス文字を処理する場合は TRUE。それ以外の場合は FALSE。
bRedraw
[in] タブ付きウィンドウを再描画する場合は TRUE。それ以外の場合は FALSE。
解説
プレフィックス文字とは、アンパサンド (&) の前に置かれたニーモニック文字です。
CMFCBaseTabCtrl::SetImageList
タブ コントロールのアイコン画像リストを設定します。
virtual BOOL SetImageList(
UINT uiID,
int cx = 15,
COLORREF clrTransp = RGB(255, 0, 255));
virtual BOOL SetImageList(HIMAGELIST hImageList);
パラメーター
uiID
[in] ビットマップ リソース ID。 SetImageList を使って、このリソースから画像リストを読み込みます。
cx
[in] 各画像の幅 (ピクセル単位)。
clrTransp
[in] 画像の透明色を示す COLORREF パラメーター。
hImageList
[in] 事前に読み込まれた画像リストへのハンドル。
戻り値
メソッドが成功した場合は 0 以外。それ以外の場合は 0。
解説
アイコン画像リストの画像がタブのラベルと共に表示されます。アイコンを表示するには、CMFCBaseTabCtrl::AddTab を呼び出すときにアイコンのインデックスを指定する必要があります。
タブ コントロールがフラット スタイルで作成された場合、SetImageList は失敗します。 uiID に示された画像をフレームワークで読み込むことができない場合にも失敗します。
このメソッドを使うと、画像とテキストのサイズに応じてタブの高さを再計算できます。
CMFCBaseTabCtrl::SetLocation
virtual void SetLocation(Location location);
パラメーター
[in] location
解説
CMFCBaseTabCtrl::SetTabBkColor
指定したタブの背景色を設定します。
virtual BOOL SetTabBkColor(
int iTab,
COLORREF color = (COLORREF)-1);
パラメーター
iTab
[in] タブの 0 から始まるインデックス。
color
[in] 設定する色。
戻り値
成功した場合は TRUE。それ以外の場合は FALSE。
CMFCBaseTabCtrl::SetTabBorderSize
タブ コントロールの新しい境界線のサイズを設定します。
virtual void SetTabBorderSize(
int nTabBorderSize,
BOOL bRepaint = TRUE);
パラメーター
nTabBorderSize
[in] 新しい境界線のサイズ (ピクセル単位)。
bRepaint
[in] フレームワークがコントロールを再描画するかどうかを示すブール型パラメーター。
CMFCBaseTabCtrl::SetTabHicon
タブ ラベルのアイコンを設定します。
virtual BOOL SetTabHicon(
int iTab,
HICON hIcon);
パラメーター
iTab
[in] タブの 0 から始まるインデックス。このメソッドを使うと、このタブのアイコンを変更できます。
hIcon
[in] アイコンへのハンドル。
戻り値
成功した場合は TRUE、それ以外の場合は FALSE。
CMFCBaseTabCtrl::SetTabIcon
タブのアイコンを設定します。
virtual BOOL SetTabIcon(
int iTab,
UINT uiIcon);
パラメーター
iTab
[in] 更新するタブの 0 から始まるインデックス。
uiIcon
[in] 新しいアイコンのアイコン ID。 この ID は、内部 CImageList オブジェクトを参照します。
戻り値
成功した場合は TRUE、それ以外の場合は FALSE。
CMFCBaseTabCtrl::SetTabIconOnly
特定のタブにアイコンのみ (テキスト ラベルなし) を表示できるようにします。
virtual BOOL SetTabIconOnly(
int iTab,
BOOL bIconOnly = TRUE,
BOOL bShowTooltipAlways = FALSE);
パラメーター
iTab
[in] 変更するタブの 0 から始まるインデックス。
bIconOnly
[in] アイコンのみを表示するかどうかを決定するブール型パラメーター。
bShowTooltipAlways
[in] アイコンのみを表示するタブ ラベルのヒントをフレームワークに表示するかどうかを決定するブール型パラメーター。
戻り値
成功した場合は TRUE、それ以外の場合は FALSE。
解説
既定では、タブ コントロールには各タブのアイコンとテキスト ラベルが表示されます。
CMFCBaseTabCtrl::SetTabLabel
タブ ラベルのテキストを設定します。
virtual BOOL SetTabLabel(
int iTab,
const CString& strLabel);
パラメーター
iTab
[in] 更新するタブの 0 から始まるインデックス。
strLabel
[in] タブ ラベルの新しいテキストを含む文字列への参照。
戻り値
成功した場合は 0 以外。それ以外の場合は 0。
CMFCBaseTabCtrl::SetTabsHeight
virtual void SetTabsHeight();
解説
CMFCBaseTabCtrl::SetTabsOrder
指定した順序でタブを配置します。
BOOL SetTabsOrder(const CArray<int,int>& arOrder);
パラメーター
arOrder
[in] 新しいタブ オーダーを定義する 0 から始まるインデックスの配列。
戻り値
成功した場合は TRUE。それ以外の場合は FAIL。
解説
arOrder 配列のサイズは、タブ コントロール内のタブ数と同じである必要があります。
CMFCBaseTabCtrl::SetTabTextColor
指定したタブのテキストの色を設定します。
virtual BOOL SetTabTextColor(
int iTab,
COLORREF color = (COLORREF)-1);
パラメーター
iTab
[in] タブの 0 から始まるインデックス。
color
[in] 新しいテキストの色を示す COLORREF パラメーター。
戻り値
成功した場合は 0 以外。それ以外の場合は 0。
CMFCBaseTabCtrl::ShowTab
指定したタブを表示または非表示にします。
virtual BOOL ShowTab(
int iTab,
BOOL bShow = TRUE,
BOOL bRecalcLayout = TRUE,
BOOL bActivate = FALSE);
パラメーター
iTab
[in] ShowTab によって表示または非表示にするタブのインデックス。
bShow
[in] タブを表示するかどうかを示すブール値パラメーター。
bRecalcLayout
[in] ウィンドウ レイアウトをすぐに再計算するかどうかを示すブール型パラメーター。
bActivate
[in] iTab で指定されたタブを選ぶかどうかを示すブール型パラメーター。
戻り値
正常終了した場合は 0 以外を返します。それ以外の場合は 0 を返します。
解説
パラメーター bActivate は、bShow が TRUE の場合にのみ適用されます。 bActivate が TRUE であり、ShowTab が成功した場合、ShowTab はメッセージ AFX_WM_CHANGE_ACTIVE_TAB をタブ ウィンドウの親に送信します。
CMFCBaseTabCtrl::StartRenameTab
virtual BOOL StartRenameTab(int iTab);
パラメーター
[in] iTab
戻り値
解説
CMFCBaseTabCtrl::SwapTabs
virtual void SwapTabs(
int nFisrtTabID,
int nSecondTabID);
パラメーター
[in] nFisrtTabID
[in] nSecondTabID