CTooltips Class Reference

#include <rosctrls.h>

Inheritance diagram for CTooltips:

Collaboration diagram for CTooltips:

Public Member Functions
HWND	Create (HWND hWndParent, DWORD dwStyles=WS_POPUP|TTS_NOPREFIX, DWORD dwExStyles=WS_EX_TOPMOST)
VOID	RelayEvent (MSG *pMsg, WPARAM extraInfo=0)
INT	GetToolCount ()
BOOL	AddTool (IN CONST TTTOOLINFOW *pInfo)
VOID	DelTool (IN HWND hwndToolOwner, IN UINT uId)
VOID	NewToolRect (IN HWND hwndToolOwner, IN UINT uId, IN RECT rect)
BOOL	GetToolInfo (IN HWND hwndToolOwner, IN UINT uId, IN OUT TTTOOLINFOW *pInfo)
VOID	SetToolInfo (IN CONST TTTOOLINFOW *pInfo)
BOOL	HitTest (IN CONST TTHITTESTINFOW *pInfo)
VOID	GetText (IN HWND hwndToolOwner, IN UINT uId, OUT PWSTR pBuffer, IN DWORD cchBuffer)
VOID	UpdateTipText (IN HWND hwndToolOwner, IN UINT uId, IN PCWSTR szText, IN HINSTANCE hinstResourceOwner=NULL)
BOOL	EnumTools (IN CONST TTTOOLINFOW *pInfo)
BOOL	GetCurrentTool (OUT OPTIONAL TTTOOLINFOW *pInfo=NULL)
VOID	GetTitle (TTGETTITLE *pTitleInfo)
BOOL	SetTitle (PCWSTR szTitleText, WPARAM icon=0)
VOID	TrackActivate (IN HWND hwndToolOwner, IN UINT uId)
VOID	TrackDeactivate ()
VOID	TrackPosition (IN WORD x, IN WORD y)
VOID	Popup ()
VOID	Pop ()
INT	GetDelayTime (UINT which)
VOID	SetDelayTime (UINT which, WORD time)
VOID	Activate (IN BOOL bActivate=TRUE)
VOID	AdjustRect (IN BOOL bTextToWindow, IN OUT RECT *pRect)
SIZE	GetBubbleSize (IN TTTOOLINFOW *pInfo)
VOID	GetMargin (OUT RECT *pRect)
VOID	SetMargin (IN RECT *pRect)
INT	GetMaxTipWidth ()
INT	SetMaxTipWidth (IN OPTIONAL INT width=-1)
COLORREF	GetTipTextColor ()
VOID	SetTipTextColor (IN COLORREF textColor)
COLORREF	GetTipBkColor ()
VOID	SetTipBkColor (IN COLORREF textColor)
VOID	SetWindowTheme (IN PCWSTR szThemeName)
VOID	Update ()
HWND	WindowFromPoint (IN POINT *pPoint)

Detailed Description

Definition at line 616 of file rosctrls.h.

Member Function Documentation

Activate()

VOID CTooltips::Activate ( IN BOOL  bActivate = TRUE )

inline

Definition at line 762 of file rosctrls.h.

    {
        SendMessageW(TTM_ACTIVATE, bActivate);
    }

AddTool()

BOOL CTooltips::AddTool ( IN CONST TTTOOLINFOW *  pInfo )

inline

Definition at line 642 of file rosctrls.h.

    {
        return SendMessageW(TTM_ADDTOOL, 0, reinterpret_cast<LPARAM>(pInfo));
    }

Referenced by CTrayShowDesktopButton::DoCreate(), CSysPagerWnd::OnCreate(), and CTrayClockWnd::OnCreate().

AdjustRect()

VOID CTooltips::AdjustRect ( IN BOOL  bTextToWindow, IN OUT RECT *  pRect  )

inline

Definition at line 768 of file rosctrls.h.

    {
        SendMessageW(TTM_ADJUSTRECT, bTextToWindow, reinterpret_cast<LPARAM>(pRect));
    }

Create()

HWND CTooltips::Create ( HWND  hWndParent, DWORD  dwStyles = WS_POPUP | TTS_NOPREFIX, DWORD  dwExStyles = WS_EX_TOPMOST  )

inline

Definition at line 621 of file rosctrls.h.

    {
        RECT r = { 0 };
        return CWindow::Create(TOOLTIPS_CLASS, hWndParent, r, L"", dwStyles, dwExStyles);
    }

Referenced by CTrayShowDesktopButton::DoCreate(), CSysPagerWnd::OnCreate(), and CTrayClockWnd::OnCreate().

DelTool()

VOID CTooltips::DelTool ( IN HWND  hwndToolOwner, IN UINT  uId  )

inline

Definition at line 647 of file rosctrls.h.

    {
        TTTOOLINFOW info = { sizeof(TTTOOLINFOW), 0 };
        info.hwnd = hwndToolOwner;
        info.uId = uId;
        SendMessageW(TTM_DELTOOL, 0, reinterpret_cast<LPARAM>(&info));
    }

EnumTools()

