API и FreeBasic. (Тултип-контрол)

Тултип - это маленькая прямоугольное окно, которое отображается, когда курсор мыши находится над какой-то определенной областью. Окно тултипа содержит текст, заданный программистом. В этом отношении тултип играет ту же роль, что и окно статуса, но оно исчезает, когда пользователь кликает или убирает курсор мыши из заданной области. Вы, вероятно, знакомы с тултипами, ассоциированные с кнопками тулбара. Эти "тултипы" - одно из удобств, предоставляемых тулбаром. Если вам нужны тултипы для других окон/контролов, вам необходимо создать собственный тултип контрол.

Теперь, когда вы знаете, что такое тултип, давайте перейдем к тому, как мы можем создать и использовать его. Ниже pасписаны шаги:

Создать тултип-контрол функцией CreateWindowEx.
Определить регион, в котором он будет отслеживать передвижения мыши.
Передать регион тултип-контролу.
Передавать сообщения от мыши в указанном регионе тултип-контролу (этот шаг зависит от заданных флагов).

Ниже мы детально проанализируем каждый шаг.

Создание тултипа

Тултип - это common control. Поэтому вам необходимо где-нибудь в программе вызвать функцию InitCommonControls. Вы создаете тултип с помощью CreateWindowEx. Это будет выглядеть примерно так:

ToolTipsClassName = "Tooltips_Class32"
...
InitCommonControls()
hwndTool = CreateWindowEx(NULL,ToolTipsClassName,NULL, _
TTS_ALWAYSTIP,CW_USEDEFAULT, _
CW_USEDEFAULT,CW_USEDEFAULT,CW_USEDEFAULT,NULL,NULL, _
hInstance,NULL)

Обратите внимание на стиль окна: TIS_ALWAYSTIР. Этот стиль указывает, что тултип будет показываться, когда курсор мыши будет находиться над заданной областью вне зависимости от статуса окна. То есть, если вы будете использовать этот флага, тултип будет появляться (когда курсор мыши будет находиться над определенной областью), даже если окно, с которым ассоциирован тултип, неактивно.

Вам не нужно задавать слили WS_POPUP и WS_EX_TOOLWINDOW, потому что тултип определяет их автоматически. Вам также не нужно указывать координаты, ширину и высоту тултипа: он сам рассчитывает свои характеристики, поэтому в качестве всех четырех параметров мы указывает CW_USEDEFAULT. Оставшиеся параметры не играют роли.

Определение tool'ов

Тултип создается, но не отображается сразу. Нам нужно, чтобы он отображался только над определенной областью. Теперь пришло время задать ее. Мы называем такую область 'tool'. Tool - это прямоугольная область клиентской части окна, в пределах которой тултип будет отслеживать передвижение мыши. Прямоугольная область может покрывать всю клиентскую часть окна или только некоторую долю от нее. Поэтому мы можем поделить 'tool' на два типа: один - это, когда в качестве tool'а выступает целая клиентская область окна, а другой - прямоугольная часть клиентской области окна. Оба типа находят свое применение. Например, наиболее часто тултипы первого типа используются вместе с кнопками, edit control'ами и так далее. Вам не нужно указывать координаты и размерность tool'а: предполагается, что будет задействована вся клиентская область. Tool'ы второго типа полезны, когда вы хотите поделить клиентскую часть окна на несколько регионов без использования дочерних окон. В этом случае вам будет необходимо задать координату верхнего левого угла, ширину и высоту tool'а.

Вы определяете характеристики tool'а в структуре TOOLINFO, которая имеет следующее определение:

Type TOOLINFO
    As UINT         cbSize
    As UINT         uFlags
    As HWND         hwnd
    As UINT         uId
    As RECT         rect
    As HINSTANCE    hinst
    As LPTSTR       lpszText
End Type

