Tooltips Class Reference

#include <Tooltips.h>

Public Member Functions
	Tooltips ()
	~Tooltips ()
void	Initialize (HINSTANCE hInstance, HWND hWnd)
void	CreateTooltipsWindow ()
void	ToggleTooltips ()
void	CreateToolTip (unsigned int tipID, RECT tipRect, char tipText[MAX_LINE_LENGTH], int tipType)
void	DeleteToolTip (unsigned int tipID, int tipType)
void	DeleteAllTooltips ()

Public Attributes
HINSTANCE	hOwnerInstance
HWND	hOwnerWnd
HWND	hToolTipsWnd

Constructor & Destructor Documentation

Tooltips()

Tooltips::Tooltips

(

)

{
    hToolTipsWnd = NULL;
}

~Tooltips()

Tooltips::~Tooltips

(

)

{
    if (hToolTipsWnd) DestroyWindow(hToolTipsWnd);
}

Member Function Documentation

Initialize()

void Tooltips::Initialize	(	HINSTANCE	hInstance,
		HWND	hWnd )

{
    hOwnerInstance = hInstance;
    hOwnerWnd = hWnd;
 
    if (pSettings->taskbarTooltips) CreateTooltipsWindow();
}

CreateTooltipsWindow()

void Tooltips::CreateTooltipsWindow

(

)

{
    hToolTipsWnd = CreateWindowEx(
        WS_EX_TOOLWINDOW | WS_EX_TOPMOST,           // window style
        TOOLTIPS_CLASS,                             // pre-defined system class for tooltips
        NULL,                                       // window name
        WS_POPUP | TTS_NOPREFIX | TTS_ALWAYSTIP,    // window parameters
        CW_USEDEFAULT,                              // x position
        CW_USEDEFAULT,                              // y position
        CW_USEDEFAULT,                              // window width
        CW_USEDEFAULT,                              // window height
        hOwnerWnd,                                 // owner window
        NULL,                                       // no menu
        hOwnerInstance,                               // hInstance
        NULL                                        // no window creation data
    );
 
    if (!hToolTipsWnd)
    {
        MessageBox(0, "Error creating tooltips window!", "BBToolbar", MB_OK | MB_ICONERROR | MB_TOPMOST);
        Log("Toolbar: Error creating tooltips window!", NULL);
        return;
    }
 
    //====================
 
    // Set some tooltips configuration parameters...
    SendMessage(hToolTipsWnd, TTM_SETMAXTIPWIDTH, 0, 300); // -> Sets the maximum width (in pixels) for tooltips, i.e. before breaking the text into multiple lines
    RECT tipMargin = { 4, 4, 4, 4 };
    SendMessage(hToolTipsWnd, TTM_SETMARGIN, 0, (LPARAM)&tipMargin); // -> Sets the top, left, bottom, and right margins (in pixels) for tooltips
    SendMessage(hToolTipsWnd, TTM_SETDELAYTIME, (WPARAM)(DWORD)TTDT_AUTOPOP, (LPARAM)MAKELONG(2000, 0)); // -> Sets the amount of time (in ms) a tooltip remains visible if the pointer is stationary within its bounding rectangle
    SendMessage(hToolTipsWnd, TTM_SETDELAYTIME, (WPARAM)(DWORD)TTDT_INITIAL, (LPARAM)MAKELONG(100, 0)); // -> Sets the amount of time (in ms) a pointer must remain stationary within the bounding rectangle before the tooltip appears
    SendMessage(hToolTipsWnd, TTM_SETDELAYTIME, (WPARAM)(DWORD)TTDT_RESHOW, (LPARAM)MAKELONG(10, 0)); // -> Sets the amount of time (in ms) it takes for a subsequent tooltip to appear as the pointer moves from one bounding rectangle to another
 
    // Set the tooltips colours... (background+text)
//  SendMessage(hToolTipsWnd, TTM_SETTIPBKCOLOR, (WPARAM)pSettings->Toolbar->TextColor, 0);
//  SendMessage(hToolTipsWnd, TTM_SETTIPTEXTCOLOR, (WPARAM)pSettings->Toolbar->Color, 0);
//  SendMessage(hToolTipsWnd, TTM_SETTIPBKCOLOR, (WPARAM)pSettings->ToolbarWindowLabel->Color, 0);
//  SendMessage(hToolTipsWnd, TTM_SETTIPTEXTCOLOR, (WPARAM)pSettings->ToolbarWindowLabel->TextColor, 0);
    SendMessage(hToolTipsWnd, TTM_SETTIPBKCOLOR, (WPARAM)0x000000, 0); // -> Sets the background color for tooltips
    SendMessage(hToolTipsWnd, TTM_SETTIPTEXTCOLOR, (WPARAM)0xffffff, 0); // -> Sets the text color for tooltips
}

