CMFCColorBar クラス

[アーティクル]
08/09/2011

CMFCColorBar クラスは、ドキュメントまたはアプリケーションで色を選択できるドッキングコントロールバーを表します。

class CMFCColorBar : public CMFCPopupMenuBar

メンバー

プロテクトコンストラクター

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

パブリックメソッド

[名前]	説明
CMFCColorBar::ContextToSize	カラーバーコントロールのボタンを格納するために必要な垂直方向と水平方向のマージンを計算し、そのボタンの位置を調整します。
CMFCColorBar::CreateControl	カラーバーコントロールウィンドウを作成し、CMFCColorBar オブジェクトに結び付け、指定されたカラーパレットが格納されるようにコントロールのサイズを変更します。
CMFCColorBar::Create	カラーバーコントロールウィンドウを作成し、CMFCColorBar オブジェクトに結び付けます。
CMFCColorBar::EnableAutomaticButton	自動ボタンの表示、非表示を切り替えます。
CMFCColorBar::EnableOtherButton	ユーザーがより多くの色を選択できるダイアログボックスの表示を有効または無効にします。
CMFCColorBar::GetColor	現在選択されている色を取得します。
CMFCColorBar::GetCommandID	現在のカラーバーコントロールのコマンド ID を取得します。
CMFCColorBar::GetHighlightedColor	カラーボタンにフォーカスがある、つまり、ボタンがホットであることを示す色を取得します。
CMFCColorBar::GetHorzMargin	水平方向のマージンを取得します。水平方向のマージンは、左右の色セルとクライアント領域の境界の間の領域です。
CMFCColorBar::GetVertMargin	縦方向のマージンを取得します。縦方向のマージンは、上部または下部の色セルとクライアント領域の境界の間の領域です。
CMFCColorBar::IsTearOff	現在のカラーバーがドッキング可能であるかどうかを示します。
CMFCColorBar::SetColor	現在選択されている色を設定します。
CMFCColorBar::SetColorName	指定した色の新しい名前を設定します。
CMFCColorBar::SetCommandID	カラーバーコントロールの新しいコマンド ID を設定します。
CMFCColorBar::SetDocumentColors	現在のドキュメントで使用する色のリストを設定します。
CMFCColorBar::SetHorzMargin	水平方向のマージンを設定します。水平方向のマージンは、左右の色セルとクライアント領域の境界の間の領域です。
CMFCColorBar::SetVertMargin	縦方向のマージンを設定します。縦方向のマージンは、上部または下部の色セルとクライアント領域の境界の間の領域です。

プロテクトメソッド

[名前]	説明
CMFCColorBar::AdjustLocations	カラーバーコントロールのカラーボタンの位置を調整します。
CMFCColorBar::AllowChangeTextLabels	カラーボタンのテキストラベルを変更できるかどうかを示します。
CMFCColorBar::AllowShowOnList	カスタマイズ中にツールバー一覧にカラーバーコントロールオブジェクトを表示できるかどうかを示します。
CMFCColorBar::CalcSize	レイアウト計算の処理の過程でフレームワークによって呼び出されます。
CMFCColorBar::CreatePalette	指定した色の配列で色を指定して、パレットを初期化します。
CMFCColorBar::GetColorGridSize	カラーバーコントロールのグリッドの行数と列数を計算します。
CMFCColorBar::GetExtraHeight	現在のカラーバーで [その他] ボタンやドキュメントの色などのさまざまなユーザーインターフェイス要素を表示するために必要な追加の高さを計算します。
CMFCColorBar::InitColors	指定したパレットの色またはシステムの既定のパレットで、色の配列を初期化します。
CMFCColorBar::OnKey	ユーザーがキーボードボタンを押したときに、フレームワークによって呼び出されます。
CMFCColorBar::OnSendCommand	ポップアップコントロールの階層構造を閉じるために、フレームワークによって呼び出されます。
CMFCColorBar::OnUpdateCmdUI	カラーバーコントロールのユーザーインターフェイス項目を表示する前に、その項目の有効と無効を切り替えるために、フレームワークによって呼び出されます。
CMFCColorBar::OpenColorDialog	色のダイアログボックスを開きます。
CMFCColorBar::Rebuild	カラーバーコントロールを完全に再描画します。
CMFCColorBar::SelectPalette	指定したデバイスコンテキストの論理パレットを、現在のカラーバーコントロールの親ボタンのパレットに設定します。
CMFCColorBar::SetPropList	m_pWndPropList プロテクトデータメンバーを、プロパティグリッドコントロールへの指定したポインターに設定します。
CMFCColorBar::ShowCommandMessageString	カラーバーコントロールを所有するフレームウィンドウに対して、ステータスバーのメッセージ行の更新を要求します。

プロテクトデータメンバー