cbSize - размер структуры TOOLINFO. Вы должны заполнить этот параметр. Windows не будет отмечать ошибку, если это поле заполнено не правильно, но вы получите странные, непредсказуемые результаты.
uFlags - битовые флаги определяют характеристики tool'а.
- TTF_IDISHWND - "ID - это hWnd". Если вы укажете этот флаг, вы должны заполнить параметр uId хэндлом окна, который вы хотите использовать. Если вы не укажете этот флаг, это будет означать, что вы хотите использовать второй тип tool'а. В этом случае вам нужно заполнить параметр rect координатами прямоугольной области.
- TTF_CENTERTIр - обычно окно тултипа появляется справа и ниже курсора мыши. Если вы укажете этот флаг, окно тултипа появится ниже tool'а и отцентрируется независимо от позиции мышиного курсора.
- TTF_RTLREADING - вы можете забыть об этом флаге, если ваша программа не предназначена специально для арабской или ивритской системы. Этот флаг отображает текст тултипа справла налево. Не работает под другими системами.
- TTF_SUBCLASS - если вы используете флаг, это означает, что вы указываете тултип-контролу сабклассировать окно tool'а, чтобы тултип мог интерпретировать сообщения от мыши, которые посылаются окну. Этот флаг очень удобен. Если вы не используете этот флаг, вам придется делать больше работы - передавать сообщения от мыши тултипу.
hWnd - Хэндл окна, который содержит tool. Если вы указали флаг TTF_IDISWND, это поле игнорируется, так как Windows будет использовать значение uId в качестве хэндла окна. Вам нужно заполнить это поле, если:
- Вы не устанавливали флаг TTF_IDISHWND
- Вы указываете значение LрSTR_TEXTCALLBACK в параметре lpszText. Это значение указывает тултипу, что когда ему необходимо отобразить свое окно, он должен уведомить об этом окно, которое содержит tool. Это вид динамического обновления текста тултипа. Если вы хотите изменять динамически текст тултипа, вам следует LpSTR_TEXTCALLBACK в качестве значения LpSTR_TEXTCALLBACK. Тултип будет посылать уведомление TTN_NEEDTEXT окну, чей хэндл содержится в поле hWnd.
uId - это поле может иметь одно из двух значений, в зависимости от того, содержит ли uFlags флаг IIF_IDISHWND.
- Определяемое приложением ID tool'а, если флаг TTF_IDISHWND. Так как это означает, что вы используете tool, покрывающее только часть клиентской области, то логично, что вы можете иметь несколько tool'ов на одной клиентской области (без пересечений). Тултип-контрол должен иметь какой-то путь отличать их друг от друга. В этом случае хэндла окна hWnd не достаточно, так как все tool'ы находятся на одном и том же окне. Определяемые приложением ID служат именно для этой цели. ID может быть любым значением, главное, чтобы оно было уникально по отношению к другим ID.
- Хэндл окна, чья клиентская область полностью используется в качестве tool'а, если указан флаг TTF_IDISHWND. Вы можете удивиться. почем это поле используется для хранения хэндла окна, если есть hWnd? Ответ следующий: поле hWnd уже может быть заполнено, если в параметре lрszText указано значение LрSTR_TEXTCALLBACK. Окно, которое ответственно за предоставление текста тултипа, и окно, которое содержит tool, могут быть не одним и тем же.
rect - структура RECT, которая указывает размерность tool'а. Эта структура определяет прямоугольник относительного верхнего левого угла клиентской области окна, указанного в параметре hWnd. То есть, вы должны заполнить эту структуру, если вы хотите указать tool, который покрывает только часть клиентской области. Тултип-контрол проигнорирует это поле, если вы укажете флаг TTF_IDISHWND (вы хотите использовать в качестве tool'а целое окно).
hInst - это хэндл процесса, содержащий ресурс строки, которая будет использована в качестве текста, если значение lpszText pавно ID строкового ресурса. Это может вас несколько смутить. Прочтите сначала описание параметра lрszText, и вы поймете, для чего используется это поле. Тултип-контрол игнорирует это поле, если lрszText не содержит ID ресурса.
lpszText - это поле имеет несколько значений:
- Если вы укажете в этом поле значение LpSTR_TEXTCALLBACK, тултип будет посылать уведомительное сообщение TTN_NEEDTEXT окну, которое идентифицируется хэндлом поля hWnd, чтобы то предоставило тултипу текстовую строку. Это наиболее динамичный метод обновления текста тултипа: вы можете менять его каждый раз, когда отображается окно тултипа.
- Если вы укажете в этом поле ID строкового ресурса, тултип, когда ему потребуется отобразить текст в своем окне, будет искать строку в таблице строк процесса, заданного параметром hInst. Тултип-контрол идентифицирует ID ресурса следующим образом: так как ID ресурса - это 16-битное значение, верхнее слово этого поля всегда будет pавно нулю. Этот метод полезен, если вы хотите портировать вашу программу на другие языки. Так как строковый ресурс определен в файле определения ресурсов, вам не нужно модифицировать исходный код. Вам только нужно изменить таблицу строк и текст тултипа изменится без риска внесения ошибок в программу.
- Если значение в этом поле не pавно LрSTR_TEXTCALLBACK и верхнее слово не равно нулю, тултип-контрол интерпретирует значение как указатель на текстовую строку, которая будет использована в качестве текста тултипа. Этот метод самый простой, но наименее гибкий.

