CWnd::EnableToolTips

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

指定されたウィンドウのツールヒントを有効にします。

BOOL EnableToolTips(
   BOOL bEnable = TRUE
);

パラメーター

bEnable
ツールヒントの有効または無効を指定します。 TRUE を指定するとコントロールが有効になり、FALSE を指定するとコントロールが無効になります。

戻り値

ツールヒントが有効な場合は、TRUE を返します。ツールヒントが無効な場合は、FALSE を返します。

解説

ウィンドウに TOOLINFO 構造体を組み入れるには、OnToolHitTest をオーバーライドします。

注意

CToolBar など、ウィンドウの中には、OnToolHitTest が組み込み実装されているものもあります。

この構造体の詳細については、Windows SDK の「TOOLINFO」を参照してください。

親ウィンドウが CFrameWnd から派生されていない限り、子コントロールのツールヒントを表示するには、単に EnableToolTips を呼び出すだけでは十分ではありません。これは、CFrameWnd が提供するのが TTN_NEEDTEXT 通知の既定のハンドラーだからです。親ウィンドウが CFrameWnd から派生されたものでない場合 (ダイアログボックスまたはフォームビューの場合)、TTN_NEEDTEXT ツールヒント通知のハンドラーを提供しない限り、子コントロールのツールヒントは正しく表示されません。「CFrameWnd から派生していないウィンドウのツールヒント」を参照してください。

EnableToolTips によってウィンドウに提供された既定のツールヒントには、対応するテキストがありません。ツールヒントに表示するテキストを取得するには、ツールヒントウィンドウが表示される直前に、TTN_NEEDTEXT 通知をツールヒントコントロールの親ウィンドウに送ります。 TOOLTIPTEXT 構造体の pszText メンバーに値を割り当てるためのメッセージハンドラーがない場合、ツールヒントのテキストは表示されません。

使用例

// From message map for CMdiView, a CView-derived class
ON_NOTIFY_EX_RANGE(TTN_NEEDTEXTW, 0, 0xFFFF, &CMdiView::OnToolTipNotify)
ON_NOTIFY_EX_RANGE(TTN_NEEDTEXTA, 0, 0xFFFF, &CMdiView::OnToolTipNotify)

void CMdiView::OnInitialUpdate()
{
   CView::OnInitialUpdate();

   m_Edit.Create(ES_MULTILINE | WS_CHILD | WS_VISIBLE | WS_TABSTOP | WS_BORDER,
      CRect(10, 10, 100, 100), this, IDC_TTEDIT);
   EnableToolTips(TRUE);   // enable tool tips for view
}

//Notification handler
BOOL CMdiView::OnToolTipNotify(UINT id, NMHDR* pNMHDR, LRESULT* pResult)
{
   UNREFERENCED_PARAMETER(id);
   UNREFERENCED_PARAMETER(pResult);

   // need to handle both ANSI and UNICODE versions of the message
   TOOLTIPTEXTA* pTTTA = (TOOLTIPTEXTA*)pNMHDR;
   TOOLTIPTEXTW* pTTTW = (TOOLTIPTEXTW*)pNMHDR;
   CStringA strTipText;
   UINT_PTR nID = pNMHDR->idFrom;
   if (pNMHDR->code == TTN_NEEDTEXTA && (pTTTA->uFlags & TTF_IDISHWND) ||
      pNMHDR->code == TTN_NEEDTEXTW && (pTTTW->uFlags & TTF_IDISHWND))
   {
      // idFrom is actually the HWND of the tool
      nID = ::GetDlgCtrlID((HWND)nID);
   }

   if (nID != 0) // will be zero on a separator
      strTipText.Format("Control ID = %d", nID);

   if (pNMHDR->code == TTN_NEEDTEXTA)
   {
      strncpy_s(pTTTA->szText, sizeof(pTTTA->szText), strTipText, 
         strTipText.GetLength() + 1);
   }
   else
   {
      ::MultiByteToWideChar(CP_ACP , 0, strTipText, strTipText.GetLength() + 1,
         pTTTW->szText, sizeof(pTTTW->szText)/(sizeof pTTTW->szText[0]));
   }

   return TRUE;    // message was handled
}