CReBarCtrl クラス

Rebar コントロールの機能がカプセル化されています。Rebar コントロールは、子ウィンドウを含むコンテナーです。

構文

class CReBarCtrl : public CWnd

メンバー

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

名前	説明
CReBarCtrl::CReBarCtrl	CReBarCtrl オブジェクトを構築します。

パブリック メソッド

名前	説明
CReBarCtrl::BeginDrag	鉄筋コントロールをドラッグ アンド ドロップ モードにします。
CReBarCtrl::Create	鉄筋コントロールを作成し、 CReBarCtrl オブジェクトにアタッチします。
CReBarCtrl::CreateEx	指定した Windows 拡張スタイルを使用して鉄筋コントロールを作成し、 CReBarCtrl オブジェクトにアタッチします。
CReBarCtrl::D eleteBand	Rebar コントロールからバンドを削除します。
CReBarCtrl::D ragMove	BeginDragの呼び出し後に、鉄筋コントロール内のドラッグ位置を更新します。
CReBarCtrl::EndDrag	Rebar コントロールのドラッグ アンド ドロップ操作を終了します。
CReBarCtrl::GetBandBorders	バンドの境界線を取得します。
CReBarCtrl::GetBandCount	現在 Rebar コントロールにあるバンドの数を取得します。
CReBarCtrl::GetBandInfo	Rebar コントロール内の指定されたバンドに関する情報を取得します。
CReBarCtrl::GetBandMargins	バンドの余白を取得します。
CReBarCtrl::GetBarHeight	Rebar コントロールの高さを取得します。
CReBarCtrl::GetBarInfo	Rebar コントロールおよび使用するイメージ リストに関する情報を取得します。
CReBarCtrl::GetBkColor	Rebar コントロールの既定の背景色を取得します。
CReBarCtrl::GetColorScheme	鉄筋コントロールに関連付けられている COLORSCHEME 構造体を取得します。
CReBarCtrl::GetDropTarget	鉄筋コントロールの IDropTarget インターフェイス ポインターを取得します。
CReBarCtrl::GetExtendedStyle	現在の鉄筋コントロールの拡張スタイルを取得します。
CReBarCtrl::GetImageList	鉄筋コントロールに関連付けられているイメージ リストを取得します。
CReBarCtrl::GetPalette	Rebar コントロールの現在のパレットを取得します。
CReBarCtrl::GetRect	Rebar コントロール内の特定のバンドの外接矩形を取得します。
CReBarCtrl::GetRowCount	鉄筋コントロール内のバンド行の数を取得します。
CReBarCtrl::GetRowHeight	Rebar コントロール内の指定した行の高さを取得します。
CReBarCtrl::GetTextColor	Rebar コントロールの既定のテキスト色を取得します。
CReBarCtrl::GetToolTips	鉄筋コントロールに関連付けられているツール ヒント コントロールのハンドルを取得します。
CReBarCtrl::HitTest	Rebar バンドがそのポイントに存在する場合に、画面上の特定のポイントにある Rebar バンドの部分を決定します。
CReBarCtrl::IDToIndex	帯識別子 (ID) を鉄筋コントロールのバンド インデックスに変換します。
CReBarCtrl::InsertBand	Rebar コントロールに新しいバンドを挿入します。
CReBarCtrl::MaximizeBand	鉄筋コントロールのバンドのサイズを最大サイズに変更します。
CReBarCtrl::MinimizeBand	Rebar コントロールのバンドのサイズを最小サイズに変更します。
CReBarCtrl::MoveBand	あるインデックスから別のインデックスにバンドを移動します。
CReBarCtrl::P ushChevron	プログラムによってシェブロンをプッシュします。
CReBarCtrl::RestoreBand	鉄筋コントロールのバンドのサイズを理想的なサイズに変更します。
CReBarCtrl::SetBandInfo	Rebar コントロールの既存のバンドの特性を設定します。
CReBarCtrl::SetBandWidth	現在の鉄筋コントロールの指定したドッキング バンドの幅を設定します。
CReBarCtrl::SetBarInfo	Rebar コントロールの特性を設定します。
CReBarCtrl::SetBkColor	Rebar コントロールの既定の背景色を設定します。
CReBarCtrl::SetColorScheme	鉄筋コントロールのボタンの配色を設定します。
CReBarCtrl::SetExtendedStyle	現在の鉄筋コントロールの拡張スタイルを設定します。
CReBarCtrl::SetImageList	鉄筋コントロールのイメージ リストを設定します。
CReBarCtrl::SetOwner	鉄筋コントロールの所有者ウィンドウを設定します。
CReBarCtrl::SetPalette	Rebar コントロールの現在のパレットを設定します。
CReBarCtrl::SetTextColor	Rebar コントロールの既定のテキスト色を設定します。
CReBarCtrl::SetToolTips	ツール ヒント コントロールを鉄筋コントロールに関連付けます。
CReBarCtrl::SetWindowTheme	鉄筋コントロールの表示スタイルを設定します。
CReBarCtrl::ShowBand	Rebar コントロール内の特定のバンドを表示または非表示にします。
CReBarCtrl::SizeToRect	鉄筋コントロールを指定した四角形に適合させます。