резюме: вы должны заполнить структуру TOOLINFO и передать ее тултипу. Эта структура задаст характеристики tool'а.

регистрация tool'а

После того, как вы заполнили структуру TOOLINFO, вы должны передать ее тултипу. Тултип может обслуживать много tool'ов, поэтому обычно одно тултипа хватает на все окно. Чтобы зарегистрировать tool, вы посылаете тултипу сообщение TTM_ADDTOOL. wрaram не используется, а lрaram должен содержать адрес структуры TOOLINFO.

Dim ti As TOOLINFO
....
SendMessage(hwndTool,TTM_ADDTOOL,NULL,Cast(LPARAM,TI))

SendMessage возвратит TRUE, если tool был успешно зарегистрирован тултипом или FALSE в обратном случае. Вы можете удалить tool сообщением TTM_DELTOOL.

Передача сообщений от мыши тултипу

Когда вышеописанные шаги выполнены, тултип имеет всю необходимую информацию о том, в какой области он должен отслеживать сообщения мыши и какой текст он должен отображать. Единственное, что отстутсвует - это триггер. Подумайте: область, указанная в качестве tool'а находится на клиенсткой части другого окна. Как может тултип перехватить сообщения от мыши для этого окна? Необходимо, чтобы он мог измерить количество времени, которое курсор мыши находится над tool'ом, чтобы вовремя отобразить окно тултипа. Есть два метода, чтобы достичь этой цели, один требует помощи со стороны окна, которое tool, а другой этого не требует.

Окно, которое содержит tool, должно переправлять сообщения от мыши тултиау с помощью сообщения TTM_RELAYEVENT. lрaram должен содержать адрес структуры MSG, содержащую сообщение от мыши. Тултип обрабатывает только следующие сообщения от мыши:

WM_LBUTTONDOWN
WM_MOUSEMOVE
WM_LBUTTONUp
WM_RBUTTONDOWN
WM_MBUTTONDOWN
WM_RBUTTONUp
WM_MBUTTONUp

Все другие сообщения игнорируются. Таким образом, в процедуре окна, содержащего tool, должен быть обработчик вроде следующего:

Function Wndproc( hWnd As HWND, uMsg As UINT, wparam As WPARAM, lparam As LPARAM) As Integer

   .......

      If uMsg=WM_CREATE Then

           .............

       Elseif uMsg=WM_LBUTTONDOWN Or uMsg=WM_MOUSEMOVE Or _

              uMsg=WM_LBUTTONUp Or uMsg=WM_RBUTTONDOWN Or _

              uMsg=WM_MBUTTONDOWN Or uMsg=WM_RBUTTONUP Or _

              uMsg=WM_MBUTTONUP

           SendMessage(hwndTooltip, TTM_RELAYEVENT, NULL, @msg)

           ..........

