Добавление DataTips

Элементы DataTips используются для предоставления детальной информации о данных, отображаемых в окне. Например, Microsoft использует DataTips в Visual C++® для показа значений переменных. Вы наводите курсор мыши на переменную во время отладки и видите текущее значение этой переменной в появившейся подсказке. DataTips полезны в любой ситуации, когда об объекте имеется больше информации, чем можно разместить в окне.

В этом примере я использую новые возможности элементов ToolTip, ставшие доступными с появлением IE 4.0 Common Controls DLL, для создания элементов DataTips, в которых содержится информация о нарисованных кругах (см. рис.6). Я создаю круги различных размеров и цветов в случайных местах окна. Когда курсор мыши находится над кругом, появляется многострочный DataTip, в котором указаны координаты центра, радиус и цвет круга. Цвет подсказки соответствует цвету круга. Многострочные подсказки с возможностью изменения цвета текста в них доступны только при инсталлированном IE 4.0.

Рис.6. Пример использования элемента DataTip

С помощью AppWizard я сгенерировал приложение с однодокументным интерфейсом (SDI), отключив опцию "предварительный просмотр при печати" и оставив остальные по умолчанию. Для реализации нужной функциональности я создал или изменил три класса: CCircle, CDTDocument, и CDTView.

CCircle – простой класс, реализующий рисование круга и определение принадлежности точки кругу (hit-testing). Код определения принадлежности точки кругу показан на рис.7. В переменных CCircle::m_CenterPoint, CCircle::m_nRadius, и CCircle::m_Color хранятся, соответственно, координаты центра, радиус и цвет круга. CCircle::Initialize принимает в качестве параметров координаты центра, радиус и цвет и использует их для инициализации соответствующих переменных класса круга. Я предпочел инициализировать переменные класса через функцию CCircle::Initialize, а не через конструктор класса, потому что так легче создавать массив кругов в классе CDTDocument. Все станет понятно, когда мы будем рассматривать класс CDTDocument.

Рис.7. Реализация алгоритма hit-testing в классе CCircle

///////////////////////////////////////////////////////////////////////////// // CCircle hittesting

inline double Square(int n) { return (double(n) * double(n)); }

BOOL CCircle::HitTest(const CPoint& Point) const {

CPoint Diff = m_CenterPoint – Point;

return ((Square(Diff.x) + Square(Diff.y)) <= Square(m_nRadius));

}

CCircle::Draw принимает указатель на контекст устройства, в котором круг должен себя нарисовать. Функция вычисляет координаты квадрата, в который будет вписан круг, создает кисть нужного цвета, после чего использует CDC::Ellipse, чтобы нарисовать круг в контексте устройства. CCircle::HitTest принимает координаты тестируемой точки и использует теорему Пифагора (a² + b² = c²) для определения принадлежности точки окну, сравнивая c2 с радиусом круга. Я определил встроенную функцию Square (возведение в квадрат), чтобы повысить читабельность кода. Встроенные методы CCircle::GetColor, CCircle::GetCenter, и CCircle::GetRadius возвращают, соответственно, переменные класса m_Color, m_CenterPoint, и m_nRadius. Я описал эти функции, а также функции CCircle::Draw и CCircle::HitTest как константные, поскольку они не изменяют внутреннее состояние класса. Другими словами, они сохраняют константность класса. Это хороший стиль программирования, потому что он позволяет вам использовать константные экземпляры CCircle.

CDTDemoDoc унаследован от CDocument. В этом классе хранится массив объектов CCircle, а также определены функции CDTDemoDoc::GetCircleCount и CDTDemoDoc::GetCircle для доступа к информации об этом массиве. CDTDemoDoc::GetCircle принимает целочисленный индекс, указывающий на смещение в массиве. Объекты CCircle хранятся в переменной CDTDemoDoc::m_CircleArray размером CIRCLECOUNT. Я мог бы объявить этот массив как открытый (public), но не сделал этого по двум причинам. Во-первых, реализацию легче менять, если ее детали скрыты от внешнего мира. Допустим, я захочу в будущем использовать для реализации массива переменного размера шаблон CArray. Во-вторых, я хочу возвращать константные ссылки пользователям CDTDemoDoc::GetCircle, чтобы они не смогли случайно изменить объекты кругов в массиве. CDTDemoDoc::CDTDemoDoc вызывает CCircle::Initialize для каждого круга в массиве. CCircle::Initialize облегчает создание массивов фиксированного размера, потому что мне не нужно передавать параметры конструктору CCircle. В противном случае мне пришлось бы создавать массив динамически. Я использовал функцию rand для установки координат кругов. Генератор случайных чисел инициализируется текущим значением времени, поэтому довольно высока вероятность того, что позиция каждого круга будет разной каждый раз, когда вы запускаете приложение.

