CBalloonQueue Class Reference

Collaboration diagram for CBalloonQueue:

Classes
struct	Info

Public Member Functions
	CBalloonQueue ()
void	Init (HWND hwndParent, CNotifyToolbar *toolbar, CTooltips *balloons)
void	Deinit ()
bool	OnTimer (int timerId)
void	UpdateInfo (InternalIconData *notifyItem)
void	RemoveInfo (InternalIconData *notifyItem)
void	CloseCurrent ()

Static Public Attributes
static const int	TimerInterval = 2000
static const int	BalloonsTimerId = 1
static const int	MinTimeout = 10000
static const int	MaxTimeout = 30000
static const int	CooldownBetweenBalloons = 2000

Private Member Functions
int	IndexOf (InternalIconData *pdata)
void	SetTimer (int length)
void	Show (Info &info)
void	Close (IN OUT InternalIconData *notifyItem, IN UINT uReason)

Private Attributes
HWND	m_hwndParent
CTooltips *	m_tooltips
CAtlList< Info >	m_queue
CNotifyToolbar *	m_toolbar
InternalIconData *	m_current
bool	m_currentClosed
int	m_timer

Detailed Description

Definition at line 83 of file syspager.cpp.

Constructor & Destructor Documentation

CBalloonQueue()

CBalloonQueue::CBalloonQueue

(

)

Definition at line 500 of file syspager.cpp.

                             :
    m_hwndParent(NULL),
    m_tooltips(NULL),
    m_toolbar(NULL),
    m_current(NULL),
    m_currentClosed(false),
    m_timer(-1)
{
}

Member Function Documentation

Close()

void CBalloonQueue::Close ( IN OUT InternalIconData *  notifyItem, IN UINT  uReason  )

private

Definition at line 642 of file syspager.cpp.

{
    TRACE("HideBalloonTip called\n");
 
    if (m_current == notifyItem && !m_currentClosed)
    {
        m_toolbar->SendNotifyCallback(m_current, uReason);
 
        // Prevent Re-entry
        m_currentClosed = true;
        m_tooltips->TrackDeactivate();
        SetTimer(CooldownBetweenBalloons);
    }
}

CloseCurrent()

void CBalloonQueue::CloseCurrent

(

)

Definition at line 590 of file syspager.cpp.

{
    if (m_current != NULL)
    {
        Close(m_current, NIN_BALLOONTIMEOUT);
    }
}

Referenced by CSysPagerWnd::OnBalloonPop().

Deinit()

void CBalloonQueue::Deinit

(

)

Definition at line 517 of file syspager.cpp.

{
    if (m_timer >= 0)
    {
        ::KillTimer(m_hwndParent, m_timer);
    }
}

Referenced by CSysPagerWnd::OnDestroy().

IndexOf()

int CBalloonQueue::IndexOf ( InternalIconData *  pdata )

private

Definition at line 598 of file syspager.cpp.

{
    int count = m_toolbar->GetButtonCount();
    for (int i = 0; i < count; i++)
    {
        if (m_toolbar->GetItemData(i) == pdata)
            return i;
    }
    return -1;
}

Referenced by Show().

Init()

void CBalloonQueue::Init	(	HWND	hwndParent,
		CNotifyToolbar *	toolbar,
		CTooltips *	balloons
	)

Definition at line 510 of file syspager.cpp.

{
    m_hwndParent = hwndParent;
    m_toolbar = toolbar;
    m_tooltips = balloons;
}

Referenced by CSysPagerWnd::OnCreate().

OnTimer()

bool CBalloonQueue::OnTimer

(

int

timerId

)

Definition at line 525 of file syspager.cpp.

{
    if (timerId != m_timer)
        return false;
 
    ::KillTimer(m_hwndParent, m_timer);
    m_timer = -1;
 
    if (m_current && !m_currentClosed)
    {
        Close(m_current, NIN_BALLOONTIMEOUT);
    }
    else
    {
        m_current = NULL;
        m_currentClosed = false;
        if (!m_queue.IsEmpty())
        {
            Info info = m_queue.RemoveHead();
            Show(info);
        }
    }
 
    return true;
}

Referenced by CSysPagerWnd::OnTimer().

RemoveInfo()

void CBalloonQueue::RemoveInfo

(

InternalIconData *

notifyItem

)

Definition at line 575 of file syspager.cpp.

{
    Close(notifyItem, NIN_BALLOONHIDE);
 
    POSITION position = m_queue.GetHeadPosition();
    while(position != NULL)
    {
        Info& info = m_queue.GetNext(position);
        if (info.pSource == notifyItem)
        {
            m_queue.RemoveAt(position);
        }
    }
}

Referenced by CNotifyToolbar::RemoveButton().

SetTimer()

void CBalloonQueue::SetTimer ( int  length )