Вы можете указать флаг TTF_SUBCLASS в параметре uFlags структуры TOOLINFO. Этот флаг указывает тултипу сабклассировать окно, которое содержит tool, чтобы перехватывать сообщения от мыши без участия сабклассированного окна. Этот метод проще использовать и он требует меньше усилий, так как тултип берет всю обработку сообщений на себя.

Вот и все. Теперь ваш тултип полностью функционален. Есть несколько полезных тултиповых сообщений, о которых вас следует знать.

TTM_ACTIVATE - если вы хотите включать/выключать контрол динамически, это сообщение для вас. Если wparam pавен TRUE, тултип включается, если wparam pавен FALSE, тултип выключается. Тултип включается автоматически, как только он был создан, поэтому вам не надо посылать сообщение, чтобы активировать его.
TTM_GETTOOLINFO и TTM_SETTOOLINFO. Если вы хотите получить/изменить значения в структуре TOOLINFO после того, как она была отправлена тултипу, используйте данное сообщение. Вам потребуется указать tool, чьи характеристики вы хотите изменить, с помощью верных uId и hWnd. Если вы хотите изменить только параметр rect, используйте сообщение TTM_NEWTOOLRECT. Если вам нужно только изменить текст тултипа, используйте TTM_UpDATATIpTEXT.
TTM_SETDELAYTIME. С помощью этого сообщения вы можете задать временную задержку, которую будет использовать тултип.

Пpимеp:

Следующий пример - это простое диалоговое окно с двумя кнопками. Клиентская область диалогового окна поделена на 4 области: верхняя левая, верхняя правая, нижняя левая и нижняя правая. Каждая область указана как tool с собственным текстом. Две кнопки также имеют свои собственные тексты подсказок.

#INCLUDE "windows.bi"
#INCLUDE "win/commctrl.bi"
Declare Function DlgProc(hDlg As HWND,uMsg As Uinteger,wParam As WPARAM,lParam As LPARAM) As Integer
Declare Sub EnumChild(hwndChild As HWND,lParam As LPARAM)
Declare Sub SetDlgToolArea(hDlg As HWND,lpti As TOOLINFO Ptr,lpText As String,id As DWORD,lprect As RECT Ptr)


#DEFINE IDD_MAINDIALOG 101
Dim Shared As String ToolTipsClassName , MainDialogText1, _
MainDialogText2 , MainDialogText3,MainDialogText4

ToolTipsClassName = "Tooltips_Class32"
MainDialogText1 = "This is the upper left area of the dialog"
MainDialogText2 = "This is the upper right area of the dialog"
MainDialogText3 = "This is the lower left area of the dialog"
MainDialogText4 = "This is the lower right area of the dialog"

Dim Shared As HWND hwndTool
Dim Shared As HINSTANCE hInstance

hInstance = GetModuleHandle(NULL)
ExitProcess(DialogBoxParam(hInstance,Cast(LPSTR,IDD_MAINDIALOG),NULL,@DlgProc,NULL))

Function DlgProc(hDlg As HWND,uMsg As Uinteger,wParam As WPARAM,lParam As LPARAM) As Integer
    Dim ti As TOOLINFO
    Dim id As DWORD
    Dim rect As RECT
    If uMsg=WM_INITDIALOG Then
        InitCommonControls()
        hwndTool = CreateWindowEx(NULL,ToolTipsClassName,NULL, _
        TTS_ALWAYSTIP,CW_USEDEFAULT, _
        CW_USEDEFAULT,CW_USEDEFAULT,CW_USEDEFAULT,NULL,NULL, _
        hInstance,NULL)
        ti.cbSize = Sizeof(TOOLINFO)
        ti.uFlags = TTF_SUBCLASS
        ti.hWnd = hDlg
        GetWindowRect(hDlg,@rect)
        SetDlgToolArea(hDlg,@ti,MainDialogText1,id,@rect)
        id+=1
        SetDlgToolArea(hDlg,@ti,MainDialogText2,id,@rect)
        id+=1
        SetDlgToolArea(hDlg,@ti,MainDialogText3,id,@rect)
        id+=1
        SetDlgToolArea(hDlg,@ti,MainDialogText4,id,@rect)
        EnumChildWindows(hDlg, Cast(ENUMWINDOWSPROC, @EnumChild),Cast(LPARAM,@ti))
    Elseif uMsg=WM_CLOSE Then
        EndDialog(hDlg,NULL)
    Else
        Return FALSE
    Endif
    Return TRUE
