4 * Copyright 2006 - 2007 Thomas Weidenmueller <w3seek@reactos.org>
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23 #include <shdeprecated.h>
25 /*****************************************************************************
26 ** ITrayBandSite ************************************************************
27 *****************************************************************************/
29 // WARNING: Can't use ATL for this class due to our ATL not fully supporting the AGGREGATION functions needed for this class to be an "outer" class
30 // it works just fine this way.
34 public IBandSiteStreamCallback
35 /* TODO: IWinEventHandler */
37 volatile LONG m_RefCount
;
39 CComPtr
<ITrayWindow
> m_Tray
;
41 CComPtr
<IUnknown
> m_Inner
;
42 CComPtr
<IBandSite
> m_BandSite
;
43 CComPtr
<IDeskBand
> m_TaskBand
;
44 CComPtr
<IWinEventHandler
> m_WindowEventHandler
;
45 CComPtr
<IContextMenu
> m_ContextMenu
;
60 virtual ULONG STDMETHODCALLTYPE
AddRef()
62 return InterlockedIncrement(&m_RefCount
);
65 virtual ULONG STDMETHODCALLTYPE
Release()
67 ULONG Ret
= InterlockedDecrement(&m_RefCount
);
75 virtual HRESULT STDMETHODCALLTYPE
QueryInterface(IN REFIID riid
, OUT LPVOID
*ppvObj
)
80 if (IsEqualIID(riid
, IID_IUnknown
) || IsEqualIID(riid
, IID_IBandSiteHelper
))
82 // return IBandSiteStreamCallback's IUnknown
83 *ppvObj
= static_cast<IBandSiteStreamCallback
*>(this);
85 else if (IsEqualIID(riid
, IID_IBandSite
))
87 *ppvObj
= static_cast<IBandSite
*>(this);
89 else if (IsEqualIID(riid
, IID_IWinEventHandler
))
91 TRACE("ITaskBandSite: IWinEventHandler queried!\n");
95 else if (m_Inner
!= NULL
)
97 return m_Inner
->QueryInterface(riid
, ppvObj
);
102 return E_NOINTERFACE
;
116 virtual ~CTrayBandSite() { }
118 virtual HRESULT STDMETHODCALLTYPE
OnLoad(
119 IN OUT IStream
*pStm
,
123 LARGE_INTEGER liPosZero
;
124 ULARGE_INTEGER liCurrent
;
129 /* NOTE: Callback routine called by the shell while loading the task band
130 stream. We use it to intercept the default behavior when the task
131 band is loaded from the stream.
133 NOTE: riid always points to IID_IUnknown! This is because the shell hasn't
134 read anything from the stream and therefore doesn't know what CLSID
135 it's dealing with. We'll have to find it out ourselves by reading
136 the GUID from the stream. */
138 /* Read the current position of the stream, we'll have to reset it everytime
139 we read a CLSID that's not the task band... */
140 ZeroMemory(&liPosZero
, sizeof(liPosZero
));
141 hRet
= pStm
->Seek(liPosZero
, STREAM_SEEK_CUR
, &liCurrent
);
145 /* Now let's read the CLSID from the stream and see if it's our task band */
146 hRet
= pStm
->Read(&clsid
, (ULONG
)sizeof(clsid
), &ulRead
);
148 if (SUCCEEDED(hRet
) && ulRead
== sizeof(clsid
))
150 if (IsEqualGUID(clsid
, CLSID_ITaskBand
))
152 ASSERT(m_TaskBand
!= NULL
);
153 /* We're trying to load the task band! Let's create it... */
155 hRet
= m_TaskBand
->QueryInterface(
160 /* Load the stream */
161 TRACE("IBandSiteStreamCallback::OnLoad intercepted the task band CLSID!\n");
169 /* Reset the position and let the shell do all the work for us */
171 *(LARGE_INTEGER
*) &liCurrent
,
176 /* Let the shell handle everything else for us :) */
177 hRet
= OleLoadFromStream(pStm
,
182 if (!SUCCEEDED(hRet
))
184 TRACE("IBandSiteStreamCallback::OnLoad(0x%p, 0x%p, 0x%p) returns 0x%x\n", pStm
, riid
, pvObj
, hRet
);
190 virtual HRESULT STDMETHODCALLTYPE
OnSave(
191 IN OUT IUnknown
*pUnk
,
192 IN OUT IStream
*pStm
)
194 /* NOTE: Callback routine called by the shell while saving the task band
195 stream. We use it to intercept the default behavior when the task
196 band is saved to the stream */
197 /* FIXME: Implement */
198 TRACE("IBandSiteStreamCallback::OnSave(0x%p, 0x%p) returns E_NOTIMPL\n", pUnk
, pStm
);
202 virtual HRESULT STDMETHODCALLTYPE
IsTaskBand(IN IUnknown
*punk
)
204 return IsSameObject(m_BandSite
, punk
);
207 virtual HRESULT STDMETHODCALLTYPE
ProcessMessage(
212 OUT LRESULT
*plResult
)
216 ASSERT(m_Rebar
!= NULL
);
218 /* Custom task band behavior */
223 const NMHDR
*nmh
= (const NMHDR
*) lParam
;
225 if (nmh
->hwndFrom
== m_Rebar
)
231 LPNMMOUSE nmm
= (LPNMMOUSE
) lParam
;
233 if (nmm
->dwHitInfo
== RBHT_CLIENT
|| nmm
->dwHitInfo
== RBHT_NOWHERE
||
234 nmm
->dwItemSpec
== (DWORD_PTR
) -1)
236 /* Make the rebar control appear transparent so the user
237 can drag the tray window */
238 *plResult
= HTTRANSPARENT
;
244 /* Deny if an Administrator disabled this "feature" */
245 *plResult
= (SHRestricted(REST_NOMOVINGBAND
) != 0);
250 //TRACE("ITrayBandSite::ProcessMessage: WM_NOTIFY for 0x%p, From: 0x%p, Code: NM_FIRST-%u...\n", hWnd, nmh->hwndFrom, NM_FIRST - nmh->code);
255 /* Forward to the shell's IWinEventHandler interface to get the default shell behavior! */
256 if (!m_WindowEventHandler
)
259 /*TRACE("Calling IWinEventHandler::ProcessMessage(0x%p, 0x%x, 0x%p, 0x%p, 0x%p) hWndRebar=0x%p\n", hWnd, uMsg, wParam, lParam, plResult, hWndRebar);*/
260 hRet
= m_WindowEventHandler
->OnWinEvent(hWnd
, uMsg
, wParam
, lParam
, plResult
);
265 if (uMsg
== WM_NOTIFY
)
267 const NMHDR
*nmh
= (const NMHDR
*) lParam
;
268 ERR("ITrayBandSite->IWinEventHandler::ProcessMessage: WM_NOTIFY for 0x%p, From: 0x%p, Code: NM_FIRST-%u returned 0x%x\n", hWnd
, nmh
->hwndFrom
, NM_FIRST
- nmh
->code
, hRet
);
272 ERR("ITrayBandSite->IWinEventHandler::ProcessMessage(0x%p,0x%x,0x%p,0x%p,0x%p->0x%p) returned: 0x%x\n", hWnd
, uMsg
, wParam
, lParam
, plResult
, *plResult
, hRet
);
280 virtual HRESULT STDMETHODCALLTYPE
AddContextMenus(
286 OUT IContextMenu
**ppcm
)
290 if (m_ContextMenu
== NULL
)
292 /* Cache the context menu so we don't need to CoCreateInstance all the time... */
293 hRet
= _CBandSiteMenu_CreateInstance(IID_PPV_ARG(IContextMenu
, &m_ContextMenu
));
294 if (FAILED_UNEXPECTEDLY(hRet
))
297 hRet
= IUnknown_SetOwner(m_ContextMenu
, (IBandSite
*)this);
298 if (FAILED_UNEXPECTEDLY(hRet
))
304 m_ContextMenu
->AddRef();
305 *ppcm
= m_ContextMenu
;
308 /* Add the menu items */
309 hRet
= m_ContextMenu
->QueryContextMenu(hmenu
, indexMenu
, idCmdFirst
, idCmdLast
, uFlags
);
310 if (FAILED_UNEXPECTEDLY(hRet
))
316 virtual HRESULT STDMETHODCALLTYPE
Lock(IN BOOL bLock
)
318 BOOL bPrevLocked
= Locked
;
322 ASSERT(m_BandSite
!= NULL
);
324 if (bPrevLocked
!= bLock
)
328 bsi
.dwMask
= BSIM_STYLE
;
329 bsi
.dwStyle
= (Locked
? BSIS_LOCKED
| BSIS_NOGRIPPER
: BSIS_AUTOGRIPPER
);
331 hRet
= m_BandSite
->SetBandSiteInfo(&bsi
);
343 /*******************************************************************/
345 virtual HRESULT STDMETHODCALLTYPE
AddBand(IN IUnknown
*punk
)
347 /* Send the DBID_DELAYINIT command to initialize the band to be added */
348 /* FIXME: Should be delayed */
349 IUnknown_Exec(punk
, IID_IDeskBand
, DBID_DELAYINIT
, 0, NULL
, NULL
);
351 HRESULT hr
= m_BandSite
->AddBand(punk
);
352 if (FAILED_UNEXPECTEDLY(hr
))
356 V_VT(&vThemeName
) = VT_BSTR
;
357 V_BSTR(&vThemeName
) = SysAllocString(L
"TaskBar");
365 SysFreeString(V_BSTR(&vThemeName
));
370 virtual HRESULT STDMETHODCALLTYPE
EnumBands(
372 OUT DWORD
*pdwBandID
)
374 return m_BandSite
->EnumBands(uBand
, pdwBandID
);
377 virtual HRESULT STDMETHODCALLTYPE
QueryBand(
379 OUT IDeskBand
**ppstb
,
385 IDeskBand
*pstb
= NULL
;
387 hRet
= m_BandSite
->QueryBand(
396 hRet
= IsSameObject(pstb
, m_TaskBand
);
399 /* Add the BSSF_UNDELETEABLE flag to pdwState because the task bar band shouldn't be deletable */
400 if (pdwState
!= NULL
)
401 *pdwState
|= BSSF_UNDELETEABLE
;
403 else if (!SUCCEEDED(hRet
))
412 else if (ppstb
!= NULL
)
418 virtual HRESULT STDMETHODCALLTYPE
SetBandState(
423 return m_BandSite
->SetBandState(dwBandID
, dwMask
, dwState
);
426 virtual HRESULT STDMETHODCALLTYPE
RemoveBand(
429 return m_BandSite
->RemoveBand(dwBandID
);
432 virtual HRESULT STDMETHODCALLTYPE
GetBandObject(
437 return m_BandSite
->GetBandObject(dwBandID
, riid
, ppv
);
440 virtual HRESULT STDMETHODCALLTYPE
SetBandSiteInfo(
441 IN
const BANDSITEINFO
*pbsinfo
)
443 return m_BandSite
->SetBandSiteInfo(pbsinfo
);
446 virtual HRESULT STDMETHODCALLTYPE
GetBandSiteInfo(
447 IN OUT BANDSITEINFO
*pbsinfo
)
449 return m_BandSite
->GetBandSiteInfo(pbsinfo
);
452 virtual BOOL
HasTaskBand()
454 CComPtr
<IPersist
> pBand
;
459 /* Enumerate all bands */
460 while (SUCCEEDED(m_BandSite
->EnumBands(uBand
, &dwBandID
)))
462 if (SUCCEEDED(m_BandSite
->GetBandObject(dwBandID
, IID_PPV_ARG(IPersist
, &pBand
))))
464 if (SUCCEEDED(pBand
->GetClassID(&BandCLSID
)))
466 if (IsEqualGUID(BandCLSID
, CLSID_ITaskBand
))
478 virtual HRESULT
Update()
480 return IUnknown_Exec(m_Inner
,
482 DBID_BANDINFOCHANGED
,
488 virtual VOID
BroadcastOleCommandExec(REFGUID pguidCmdGroup
,
494 IOleCommandTarget
*pOct
;
498 /* Enumerate all bands */
499 while (SUCCEEDED(m_BandSite
->EnumBands(uBand
, &dwBandID
)))
501 if (SUCCEEDED(m_BandSite
->GetBandObject(dwBandID
, IID_PPV_ARG(IOleCommandTarget
, &pOct
))))
503 /* Execute the command */
518 virtual HRESULT
FinishInit()
520 /* Broadcast the DBID_FINISHINIT command */
521 BroadcastOleCommandExec(IID_IDeskBand
, DBID_FINISHINIT
, 0, NULL
, NULL
);
526 virtual HRESULT
Show(IN BOOL bShow
)
528 CComPtr
<IDeskBarClient
> pDbc
;
531 hRet
= m_BandSite
->QueryInterface(IID_PPV_ARG(IDeskBarClient
, &pDbc
));
534 hRet
= pDbc
->UIActivateDBC(bShow
? DBC_SHOW
: DBC_HIDE
);
540 virtual HRESULT
LoadFromStream(IN OUT IStream
*pStm
)
542 CComPtr
<IPersistStream
> pPStm
;
545 ASSERT(m_BandSite
!= NULL
);
547 /* We implement the undocumented COM interface IBandSiteStreamCallback
548 that the shell will query so that we can intercept and custom-load
549 the task band when it finds the task band's CLSID (which is internal).
550 This way we can prevent the shell from attempting to CoCreateInstance
551 the (internal) task band, resulting in a failure... */
552 hRet
= m_BandSite
->QueryInterface(IID_PPV_ARG(IPersistStream
, &pPStm
));
555 hRet
= pPStm
->Load(pStm
);
556 TRACE("->Load() returned 0x%x\n", hRet
);
562 virtual IStream
* GetUserBandsStream(IN DWORD grfMode
)
565 IStream
*Stream
= NULL
;
567 if (RegCreateKeyW(hkExplorer
,
569 &hkStreams
) == ERROR_SUCCESS
)
571 Stream
= SHOpenRegStreamW(hkStreams
,
576 RegCloseKey(hkStreams
);
582 virtual IStream
* GetDefaultBandsStream(IN DWORD grfMode
)
585 IStream
*Stream
= NULL
;
587 if (RegCreateKeyW(HKEY_LOCAL_MACHINE
,
588 L
"Software\\Microsoft\\Windows\\CurrentVersion\\Explorer\\Streams",
589 &hkStreams
) == ERROR_SUCCESS
)
591 Stream
= SHOpenRegStreamW(hkStreams
,
596 RegCloseKey(hkStreams
);
602 virtual HRESULT
Load()
607 /* Try to load the user's settings */
608 pStm
= GetUserBandsStream(STGM_READ
);
611 hRet
= LoadFromStream(pStm
);
613 TRACE("Loaded user bands settings: 0x%x\n", hRet
);
619 /* If the user's settings couldn't be loaded, try with
620 default settings (ie. when the user logs in for the
622 if (!SUCCEEDED(hRet
))
624 pStm
= GetDefaultBandsStream(STGM_READ
);
627 hRet
= LoadFromStream(pStm
);
629 TRACE("Loaded default user bands settings: 0x%x\n", hRet
);
639 HRESULT
_Init(IN ITrayWindow
*tray
, IN IDeskBand
* pTaskBand
)
641 CComPtr
<IDeskBarClient
> pDbc
;
642 CComPtr
<IDeskBand
> pDb
;
643 CComPtr
<IOleWindow
> pOw
;
647 m_TaskBand
= pTaskBand
;
649 /* Create the RebarBandSite */
650 hRet
= _CBandSite_CreateInstance(static_cast<IBandSite
*>(this), IID_PPV_ARG(IUnknown
, &m_Inner
));
651 if (FAILED_UNEXPECTEDLY(hRet
))
654 hRet
= m_Inner
->QueryInterface(IID_PPV_ARG(IBandSite
, &m_BandSite
));
655 if (FAILED_UNEXPECTEDLY(hRet
))
658 hRet
= m_Inner
->QueryInterface(IID_PPV_ARG(IWinEventHandler
, &m_WindowEventHandler
));
659 if (FAILED_UNEXPECTEDLY(hRet
))
662 hRet
= m_Inner
->QueryInterface(IID_PPV_ARG(IDeskBarClient
, &pDbc
));
663 if (FAILED_UNEXPECTEDLY(hRet
))
669 /* Crete the rebar in the tray */
670 hRet
= pDbc
->SetDeskBarSite(tray
);
671 if (FAILED_UNEXPECTEDLY(hRet
))
674 hRet
= pDbc
->GetWindow(&m_Rebar
);
675 if (FAILED_UNEXPECTEDLY(hRet
))
678 SetWindowStyle(m_Rebar
, RBS_BANDBORDERS
, 0);
680 /* Set the Desk Bar mode to the current one */
682 /* FIXME: We need to set the mode (and update) whenever the user docks
683 the tray window to another monitor edge! */
684 if (!m_Tray
->IsHorizontal())
685 dwMode
= DBIF_VIEWMODE_VERTICAL
;
687 hRet
= pDbc
->SetModeDBC(dwMode
);
689 /* Load the saved state of the task band site */
690 /* FIXME: We should delay loading shell extensions, also see DBID_DELAYINIT */
693 /* Add the task bar band if it hasn't been added while loading */
696 hRet
= m_BandSite
->AddBand(m_TaskBand
);
697 if (FAILED_UNEXPECTEDLY(hRet
))
701 /* Should we send this after showing it? */
704 /* FIXME: When should we send this? Does anyone care anyway? */
707 /* Activate the band site */
713 /*******************************************************************/
715 HRESULT
CTrayBandSite_CreateInstance(IN ITrayWindow
*tray
, IN IDeskBand
* pTaskBand
, OUT ITrayBandSite
** pBandSite
)
719 CTrayBandSite
* tb
= new CTrayBandSite();
725 hr
= tb
->_Init(tray
, pTaskBand
);
726 if (FAILED_UNEXPECTEDLY(hr
))