解説

鉄筋コントロールが存在するアプリケーションは、鉄筋コントロールに含まれる子ウィンドウを鉄筋バンドに割り当てます。 通常、子ウィンドウは別の共通コントロールです。

鉄筋コントロールには、1 つ以上のバンドが含まれています。 各バンドには、グリッパー バー、ビットマップ、テキスト ラベル、および子ウィンドウの組み合わせを含めることができます。 バンドには、これらの各項目のうち 1 つだけを含めることができます。

鉄筋コントロールは、指定された背景ビットマップ上に子ウィンドウを表示できます。 RBBS_FIXEDSIZE スタイルを使用するものを除き、すべての Rebar コントロール バンドのサイズを変更できます。 鉄筋コントロール バンドの位置を変更したり、サイズを変更したりすると、そのバンドに割り当てられた子ウィンドウのサイズと位置が、鉄筋コントロールによって管理されます。 コントロール内のバンドのサイズを変更するには、バンドのグリッパー バーをクリックしてドラッグします。

次の図は、3 つのバンドを持つ鉄筋コントロールを示しています。

• バンド 0 には、フラットで透明なツール バー コントロールが含まれています。

• バンド 1 には、透明な標準と透明の両方のドロップダウン ボタンが含まれています。

• バンド 2 には、コンボ ボックスと 4 つの標準ボタンが含まれています。

  

鉄筋コントロール

鉄筋コントロールのサポート:

• 画像リスト。

• メッセージ処理。

• カスタム描画機能。

• 標準のウィンドウ スタイルに加えて、さまざまなコントロール スタイル。 これらのスタイルの一覧については、Windows SDK の「 Rebar コントロール スタイル 」を参照してください。

詳細については、「 CReBarCtrl の使用」を参照してください。

継承階層

CObject

CCmdTarget

CWnd

CReBarCtrl

要件

ヘッダー: afxcmn.h

CReBarCtrl::BeginDrag

Windows SDK で説明されているように、Win32 メッセージ RB_BEGINDRAGの動作を実装します。

void BeginDrag(
    UINT uBand,
    DWORD dwPos = (DWORD)-1);

パラメーター

uBand
ドラッグ アンド ドロップ操作が影響を受けるバンドの 0 から始まるインデックス。

dwPos
開始マウス座標を含む DWORD 値。 水平座標は LOWORD に含まれており、垂直座標は HIWORD に含まれています。 (DWORD)-1 を渡すと、 GetMessage または PeekMessageというコントロールのスレッドが最後に呼び出されたとき、鉄筋コントロールはマウスの位置を使用します。

CReBarCtrl::Create

鉄筋コントロールを作成し、 CReBarCtrl オブジェクトにアタッチします。

virtual BOOL Create(
    DWORD dwStyle,
    const RECT& rect,
    CWnd* pParentWnd,
    UINT nID);

パラメーター

dwStyle
コントロールに適用される鉄筋コントロール スタイルの組み合わせを指定します。 サポートされているスタイルの一覧については、Windows SDK の「 Rebar コントロール スタイル 」を参照してください。

rect
CRect オブジェクトまたは RECT 構造体への参照。これは、鉄筋コントロールの位置とサイズです。

pParentWnd
鉄筋コントロールの親ウィンドウである CWnd オブジェクトへのポインター。 NULL は指定できません。

nID
鉄筋コントロールのコントロール ID を指定します。

戻り値

オブジェクトが正常に作成された場合は 0 以外。それ以外の場合は 0。

解説

2 つの手順で鉄筋コントロールを作成します。