End Function

Sub EnumChild (hwndChild As HWND,lParam As LPARAM)
    Dim buffer As ZString*256
    Dim TI As TOOLINFO Ptr = Cast(TOOLINFO Ptr,lparam)
    TI->uId = Cast(UINT,hwndChild)
    TI->uFlags Or = TTF_IDISHWND
    GetWindowText(hwndChild,@buffer,255)
    TI->lpszText = @buffer
    SendMessage(hwndTool,TTM_ADDTOOL,NULL,Cast(LPARAM,TI))
End Sub

Sub SetDlgToolArea(hDlg As HWND,lpti_ As TOOLINFO Ptr,lpText As String,id As DWORD,lprect_ As RECT Ptr)
    Dim As TOOLINFO Ptr LPTI = Cast(TOOLINFO Ptr,lpti_)
    Dim As RECT Ptr LPRECT = lprect_
    If id=0 Then
        LPTI->rect.left = 0
        LPTI->rect.top = 0
        LPTI->rect.right = LPRECT->Right/2
        LPTI->rect.bottom =LPRECT->bottom/2
    Elseif id=1 Then
        LPTI->rect.left = (LPRECT->Right - LPRECT->Left)/2 +1
        LPTI->rect.top = 0
        LPTI->rect.right = LPRECT->Right - LPRECT->Left
        LPTI->rect.bottom = LPRECT->bottom - LPRECT->top
    Elseif id=2 Then
        LPTI->rect.left = 0
        LPTI->rect.top = (LPRECT->bottom - LPRECT->top)/2 + 1
        LPTI->rect.right = LPRECT->Right - LPRECT->Left /2
        LPTI->rect.bottom = LPRECT->bottom - LPRECT->top
    Else
        LPTI->rect.left = (LPRECT->Right - LPRECT->Left)/2 +1
        LPTI->rect.top = (LPRECT->bottom - LPRECT->top)/2 +1
        LPTI->rect.right = LPRECT->Right - LPRECT->Left
        LPTI->rect.bottom = LPRECT->bottom - LPRECT->top
    Endif
    LPTI->lpszText = Strptr(lpText)
    SendMessage(hwndTool,TTM_ADDTOOL,NULL,Cast(LPARAM,lpti))
End Sub

Файл ресурсов:

#DEFINE IDD_MAINDIALOG                  101
#DEFINE IDC_OK                          1000
#DEFINE IDC_EXIT                        1001
IDD_MAINDIALOG DIALOG DISCARDABLE  0, 0, 229, 96
STYLE DS_MODALFRAME | DS_3DLOOK | WS_POPUP | WS_VISIBLE | WS_CAPTION | 
    WS_SYSMENU | DS_CENTER
CAPTION "Tooltip Example"
FONT 8, "MS Sans Serif"
BEGIN
    PUSHBUTTON      "OK",IDC_OK,55,68,50,14
    PUSHBUTTON      "E&xit",IDC_EXIT,123,68,50,14
End

Анализ:

После того, как создано основное диалоговое окно, мы создает тултип-контрол функцией CreateWindowsEx.

InitCommonControls()
hwndTool = CreateWindowEx(NULL,ToolTipsClassName,NULL, _
TTS_ALWAYSTIP,CW_USEDEFAULT, _
CW_USEDEFAULT,CW_USEDEFAULT,CW_USEDEFAULT,NULL,NULL, _
hInstance,NULL)

