Share via


CSmartDockingInfo クラス

スマート ドッキング マーカーの外観を定義します。

構文

class CSmartDockingInfo : public CObject

メンバー

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

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

パブリック メソッド

名前 説明
CSmartDockingInfo::CopyTo 指定された CSmartDockingInfo オブジェクトに現在のスマート ドッキング情報パラメーターをコピーします。

データ メンバー

名前 説明
CSmartDockingInfo::m_bUseThemeColorInShading フレームワークがスマート ドッキング マーカーを表示するときに、現在のテーマの色を使用するかどうかを指定します。
CSmartDockingInfo::m_clrBaseBackground スマート ドッキング マーカーの基本背景色を指定します。
CSmartDockingInfo::m_clrToneDest スマート ドッキング マーカー ビットマップで置き換える m_clrToneSrc 色を指定します。
CSmartDockingInfo::m_clrToneSrc スマート ドッキング マーカー ビットマップの色を指定します。
CSmartDockingInfo::m_clrTransparent スマート ドッキング マーカー ビットマップが透明な場合の色を指定します。
CSmartDockingInfo::m_nCentralGroupOffset 中央グループの四角形の境界からのスマート ドッキング マーカーの中心グループのオフセットを指定します。
CSmartDockingInfo::m_sizeTotal グループ内のすべてのスマート ドッキング マーカーの合計サイズを指定します。
CSmartDockingInfo::m_uiMarkerBmpResID 強調表示されていないスマート ドッキング マーカーにフレームワークが使用するビットマップのリソース ID を定義します。
CSmartDockingInfo::m_uiMarkerLightBmpResID 強調表示されているスマート ドッキング マーカーにフレームワークが使用するビットマップのリソース ID を定義します。

解説

フレームワークは、スマート ドッキング マーカーを内部的に処理します。 次の図は、標準のスマート ドッキング マーカーを示しています。

Standard markers for smart docking.

この図の左側の画像は、タブへのドッキングが有効になっていない中央グループのスマート ドッキング マーカーを示しています。 中央の画像は、右端のスマート ドッキング マーカーを示しています。 右側の画像は、タブへのドッキングが有効になっている中央グループのスマート ドッキング マーカーを示しています。 中央グループのスマート ドッキング マーカーには、メイン ビットマップと 5 つのスマート ドッキング マーカー ビットマップがあります。

スマート ドッキング マーカーの次のパラメーターをカスタマイズできます。

  • 色 たとえば、図のマーカーの青い色をユーザー定義の色に置き換えることができます。

  • 透明度の色。

  • 境界の四角形の境界線からの中央グループ内のスマート ドッキング マーカーのオフセット。

  • 中央グループを表すメインビットマップ。

  • 通常の強調表示されたスマート ドッキング マーカーを表すビットマップ。

次の図は、カスタマイズされたスマート ドッキング マーカーの例を示しています。

Custom markers for smart docking.

継承階層

CObject

CSmartDockingInfo

必要条件

ヘッダー: afxDockingManager.h

CSmartDockingInfo::CopyTo

指定された CSmartDockingInfo オブジェクトに現在のスマート ドッキング パラメーターをコピーします。

void CopyTo(CSmartDockingInfo& params);

パラメーター

params
[out]現在のスマート ドッキング パラメーターが設定されている型 CSmartDockingInfo のオブジェクト。

CSmartDockingInfo::m_bUseThemeColorInShading

フレームワークがスマート ドッキング マーカーを表示するときに、現在のテーマの色を使用するかどうかを指定します。

BOOL m_bUseThemeColorInShading;

解説

TRUE の場合、マーカーは現在のテーマの色を使用して描画されます。それ以外の場合、マーカーは水色で描画されます。

既定値は FALSE です。

CSmartDockingInfo::m_clrBaseBackground

スマート ドッキング マーカーの基本背景色を指定します。

COLORREF m_clrBaseBackground;

CSmartDockingInfo::m_clrToneDest