1. CReBarCtrl を呼び出して、CReBarCtrl オブジェクトを構築します。

2. このメンバー関数を呼び出します。これにより、Windows 鉄筋コントロールが作成され、 CReBarCtrl オブジェクトにアタッチされます。

Createを呼び出すと、共通コントロールが初期化されます。

例

CReBarCtrl *pReBarCtrl = new CReBarCtrl();
CRect rect;
GetWindowRect(rect);
pReBarCtrl->Create(RBS_BANDBORDERS, rect, this, AFX_IDW_REBAR);

// Use ReBar Control.

delete pReBarCtrl;

CReBarCtrl::CreateEx

コントロール (子ウィンドウ) を作成し、 CReBarCtrl オブジェクトに関連付けます。

virtual BOOL CreateEx(
    DWORD dwExStyle,
    DWORD dwStyle,
    const RECT& rect,
    CWnd* pParentWnd,
    UINT nID);

パラメーター

dwExStyle
作成するコントロールの拡張スタイルを指定します。 拡張 Windows スタイルの一覧については、Windows SDK の CreateWindowEx の dwExStyle パラメーターを参照してください。

dwStyle
コントロールに適用される鉄筋コントロール スタイルの組み合わせを指定します。 サポートされているスタイルの一覧については、Windows SDK の「 Rebar コントロール スタイル 」を参照してください。

rect
作成するウィンドウのサイズと位置を記述する RECT 構造体への参照 ( pParentWnd のクライアント座標)。

pParentWnd
コントロールの親であるウィンドウへのポインター。

nID
コントロールの子ウィンドウ ID。

戻り値

正常終了した場合は 0 以外を返します。それ以外の場合は 0 を返します。

解説

Create の代わりにCreateExを使用して、Windows 拡張スタイルの前書きWS_EX_で指定された拡張 Windows スタイルを適用します。

CReBarCtrl::CReBarCtrl

CReBarCtrl オブジェクトを作成します。

CReBarCtrl();

例

CReBarCtrl::Create の例を参照してください。

CReBarCtrl::D eleteBand

Windows SDK で説明されているように、Win32 メッセージ RB_DELETEBANDの動作を実装します。

BOOL DeleteBand(UINT uBand);

パラメーター

uBand
削除するバンドの 0 から始まるインデックス。

戻り値

バンドが正常に削除された場合は 0 以外。それ以外の場合は 0。

例

UINT nCount = m_wndReBar.GetReBarCtrl().GetBandCount();

if (nCount > 0)
   m_wndReBar.GetReBarCtrl().DeleteBand(nCount - 1);

CReBarCtrl::D ragMove

Windows SDK で説明されているように、Win32 メッセージ RB_DRAGMOVEの動作を実装します。

void DragMove(DWORD dwPos = (DWORD)-1);

パラメーター

dwPos
新しいマウス座標を含む DWORD 値。 水平座標は LOWORD に含まれており、垂直座標は HIWORD に含まれています。 (DWORD)-1 を渡すと、 GetMessage または PeekMessageというコントロールのスレッドが最後に呼び出されたとき、鉄筋コントロールはマウスの位置を使用します。

CReBarCtrl::EndDrag

Windows SDK で説明されているように、Win32 メッセージ RB_ENDDRAGの動作を実装します。

void EndDrag();

CReBarCtrl::GetBandBorders

Windows SDK で説明されているように、Win32 メッセージ RB_GETBANDBORDERSの動作を実装します。

void GetBandBorders(
    UINT uBand,
    LPRECT prc) const;

パラメーター

uBand
罫線を取得するバンドの 0 から始まるインデックス。

prc
バンド境界を受け取る RECT 構造体へのポインター。 鉄筋コントロールにRBS_BANDBORDERS スタイルがある場合、この構造の各メンバーは、境界線を構成する、バンドの対応する側のピクセル数を受け取ります。 鉄筋コントロールにRBS_BANDBORDERS スタイルがない場合は、この構造の左側のメンバーのみが有効な情報を受け取ります。 鉄筋コントロール スタイルの詳細については、Windows SDK の「 Rebar コントロール スタイル 」を参照してください。

CReBarCtrl::GetBandCount

Windows SDK で説明されているように、Win32 メッセージ RB_GETBANDCOUNTの動作を実装します。

UINT GetBandCount() const;

戻り値

コントロールに割り当てられたバンドの数。

CReBarCtrl::GetBandInfo