ToggleTooltips()

void Tooltips::ToggleTooltips

(

)

{
    // Should we enable or disable taskbar tooltips?
    if (pSettings->taskbarTooltips)
    {
        pSettings->taskbarTooltips = false;
        DeleteAllTooltips();
        if (hToolTipsWnd) DestroyWindow(hToolTipsWnd);
        hToolTipsWnd = NULL;
    }
    else
    {
        pSettings->taskbarTooltips = true;
        if (!hToolTipsWnd) CreateTooltipsWindow();
        pToolbar->UpdateToolbarWindow(); // This will also create taskbar tooltips if/as applicable...
    }
 
    // Save the new setting to xoblite.rc...
    WriteBool(pSettings->xobrcFile, "xoblite.taskbar.tooltips:", pSettings->taskbarTooltips);
}

CreateToolTip()

void Tooltips::CreateToolTip	(	unsigned int	tipID,
		RECT	tipRect,
		char	tipText[MAX_LINE_LENGTH],
		int	tipType )

{
    if (!hToolTipsWnd) return;
 
    // Fill in the basics of the TOOLINFO structure...
    TOOLINFO ti;
    ZeroMemory(&ti, sizeof(ti));
    ti.cbSize = sizeof(TOOLINFO);
    ti.hwnd = pToolbar->hToolbarWnd;
    ti.uId = tipID;
 
    // Check to see if the tooltip exists...
    bool exists = SendMessage(hToolTipsWnd, TTM_GETTOOLINFO, 0, (LPARAM)(LPTOOLINFO)&ti) ? true : false;
 
    // Complete the rest of the TOOLINFO structure...
    ti.uFlags = TTF_SUBCLASS | TTF_CENTERTIP; // -> Center the tooltip below the item...
    ti.hinst =  pToolbar->hToolbarInstance;
    ti.lpszText = tipText;
    ti.rect = tipRect;
 
    // If it exists, modify the tooltip, if not, add it...
    if (exists) SendMessage(hToolTipsWnd, TTM_SETTOOLINFO, 0, (LPARAM)(LPTOOLINFO)&ti);
    else SendMessage(hToolTipsWnd, TTM_ADDTOOL, 0, (LPARAM)&ti);
}

DeleteToolTip()

void Tooltips::DeleteToolTip	(	unsigned int	tipID,
		int	tipType )

{
    if (!hToolTipsWnd) return;
 
    // Fill in the basics of the TOOLINFO structure...
    TOOLINFO ti;
    ZeroMemory(&ti, sizeof(ti));
    ti.cbSize = sizeof(TOOLINFO);
    ti.hwnd = pToolbar->hToolbarWnd;
    ti.uId = tipID;
 
    // Check to see if the tooltip exists, and if so delete it...
//  bool exists = SendMessage(hToolTipsWnd, TTM_GETTOOLINFO, 0, (LPARAM)(LPTOOLINFO)&ti) ? true : false;
//  if (exists) SendMessage(hToolTipsWnd, TTM_DELTOOL, 0, (LPARAM)(LPTOOLINFO)&ti);
    SendMessage(hToolTipsWnd, TTM_DELTOOL, 0, (LPARAM)(LPTOOLINFO)&ti);
}

DeleteAllTooltips()

void Tooltips::DeleteAllTooltips

(

)

{
    // Delete any existing taskbar tooltips...
    for (int i=0; i < (int)pTaskbar->taskList.size(); i++)
    {
        DeleteToolTip((UINT)pTaskbar->taskList[i]->hwnd, TOOLTIP_TYPE_TASK);
    }
}

Member Data Documentation

hOwnerInstance

HINSTANCE Tooltips::hOwnerInstance

hOwnerWnd

HWND Tooltips::hOwnerWnd

hToolTipsWnd

HWND Tooltips::hToolTipsWnd