Класс CDTDemoView ответственен за отображение кругов и реализацию элементов DataTip (см. рис.8). В переменной CDTDemoView::m_ToolTip хранится элемент ToolTip, который выступает в качестве DataTip. Я хотел, чтобы этот пример показал вам, как использовать класс CToolTipCtrl напрямую, вместо использования функций класса CWnd. Однако, в данном случае, даже если я захотел использовать CWnd, я бы не смог, потому что мне нужен прямой доступ к элементу ToolTip, чтобы посылать ему сообщения. CWnd не предоставляет документированных способов доступа к создаваемому им элементу ToolTip, а я не хотел бы полагаться на детали конкретной реализации. CDTDemoView::m_pCircleHit хранит круг под курсором мыши. Если ни один из кругов не попадает под курсор мыши, CDTDemoView::m_pCircleHit может быть NULL.

Рис.8. DTDemoView

/////////////////////////////////////////////////////////////////////////////

// DTDemoView.cpp : implementation of the CDTDemoView class

.

/////////////////////////////////////////////////////////////////////////////

// CDTDemoView HitTest

const CCircle* CDTDemoView::HitTest(const CPoint& Point) {

CDTDemoDoc* pDoc = GetDocument();

ASSERT_VALID(pDoc);

// Проверяем в обратном порядке, чтобы корректно обработать

// перекрывающиеся круги

const CCircle *pCircleHit = NULL;

for (int n = pDoc->GetCircleCount() – 1; n >= 0 && pCircleHit == NULL; n--) {

if (pDoc->GetCircle(n).HitTest(Point)) {

pCircleHit = &(pDoc->GetCircle(n));

}

return pCircleHit;

}

/////////////////////////////////////////////////////////////////////////////

// CDTDemoView drawing

void CDTDemoView::OnDraw(CDC* pDC) {

CDTDemoDoc* pDoc = GetDocument();

ASSERT_VALID(pDoc);

for (int n = 0; n < pDoc->GetCircleCount(); n++) {

pDoc->GetCircle(n).Draw(pDC);

}

/////////////////////////////////////////////////////////////////////////////

// CDTDemoView diagnostics

#ifdef _DEBUG

void CDTDemoView::AssertValid() const {

CView::AssertValid(); } void CDTDemoView::Dump(CDumpContext& dc) const {

CView::Dump(dc);

}

CDTDemoDoc* CDTDemoView::GetDocument() // non-debug version is inline

{

ASSERT(m_pDocument->IsKindOf(RUNTIME_CLASS(CDTDemoDoc)));

return (CDTDemoDoc*)m_pDocument;

}

#endif //_DEBUG

/////////////////////////////////////////////////////////////////////////////

// CDTDemoView message handlers

void CDTDemoView::OnInitialUpdate() {

CView::OnInitialUpdate();

CRect ClientRect(0, 0, 1000, 1000);

if (m_ToolTip.Create(this, TTS_ALWAYSTIP) && m_ToolTip.AddTool(this)) {

m_ToolTip.SendMessage(TTM_SETMAXTIPWIDTH, 0, SHRT_MAX);

m_ToolTip.SendMessage(TTM_SETDELAYTIME, TTDT_AUTOPOP, SHRT_MAX);

m_ToolTip.SendMessage(TTM_SETDELAYTIME, TTDT_INITIAL, 200);

m_ToolTip.SendMessage(TTM_SETDELAYTIME, TTDT_RESHOW, 200);

} else {

TRACE("Error in creating ToolTip");

}

BOOL CDTDemoView::OnToolTipNeedText(UINT id, NMHDR * pNMHDR, LRESULT * pResult) {

BOOL bHandledNotify = FALSE;

CPoint CursorPos;

VERIFY(::GetCursorPos(&CursorPos));

ScreenToClient(&CursorPos);

CRect ClientRect;

GetClientRect(ClientRect);

// Удостовериться, что курсор попадает в клиентскую область окна,

// потому что библиотека тоже хочет получать эти сообщения для

// показа подсказок на панели инструментов.

if (ClientRect.PtInRect(CursorPos)) {

TOOLTIPTEXT *pTTT = (TOOLTIPTEXT *)pNMHDR;

m_pCircleHit = HitTest(CursorPos);

if (m_pCircleHit) {

// Adjust the text by filling in TOOLTIPTEXT

CString strTip;

const CPoint& Center = m_pCircleHit->GetCenter();

COLORREF Color = m_pCircleHit->GetColor();

strTip.Format("Center: (%d, %d)\nRadius: %d\nColor: (%d, %d, %d)", Center.x, Center.y, m_pCircleHit->GetRadius(), (int)GetRValue(Color), (int)GetGValue(Color), (int)GetBValue(Color));

ASSERT(strTip.GetLength() < sizeof(pTTT->szText));

::strcpy(pTTT->szText, strTip);

// Set the text color to same color as circle

m_ToolTip.SendMessage(TTM_SETTIPTEXTCOLOR, Color, L);

} else {

pTTT->szText[0] = 0;

}

bHandledNotify = TRUE;

}

return bHandledNotify;

}

BOOL CDTDemoView::PreTranslateMessage(MSG* pMsg) {

if (::IsWindow(m_ToolTip.m_hWnd) && pMsg->hwnd == m_hWnd) {

switch(pMsg->message) {

case WM_LBUTTONDOWN:

case WM_MOUSEMOVE:

case WM_LBUTTONUP:

case WM_RBUTTONDOWN:

case WM_MBUTTONDOWN:

case WM_RBUTTONUP:

case WM_MBUTTONUP:

m_ToolTip.RelayEvent(pMsg);

break;

}

return CView::PreTranslateMessage(pMsg);

}

void CDTDemoView::OnMouseMove(UINT nFlags, CPoint point) {

if (::IsWindow(m_ToolTip.m_hWnd)) {

const CCircle* pCircleHit = HitTest(point);

if (!pCircleHit || pCircleHit != m_pCircleHit) {

// Activate() скрывает подсказку.

m_ToolTip.Activate(FALSE);

}

if (pCircleHit) {

m_ToolTip.Activate(TRUE);

m_pCircleHit = pCircleHit;

}

CView::OnMouseMove(nFlags, point);

}

CDTDemoView::OnInitialUpdate создает DataTip и подготавливает его к использованию. Я вызываю m_ToolTip.Create и передаю ей TTS_ALWAYSTIP, чтобы DataTip показывался независимо от того, активно приложение или нет. Затем я вызываю m_ToolTip.AddTool и передаю ей CDTDemoView, как окно, содержащее инструмент. Из-за того, что последние параметры в CToolTipCtrl::AddTool имеют значения по умолчанию (LPSTR_TEXTCALLBACK как текст подсказки, NULL для параметра lpRectTool и 0 для nIDTool), все окно будет считаться инструментом и нотификационное сообщение TTN_NEEDTEXT будет послано CDTDemoView. Эта сообщение позволяет мне установить текст подсказки в функции CDTDemoView::OnToolTipNeedText.

Я посылаю несколько сообщений элементу DataTip, чтобы подготовить его к использованию. TTM_SETMAXTIPWIDTH посылается с заведомо большим значением (SHRT_MAX) в параметре lParam для установки максимальной ширины подсказки.[2] Это заставляет элемент ToolTip распознавать символы новой строки в строке подсказки (новая возможность IE 4.0 Common Controls DLL). Затем я три раза посылаю сообщение TTM_SETDELAYTIME.[3] В первый раз параметр wParam имеет значение TTDT_AUTOPOP, для установки времени, которое должно пройти до того, как ToolTip исчезнет. Время инициализируется в параметре lParam заведомо большим значением (SHRT_MAX), чтобы отключить автоисчезание подсказок.[4] Теперь я могу контролировать их время жизни. Во второй раз в wParam передается TTDT_INITIAL, что задает интервал между моментом остановки курсора мыши и первым появлением подсказки. Этот интервал устанавливается в 200 миллисекунд, поэтому подсказка появляется довольно быстро. И, наконец, TTDT_RESHOW устанавливает временной интервал между появлением следующей подсказки при перемещении курсора в другой круг. Этот интервал также установлен в 200 миллисекунд. Почему я не использовал CToolTipCtrl::SetDelayTime для установки интервалов? К сожалению, CToolTipCtrl::SetDelayTime позволяет задать только интервал для TTDT_AUTOMATIC.

Реализации CDTDemoView::OnDraw и CDTDemoView::HitTest довольно прозрачны. CDTDemoView::OnDraw проходит по массиву кругов, вызывая для каждого круга CCircle::Draw. Функция CDTDemoView::HitTest проверяет, находится ли переданная ему точка над каким-нибудь кругом, вызывая для каждого круга в массиве CCircle::HitTest. Обратите внимание, что эта проверка выполняется в порядке, обратном используемому в CDTDemoView::OnDraw. Это делается для учитывания z-сортировки (z-order) кругов. Например, если круг Б нарисован поверх круга A, тогда сначала должна вызваться функция проверки круга Б.

Функция CDTDemoView::OnToolTipNeedText перехватывает нотификационные сообщения TTN_NEEDTEXT от элемента, на который указывает переменная m_ToolTip. Главное предназначение этой функции – определить, над каким кругом находится курсор и определить текст подсказки. Сначала она получает координаты курсора мыши и конвертирует их в клиентскую систему координат. Затем идет проверка на принадлежность координат клиентской части представления. Если этого не сделать, пропадут подсказки на панели инструментов, так как нотификационное сообщение TTN_NEEDTEXT используется также панелью инструментов. CDTDemoView::OnToolTipNeedText автоматически будет получать все сообщения TTN_NEEDTEXT при активном окне представления. Переменная bHandledNotify показывает, должно ли сообщение передаваться дальше главному окну. Если курсор находится в клиентской части окна, я проверяю его координаты на принадлежность какому-нибудь кругу и сохраняю результаты проверки в переменной m_pCircleHit. Эта переменная также используется в функции CDTDemoView::OnMouseMove. Если курсор попадает в один из кругов, я создаю строку подсказки, в которую заношу координаты центра, радиус и цвет круга. Эта строка копируется в поле szText переданной структуры TOOLTIPTEXT. И, наконец, я устанавливаю цвет текста подсказки с помощью сообщения TTM_SETTIPTEXTCOLOR.[5] Параметр wParam этого сообщения содержит новое значение цвета текста, и устанавливается равным цвету круга (еще одна новая возможность IE 4.0 Common Controls DLL). Если курсор не попадает ни в один круг, поле szText указывает на пустую строку.

Функция CDTDemoView::PreTranslateMessage ретранслирует некоторые сообщения мыши элементу DataTip с помощью функции CToolTipCtrl::RelayEvent. CDTDemoView::PreTranslateMessage вызывается для каждого сообщения, посылаемого окну. Проще всего вызывать CToolTipCtrl::RelayEvent здесь, потому что в этом случае мне не нужно переопределять перехватчики каждого сообщения мыши для передачи этих сообщений элементу DataTip. Подобным же образом работает и поддержка подсказок классом CWnd.

Функция CDTDemoView::OnMouseMove прячет и показывает подсказку в зависимости от принадлежности координат курсора какому-нибудь кругу, что определяется функцией HitTest. Если курсор мыши не находится над кругом либо если он находится не над тем кругом, над которым он находился во время последнего показа подсказки, то CDTDemoView::OnMouseMove прячет подсказку вызовом m_ToolTip.Activate(FALSE). Значение FALSE показывает, что элемент DataTip должен быть спрятан. Далее, если курсор находится над другим кругом, подсказка снова выводится на экран вызовом m_ToolTip.Activate(TRUE), а в переменную CDTDemoView::m_pCircleHit заносится указатель на новый круг. Таким образом, при перемещении курсора с одного круга на другой, я выключаю подсказку и сразу включаю ее. Это делается для того, чтобы элемент DataTip запросил новый текст подсказки через сообщение TTN_NEEDTEXT, что позволяет инициализировать подсказку новой информацией о круге. В IE 4.0 для скрытия подсказки предназначено сообщение TTM_POP, но это сообщение отсутствовало в той версии файла commctrl.h, которая у меня была.

Примечания:

для этой цели можно также использовать CToolTipCtrl::SetMaxTipWidth – прим.пер.

что эквивалентно CToolTipCtrl::SetDelayTime – прим.пер.

справедливости ради нужно сказать, что значение SHRT_MAX дает задержку порядка 30 секунд, а не отключает автоисчезание полностью – прим.пер.

что эквивалентно CToolTipCtrl::SetTipTextColor – прим.пер.

Оглавление