Windows SDK で説明されているように、Win32 メッセージ RB_GETBANDINFO の動作を実装します。

BOOL GetBandInfo(
    UINT uBand,
    REBARBANDINFO* prbbi) const;

パラメーター

uBand
情報を取得するバンドの 0 から始まるインデックス。

prbbi
バンド情報を受信する REBARBANDINFO 構造体へのポインター。 この構造体の cbSize メンバーを sizeof(REBARBANDINFO) に設定し、このメッセージを送信する前に、 fMask メンバーを取得するアイテムに設定する必要があります。

戻り値

成功した場合は 0 以外を返します。それ以外の場合は 0 を返します。

CReBarCtrl::GetBandMargins

バンドの余白を取得します。

void GetBandMargins(PMARGINS pMargins);

パラメーター

pMargins
情報を受け取る MARGINS構造体へのポインター。

解説

このメンバー関数は、Windows SDK で説明されているように、 RB_GETBANDMARGINS メッセージの機能をエミュレートします。

CReBarCtrl::GetBarHeight

鉄筋バーの高さを取得します。

UINT GetBarHeight() const;

戻り値

コントロールの高さをピクセル単位で表す値。

CReBarCtrl::GetBarInfo

Windows SDK で説明されているように、Win32 メッセージ RB_GETBARINFOの動作を実装します。

BOOL GetBarInfo(REBARINFO* prbi) const;

パラメーター

prbi
鉄筋コントロール情報を受け取る REBARINFO 構造体へのポインター。 このメッセージを送信する前に、この構造体の cbSize メンバーを sizeof(REBARINFO) に設定する必要があります。

戻り値

成功した場合は 0 以外を返します。それ以外の場合は 0 を返します。

CReBarCtrl::GetBkColor

Windows SDK で説明されているように、Win32 メッセージ RB_GETBKCOLORの動作を実装します。

COLORREF GetBkColor() const;

戻り値

現在の既定の背景色を表す COLORREF 値。

CReBarCtrl::GetColorScheme

鉄筋コントロールの COLORSCHEME 構造体を取得します。

BOOL GetColorScheme(COLORSCHEME* lpcs);

パラメーター

lpcs
Windows SDK で説明されているように、 COLORSCHEME 構造体へのポインター。

戻り値

成功した場合は 0 以外を返します。それ以外の場合は 0 を返します。

解説

COLORSCHEME構造には、ボタンの強調表示の色とボタンの影の色が含まれます。

CReBarCtrl::GetDropTarget

Windows SDK で説明されているように、Win32 メッセージ RB_GETDROPTARGETの動作を実装します。

IDropTarget* GetDropTarget() const;

戻り値

IDropTarget インターフェイスへのポインター。

CReBarCtrl::GetExtendedStyle

現在の鉄筋コントロールの拡張スタイルを取得します。

DWORD GetExtendedStyle() const;

戻り値

拡張スタイルを示すフラグのビットごとの組み合わせ (OR)。 使用可能なフラグは、RBS_EX_SPLITTERとRBS_EX_TRANSPARENTです。 詳細については、CReBarCtrl::SetExtendedStyle メソッドの dwMask パラメーターを参照してください。

解説

このメソッドは、Windows SDK で説明されている RB_GETEXTENDEDSTYLE メッセージを送信します。

CReBarCtrl::GetImageList

鉄筋コントロールに関連付けられている CImageList オブジェクトを取得します。

CImageList* GetImageList() const;

戻り値

CImageList オブジェクトへのポインター。 コントロールにイメージ リストが設定されていない場合は NULL を返します。

解説

このメンバー関数は、Windows SDK で説明されているように、 REBARINFO 構造体に格納されているサイズとマスクの情報を使用します。

CReBarCtrl::GetPalette

Rebar コントロールの現在のパレットを取得します。

CPalette* GetPalette() const;

戻り値

鉄筋コントロールの現在のパレットを指定する CPalette オブジェクトへのポインター。

解説

このメンバー関数は、HPALETTE ではなく、 CPalette オブジェクトを戻り値として使用することに注意してください。

例

CPalette *pPalette = m_wndReBar.GetReBarCtrl().GetPalette();
if (pPalette)
{
   int nEntries = pPalette->GetEntryCount();
   CString msg;
   msg.Format(_T("Number of palette entries: %d"), nEntries);
   AfxMessageBox(msg);
}
else
{
   AfxMessageBox(_T("No palette!"));
}