После этого мы переходим к определению четырех tool'ов для каждого угла диалогового окна.

ti.cbSize = Sizeof(TOOLINFO)
ti.uFlags = TTF_SUBCLASS
ti.hWnd = hDlg
GetWindowRect(hDlg,@rect)
SetDlgToolArea(hDlg,@ti,MainDialogText1,id,@rect)

Мы инициализируем члены структуры TOOLINFO. Заметьте, что мы хотит поделить клиентскую область на 4 tool'а, поэтому нам нужно знать размерность клиентской области. Это то, для чего мы вызываем GetWindowsRect. Мы не хотим передавать сообщения мыши тултипу, поэтому мы указываем флага TIF_SUBCLASS.

SetDlgToolArea - это функция, которая высчитывает координаты прямоугольной области каждого tool'а и регистрирует tool в тултипе. Я не хочу вдаваться в подробности относительно этого, достаточно сказать, что она делит клиентскую область на 4 области с одними и теми же размерами. Затем она посылает сообщение TTN_ADDTOOL тултипу, передавая адрес структуры TOOLINFO в lparam.

SendMessage(hwndTool,TTM_ADDTOOL,NULL,Cast(LPARAM,lpti))

После того, как все 4 tool'а зарегистрированы, мы можем перейти к кнопкам на диалоговом окне. Мы можем обрабатывать каждую кнопку с помошью ее ID, но это утомительно. Вместо этого мы используем EnumChildWindows ApI, чтобы перечислить все контролы на диалоговом окне и затем зарегистрировать для каждого из них подсказку. EnumChildWindows имеет следующий синтаксис:

EnumChildWindows(hDlg As HWND, lpEnumFunc As ENUMWINDOWSPROC,lparam As LPARAM) As BOOL

hWnd - хэндл родительского окна. lрEnumFunc - адрес функции EnumChildproc, которая будет вызываться для каждого перечисленного контрола. lparam - заданное приложением значение, которое будет передано EnumChildproc. У этой функции следующее определение:

EnumChildProc(hwnd As HWND ,lParam As LPARAM ) As Bool

hwndChild - хэндл контрола, найденного EnumChildWindows. lparam - это тоже значение, что вы передали EnumChildWindow. В нашем примере мы вызываем EnumChildWindows следующим образом:

EnumChildWindows(hDlg, Cast(ENUMWINDOWSPROC, @EnumChild),Cast(LPARAM,@ti))

Мы передаем адрес структуры TOOLINFO в параметре lparam, потому что мы будем регистрировать подсказки для каждого дочерний контрол в функции EnumChild. Если мы не будем использовать данный метода, нам придется объявить глобальную переменную, чтобы предотвратить баги.

Когда мы вызываем EnumchildWindows, Windows перечислит дочерние конролы нашего диалогового окна и вызовет для каждого из ни функцию Enumchild. То есть, если наше диалоговое окно имеет два контрола, EnumChild будет вызван дважды.

Функция EnumChild заполнит соответствующие поля структуры TOOLINFO и зарегистрирует tool.

Sub EnumChild (hwndChild As HWND,lParam As LPARAM)
    Dim buffer As ZString*256
    Dim TI As TOOLINFO Ptr = Cast(TOOLINFO Ptr,lparam)
    TI->uId = Cast(UINT,hwndChild)
    TI->uFlags Or = TTF_IDISHWND
    GetWindowText(hwndChild,@buffer,255)
    TI->lpszText = @buffer
    SendMessage(hwndTool,TTM_ADDTOOL,NULL,Cast(LPARAM,TI))
End Sub

Заметьте, что в этом случае мы используем другой тип tool'ов, покрывающий всю клиентскую область окна. Поэтому нам нужно заполнить поле uID хэндлом окна, которое содержит tool. Также мы указываем флаг TTF_IDISHWND в параметре uFlags.

Перевод на русский с оригинала: Aquila, адаптация материалов под FreeBasic: Станислав Будинов

содержание | назад | вперед