CTooltip Class ReferenceProvides a wrapper for windows tooltips.
More...
#include <Tooltip.h>
List of all members.
|
Public Member Functions |
| BOOL | UpdateText (UINT uId, LPCTSTR pText) |
| | Call to update the tooltip text for an item.
|
| BOOL | RelayEvent (HWND hWnd, UINT uMsg, WPARAM wParam, LPARAM lParam, DWORD dwTime, POINT pt) |
| | Called to relay tooltip event.
|
| BOOL | RelayEvent (LPMSG pMsg) |
| | Called to relay tooltip event.
|
| BOOL | Track (long x, long y) |
| | Call to move tracking tooltip.
|
| BOOL | TrackActivate (UINT uId, BOOL bActivate) |
| | Call to activate a tracking tooltip.
|
| BOOL | Add (UINT uId, LPCTSTR pText, DWORD dwFlags=TTF_SUBCLASS) |
| | Adds a tooltip to window control.
|
| BOOL | Add (LPRECT pRect, LPCTSTR pText, DWORD dwFlags=TTF_SUBCLASS) |
| | Adds a tooltip region to window.
|
|
void | Destroy () |
| | Call to destroy all tooltips.
|
| BOOL | Create (HWND hWnd, HINSTANCE hInstance) |
| | Initializes tooltip support for the specified window.
|
|
| CTooltip () |
| | Constructor.
|
|
virtual | ~CTooltip () |
| | Destructor.
|
|
BOOL | IsTip () |
| | Returns non-zero if tooltips are initialized.
|
|
HWND | GetSafeHwnd () |
| | Returns the tooltip window.
|
|
| operator HWND () |
| | Returns the tooltip window.
|
Detailed Description
Provides a wrapper for windows tooltips.
Easily add tooltips to any window.
Member Function Documentation
| BOOL CTooltip::Add |
( |
LPRECT |
pRect, |
|
|
LPCTSTR |
pText, |
|
|
DWORD |
dwFlags = TTF_SUBCLASS |
|
) |
|
|
|
|
Adds a tooltip region to window.
- Parameters:
-
| [in] | pRect | - Area associated with tooltip |
| [in] | pText | - Tooltip text |
| [in] | dwFlags | - Tooltip flags |
- Returns:
- Non-zero on success
- See also:
|
| BOOL CTooltip::Add |
( |
UINT |
uId, |
|
|
LPCTSTR |
pText, |
|
|
DWORD |
dwFlags = TTF_SUBCLASS |
|
) |
|
|
|
|
Adds a tooltip to window control.
- Parameters:
-
| [in] | uId | - Control ID |
| [in] | pText | - Tooltip text |
| [in] | dwFlags | - Tooltip flags |
- Returns:
- Non-zero if success
- See also:
|
| BOOL CTooltip::Create |
( |
HWND |
hWnd, |
|
|
HINSTANCE |
hInstance |
|
) |
|
|
|
|
Initializes tooltip support for the specified window.
- Parameters:
-
| [in] | hWnd | - Window that will support tooltips |
| [in] | hInstance | - Application instance handle |
- Returns:
- Non-zero if success
- See also:
|
| BOOL CTooltip::RelayEvent |
( |
LPMSG |
pMsg |
) |
|
|
|
|
Called to relay tooltip event.
- Parameters:
-
- Returns:
- See also:
|
| BOOL CTooltip::RelayEvent |
( |
HWND |
hWnd, |
|
|
UINT |
uMsg, |
|
|
WPARAM |
wParam, |
|
|
LPARAM |
lParam, |
|
|
DWORD |
dwTime, |
|
|
POINT |
pt |
|
) |
|
|
|
|
Called to relay tooltip event.
- Parameters:
-
| [in] | hWnd | - Window handle |
| [in] | uMsg | - Message id |
| [in] | wParam | - WPARAM value |
| [in] | lParam | - LPARAM value |
| [in] | dwTime | - Time |
| [in] | pt | - Point |
- Returns:
- See also:
|
| BOOL CTooltip::Track |
( |
long |
x, |
|
|
long |
y |
|
) |
|
|
|
|
Call to move tracking tooltip.
- Parameters:
-
| [in] | x | - Horzontal offset of tooltip position |
| [in] | y | - Vertical offset of tooltip position |
- Returns:
- Non-zero if success
- See also:
|
| BOOL CTooltip::TrackActivate |
( |
UINT |
uId, |
|
|
BOOL |
bActivate |
|
) |
|
|
|
|
Call to activate a tracking tooltip.
- Parameters:
-
| [in] | uId | - ID of tooltip |
| [in] | bActivate | - Non-zero to activate tooltip |
- Returns:
- Non-zero if success
- See also:
|
| BOOL CTooltip::UpdateText |
( |
UINT |
uId, |
|
|
LPCTSTR |
pText |
|
) |
|
|
|
|
Call to update the tooltip text for an item.
- Parameters:
-
| [in] | uId | - Item id |
| [in] | pText | - New tooltip text |
- Returns:
- Non-zero if success
- See also:
|
The documentation for this class was generated from the following files:
|