CReBarCtrl::GetRect

Windows SDK で説明されているように、Win32 メッセージ RB_GETRECTの動作を実装します。

BOOL GetRect(
    UINT uBand,
    LPRECT prc) const;

パラメーター

uBand
鉄筋コントロールのバンドの 0 から始まるインデックス。

prc
鉄筋バンドの境界を受け取る RECT 構造体へのポインター。

戻り値

成功した場合は 0 以外を返します。それ以外の場合は 0 を返します。

例

CRect rc;
m_wndReBar.GetReBarCtrl().GetRect(0, &rc);
CString msg;
msg.Format(_T("rect.left = %d, rect.top = %d, ")
           _T("rect.right = %d, rect.bottom = %d"),
           rc.left,
           rc.top, rc.right, rc.bottom);
AfxMessageBox(msg);

CReBarCtrl::GetRowCount

Windows SDK で説明されているように、Win32 メッセージ RB_GETROWCOUNTの動作を実装します。

UINT GetRowCount() const;

戻り値

コントロール内のバンド行の数を表す UINT 値。

例

UINT nRowCount = m_wndReBar.GetReBarCtrl().GetRowCount();
CString msg;
msg.Format(_T("Row Count is %d"), nRowCount);
AfxMessageBox(msg);

CReBarCtrl::GetRowHeight

Windows SDK で説明されているように、Win32 メッセージ RB_GETROWHEIGHTの動作を実装します。

UINT GetRowHeight(UINT uRow) const;

パラメーター

uRow
高さを取得するバンドの 0 から始まるインデックス。

戻り値

行の高さをピクセル単位で表す UINT 値。

例

int nCount = m_wndReBar.GetReBarCtrl().GetRowCount();
for (int i = 0; i < nCount; i++)
{
   UINT nHeight = m_wndReBar.GetReBarCtrl().GetRowHeight(i);
   CString msg;
   msg.Format(_T("Height of row %d is %u"), i, nHeight);
   AfxMessageBox(msg);
}

CReBarCtrl::GetTextColor

Windows SDK で説明されているように、Win32 メッセージ RB_GETTEXTCOLORの動作を実装します。

COLORREF GetTextColor() const;

戻り値

現在の既定のテキストの色を表す COLORREF 値。

CReBarCtrl::GetToolTips

Windows SDK で説明されているように、Win32 メッセージ RB_GETTOOLTIPSの動作を実装します。

CToolTipCtrl* GetToolTips() const;

戻り値

CToolTipCtrl オブジェクトへのポインター。

解説

GetToolTipsの MFC 実装では、HWND ではなく、CToolTipCtrlへのポインターが返されることに注意してください。

CReBarCtrl::HitTest

Windows SDK で説明されているように、Win32 メッセージ RB_HITTESTの動作を実装します。

int HitTest(RBHITTESTINFO* prbht);

パラメーター

prbht
RBHITTESTINFO 構造体へのポインター。 メッセージを送信する前に、この構造体の pt メンバーをクライアント座標でテストするポイントに初期化する必要があります。

戻り値

指定したポイントのバンドの 0 から始まるインデックス。鉄筋バンドがポイントに存在しない場合は -1。

CReBarCtrl::IDToIndex

Windows SDK で説明されているように、Win32 メッセージ RB_IDTOINDEXの動作を実装します。

int IDToIndex(UINT uBandID) const;

パラメーター

uBandID
バンドが挿入されるときに、REBARBANDINFO 構造体のwID メンバーで渡される、指定されたバンドのアプリケーション定義識別子。

戻り値

成功した場合は 0 から始まるバンド インデックス。それ以外の場合は -1。 重複するバンド インデックスが存在する場合は、最初のインデックスが返されます。

CReBarCtrl::InsertBand

Windows SDK で説明されているように、Win32 メッセージ RB_INSERTBANDの動作を実装します。

BOOL InsertBand(
    UINT uIndex,
    REBARBANDINFO* prbbi);

パラメーター

uIndex
バンドが挿入される位置の 0 から始まるインデックス。 このパラメーターを -1 に設定すると、コントロールは最後の場所に新しいバンドを追加します。

prbbi
挿入するバンドを定義する REBARBANDINFO 構造体へのポインター。 この関数を呼び出す前に、この構造体の cbSize メンバーを sizeof(REBARBANDINFO) に設定する必要があります。

戻り値