スマート ドッキング マーカー ビットマップで置き換える m_clrToneSrc 色を指定します。

COLORREF m_clrToneDest;

解説

マーカー ビットマップの色をプログラムで変更するには、この値を設定します。 たとえば、フレームワークで提供される標準マーカーの色を変更する場合は、この値を目的の色に設定します。 既定では、 CSmartDockingInfo::m_clrToneSrc は RGB (61、123、241) (青みがかった色) に設定されています。

カスタム マーカーの色を変更するには、両方 m_clrToneDestm_clrToneSrc指定する必要があります。

CSmartDockingInfo::m_clrToneSrc

スマート ドッキング マーカー ビットマップの色を指定します。

COLORREF m_clrToneSrc;

解説

この値は、カスタム ビットマップの色を別の色に置き換える場合にのみ設定します。 標準 (フレームワーク指定) マーカーの色を変更する場合は、この値を設定する必要はありません。

スマート ドッキング グループのメンバーを空のままにするために使用 (COLORREF)-1 します。

CSmartDockingInfo::m_clrTransparent

スマート ドッキング マーカー ビットマップが透明な場合の色を指定します。

COLORREF m_clrTransparent;

解説

ドッキング グループにカスタム マーカーとカスタム ビットマップを表示する場合は、この値を設定する必要があります。

CSmartDockingInfo::m_nCentralGroupOffset

スマート ドッキング マーカーの中央グループと中央グループの四角形の境界の間のオフセットを指定します。

int m_nCentralGroupOffset;

解説

カスタム マーカーとスマート ドッキング マーカーの中央グループの境界間の既定のオフセットを変更する場合は、この値を指定します。 既定のオフセットは 5 ピクセルです。

CSmartDockingInfo::m_sizeTotal

中央グループ内のすべてのスマート ドッキング マーカーを囲む外接する四角形の合計サイズを指定します。

CSize m_sizeTotal;

解説

中央グループ マーカーの外接する四角形のサイズに設定 m_sizeTotal します。 マーカーにカスタム ビットマップを使用している場合は、この値を指定する必要があります。

CSmartDockingInfo::m_uiMarkerBmpResID

強調表示されていないカスタム スマート ドッキング マーカーに使用されるビットマップのリソース ID を定義します。

UINT m_uiMarkerBmpResID[AFX_SD_MARKERS_NUM];

解説

この配列には、スマート ドッキング マーカーを表すビットマップのリソース ID を入力します。 AFX_SD_MARKERS_NUMは現在 5 として定義されています。 次のように配列を入力します。

params.m_uiMarkerBmpResID[0] = IDB_MARKER_LEFT;
params.m_uiMarkerBmpResID[1] = IDB_MARKER_RIGHT;
params.m_uiMarkerBmpResID[2] = IDB_MARKER_TOP;
params.m_uiMarkerBmpResID[3] = IDB_MARKER_BOTTOM;
params.m_uiMarkerBmpResID[4] = IDB_MARKER_CENTER;

CSmartDockingInfo::m_uiMarkerLightBmpResID

強調表示されたカスタム スマート ドッキング マーカーに使用されるビットマップのリソース ID を定義します。

UINT m_uiMarkerLightBmpResID[AFX_SD_MARKERS_NUM];

解説

この配列には、強調表示されたスマート ドッキング マーカーを表すビットマップのリソース ID を入力します。 AFX_SD_MARKERS_NUMは現在 5 として定義されています。 次のように配列を入力します。

params.m_uiMarkerLightBmpResID[0] = IDB_MARKER_LEFT_LIGHT;
params.m_uiMarkerLightBmpResID[1] = IDB_MARKER_RIGHT_LIGHT;
params.m_uiMarkerLightBmpResID[2] = IDB_MARKER_TOP_LIGHT;
params.m_uiMarkerLightBmpResID[3] = IDB_MARKER_BOTTOM_LIGHT;
params.m_uiMarkerLightBmpResID[4] = IDB_MARKER_CENTER_LIGHT;

関連項目

階層図
クラス
CObject クラス