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>
27 /*****************************************************************************
28 ** ITrayBandSite ************************************************************
29 *****************************************************************************/
31 // 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
32 // it works just fine this way.
36 public IBandSiteStreamCallback
37 /* TODO: IWinEventHandler */
39 volatile LONG m_RefCount
;
41 CComPtr
<ITrayWindow
> Tray
;
43 CComPtr
<IUnknown
> punkInner
;
44 CComPtr
<IBandSite
> BandSite
;
45 CComPtr
<ITaskBand
> TaskBand
;
46 CComPtr
<IWinEventHandler
> WindowEventHandler
;
47 CComPtr
<IContextMenu
> ContextMenu
;
62 virtual ULONG STDMETHODCALLTYPE
AddRef()
64 return InterlockedIncrement(&m_RefCount
);
67 virtual ULONG STDMETHODCALLTYPE
Release()
69 ULONG Ret
= InterlockedDecrement(&m_RefCount
);
77 virtual HRESULT STDMETHODCALLTYPE
QueryInterface(IN REFIID riid
, OUT LPVOID
*ppvObj
)
82 if (IsEqualIID(riid
, IID_IUnknown
) || IsEqualIID(riid
, IID_IBandSiteStreamCallback
))
84 // return IBandSiteStreamCallback's IUnknown
85 *ppvObj
= static_cast<IBandSiteStreamCallback
*>(this);
87 else if (IsEqualIID(riid
, IID_IBandSite
))
89 *ppvObj
= static_cast<IBandSite
*>(this);
91 else if (IsEqualIID(riid
, IID_IWinEventHandler
))
93 TRACE("ITaskBandSite: IWinEventHandler queried!\n");
97 else if (punkInner
!= NULL
)
99 return punkInner
->QueryInterface(riid
, ppvObj
);
104 return E_NOINTERFACE
;
118 virtual ~CTrayBandSite() { }
120 virtual HRESULT STDMETHODCALLTYPE
OnLoad(
121 IN OUT IStream
*pStm
,
125 LARGE_INTEGER liPosZero
;
126 ULARGE_INTEGER liCurrent
;
131 /* NOTE: Callback routine called by the shell while loading the task band
132 stream. We use it to intercept the default behavior when the task
133 band is loaded from the stream.
135 NOTE: riid always points to IID_IUnknown! This is because the shell hasn't
136 read anything from the stream and therefore doesn't know what CLSID
137 it's dealing with. We'll have to find it out ourselves by reading
138 the GUID from the stream. */
140 /* Read the current position of the stream, we'll have to reset it everytime
141 we read a CLSID that's not the task band... */
142 ZeroMemory(&liPosZero
,
144 hRet
= pStm
->Seek(liPosZero
, STREAM_SEEK_CUR
, &liCurrent
);
148 /* Now let's read the CLSID from the stream and see if it's our task band */
149 hRet
= pStm
->Read(&clsid
, (ULONG
)sizeof(clsid
), &ulRead
);
151 if (SUCCEEDED(hRet
) && ulRead
== sizeof(clsid
))
153 if (IsEqualGUID(clsid
, CLSID_ITaskBand
))
155 ASSERT(TaskBand
!= NULL
);
156 /* We're trying to load the task band! Let's create it... */
158 hRet
= TaskBand
->QueryInterface(
163 /* Load the stream */
164 TRACE("IBandSiteStreamCallback::OnLoad intercepted the task band CLSID!\n");
172 /* Reset the position and let the shell do all the work for us */
174 *(LARGE_INTEGER
*) &liCurrent
,
179 /* Let the shell handle everything else for us :) */
180 hRet
= OleLoadFromStream(pStm
,
185 if (!SUCCEEDED(hRet
))
187 TRACE("IBandSiteStreamCallback::OnLoad(0x%p, 0x%p, 0x%p) returns 0x%x\n", pStm
, riid
, pvObj
, hRet
);
193 virtual HRESULT STDMETHODCALLTYPE
OnSave(
194 IN OUT IUnknown
*pUnk
,
195 IN OUT IStream
*pStm
)
197 /* NOTE: Callback routine called by the shell while saving the task band
198 stream. We use it to intercept the default behavior when the task
199 band is saved to the stream */
200 /* FIXME: Implement */
201 TRACE("IBandSiteStreamCallback::OnSave(0x%p, 0x%p) returns E_NOTIMPL\n", pUnk
, pStm
);
205 virtual HRESULT STDMETHODCALLTYPE
IsTaskBand(
208 return IsSameObject((IUnknown
*) BandSite
,
212 virtual HRESULT STDMETHODCALLTYPE
ProcessMessage(
217 OUT LRESULT
*plResult
)
221 ASSERT(hWndRebar
!= NULL
);
223 /* Custom task band behavior */
228 const NMHDR
*nmh
= (const NMHDR
*) lParam
;
230 if (nmh
->hwndFrom
== hWndRebar
)
236 LPNMMOUSE nmm
= (LPNMMOUSE
) lParam
;
238 if (nmm
->dwHitInfo
== RBHT_CLIENT
|| nmm
->dwHitInfo
== RBHT_NOWHERE
||
239 nmm
->dwItemSpec
== (DWORD_PTR
) -1)
241 /* Make the rebar control appear transparent so the user
242 can drag the tray window */
243 *plResult
= HTTRANSPARENT
;
249 /* Deny if an Administrator disabled this "feature" */
250 *plResult
= (SHRestricted(REST_NOMOVINGBAND
) != 0);
255 //TRACE("ITrayBandSite::ProcessMessage: WM_NOTIFY for 0x%p, From: 0x%p, Code: NM_FIRST-%u...\n", hWnd, nmh->hwndFrom, NM_FIRST - nmh->code);
260 /* Forward to the shell's IWinEventHandler interface to get the default shell behavior! */
261 if (!WindowEventHandler
)
264 /*TRACE("Calling IWinEventHandler::ProcessMessage(0x%p, 0x%x, 0x%p, 0x%p, 0x%p) hWndRebar=0x%p\n", hWnd, uMsg, wParam, lParam, plResult, hWndRebar);*/
265 hRet
= WindowEventHandler
->OnWinEvent(
271 if (FAILED_UNEXPECTEDLY(hRet
))
273 if (uMsg
== WM_NOTIFY
)
275 const NMHDR
*nmh
= (const NMHDR
*) lParam
;
276 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
);
280 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
);
287 virtual HRESULT STDMETHODCALLTYPE
AddContextMenus(
293 OUT IContextMenu
**ppcm
)
298 if (ContextMenu
== NULL
)
300 /* Cache the context menu so we don't need to CoCreateInstance all the time... */
301 hRet
= CoCreateInstance(CLSID_IShellBandSiteMenu
, NULL
, CLSCTX_INPROC_SERVER
, IID_PPV_ARG(IShellService
, &pSs
));
302 TRACE("CoCreateInstance(CLSID_IShellBandSiteMenu) for IShellService returned: 0x%x\n", hRet
);
303 if (!SUCCEEDED(hRet
))
306 hRet
= pSs
->SetOwner((IBandSite
*)this);
307 if (!SUCCEEDED(hRet
))
313 hRet
= pSs
->QueryInterface(IID_PPV_ARG(IContextMenu
, &ContextMenu
));
317 if (!SUCCEEDED(hRet
))
323 ContextMenu
->AddRef();
327 /* Add the menu items */
328 return ContextMenu
->QueryContextMenu(
336 virtual HRESULT STDMETHODCALLTYPE
Lock(
339 BOOL bPrevLocked
= Locked
;
343 ASSERT(BandSite
!= NULL
);
345 if (bPrevLocked
!= bLock
)
349 bsi
.dwMask
= BSIM_STYLE
;
350 bsi
.dwStyle
= (Locked
? BSIS_LOCKED
| BSIS_NOGRIPPER
: BSIS_AUTOGRIPPER
);
352 hRet
= BandSite
->SetBandSiteInfo(&bsi
);
364 /*******************************************************************/
366 virtual HRESULT STDMETHODCALLTYPE
AddBand(
369 IOleCommandTarget
*pOct
;
372 hRet
= punk
->QueryInterface(IID_PPV_ARG(IOleCommandTarget
, &pOct
));
375 /* Send the DBID_DELAYINIT command to initialize the band to be added */
376 /* FIXME: Should be delayed */
387 return BandSite
->AddBand(
391 virtual HRESULT STDMETHODCALLTYPE
EnumBands(
393 OUT DWORD
*pdwBandID
)
395 return BandSite
->EnumBands(
400 virtual HRESULT STDMETHODCALLTYPE
QueryBand(
402 OUT IDeskBand
**ppstb
,
408 IDeskBand
*pstb
= NULL
;
410 hRet
= BandSite
->QueryBand(
419 hRet
= IsSameObject(pstb
, TaskBand
);
422 /* Add the BSSF_UNDELETEABLE flag to pdwState because the task bar band shouldn't be deletable */
423 if (pdwState
!= NULL
)
424 *pdwState
|= BSSF_UNDELETEABLE
;
426 else if (!SUCCEEDED(hRet
))
435 else if (ppstb
!= NULL
)
441 virtual HRESULT STDMETHODCALLTYPE
SetBandState(
446 return BandSite
->SetBandState(dwBandID
, dwMask
, dwState
);
449 virtual HRESULT STDMETHODCALLTYPE
RemoveBand(
452 return BandSite
->RemoveBand(dwBandID
);
455 virtual HRESULT STDMETHODCALLTYPE
GetBandObject(
460 return BandSite
->GetBandObject(dwBandID
, riid
, ppv
);
463 virtual HRESULT STDMETHODCALLTYPE
SetBandSiteInfo(
464 IN
const BANDSITEINFO
*pbsinfo
)
466 return BandSite
->SetBandSiteInfo(pbsinfo
);
469 virtual HRESULT STDMETHODCALLTYPE
GetBandSiteInfo(
470 IN OUT BANDSITEINFO
*pbsinfo
)
472 return BandSite
->GetBandSiteInfo(pbsinfo
);
475 virtual BOOL
HasTaskBand()
477 ASSERT(TaskBand
!= NULL
);
479 return SUCCEEDED(TaskBand
->GetRebarBandID(
483 virtual HRESULT
AddTaskBand()
486 /* FIXME: This is the code for the simple taskbar */
487 IObjectWithSite
*pOws
;
490 hRet
= TaskBand
->QueryInterface(
491 &IID_IObjectWithSite
,
495 hRet
= pOws
->SetSite(
496 (IUnknown
*)TaskBand
);
505 return BandSite
->AddBand(TaskBand
);
512 virtual HRESULT
Update()
514 IOleCommandTarget
*pOct
;
517 hRet
= punkInner
->QueryInterface(IID_PPV_ARG(IOleCommandTarget
, &pOct
));
520 /* Send the DBID_BANDINFOCHANGED command to update the band site */
523 DBID_BANDINFOCHANGED
,
534 virtual VOID
BroadcastOleCommandExec(const GUID
*pguidCmdGroup
,
540 IOleCommandTarget
*pOct
;
544 /* Enumerate all bands */
545 while (SUCCEEDED(BandSite
->EnumBands(uBand
, &dwBandID
)))
547 if (SUCCEEDED(BandSite
->GetBandObject(dwBandID
, IID_PPV_ARG(IOleCommandTarget
, &pOct
))))
549 /* Execute the command */
564 virtual HRESULT
FinishInit()
566 /* Broadcast the DBID_FINISHINIT command */
567 BroadcastOleCommandExec(&IID_IDeskBand
, DBID_FINISHINIT
, 0, NULL
, NULL
);
572 virtual HRESULT
Show(
575 IDeskBarClient
*pDbc
;
578 hRet
= BandSite
->QueryInterface(IID_PPV_ARG(IDeskBarClient
, &pDbc
));
581 hRet
= pDbc
->UIActivateDBC(
582 bShow
? DBC_SHOW
: DBC_HIDE
);
589 virtual HRESULT
LoadFromStream(IN OUT IStream
*pStm
)
591 IPersistStream
*pPStm
;
594 ASSERT(BandSite
!= NULL
);
596 /* We implement the undocumented COM interface IBandSiteStreamCallback
597 that the shell will query so that we can intercept and custom-load
598 the task band when it finds the task band's CLSID (which is internal).
599 This way we can prevent the shell from attempting to CoCreateInstance
600 the (internal) task band, resulting in a failure... */
601 hRet
= BandSite
->QueryInterface(IID_PPV_ARG(IPersistStream
, &pPStm
));
606 TRACE("->Load() returned 0x%x\n", hRet
);
614 GetUserBandsStream(IN DWORD grfMode
)
617 IStream
*Stream
= NULL
;
619 if (RegCreateKey(hkExplorer
,
621 &hkStreams
) == ERROR_SUCCESS
)
623 Stream
= SHOpenRegStream(hkStreams
,
625 TEXT("TaskbarWinXP"),
628 RegCloseKey(hkStreams
);
635 GetDefaultBandsStream(IN DWORD grfMode
)
638 IStream
*Stream
= NULL
;
640 if (RegCreateKey(HKEY_LOCAL_MACHINE
,
641 TEXT("Software\\Microsoft\\Windows\\CurrentVersion\\Explorer\\Streams"),
642 &hkStreams
) == ERROR_SUCCESS
)
644 Stream
= SHOpenRegStream(hkStreams
,
646 TEXT("Default Taskbar"),
649 RegCloseKey(hkStreams
);
655 virtual HRESULT
Load()
660 /* Try to load the user's settings */
661 pStm
= GetUserBandsStream(STGM_READ
);
664 hRet
= LoadFromStream(pStm
);
666 TRACE("Loaded user bands settings: 0x%x\n", hRet
);
672 /* If the user's settings couldn't be loaded, try with
673 default settings (ie. when the user logs in for the
675 if (!SUCCEEDED(hRet
))
677 pStm
= GetDefaultBandsStream(STGM_READ
);
680 hRet
= LoadFromStream(pStm
);
682 TRACE("Loaded default user bands settings: 0x%x\n", hRet
);
692 HRESULT
_Init(IN OUT ITrayWindow
*tray
, OUT HWND
*phWndRebar
, OUT HWND
*phwndTaskSwitch
)
694 IDeskBarClient
*pDbc
;
700 *phwndTaskSwitch
= NULL
;
704 /* Create a RebarBandSite provided by the shell */
705 hRet
= CoCreateInstance(CLSID_RebarBandSite
,
706 static_cast<IBandSite
*>(this),
707 CLSCTX_INPROC_SERVER
,
708 IID_PPV_ARG(IUnknown
, &punkInner
));
709 if (!SUCCEEDED(hRet
))
714 hRet
= punkInner
->QueryInterface(IID_PPV_ARG(IBandSite
, &BandSite
));
715 if (!SUCCEEDED(hRet
))
720 hRet
= punkInner
->QueryInterface(IID_PPV_ARG(IWinEventHandler
, &WindowEventHandler
));
721 if (!SUCCEEDED(hRet
))
726 TaskBand
= CreateTaskBand(Tray
);
727 if (TaskBand
!= NULL
)
729 /* Add the task band to the site */
730 hRet
= BandSite
->QueryInterface(IID_PPV_ARG(IDeskBarClient
, &pDbc
));
733 hRet
= TaskBand
->QueryInterface(IID_PPV_ARG(IOleWindow
, &pOw
));
736 /* We cause IDeskBarClient to create the rebar control by passing the new
737 task band to it. The band reports the tray window handle as window handle
738 so that IDeskBarClient knows the parent window of the Rebar control that
739 it wants to create. */
740 hRet
= pDbc
->SetDeskBarSite(pOw
);
744 /* The Rebar control is now created, we can query the window handle */
745 hRet
= pDbc
->GetWindow(&hWndRebar
);
749 /* We need to manually remove the RBS_BANDBORDERS style! */
750 SetWindowStyle(hWndRebar
, RBS_BANDBORDERS
, 0);
761 /* Set the Desk Bar mode to the current one */
763 /* FIXME: We need to set the mode (and update) whenever the user docks
764 the tray window to another monitor edge! */
766 if (!Tray
->IsHorizontal())
767 dwMode
= DBIF_VIEWMODE_VERTICAL
;
769 hRet
= pDbc
->SetModeDBC(dwMode
);
775 /* Load the saved state of the task band site */
776 /* FIXME: We should delay loading shell extensions, also see DBID_DELAYINIT */
779 /* Add the task bar band if it hasn't been added already */
780 hRet
= AddTaskBand();
783 hRet
= TaskBand
->QueryInterface(IID_PPV_ARG(IDeskBand
, &pDb
));
786 hRet
= pDb
->GetWindow(phwndTaskSwitch
);
787 if (!SUCCEEDED(hRet
))
788 *phwndTaskSwitch
= NULL
;
794 /* Should we send this after showing it? */
797 /* FIXME: When should we send this? Does anyone care anyway? */
800 /* Activate the band site */
805 *phWndRebar
= hWndRebar
;
810 /*******************************************************************/
813 CreateTrayBandSite(IN OUT ITrayWindow
*Tray
,
814 OUT HWND
*phWndRebar
,
815 OUT HWND
*phWndTaskSwitch
)
819 CTrayBandSite
* tb
= new CTrayBandSite();
826 hr
= tb
->_Init(Tray
, phWndRebar
, phWndTaskSwitch
);
827 if (FAILED_UNEXPECTEDLY(hr
))