成功した場合は 0 以外を返します。それ以外の場合は 0 を返します。

例

REBARBANDINFO rbbi = {0};
rbbi.cbSize = sizeof(rbbi);

TCHAR szText[80];
rbbi.lpText = szText;
rbbi.cch = sizeof(szText) / sizeof(szText[0]);

rbbi.fMask = RBBIM_BACKGROUND | RBBIM_CHILD |
             RBBIM_CHILDSIZE | RBBIM_COLORS | RBBIM_HEADERSIZE |
             RBBIM_IDEALSIZE | RBBIM_ID | RBBIM_IMAGE |
             RBBIM_LPARAM | RBBIM_SIZE | RBBIM_STYLE | RBBIM_TEXT;

m_wndReBar.GetReBarCtrl().GetBandInfo(0, &rbbi);

m_wndReBar.GetReBarCtrl().InsertBand(1, &rbbi);

CReBarCtrl::MaximizeBand

鉄筋コントロールのバンドのサイズを最大サイズに変更します。

void MaximizeBand(UINT uBand);

パラメーター

uBand
最大化するバンドの 0 から始まるインデックス。

解説

Windows SDK で説明されているように、fIdealが 0 に設定された Win32 メッセージ RB_MAXIMIZEBANDの動作を実装します。

例

CReBarCtrl& refReBarCtrl = m_wndReBar.GetReBarCtrl();
UINT nCount = refReBarCtrl.GetBandCount();

for (UINT i = 0; i < nCount; i++)
   refReBarCtrl.MaximizeBand(i);   

CReBarCtrl::MinimizeBand

Rebar コントロールのバンドのサイズを最小サイズに変更します。

void MinimizeBand(UINT uBand);

パラメーター

uBand
最小化するバンドの 0 から始まるインデックス。

解説

Windows SDK で説明されているように、Win32 メッセージ RB_MINIMIZEBANDの動作を実装します。

例

CReBarCtrl &refReBarCtrl = m_wndReBar.GetReBarCtrl();
UINT nCount = refReBarCtrl.GetBandCount();

for (UINT i = 0; i < nCount; i++)
   refReBarCtrl.MinimizeBand(i);

CReBarCtrl::MoveBand

Windows SDK で説明されているように、Win32 メッセージ RB_MOVEBANDの動作を実装します。

BOOL MoveBand(
    UINT uFrom,
    UINT uTo);

パラメーター

uFrom
移動するバンドの 0 から始まるインデックス。

uTo
新しいバンド位置の 0 から始まるインデックス。 このパラメーター値は、バンドの数から 1 を引いた値を超えてはなりません。 バンドの数を取得するには、 GetBandCount を呼び出します。

戻り値

成功した場合は 0 以外を返します。それ以外の場合は 0 を返します。

CReBarCtrl::P ushChevron

Windows SDK で説明されているように、Win32 メッセージ RB_PUSHCHEVRONの動作を実装します。

void PushChevron(
    UINT uBand,
    LPARAM lAppValue);

パラメーター

uBand
シェブロンがプッシュされるバンドの 0 から始まるインデックス。

lAppValue
アプリケーション定義の 32 ビット値。 Windows SDK のRB_PUSHCHEVRONの「lAppValue」を参照してください。

CReBarCtrl::RestoreBand

鉄筋コントロールのバンドのサイズを理想的なサイズに変更します。

void RestoreBand(UINT uBand);

パラメーター

uBand
最大化するバンドの 0 から始まるインデックス。

解説

Windows SDK で説明されているように、fIdealが 1 に設定された Win32 メッセージ RB_MAXIMIZEBANDの動作を実装します。

例

CReBarCtrl &refReBarCtrl = m_wndReBar.GetReBarCtrl();
UINT nCount = refReBarCtrl.GetBandCount();

for (UINT i = 0; i < nCount; i++)
   refReBarCtrl.RestoreBand(i);

CReBarCtrl::SetBandInfo

Windows SDK で説明されているように、Win32 メッセージ RB_SETBANDINFOの動作を実装します。

BOOL SetBandInfo(
    UINT uBand,
    REBARBANDINFO* prbbi);

パラメーター

uBand
新しい設定を受け取るバンドの 0 から始まるインデックス。

prbbi
挿入するバンドを定義する REBARBANDINFO 構造体へのポインター。 このメッセージを送信する前に、この構造体の cbSize メンバーを sizeof(REBARBANDINFO) に設定する必要があります。