[名前]	説明
m_bInternal	マウスイベントが処理されるかどうかを表すブール値フィールド。通常、このフィールドが TRUE で、カスタマイズモードが FALSE の場合は、マウスイベントが処理されます。
m_bIsEnabled	コントロールが有効かどうかを示すブール値。
m_bIsTearOff	カラーバーコントロールがドッキングをサポートするかどうかを示すブール値。
m_BoxSize	カラーバーグリッドのセルのサイズを指定する CSize オブジェクト。
m_bShowDocColorsWhenDocked	カラーバーがドッキングされたときにドキュメントの色を表示するかどうかを示すブール値。詳細については、「CMFCColorBar::SetDocumentColors」を参照してください。
m_bStdColorDlg	標準システムの色のダイアログボックスを表示するか、CMFCColorDialog ダイアログボックスを表示するかを示すブール値。詳細については、「CMFCColorBar::EnableOtherButton」を参照してください。
m_ColorAutomatic	現在の自動設定の色を格納する COLORREF。詳細については、「CMFCColorBar::EnableOtherButton」を参照してください。
m_ColorNames	RGB カラーのセットをその名前と関連付ける CMap オブジェクト。
m_colors	カラーバーコントロールに表示される色を含む COLORREF 値の CArray。
m_ColorSelected	ユーザーがカラーバーコントロールから現在選択している色を示す COLORREF 値。
m_lstDocColors	ドキュメントで現在使用されている色を含む COLORREF 値の CList。
m_nCommandID	カラーボタンのコマンド ID を示す符号なし整数。
m_nHorzMargin	色のグリッドにあるカラーボタン間の水平マージンを示す整数。
m_nHorzOffset	カラーボタンの中心への水平オフセットを示す整数。この値は、テキストまたはイメージに加えて色がボタンに表示されている場合に有効です。
m_nNumColumns	色のカラーバーコントロールグリッドの列数を示す整数。
m_nNumColumnsVert	色の垂直方向のグリッドの列数を示す整数。
m_nNumRowsHorz	色の水平方向のグリッドの列数を示す整数。
m_nRowHeight	色のグリッドにあるカラーボタンの行の高さを示す整数。
m_nVertMargin	色のグリッドにあるカラーボタン間の垂直マージンを示す整数。
m_nVertOffset	カラーボタンの中心への垂直オフセットを示す整数。この値は、テキストまたはイメージに加えて色がボタンに表示されている場合に有効です。
m_Palette	カラーバーコントロールで使用される色の CPalette。
m_pParentBtn	現在のボタンの親である CMFCColorButton オブジェクトへのポインター。この値は、カラーボタンがツールバーの階層またはカラープロパティグリッドコントロールにある場合に有効です。
m_pParentRibbonBtn	リボン上にあり、現在のボタンの親ボタンである CMFCRibbonColorButton オブジェクトへのポインター。この値は、カラーボタンがツールバーの階層またはカラープロパティグリッドコントロールにある場合に有効です。
m_pWndPropList	CMFCPropertyGridCtrl オブジェクトへのポインター。
m_strAutoColor	[自動] ボタンに表示されるテキストである CString。詳細については、「CMFCColorBar::EnableAutomaticButton」を参照してください。
m_strDocColors	ドキュメントの色ボタンに表示されるテキストである CString。詳細については、「CMFCColorBar::SetDocumentColors」を参照してください。
m_strOtherColor	[その他] ボタンに表示されるテキストである CString。詳細については、「CMFCColorBar::EnableOtherButton」を参照してください。

解説

通常は、CMFCColorBar オブジェクトを直接作成しないでください。代わりに、CMFCColorMenuButton クラス (メニューおよびツールバーで使用されます) または CMFCColorButton クラスにより CMFCColorBar オブジェクトが作成されます。

CMFCColorBar クラスには、次の機能が用意されています。

ドキュメントの色のリストを自動的に調整します。
その状態をドキュメントの状態と共に保存および復元します。
"自動" ボタンを管理します。
CMFCColorPickerCtrl クラスコントロールを使用して、カスタムの色を選択します。
"ティアオフ" 状態をサポートします (CMFCColorMenuButton クラスにより作成される場合)。

CMFCColorBar 機能をアプリケーションに組み込むには、次の操作を行います。

標準メニューボタンを作成して ID (この例では ID_CHAR_COLOR) を割り当てます。
フレームウィンドウクラスで、CFrameWndEx::OnShowPopupMenu メソッドをオーバーライドして、(CMFCToolBar::ReplaceButton を呼び出すことにより) 標準メニューボタンを CMFCColorMenuButton クラスオブジェクトと置き換えます。
すべてのスタイルを設定し、CMFCColorMenuButton クラスの作成中に CMFCColorBar オブジェクトの機能を有効または無効にします。フレームワークが CreatePopupMenu メソッドを呼び出した後、CMFCColorMenuButton オブジェクトにより CMFCColorBar オブジェクトが動的に作成されます。

ユーザーがカラーバーコントロールボタンをクリックすると、フレームワークは ON_COMMAND マクロを使用してカラーバーコントロールに通知します。マクロでは、コマンド ID パラメーターは手順 1. でカラーバーコントロールボタンに割り当てた値 (この例では ID_CHAR_COLOR) になります。詳細については、「CMFCColorMenuButton クラス」、「CMFCColorButton クラス」、「CMFCColorPickerCtrl クラス」、「CFrameWndEx クラス」、および「CMFCToolBar クラス」を参照してください。

使用例

CMFCColorBar クラスのさまざまなメソッドを使用してカラーバーを設定する方法を、次の例に示します。これらのメソッドは、水平マージンと垂直マージンを設定して、その他ボタンを有効にし、カラーバーコントロールウィンドウを作成して、現在選択されている色を設定します。この例は、「NewControls サンプル:MFC コントロールデモンストレーションアプリケーション」の一部です。

    CMFCColorBar m_wndColorBar;


...


    // set the margins
    m_wndColorBar.SetHorzMargin(0);
    m_wndColorBar.SetVertMargin(0);
    // enable the display of a dialog box that 
    // lets the user select more colors
    m_wndColorBar.EnableOtherButton(_T("Other..."));
    // create a color bar control window
    m_wndColorBar.CreateControl(this, rectColorBar, IDC_COLORBAR, 5 /* columns */);
    // set the currently selected color
    m_wndColorBar.SetColor(RGB(255, 0, 0));