private

Definition at line 609 of file syspager.cpp.

{
    m_timer = ::SetTimer(m_hwndParent, BalloonsTimerId, length, NULL);
}

Referenced by Close(), SetTimer(), and Show().

Show()

void CBalloonQueue::Show ( Info &  info )

private

Definition at line 614 of file syspager.cpp.

{
    TRACE("ShowBalloonTip called for flags=%x text=%ws; title=%ws\n", info.uIcon, info.szInfo, info.szInfoTitle);
 
    // TODO: NIF_REALTIME, NIIF_NOSOUND, other Vista+ flags
 
    const int index = IndexOf(info.pSource);
    RECT rc;
    m_toolbar->GetItemRect(index, &rc);
    m_toolbar->ClientToScreen(&rc);
    const WORD x = (rc.left + rc.right) / 2;
    const WORD y = (rc.top + rc.bottom) / 2;
 
    m_tooltips->SetTitle(info.szInfoTitle, info.uIcon);
    m_tooltips->TrackPosition(x, y);
    m_tooltips->UpdateTipText(m_hwndParent, reinterpret_cast<LPARAM>(m_toolbar->m_hWnd), info.szInfo);
    m_tooltips->TrackActivate(m_hwndParent, reinterpret_cast<LPARAM>(m_toolbar->m_hWnd));
 
    m_current = info.pSource;
    int timeout = info.uTimeout;
    if (timeout < MinTimeout) timeout = MinTimeout;
    if (timeout > MaxTimeout) timeout = MaxTimeout;
 
    SetTimer(timeout);
 
    m_toolbar->SendNotifyCallback(m_current, NIN_BALLOONSHOW);
}

Referenced by OnTimer(), and UpdateInfo().

UpdateInfo()

void CBalloonQueue::UpdateInfo

(

InternalIconData *

notifyItem

)

Definition at line 551 of file syspager.cpp.

{
    size_t len = 0;
    HRESULT hr = StringCchLength(notifyItem->szInfo, _countof(notifyItem->szInfo), &len);
    if (SUCCEEDED(hr) && len > 0)
    {
        Info info(notifyItem);
 
        // If m_current == notifyItem, we want to replace the previous balloon even if there is a queue.
        if (m_current != notifyItem && (m_current != NULL || !m_queue.IsEmpty()))
        {
            m_queue.AddTail(info);
        }
        else
        {
            Show(info);
        }
    }
    else
    {
        Close(notifyItem, NIN_BALLOONHIDE);
    }
}

Referenced by CNotifyToolbar::AddButton(), and CNotifyToolbar::UpdateButton().

Member Data Documentation

BalloonsTimerId

const int CBalloonQueue::BalloonsTimerId = 1

static

Definition at line 87 of file syspager.cpp.

Referenced by SetTimer().

CooldownBetweenBalloons

const int CBalloonQueue::CooldownBetweenBalloons = 2000

static

Definition at line 90 of file syspager.cpp.

Referenced by Close().

m_current

InternalIconData* CBalloonQueue::m_current

private

Definition at line 121 of file syspager.cpp.

Referenced by Close(), CloseCurrent(), OnTimer(), Show(), and UpdateInfo().

m_currentClosed

bool CBalloonQueue::m_currentClosed

private

Definition at line 122 of file syspager.cpp.

Referenced by Close(), and OnTimer().

m_hwndParent

HWND CBalloonQueue::m_hwndParent

private

Definition at line 113 of file syspager.cpp.

Referenced by Deinit(), Init(), OnTimer(), SetTimer(), and Show().

m_queue

CAtlList<Info> CBalloonQueue::m_queue

private

Definition at line 117 of file syspager.cpp.

Referenced by OnTimer(), RemoveInfo(), and UpdateInfo().

m_timer

int CBalloonQueue::m_timer

private

Definition at line 124 of file syspager.cpp.

Referenced by Deinit(), OnTimer(), and SetTimer().

m_toolbar

CNotifyToolbar* CBalloonQueue::m_toolbar

private

Definition at line 119 of file syspager.cpp.

Referenced by Close(), IndexOf(), Init(), and Show().

m_tooltips

CTooltips* CBalloonQueue::m_tooltips

private

Definition at line 115 of file syspager.cpp.

Referenced by Close(), Init(), and Show().

MaxTimeout

const int CBalloonQueue::MaxTimeout = 30000

static

Definition at line 89 of file syspager.cpp.

Referenced by Show().

MinTimeout

const int CBalloonQueue::MinTimeout = 10000

static

Definition at line 88 of file syspager.cpp.

Referenced by Show().

TimerInterval

const int CBalloonQueue::TimerInterval = 2000

static

Definition at line 86 of file syspager.cpp.

---

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

• base/shell/explorer/syspager.cpp