戻り値

成功した場合は 0 以外を返します。それ以外の場合は 0 を返します。

例

int nCount = m_wndReBar.GetReBarCtrl().GetBandCount();
CString strText;
REBARBANDINFO rbbi = {0};
rbbi.cbSize = sizeof(rbbi);
for (int i = 0; i < nCount; i++)
{
   strText.Format(_T("Band #: %d"), i);
   rbbi.lpText = strText.GetBuffer();
   rbbi.cch = strText.GetLength() + 1;
   rbbi.fMask = RBBIM_TEXT;

   m_wndReBar.GetReBarCtrl().SetBandInfo(i, &rbbi);

   strText.ReleaseBuffer();
}

CReBarCtrl::SetBandWidth

現在の鉄筋コントロールの指定したドッキング バンドの幅を設定します。

BOOL SetBandWidth(
    UINT uBand,
    int cxWidth);

パラメーター

uBand
[in]鉄筋バンドの 0 から始まるインデックス。

cxWidth
[in]鉄筋バンドの新しい幅 (ピクセル単位)。

戻り値

メソッドが成功した場合は TRUE。それ以外の場合は FALSE。

解説

このメソッドは、Windows SDK で説明されている RB_SETBANDWIDTH メッセージを送信します。

例

最初のコード例では、現在の鉄筋コントロールにアクセスするために使用される変数 ( m_rebar) を定義します。 この変数は次の例で使用されています。

public:
CReBarCtrl m_rebar;
BOOL bRet;
static const int TOTAL_BANDS = 5;
static const int BUFFER_SIZE = 10;

次のコード例では、各鉄筋バンドを同じ幅に設定します。

// Set the width of each band.
m_rebar.GetClientRect(&rect);
int iWidth = rect.Width() / TOTAL_BANDS;
for (int iIndex = 0; iIndex < TOTAL_BANDS; iIndex++)
   bRet = m_rebar.SetBandWidth(iIndex, iWidth);

CReBarCtrl::SetBarInfo

Windows SDK で説明されているように、Win32 メッセージ RB_SETBARINFOの動作を実装します。

BOOL SetBarInfo(REBARINFO* prbi);

パラメーター

prbi
設定する情報を含む REBARINFO 構造体へのポインター。 このメッセージを送信する前に、この構造体の cbSize メンバーを sizeof(REBARINFO) に設定する必要があります

戻り値

成功した場合は 0 以外を返します。それ以外の場合は 0 を返します。

例

REBARINFO rbi = {0};
rbi.cbSize = sizeof(REBARINFO);
rbi.fMask = 0;
rbi.himl = 0;
m_wndReBar.GetReBarCtrl().SetBarInfo(&rbi);

CReBarCtrl::SetBkColor

Windows SDK で説明されているように、Win32 メッセージ RB_SETBKCOLORの動作を実装します。

COLORREF SetBkColor(COLORREF clr);

パラメーター

clr
新しい既定の背景色を表す COLORREF 値。

戻り値

前の既定の背景色を表す COLORREF 値。

解説

背景色を設定するタイミングと既定値を設定する方法の詳細については、このトピックを参照してください。

CReBarCtrl::SetColorScheme

鉄筋コントロールのボタンの配色を設定します。

void SetColorScheme(const COLORSCHEME* lpcs);

パラメーター

lpcs
Windows SDK で説明されているように、 COLORSCHEME 構造体へのポインター。

解説

COLORSCHEME構造には、ボタンの強調表示の色とボタンの影の色の両方が含まれます。

CReBarCtrl::SetExtendedStyle

現在の鉄筋コントロールの拡張スタイルを設定します。

DWORD SetExtendedStyle(
    DWORD dwMask,
    DWORD dwStyleEx);

パラメーター

dwMask
[in] dwStyleEx パラメーターに適用されるフラグを指定するフラグのビットごとの組み合わせ (OR)。 次の値のうち 1 つ以上を使用します。

• RBS_EX_SPLITTER: 既定では、水平モードでは下部にスプリッターを表示し、垂直モードでは右に表示します。
• RBS_EX_TRANSPARENT: WM_ERASEBKGND メッセージを親ウィンドウに転送します。

dwStyleEx
[in]適用するスタイルを指定するフラグのビットごとの組み合わせ (OR)。 スタイルを設定するには、 dwMask パラメーターで使用されるのと同じフラグを指定します。 スタイルをリセットするには、2 進ゼロを指定します。