BOOL CTooltips::EnumTools ( IN CONST TTTOOLINFOW *  pInfo )

inline

Definition at line 700 of file rosctrls.h.

    {
        return SendMessageW(TTM_ENUMTOOLS, 0, reinterpret_cast<LPARAM>(pInfo));
    }

GetBubbleSize()

SIZE CTooltips::GetBubbleSize ( IN TTTOOLINFOW *  pInfo )

inline

Definition at line 774 of file rosctrls.h.

    {
        DWORD ret = SendMessageW(TTM_GETBUBBLESIZE, 0, reinterpret_cast<LPARAM>(pInfo));
        const SIZE sz = { LOWORD(ret), HIWORD(ret) };
        return sz;
    }

GetCurrentTool()

BOOL CTooltips::GetCurrentTool ( OUT OPTIONAL TTTOOLINFOW *  pInfo = NULL )

inline

Definition at line 705 of file rosctrls.h.

    {
        return SendMessageW(TTM_GETCURRENTTOOL, 0, reinterpret_cast<LPARAM>(pInfo));
    }

GetDelayTime()

INT CTooltips::GetDelayTime ( UINT  which )

inline

Definition at line 751 of file rosctrls.h.

    {
        return SendMessageW(TTM_GETDELAYTIME, which);
    }

GetMargin()

VOID CTooltips::GetMargin ( OUT RECT *  pRect )

inline

Definition at line 782 of file rosctrls.h.

    {
        SendMessageW(TTM_GETMARGIN, 0, reinterpret_cast<LPARAM>(pRect));
    }

GetMaxTipWidth()

INT CTooltips::GetMaxTipWidth ( )

inline

Definition at line 793 of file rosctrls.h.

    {
        return SendMessageW(TTM_GETMAXTIPWIDTH);
    }

GetText()

VOID CTooltips::GetText ( IN HWND  hwndToolOwner, IN UINT  uId, OUT PWSTR  pBuffer, IN DWORD  cchBuffer  )

inline

Definition at line 681 of file rosctrls.h.

    {
        TTTOOLINFOW info = { sizeof(TTTOOLINFOW), 0 };
        info.hwnd = hwndToolOwner;
        info.uId = uId;
        info.lpszText = pBuffer;
        SendMessageW(TTM_GETTEXT, cchBuffer, reinterpret_cast<LPARAM>(&info));
    }

GetTipBkColor()

COLORREF CTooltips::GetTipBkColor ( )

inline

Definition at line 814 of file rosctrls.h.

    {
        return SendMessageW(TTM_GETTIPBKCOLOR);
    }

GetTipTextColor()

COLORREF CTooltips::GetTipTextColor ( )

inline

Definition at line 804 of file rosctrls.h.

    {
        return SendMessageW(TTM_GETTIPTEXTCOLOR);
    }

GetTitle()

VOID CTooltips::GetTitle ( TTGETTITLE *  pTitleInfo )

inline

Definition at line 710 of file rosctrls.h.

    {
        SendMessageW(TTM_GETTITLE, 0, reinterpret_cast<LPARAM>(pTitleInfo));
    }

GetToolCount()

INT CTooltips::GetToolCount ( )

inline

Definition at line 637 of file rosctrls.h.

    {
        return SendMessageW(TTM_GETTOOLCOUNT, 0, 0);
    }

GetToolInfo()

BOOL CTooltips::GetToolInfo ( IN HWND  hwndToolOwner, IN UINT  uId, IN OUT TTTOOLINFOW *  pInfo  )

inline

Definition at line 664 of file rosctrls.h.

    {
        pInfo->hwnd = hwndToolOwner;
        pInfo->uId = uId;
        return SendMessageW(TTM_GETTOOLINFO, 0, reinterpret_cast<LPARAM>(pInfo));
    }

HitTest()

BOOL CTooltips::HitTest ( IN CONST TTHITTESTINFOW *  pInfo )

inline

Definition at line 676 of file rosctrls.h.

    {
        return SendMessageW(TTM_HITTEST, 0, reinterpret_cast<LPARAM>(pInfo));
    }

NewToolRect()

VOID CTooltips::NewToolRect ( IN HWND  hwndToolOwner, IN UINT  uId, IN RECT  rect  )

inline

Definition at line 655 of file rosctrls.h.

    {
        TTTOOLINFOW info = { sizeof(TTTOOLINFOW), 0 };
        info.hwnd = hwndToolOwner;
        info.uId = uId;
        info.rect = rect;
        SendMessageW(TTM_NEWTOOLRECT, 0, reinterpret_cast<LPARAM>(&info));
    }

Pop()

VOID CTooltips::Pop ( )

inline

Definition at line 745 of file rosctrls.h.

    {
        SendMessageW(TTM_POP);
    }

Popup()

VOID CTooltips::Popup ( )

inline

Definition at line 739 of file rosctrls.h.

    {
        SendMessageW(TTM_POPUP);
    }

RelayEvent()

VOID CTooltips::RelayEvent ( MSG *  pMsg, WPARAM  extraInfo = 0  )

