CToolTipCtrl
Klasa
Hermetyzuje funkcjonalność "kontrolki etykietki narzędzia", małe okno podręczne, które wyświetla pojedynczy wiersz tekstu opisujący przeznaczenie narzędzia w aplikacji.
Składnia
class CToolTipCtrl : public CWnd
Elementy członkowskie
Konstruktory publiczne
Nazwa/nazwisko | opis |
---|---|
CToolTipCtrl::CToolTipCtrl |
CToolTipCtrl Tworzy obiekt. |
Metody publiczne
Nazwa/nazwisko | opis |
---|---|
CToolTipCtrl::Activate |
Aktywuje i dezaktywuje kontrolkę etykietki narzędzia. |
CToolTipCtrl::AddTool |
Rejestruje narzędzie za pomocą kontrolki etykietki narzędzia. |
CToolTipCtrl::AdjustRect |
Konwertuje prostokąt wyświetlania tekstu kontrolki etykietki narzędzia i jego prostokąt okna. |
CToolTipCtrl::Create |
Tworzy kontrolkę etykietki narzędzia i dołącza ją do CToolTipCtrl obiektu. |
CToolTipCtrl::CreateEx |
Tworzy kontrolkę etykietki narzędzia z określonymi stylami rozszerzonymi systemu Windows i dołącza ją do CToolTipCtrl obiektu. |
CToolTipCtrl::DelTool |
Usuwa narzędzie z kontrolki etykietki narzędzia. |
CToolTipCtrl::GetBubbleSize |
Pobiera rozmiar etykietki narzędzia. |
CToolTipCtrl::GetCurrentTool |
Pobiera informacje, takie jak rozmiar, położenie i tekst okna etykietki narzędzia wyświetlane przez bieżącą kontrolkę etykietki narzędzia. |
CToolTipCtrl::GetDelayTime |
Pobiera początkowe, wyskakujące okienka i ponownie wyświetla czasy trwania, które są obecnie ustawione dla kontrolki etykietki narzędzia. |
CToolTipCtrl::GetMargin |
Pobiera górne, lewe, dolne i prawe marginesy ustawione dla okna etykietki narzędzia. |
CToolTipCtrl::GetMaxTipWidth |
Pobiera maksymalną szerokość okna etykietki narzędzia. |
CToolTipCtrl::GetText |
Pobiera tekst, który jest utrzymywany przez kontrolkę etykietki narzędzia dla narzędzia. |
CToolTipCtrl::GetTipBkColor |
Pobiera kolor tła w oknie etykietki narzędzia. |
CToolTipCtrl::GetTipTextColor |
Pobiera kolor tekstu w oknie etykietki narzędzia. |
CToolTipCtrl::GetTitle |
Pobiera tytuł bieżącej kontrolki etykietki narzędzia. |
CToolTipCtrl::GetToolCount |
Pobiera liczbę narzędzi obsługiwanych przez kontrolkę etykietki narzędzia. |
CToolTipCtrl::GetToolInfo |
Pobiera informacje, które kontrolka etykietki narzędzia przechowuje na temat narzędzia. |
CToolTipCtrl::HitTest |
Testuje punkt w celu określenia, czy znajduje się on w obrębie prostokąta ograniczenia danego narzędzia. Jeśli tak, pobiera informacje o narzędziu. |
CToolTipCtrl::Pop |
Usuwa wyświetlane okno etykietki narzędzia z widoku. |
CToolTipCtrl::Popup |
Powoduje, że bieżąca kontrolka etykietki narzędzia jest wyświetlana na współrzędnych ostatniego komunikatu myszy. |
CToolTipCtrl::RelayEvent |
Przekazuje komunikat myszy do kontrolki etykietki narzędzia na potrzeby przetwarzania. |
CToolTipCtrl::SetDelayTime |
Ustawia początkowe, wyskakujące okienka i ponownie pokaż czasy trwania kontrolki etykietki narzędzia. |
CToolTipCtrl::SetMargin |
Ustawia górne, lewe, dolne i prawe marginesy okna etykietki narzędzia. |
CToolTipCtrl::SetMaxTipWidth |
Ustawia maksymalną szerokość okna etykietki narzędzia. |
CToolTipCtrl::SetTipBkColor |
Ustawia kolor tła w oknie etykietki narzędzia. |
CToolTipCtrl::SetTipTextColor |
Ustawia kolor tekstu w oknie etykietki narzędzia. |
CToolTipCtrl::SetTitle |
Dodaje standardową ikonę i ciąg tytułu do etykietki narzędzia. |
CToolTipCtrl::SetToolInfo |
Ustawia informacje obsługiwane przez etykietkę narzędzia dla narzędzia. |
CToolTipCtrl::SetToolRect |
Ustawia nowy prostokąt ograniczenia dla narzędzia. |
CToolTipCtrl::SetWindowTheme |
Ustawia styl wizualny okna etykietki narzędzia. |
CToolTipCtrl::Update |
Wymusza ponowne rysowanie bieżącego narzędzia. |
CToolTipCtrl::UpdateTipText |
Ustawia tekst etykietki narzędzia dla narzędzia. |
Uwagi
"narzędzie" to okno, takie jak okno podrzędne lub kontrolka, albo prostokątny obszar zdefiniowany przez aplikację w obszarze klienta okna. Etykietka narzędzia jest ukryta przez większość czasu, pojawiając się tylko wtedy, gdy użytkownik umieszcza kursor na narzędziu i pozostawia go tam przez około połowę sekundy. Etykietka narzędzia jest wyświetlana w pobliżu kursora i znika po kliknięciu przycisku myszy przez użytkownika lub przesunięciu kursora z narzędzia.
CToolTipCtrl
Zapewnia funkcję kontrolowania początkowego czasu i czasu trwania etykietki narzędzia, szerokości marginesu otaczającego tekst etykietki narzędzia, szerokości samego okna etykietki narzędzia oraz koloru tła i tekstu etykietki narzędzia. Pojedyncza kontrolka etykietki narzędzia może dostarczać informacje dla więcej niż jednego narzędzia.
Klasa CToolTipCtrl
udostępnia funkcje typowej kontrolki etykietki narzędzi systemu Windows. Ta kontrolka CToolTipCtrl
(i dlatego klasa) jest dostępna tylko dla programów działających w systemach Windows 95/98 i Windows NT w wersji 3.51 lub nowszej.
Aby uzyskać więcej informacji na temat włączania etykietek narzędzi, zobacz Porady dotyczące narzędzi w systemie Windows, które nie pochodzą z CFrameWnd
systemu .
Aby uzyskać więcej informacji na temat korzystania z programu CToolTipCtrl
, zobacz Controls and Using CToolTipCtrl
.
Hierarchia dziedziczenia
CToolTipCtrl
Wymagania
Nagłówek: afxcmn.h
CToolTipCtrl::Activate
Wywołaj tę funkcję, aby aktywować lub dezaktywować kontrolkę etykietki narzędzia.
void Activate(BOOL bActivate);
Parametry
bActivate
Określa, czy kontrolka etykietki narzędzia ma zostać aktywowana, czy dezaktywowana.
Uwagi
Jeśli bActivate
jest TRUE
to , kontrolka jest aktywowana; jeśli FALSE
, jest dezaktywowana.
Gdy kontrolka etykietki narzędzia jest aktywna, informacje o etykietce narzędzia są wyświetlane, gdy kursor znajduje się na narzędziu zarejestrowanym za pomocą kontrolki; gdy jest nieaktywny, informacje o etykietce narzędzia nie są wyświetlane, nawet gdy kursor znajduje się na narzędziu.
Przykład
Zobacz przykład dla elementu CPropertySheet::GetTabControl
.
CToolTipCtrl::AddTool
Rejestruje narzędzie za pomocą kontrolki etykietki narzędzia.
BOOL AddTool(
CWnd* pWnd,
UINT nIDText,
LPCRECT lpRectTool = NULL,
UINT_PTR nIDTool = 0);
BOOL AddTool(
CWnd* pWnd,
LPCTSTR lpszText = LPSTR_TEXTCALLBACK,
LPCRECT lpRectTool = NULL,
UINT_PTR nIDTool = 0);
Parametry
pWnd
Wskaźnik do okna zawierającego narzędzie.
nIDText
Identyfikator zasobu ciągu zawierającego tekst narzędzia.
lpRectTool
Wskaźnik do RECT
struktury zawierającej współrzędne prostokąta ograniczenia narzędzia. Współrzędne są względne względem lewego górnego rogu obszaru klienta okna zidentyfikowanego przez pWnd
element .
nIDTool
Identyfikator narzędzia.
lpszText
Wskaźnik do tekstu narzędzia. Jeśli ten parametr zawiera wartość LPSTR_TEXTCALLBACK
, TTN_NEEDTEXT
komunikaty powiadomień są przekazywane do elementu nadrzędnego okna wskazującego pWnd
.
Wartość zwracana
Bezzerowe, jeśli się powiedzie; w przeciwnym razie 0.
Uwagi
Parametry lpRectTool
i nIDTool
muszą być prawidłowe lub jeśli lpRectTool
ma NULL
wartość , nIDTool
musi mieć wartość 0.
Kontrolka etykietki narzędzia może być skojarzona z więcej niż jednym narzędziem. Wywołaj tę funkcję, aby zarejestrować narzędzie za pomocą kontrolki etykietki narzędzia, aby informacje przechowywane w etykietce narzędzia są wyświetlane, gdy kursor znajduje się na narzędziu.
Uwaga
Nie można ustawić etykietki narzędzia na kontrolkę statyczną przy użyciu polecenia AddTool
.
Przykład
Zobacz przykład dla elementu CPropertySheet::GetTabControl
.
CToolTipCtrl::AdjustRect
Konwertuje prostokąt wyświetlania tekstu kontrolki etykietki narzędzia i jego prostokąt okna.
BOOL AdjustRect(
LPRECT lprc,
BOOL bLarger = TRUE);
Parametry
lprc
Wskaźnik do RECT
struktury zawierającej prostokąt okna etykietki narzędzia lub prostokąt wyświetlania tekstu.
bLarger
lprc
Jeśli TRUE
parametr służy do określania prostokąta wyświetlania tekstu i otrzymuje odpowiedni prostokąt okna. lprc
Jeśli FALSE
parametr służy do określania prostokąta okna i otrzymuje odpowiedni prostokąt wyświetlania tekstu.
Wartość zwracana
Niezerowe, jeśli prostokąt został pomyślnie skorygowany; w przeciwnym razie 0.
Uwagi
Ta funkcja składowa oblicza prostokąt wyświetlania tekstu kontrolki etykietki narzędzia z prostokąta okna lub prostokąt okna etykietki narzędzia potrzebny do wyświetlenia określonego prostokąta wyświetlania tekstu.
Ta funkcja składowa implementuje zachowanie komunikatu TTM_ADJUSTRECT
Win32 zgodnie z opisem w zestawie WINDOWS SDK.
CToolTipCtrl::Create
Tworzy kontrolkę etykietki narzędzia i dołącza ją do CToolTipCtrl
obiektu.
virtual BOOL Create(CWnd* pParentWnd, DWORD dwStyle = 0);
Parametry
pParentWnd
Określa okno nadrzędne kontrolki etykietki narzędzia, zwykle CDialog
. Nie może to być NULL
.
dwStyle
Określa styl kontrolki etykietki narzędzia. Aby uzyskać więcej informacji, zobacz sekcję Uwagi.
Wartość zwracana
Niezero, jeśli CToolTipCtrl
obiekt został pomyślnie utworzony; w przeciwnym razie 0.
Uwagi
Utworzysz element CToolTipCtrl
w dwóch krokach. Najpierw wywołaj konstruktor, aby skonstruować CToolTipCtrl
obiekt, a następnie wywołaj Create
metodę , aby utworzyć kontrolkę etykietki narzędzia i dołączyć ją do CToolTipCtrl
obiektu.
Parametr dwStyle
może być dowolną kombinacją stylów okna. Ponadto kontrolka etykietki narzędzia ma dwa style specyficzne dla klasy: TTS_ALWAYSTIP
i TTS_NOPREFIX
.
Styl | Znaczenie |
---|---|
TTS_ALWAYSTIP |
Określa, że etykietka narzędzia będzie wyświetlana, gdy kursor znajduje się na narzędziu, niezależnie od tego, czy okno właściciela kontrolki etykietki narzędzia jest aktywne, czy nieaktywne. Bez tego stylu kontrolka etykietki narzędzi jest wyświetlana, gdy okno właściciela narzędzia jest aktywne, ale nie wtedy, gdy jest nieaktywne. |
TTS_NOPREFIX |
Ten styl uniemożliwia systemowi usuwanie znaku ampersand (& ) z ciągu. Jeśli kontrolka etykietki narzędzia nie ma TTS_NOPREFIX stylu, system automatycznie usuwa znaki i ampersand, umożliwiając aplikacji używanie tego samego ciągu co element menu i jako tekst w kontrolce etykietki narzędzia. |
Kontrolka etykietki narzędzia ma WS_POPUP
style okien i WS_EX_TOOLWINDOW
, niezależnie od tego, czy są one określone podczas tworzenia kontrolki.
Aby utworzyć kontrolkę etykietki narzędzi z rozszerzonymi stylami okien, wywołaj metodę CToolTipCtrl::CreateEx
zamiast Create
.
Przykład
Zobacz przykład dla elementu CPropertySheet::GetTabControl
.
CToolTipCtrl::CreateEx
Tworzy kontrolkę (okno podrzędne) i kojarzy ją z obiektem CToolTipCtrl
.
virtual BOOL CreateEx(
CWnd* pParentWnd,
DWORD dwStyle = 0,
DWORD dwStyleEx = 0);
Parametry
pParentWnd
Wskaźnik do okna, który jest elementem nadrzędnym kontrolki.
dwStyle
Określa styl kontrolki etykietki narzędzia. Aby uzyskać więcej informacji, Create
zobacz sekcję Uwagi.
dwStyleEx
Określa rozszerzony styl tworzonej kontrolki. Aby uzyskać listę rozszerzonych stylów systemu Windows, zobacz dwExStyle
parametr dla CreateWindowEx
w zestawie Windows SDK.
Wartość zwracana
Wartość niezerowa, jeśli operacja zakończyła się powodzeniem, w przeciwnym razie 0.
Uwagi
Create
Zamiast CreateEx
stosować rozszerzone style systemu Windows określone w rozszerzonym prefiksie WS_EX_
stylu systemu Windows.
CToolTipCtrl::CToolTipCtrl
CToolTipCtrl
Tworzy obiekt.
CToolTipCtrl();
Uwagi
Należy wywołać metodę Create
po utworzeniu obiektu.
Przykład
// Declare a CToolTipCtrl object.
CToolTipCtrl m_ToolTipCtrl;
CToolTipCtrl::DelTool
Usuwa narzędzie określone przez pWnd
program i nIDTool
z kolekcji narzędzi obsługiwanych przez kontrolkę etykietki narzędzia.
void DelTool(
CWnd* pWnd,
UINT_PTR nIDTool = 0);
Parametry
pWnd
Wskaźnik do okna zawierającego narzędzie.
nIDTool
Identyfikator narzędzia.
CToolTipCtrl::GetBubbleSize
Pobiera rozmiar etykietki narzędzia.
CSize GetBubbleSize(LPTOOLINFO lpToolInfo) const;
Parametry
lpToolInfo
Wskaźnik do struktury etykietki TOOLINFO
narzędzia.
Wartość zwracana
Rozmiar etykietki narzędzia.
Uwagi
Ta funkcja składowa implementuje zachowanie komunikatu TTM_GETBUBBLESIZE
Win32 zgodnie z opisem w zestawie WINDOWS SDK.
CToolTipCtrl::GetCurrentTool
Pobiera informacje, takie jak rozmiar, położenie i tekst okna etykietki narzędzia wyświetlane przez bieżącą kontrolkę etykietki narzędzia.
BOOL GetCurrentTool(LPTOOLINFO lpToolInfo) const;
Parametry
lpToolInfo
[out] Wskaźnik do TOOLINFO
struktury, która odbiera informacje o bieżącym oknie etykietki narzędzia.
Wartość zwracana
TRUE
jeśli informacje zostały pomyślnie pobrane; w przeciwnym razie, FALSE
.
Uwagi
Ta metoda wysyła TTM_GETCURRENTTOOL
komunikat opisany w zestawie SDK systemu Windows.
Przykład
Poniższy przykład kodu pobiera informacje o bieżącym oknie etykietki narzędzia.
{
//Get information about the current tooltip.
TOOLINFO tInfo = {0};
tInfo.cbSize = sizeof(TOOLINFO);
CToolBarCtrl& m_toolBarCtrl = m_wndToolBar.GetToolBarCtrl();
CToolTipCtrl* m_toolTip = m_toolBarCtrl.GetToolTips();
BOOL bRet = m_toolTip->GetCurrentTool( &tInfo );
}
CToolTipCtrl::GetDelayTime
Pobiera początkowe, wyskakujące okienka i ponownie wyświetla czasy trwania aktualnie ustawione dla kontrolki etykietki narzędzia.
int GetDelayTime(DWORD dwDuration) const;
Parametry
dwDuration
Flaga określająca, która wartość czasu trwania zostanie pobrana. Ten parametr może być jedną z następujących wartości:
TTDT_AUTOPOP
Pobieranie czasu, przez jaki okno etykietki narzędzia pozostaje widoczne, jeśli wskaźnik jest nieruchomy w obrębie prostokąta ograniczenia narzędzia.TTDT_INITIAL
Pobieranie czasu, przez jaki wskaźnik musi pozostać nieruchomy w obrębie prostokąta ograniczenia narzędzia przed wyświetleniem okna etykietki narzędzia.TTDT_RESHOW
Pobierz czas potrzebny na wyświetlenie kolejnych okien etykietek narzędzi, gdy wskaźnik przechodzi z jednego narzędzia do drugiego.
Wartość zwracana
Określony czas opóźnienia (w milisekundach)
Uwagi
Ta funkcja składowa implementuje zachowanie komunikatu TTM_GETDELAYTIME
Win32 zgodnie z opisem w zestawie WINDOWS SDK.
CToolTipCtrl::GetMargin
Pobiera górne, lewe, dolne i prawe marginesy ustawione dla okna etykietki narzędzia.
void GetMargin(LPRECT lprc) const;
Parametry
lprc
RECT
Adres struktury, która będzie otrzymywać informacje o marginesie. Elementy członkowskie RECT
struktury nie definiują prostokąta ograniczenia. W celu tego komunikatu elementy członkowskie struktury są interpretowane w następujący sposób:
Element członkowski | Reprezentacja |
---|---|
top |
Odległość między górną krawędzią a górną krawędzią tekstu etykietki narzędzia w pikselach. |
left |
Odległość między lewym obramowaniem a lewym końcem tekstu porad w pikselach. |
bottom |
Odległość między dolną krawędzią a dolną krawędzią tekstu porad w pikselach. |
right |
Odległość między prawym obramowaniem a prawym końcem tekstu porad w pikselach. |
Uwagi
Ta funkcja składowa implementuje zachowanie komunikatu TTM_GETMARGIN
Win32 zgodnie z opisem w zestawie WINDOWS SDK.
CToolTipCtrl::GetMaxTipWidth
Pobiera maksymalną szerokość okna etykietki narzędzia.
int GetMaxTipWidth() const;
Wartość zwracana
Maksymalna szerokość okna etykietki narzędzia.
Uwagi
Ta funkcja składowa implementuje zachowanie komunikatu TTM_GETMAXTIPWIDTH
Win32 zgodnie z opisem w zestawie WINDOWS SDK.
CToolTipCtrl::GetText
Pobiera tekst, który jest utrzymywany przez kontrolkę etykietki narzędzia dla narzędzia.
void GetText(
CString& str,
CWnd* pWnd,
UINT_PTR nIDTool = 0) const;
Parametry
str
Odwołanie do CString
obiektu, który odbiera tekst narzędzia.
pWnd
Wskaźnik do okna zawierającego narzędzie.
nIDTool
Identyfikator narzędzia.
Uwagi
Parametry pWnd
i nIDTool
identyfikują narzędzie. Jeśli to narzędzie zostało wcześniej zarejestrowane w kontrolce etykietki narzędzia za pomocą poprzedniego wywołania metody CToolTipCtrl::AddTool
, obiekt, str
do którego odwołuje się parametr, zostanie przypisany tekst narzędzia.
CToolTipCtrl::GetTipBkColor
Pobiera kolor tła w oknie etykietki narzędzia.
COLORREF GetTipBkColor() const;
Wartość zwracana
COLORREF
Wartość reprezentująca kolor tła.
Uwagi
Ta funkcja składowa implementuje zachowanie komunikatu TTM_GETTIPBKCOLOR
Win32 zgodnie z opisem w zestawie WINDOWS SDK.
CToolTipCtrl::GetTipTextColor
Pobiera kolor tekstu w oknie etykietki narzędzia.
COLORREF GetTipTextColor() const;
Wartość zwracana
COLORREF
Wartość reprezentująca kolor tekstu.
Uwagi
Ta funkcja składowa implementuje zachowanie komunikatu TTM_GETTIPTEXTCOLOR
Win32 zgodnie z opisem w zestawie WINDOWS SDK.
CToolTipCtrl::GetTitle
Pobiera tytuł bieżącej kontrolki etykietki narzędzia.
void GetTitle(PTTGETTITLE pttgt) const;
Parametry
pttgt
[out] Wskaźnik do struktury zawierającej TTGETTITLE
informacje o kontrolce etykietki narzędzia. Gdy ta metoda zwróci, pszTitle
element członkowski TTGETTITLE
struktury wskazuje tekst tytułu.
Uwagi
Ta metoda wysyła TTM_GETTITLE
komunikat opisany w zestawie SDK systemu Windows.
CToolTipCtrl::GetToolCount
Pobiera liczbę narzędzi zarejestrowanych za pomocą kontrolki etykietki narzędzia.
int GetToolCount() const;
Wartość zwracana
Liczba narzędzi zarejestrowanych w kontrolce etykietki narzędzi.
CToolTipCtrl::GetToolInfo
Pobiera informacje, które kontrolka etykietki narzędzia przechowuje na temat narzędzia.
BOOL GetToolInfo(
CToolInfo& ToolInfo,
CWnd* pWnd,
UINT_PTR nIDTool = 0) const;
Parametry
ToolInfo
Odwołanie do TOOLINFO
obiektu, który odbiera tekst narzędzia.
pWnd
Wskaźnik do okna zawierającego narzędzie.
nIDTool
Identyfikator narzędzia.
Wartość zwracana
Bezzerowe, jeśli się powiedzie; w przeciwnym razie 0.
Uwagi
Elementy hwnd
i uId
struktury TOOLINFO
, do których odwołuje się CToolInfo
narzędzie. Jeśli to narzędzie zostało zarejestrowane w kontrolce etykietki narzędzia za pomocą poprzedniego wywołania metody AddTool
, TOOLINFO
struktura zostanie wypełniona informacjami o narzędziu.
CToolTipCtrl::HitTest
Testuje punkt w celu określenia, czy znajduje się on w prostokątze ograniczenia danego narzędzia, a jeśli tak, pobierz informacje o narzędziu.
BOOL HitTest(
CWnd* pWnd,
CPoint pt,
LPTOOLINFO lpToolInfo) const;
Parametry
pWnd
Wskaźnik do okna zawierającego narzędzie.
pt
Wskaźnik do CPoint
obiektu zawierającego współrzędne punktu do przetestowania.
lpToolInfo
Wskaźnik do TOOLINFO
struktury zawierającej informacje o narzędziu.
Wartość zwracana
Niezerowe, jeśli punkt określony przez informacje o teście trafienia znajduje się w prostokątie ograniczenia narzędzia; w przeciwnym razie 0.
Uwagi
Jeśli ta funkcja zwraca wartość niezerową, struktura wskazywana przez lpToolInfo
element jest wypełniona informacjami o narzędziu w obrębie którego prostokąt leży.
Struktura jest definiowana TTHITTESTINFO
w następujący sposób:
typedef struct _TT_HITTESTINFO { // tthti
HWND hwnd; // handle of tool or window with tool
POINT pt; // client coordinates of point to test
TOOLINFO ti; // receives information about the tool
} TTHITTESTINFO, FAR * LPHITTESTINFO;
hwnd
Określa uchwyt narzędzia.
pt
Określa współrzędne punktu, jeśli punkt znajduje się w prostokątie ograniczenia narzędzia.
ti
Informacje o narzędziu. Aby uzyskać więcej informacji na temat
TOOLINFO
struktury, zobaczCToolTipCtrl::GetToolInfo
.
CToolTipCtrl::Pop
Usuwa wyświetlane okno etykietki narzędzia z widoku.
void Pop();
Uwagi
Ta funkcja składowa implementuje zachowanie komunikatu TTM_POP
Win32 zgodnie z opisem w zestawie WINDOWS SDK.
CToolTipCtrl::Popup
Powoduje, że bieżąca kontrolka etykietki narzędzia jest wyświetlana na współrzędnych ostatniego komunikatu myszy.
void Popup();
Uwagi
Ta metoda wysyła TTM_POPUP
komunikat opisany w zestawie SDK systemu Windows.
Przykład
W poniższym przykładzie kodu zostanie wyświetlone okno etykietki narzędzia.
{
// Display the most recent tooltip.
CToolBarCtrl &m_toolBarCtrl = m_wndToolBar.GetToolBarCtrl();
CToolTipCtrl *m_toolTip = m_toolBarCtrl.GetToolTips();
m_toolTip->Popup();
}
CToolTipCtrl::RelayEvent
Przekazuje komunikat myszy do kontrolki etykietki narzędzia na potrzeby przetwarzania.
void RelayEvent(LPMSG lpMsg);
Parametry
lpMsg
Wskaźnik do struktury zawierającej MSG
komunikat do przekazywania.
Uwagi
Kontrolka etykietki narzędzia przetwarza tylko następujące komunikaty, które są do niego wysyłane przez program RelayEvent
:
WM_LBUTTONDOWN |
WM_MOUSEMOVE |
---|---|
WM_LBUTTONUP |
WM_RBUTTONDOWN |
WM_MBUTTONDOWN |
WM_RBUTTONUP |
WM_MBUTTONUP |
Przykład
Zobacz przykład dla elementu CPropertySheet::GetTabControl
.
CToolTipCtrl::SetDelayTime
Ustawia czas opóźnienia kontrolki etykietki narzędzia.
void SetDelayTime(UINT nDelay);
void SetDelayTime(
DWORD dwDuration,
int iTime);
Parametry
nDelay
Określa nowy czas opóźnienia (w milisekundach).
dwDuration
Flaga określająca, która wartość czasu trwania zostanie pobrana. Zobacz CToolTipCtrl::GetDelayTime
opis prawidłowych wartości.
iTime
Określony czas opóźnienia (w milisekundach).
Uwagi
Czas opóźnienia to czas, przez jaki kursor musi pozostać na narzędziu, zanim pojawi się okno etykietki narzędzia. Domyślny czas opóźnienia to 500 milisekund.
CToolTipCtrl::SetMargin
Ustawia górne, lewe, dolne i prawe marginesy okna etykietki narzędzia.
void SetMargin(LPRECT lprc);
Parametry
lprc
RECT
Adres struktury zawierającej informacje o marginesie do ustawienia. Elementy członkowskie RECT
struktury nie definiują prostokąta ograniczenia. Zobacz CToolTipCtrl::GetMargin
opis informacji o marginesie.
Uwagi
Ta funkcja składowa implementuje zachowanie komunikatu TTM_SETMARGIN
Win32 zgodnie z opisem w zestawie WINDOWS SDK.
CToolTipCtrl::SetMaxTipWidth
Ustawia maksymalną szerokość okna etykietki narzędzia.
int SetMaxTipWidth(int iWidth);
Parametry
iWidth
Maksymalna szerokość okna etykietki narzędzia do ustawienia.
Wartość zwracana
Poprzednia maksymalna szerokość końcówki.
Uwagi
Ta funkcja składowa implementuje zachowanie komunikatu TTM_SETMAXTIPWIDTH
Win32 zgodnie z opisem w zestawie WINDOWS SDK.
CToolTipCtrl::SetTipBkColor
Ustawia kolor tła w oknie etykietki narzędzia.
void SetTipBkColor(COLORREF clr);
Parametry
clr
Nowy kolor tła.
Uwagi
Ta funkcja składowa implementuje zachowanie komunikatu TTM_SETTIPBKCOLOR
Win32 zgodnie z opisem w zestawie WINDOWS SDK.
CToolTipCtrl::SetTipTextColor
Ustawia kolor tekstu w oknie etykietki narzędzia.
void SetTipTextColor(COLORREF clr);
Parametry
clr
Nowy kolor tekstu.
Uwagi
Ta funkcja składowa implementuje zachowanie komunikatu TTM_SETTIPTEXTCOLOR
Win32 zgodnie z opisem w zestawie WINDOWS SDK.
CToolTipCtrl::SetTitle
Dodaje standardową ikonę i ciąg tytułu do etykietki narzędzia.
BOOL SetTitle(
UINT uIcon,
LPCTSTR lpstrTitle);
Parametry
uIcon
Zobacz icon
w TTM_SETTITLE
zestawie Windows SDK.
lpstrTitle
Wskaźnik do ciągu tytułu.
Wartość zwracana
Bezzerowe, jeśli się powiedzie; w przeciwnym razie 0.
Uwagi
Ta funkcja składowa implementuje zachowanie komunikatu TTM_SETTITLE
Win32 zgodnie z opisem w zestawie WINDOWS SDK.
CToolTipCtrl::SetToolInfo
Ustawia informacje obsługiwane przez etykietkę narzędzia dla narzędzia.
void SetToolInfo(LPTOOLINFO lpToolInfo);
Parametry
lpToolInfo
Wskaźnik do TOOLINFO
struktury, która określa informacje do ustawienia.
CToolTipCtrl::SetToolRect
Ustawia nowy prostokąt ograniczenia dla narzędzia.
void SetToolRect(
CWnd* pWnd,
UINT_PTR nIDTool,
LPCRECT lpRect);
Parametry
pWnd
Wskaźnik do okna zawierającego narzędzie.
nIDTool
Identyfikator narzędzia.
lpRect
Wskaźnik do RECT
struktury określającej nowy prostokąt ograniczenia.
CToolTipCtrl::SetWindowTheme
Ustawia styl wizualny okna etykietki narzędzia.
HRESULT SetWindowTheme(LPCWSTR pszSubAppName);
Parametry
pszSubAppName
Wskaźnik do ciągu Unicode, który zawiera styl wizualizacji do ustawienia.
Wartość zwracana
Wartość zwracana nie jest używana.
Uwagi
Ta funkcja składowa emuluje funkcjonalność komunikatu TTM_SETWINDOWTHEME
zgodnie z opisem w zestawie WINDOWS SDK.
CToolTipCtrl::Update
Wymusza ponowne rysowanie bieżącego narzędzia.
void Update();
CToolTipCtrl::UpdateTipText
Aktualizuje tekst etykietki narzędzia dla narzędzi tego formantu.
void UpdateTipText(
LPCTSTR lpszText,
CWnd* pWnd,
UINT_PTR nIDTool = 0);
void UpdateTipText(
UINT nIDText,
CWnd* pWnd,
UINT_PTR nIDTool = 0);
Parametry
lpszText
Wskaźnik do tekstu narzędzia.
pWnd
Wskaźnik do okna zawierającego narzędzie.
nIDTool
Identyfikator narzędzia.
nIDText
Identyfikator zasobu ciągu zawierającego tekst narzędzia.