戻り値

前の拡張スタイル。

解説

このメソッドは、Windows SDK で説明されている RB_SETEXTENDEDSTYLE メッセージを送信します。

CReBarCtrl::SetImageList

イメージ リストを鉄筋コントロールに割り当てます。

BOOL SetImageList(CImageList* pImageList);

パラメーター

pImageList
鉄筋コントロールに割り当てるイメージ リストを含む CImageList オブジェクトへのポインター。

戻り値

成功した場合は 0 以外を返します。それ以外の場合は 0 を返します。

CReBarCtrl::SetOwner

Windows SDK で説明されているように、Win32 メッセージ RB_SETPARENTの動作を実装します。

CWnd* SetOwner(CWnd* pWnd);

パラメーター

pWnd
鉄筋コントロールの所有者として設定する CWnd オブジェクトへのポインター。

戻り値

鉄筋コントロールの現在の所有者である CWnd オブジェクトへのポインター。

解説

このメンバー関数は、ポインターを使用して、ウィンドウへのハンドルではなく、鉄筋コントロールの現在の所有者と選択した所有者の両方のオブジェクトを CWnd します。

Note

このメンバー関数は、コントロールの作成時に設定された実際の親を変更しません。ではなく、指定したウィンドウに通知メッセージを送信します。

CReBarCtrl::SetPalette

Windows SDK で説明されているように、Win32 メッセージ RB_SETPALETTEの動作を実装します。

CPalette* SetPalette(HPALETTE hPal);

パラメーター

hPal
鉄筋コントロールが使用する新しいパレットを指定する HPALETTE。

戻り値

鉄筋コントロールの前のパレットを指定する CPalette オブジェクトへのポインター。

解説

このメンバー関数は、HPALETTE ではなく、 CPalette オブジェクトを戻り値として使用することに注意してください。

CReBarCtrl::SetTextColor

Windows SDK で説明されているように、Win32 メッセージ RB_SETTEXTCOLORの動作を実装します。

COLORREF SetTextColor(COLORREF clr);

パラメーター

clr
CReBarCtrl オブジェクトの新しいテキストの色を表す COLORREF 値。

戻り値

CReBarCtrl オブジェクトに関連付けられた前のテキストの色を表すCOLORREF値。

解説

これは、鉄筋コントロールのテキストの色の柔軟性をサポートするために提供されます。

CReBarCtrl::SetToolTips

ツール ヒント コントロールを鉄筋コントロールに関連付けます。

void SetToolTips(CToolTipCtrl* pToolTip);

パラメーター

pToolTip
CToolTipCtrl オブジェクトへのポインター

解説

完了したら、 CToolTipCtrl オブジェクトを破棄する必要があります。

CReBarCtrl::SetWindowTheme

鉄筋コントロールの表示スタイルを設定します。

HRESULT SetWindowTheme(LPCWSTR pszSubAppName);

パラメーター

pszSubAppName
設定する鉄筋の表示スタイルを含む Unicode 文字列へのポインター。

戻り値

戻り値は使用されません。

解説

このメンバー関数は、Windows SDK で説明されているように、 RB_SETWINDOWTHEME メッセージの機能をエミュレートします。

CReBarCtrl::ShowBand

Windows SDK で説明されているように、Win32 メッセージ RB_SHOWBANDの動作を実装します。

BOOL ShowBand(
    UINT uBand,
    BOOL fShow = TRUE);

パラメーター

uBand
鉄筋コントロールのバンドの 0 から始まるインデックス。

fShow
バンドを表示するか非表示にするかを示します。 この値が TRUE の場合、バンドが表示されます。 それ以外の場合、バンドは非表示になります。

戻り値

成功した場合は 0 以外を返します。それ以外の場合は 0 を返します。

CReBarCtrl::SizeToRect

Windows SDK で説明されているように、Win32 メッセージ RB_SIZETORECTの動作を実装します。

BOOL SizeToRect(CRect& rect);

パラメーター

rect
鉄筋コントロールのサイズを設定する四角形を指定する CRect オブジェクトへの参照。

戻り値

成功した場合は 0 以外を返します。それ以外の場合は 0 を返します。

解説

このメンバー関数は、RECT構造体ではなく、CRect オブジェクトをパラメーターとして使用します。

関連項目

CWnd クラス
階層図