inline

Definition at line 630 of file rosctrls.h.

    {
        SendMessageW(TTM_RELAYEVENT, extraInfo, reinterpret_cast<LPARAM>(pMsg));
    }

SetDelayTime()

VOID CTooltips::SetDelayTime ( UINT  which, WORD  time  )

inline

Definition at line 756 of file rosctrls.h.

    {
        SendMessageW(TTM_SETDELAYTIME, which, MAKELPARAM(time, 0));
    }

SetMargin()

VOID CTooltips::SetMargin ( IN RECT *  pRect )

inline

Definition at line 787 of file rosctrls.h.

    {
        SendMessageW(TTM_SETMARGIN, 0, reinterpret_cast<LPARAM>(pRect));
    }

SetMaxTipWidth()

INT CTooltips::SetMaxTipWidth ( IN OPTIONAL INT  width = -1 )

inline

Definition at line 798 of file rosctrls.h.

    {
        return SendMessageW(TTM_SETMAXTIPWIDTH, 0, width);
    }

Referenced by CBalloonQueue::Show().

SetTipBkColor()

VOID CTooltips::SetTipBkColor ( IN COLORREF  textColor )

inline

Definition at line 819 of file rosctrls.h.

    {
        SendMessageW(TTM_SETTIPBKCOLOR, textColor);
    }

SetTipTextColor()

VOID CTooltips::SetTipTextColor ( IN COLORREF  textColor )

inline

Definition at line 809 of file rosctrls.h.

    {
        SendMessageW(TTM_SETTIPTEXTCOLOR, textColor);
    }

SetTitle()

BOOL CTooltips::SetTitle ( PCWSTR  szTitleText, WPARAM  icon = 0  )

inline

Definition at line 715 of file rosctrls.h.

    {
        return SendMessageW(TTM_SETTITLE, icon, reinterpret_cast<LPARAM>(szTitleText));
    }

Referenced by CBalloonQueue::Show().

SetToolInfo()

VOID CTooltips::SetToolInfo ( IN CONST TTTOOLINFOW *  pInfo )

inline

Definition at line 671 of file rosctrls.h.

    {
        SendMessageW(TTM_SETTOOLINFO, 0, reinterpret_cast<LPARAM>(pInfo));
    }

SetWindowTheme()

VOID CTooltips::SetWindowTheme ( IN PCWSTR  szThemeName )

inline

Definition at line 824 of file rosctrls.h.

    {
        SendMessageW(TTM_SETWINDOWTHEME, 0, reinterpret_cast<LPARAM>(szThemeName));
    }

TrackActivate()

VOID CTooltips::TrackActivate ( IN HWND  hwndToolOwner, IN UINT  uId  )

inline

Definition at line 720 of file rosctrls.h.

    {
        TTTOOLINFOW info = { sizeof(TTTOOLINFOW), 0 };
        info.hwnd = hwndToolOwner;
        info.uId = uId;
        SendMessageW(TTM_TRACKACTIVATE, TRUE, reinterpret_cast<LPARAM>(&info));
    }

Referenced by CBalloonQueue::Show().

TrackDeactivate()

VOID CTooltips::TrackDeactivate ( )

inline

Definition at line 728 of file rosctrls.h.

    {
        SendMessageW(TTM_TRACKACTIVATE, FALSE, NULL);
    }

Referenced by CBalloonQueue::Close().

TrackPosition()

VOID CTooltips::TrackPosition ( IN WORD  x, IN WORD  y  )

inline

Definition at line 733 of file rosctrls.h.

    {
        SendMessageW(TTM_TRACKPOSITION, 0, MAKELPARAM(x, y));
    }

Referenced by CBalloonQueue::Show().

Update()

VOID CTooltips::Update ( )

inline

Definition at line 830 of file rosctrls.h.

    {
        SendMessageW(TTM_UPDATE);
    }

UpdateTipText()

VOID CTooltips::UpdateTipText ( IN HWND  hwndToolOwner, IN UINT  uId, IN PCWSTR  szText, IN HINSTANCE  hinstResourceOwner = NULL  )

inline

Definition at line 690 of file rosctrls.h.

    {
        TTTOOLINFOW info = { sizeof(TTTOOLINFOW), 0 };
        info.hwnd = hwndToolOwner;
        info.uId = uId;
        info.lpszText = const_cast<PWSTR>(szText);
        info.hinst = hinstResourceOwner;
        SendMessageW(TTM_UPDATETIPTEXT, 0, reinterpret_cast<LPARAM>(&info));
    }

Referenced by CBalloonQueue::Show(), and CTrayClockWnd::UpdateWnd().

WindowFromPoint()

HWND CTooltips::WindowFromPoint ( IN POINT *  pPoint )

inline

Definition at line 835 of file rosctrls.h.

    {
        return reinterpret_cast<HWND>(SendMessageW(TTM_WINDOWFROMPOINT, 0, reinterpret_cast<LPARAM>(pPoint)));
    }

---

The documentation for this class was generated from the following file:

• sdk/include/reactos/ui/rosctrls.h