ReactOS 0.4.15-dev-7934-g1dc8d80
CMenuSFToolbar Class Reference

#include <CMenuToolbars.h>

Inheritance diagram for CMenuSFToolbar:
Collaboration diagram for CMenuSFToolbar:

Public Member Functions

 CMenuSFToolbar (CMenuBand *menuBand)
 
virtual ~CMenuSFToolbar ()
 
HRESULT SetShellFolder (IShellFolder *psf, LPCITEMIDLIST pidlFolder, HKEY hKey, DWORD dwFlags)
 
HRESULT GetShellFolder (DWORD *pdwFlags, LPITEMIDLIST *ppidl, REFIID riid, void **ppv)
 
virtual HRESULT FillToolbar (BOOL clearFirst=FALSE) override
 
- Public Member Functions inherited from CMenuToolbarBase
 CMenuToolbarBase (CMenuBand *menuBand, BOOL usePager)
 
virtual ~CMenuToolbarBase ()
 
HRESULT IsWindowOwner (HWND hwnd)
 
HRESULT CreateToolbar (HWND hwndParent, DWORD dwFlags)
 
HRESULT GetWindow (HWND *phwnd)
 
HRESULT ShowDW (BOOL fShow)
 
HRESULT Close ()
 
HRESULT OnWinEvent (HWND hWnd, UINT uMsg, WPARAM wParam, LPARAM lParam, LRESULT *theResult)
 
HRESULT ChangeHotItem (CMenuToolbarBase *toolbar, INT item, DWORD dwFlags)
 
HRESULT ChangePopupItem (CMenuToolbarBase *toolbar, INT item)
 
HRESULT PopupSubMenu (UINT itemId, UINT index, IShellMenu *childShellMenu, BOOL keyInitiated)
 
HRESULT PopupSubMenu (UINT itemId, UINT index, HMENU menu)
 
HRESULT TrackContextMenu (IContextMenu *contextMenu, POINT pt)
 
HRESULT KeyboardItemChange (DWORD changeType)
 
HRESULT PrepareExecuteItem (INT iItem)
 
HRESULT ExecuteItem ()
 
HRESULT GetSizes (SIZE *pMinSize, SIZE *pMaxSize, SIZE *pIntegralSize)
 
HRESULT SetPosSize (int x, int y, int cx, int cy)
 
void InvalidateDraw ()
 
HRESULT DisableMouseTrack (BOOL bDisable)
 
virtual HRESULT FillToolbar (BOOL clearFirst=FALSE)=0
 
HRESULT CancelCurrentPopup ()
 
HRESULT PopupItem (INT iItem, BOOL keyInitiated)
 
HRESULT GetDataFromId (INT iItem, INT *pIndex, DWORD_PTR *pData)
 
HRESULT KillPopupTimer ()
 
HRESULT MenuBarMouseDown (INT iIndex, BOOL isLButton)
 
HRESULT MenuBarMouseUp (INT iIndex, BOOL isLButton)
 
HRESULT ProcessClick (INT iItem)
 
HRESULT ProcessContextMenu (INT iItem)
 
HRESULT BeforeCancelPopup ()
 

Protected Member Functions

virtual HRESULT OnDeletingButton (const NMTOOLBAR *tb) override
 
virtual HRESULT InternalGetTooltip (INT iItem, INT index, DWORD_PTR dwData, LPWSTR pszText, INT cchTextMax) override
 
virtual HRESULT InternalExecuteItem (INT iItem, INT index, DWORD_PTR dwData) override
 
virtual HRESULT InternalPopupItem (INT iItem, INT index, DWORD_PTR dwData, BOOL keyInitiated) override
 
virtual HRESULT InternalHasSubMenu (INT iItem, INT index, DWORD_PTR dwData) override
 
virtual HRESULT InternalContextMenu (INT iItem, INT index, DWORD_PTR dwData, POINT pt) override
 
- Protected Member Functions inherited from CMenuToolbarBase
virtual HRESULT OnDeletingButton (const NMTOOLBAR *tb) PURE
 
virtual HRESULT InternalGetTooltip (INT iItem, INT index, DWORD_PTR dwData, LPWSTR pszText, INT cchTextMax) PURE
 
virtual HRESULT InternalExecuteItem (INT iItem, INT index, DWORD_PTR dwData) PURE
 
virtual HRESULT InternalPopupItem (INT iItem, INT index, DWORD_PTR dwData, BOOL keyInitiated) PURE
 
virtual HRESULT InternalHasSubMenu (INT iItem, INT index, DWORD_PTR dwData) PURE
 
virtual HRESULT InternalContextMenu (INT iItem, INT index, DWORD_PTR dwData, POINT pt) PURE
 
HRESULT AddButton (DWORD commandId, LPCWSTR caption, BOOL hasSubMenu, INT iconId, DWORD_PTR buttonData, BOOL last)
 
HRESULT AddSeparator (BOOL last)
 
HRESULT AddPlaceholder ()
 
HRESULT ClearToolbar ()
 
HWND GetToolbar ()
 

Private Attributes

CComPtr< IShellFolderm_shellFolder
 
LPCITEMIDLIST m_idList
 
HKEY m_hKey
 

Additional Inherited Members

- Protected Attributes inherited from CMenuToolbarBase
CMenuBandm_menuBand
 
DWORD m_dwMenuFlags
 
BOOL m_hasSizes
 
SIZE m_idealSize
 
SIZE m_itemSize
 
BOOL m_usePager
 
CMenuToolbarBasem_hotBar
 
INT m_hotItem
 
CMenuToolbarBasem_popupBar
 
INT m_popupItem
 
DWORD m_initFlags
 
BOOL m_isTrackingPopup
 
INT m_executeIndex
 
INT m_executeItem
 
DWORD_PTR m_executeData
 
BOOL m_cancelingPopup
 

Detailed Description

Definition at line 167 of file CMenuToolbars.h.

Constructor & Destructor Documentation

◆ CMenuSFToolbar()

CMenuSFToolbar::CMenuSFToolbar ( CMenuBand menuBand)

Definition at line 1300 of file CMenuToolbars.cpp.

1300 :
1301 CMenuToolbarBase(menuBand, TRUE),
1303 m_idList(NULL),
1304 m_hKey(NULL)
1305{
1306}
LPCITEMIDLIST m_idList
CComPtr< IShellFolder > m_shellFolder
#define NULL
Definition: types.h:112
#define TRUE
Definition: types.h:120

◆ ~CMenuSFToolbar()

CMenuSFToolbar::~CMenuSFToolbar ( )
virtual

Definition at line 1308 of file CMenuToolbars.cpp.

1309{
1310}

Member Function Documentation

◆ FillToolbar()

HRESULT CMenuSFToolbar::FillToolbar ( BOOL  clearFirst = FALSE)
overridevirtual

Implements CMenuToolbarBase.

Definition at line 1338 of file CMenuToolbars.cpp.

1339{
1340 HRESULT hr;
1341
1342 CComPtr<IEnumIDList> eidl;
1343 hr = m_shellFolder->EnumObjects(GetToolbar(), SHCONTF_FOLDERS | SHCONTF_NONFOLDERS, &eidl);
1345 return hr;
1346
1347 HDPA dpaSort = DPA_Create(10);
1348
1350 hr = eidl->Next(1, &item, NULL);
1351 while (hr == S_OK)
1352 {
1353 if (m_menuBand->_CallCBWithItemPidl(item, 0x10000000, 0, 0) == S_FALSE)
1354 {
1355 DPA_AppendPtr(dpaSort, item);
1356 }
1357 else
1358 {
1360 }
1361
1362 hr = eidl->Next(1, &item, NULL);
1363 }
1364
1365 // If no items were added, show the "empty" placeholder
1366 if (DPA_GetPtrCount(dpaSort) == 0)
1367 {
1368 DPA_Destroy(dpaSort);
1369 return AddPlaceholder();
1370 }
1371
1372 TRACE("FillToolbar added %d items to the DPA\n", DPA_GetPtrCount(dpaSort));
1373
1375
1376 BOOL StartMenuAdminTools = SHRegGetBoolUSValueW(
1377 L"Software\\Microsoft\\Windows\\CurrentVersion\\Explorer\\Advanced",
1378 L"StartMenuAdminTools", FALSE, TRUE);
1379
1380 BOOL bMustHideAdminTools = IsPidlPrograms(m_idList) && !StartMenuAdminTools;
1381 TRACE("StartMenuAdminTools: %d\n", StartMenuAdminTools);
1382 TRACE("bMustHideAdminTools: %d\n", bMustHideAdminTools);
1383
1384 WCHAR szAdminTools[MAX_PATH];
1385 if (bMustHideAdminTools)
1386 {
1388 szAdminTools, _countof(szAdminTools));
1389 }
1390
1391 for (int i = 0; i<DPA_GetPtrCount(dpaSort);)
1392 {
1393 item = (LPITEMIDLIST)DPA_GetPtr(dpaSort, i);
1394
1395 STRRET sr = { STRRET_CSTR };
1396 hr = m_shellFolder->GetDisplayNameOf(item, SIGDN_NORMALDISPLAY, &sr);
1398 {
1399 DPA_Destroy(dpaSort);
1400 return hr;
1401 }
1402
1403 PWSTR MenuString;
1404 StrRetToStr(&sr, NULL, &MenuString);
1405
1406 if (bMustHideAdminTools && lstrcmpiW(MenuString, szAdminTools) == 0)
1407 {
1408 ++i;
1409 CoTaskMemFree(MenuString);
1410 continue;
1411 }
1412
1413 INT indexOpen = 0;
1415
1416 LPCITEMIDLIST itemc = item;
1417
1418 SFGAOF attrs = SFGAO_FOLDER;
1419 hr = m_shellFolder->GetAttributesOf(1, &itemc, &attrs);
1420
1421 DWORD_PTR dwData = reinterpret_cast<DWORD_PTR>(item);
1422
1423 // Fetch next item already, so we know if the current one is the last
1424 i++;
1425
1426 AddButton(i, MenuString, attrs & SFGAO_FOLDER, index, dwData, i >= DPA_GetPtrCount(dpaSort));
1427
1428 CoTaskMemFree(MenuString);
1429 }
1430
1431 DPA_Destroy(dpaSort);
1432 return hr;
1433}
int CALLBACK PidlListSort(void *item1, void *item2, LPARAM lParam)
static BOOL IsPidlPrograms(LPCITEMIDLIST pidlTarget)
HRESULT _CallCBWithItemPidl(LPITEMIDLIST pidl, UINT uMsg, WPARAM wParam, LPARAM lParam)
Definition: CMenuBand.cpp:773
HRESULT AddPlaceholder()
CMenuBand * m_menuBand
Definition: CMenuToolbars.h:39
HRESULT AddButton(DWORD commandId, LPCWSTR caption, BOOL hasSubMenu, INT iconId, DWORD_PTR buttonData, BOOL last)
#define FALSE
Definition: types.h:117
BOOL WINAPI DPA_Sort(HDPA hdpa, PFNDPACOMPARE pfnCompare, LPARAM lParam)
Definition: dpa.c:813
BOOL WINAPI DPA_Destroy(HDPA hdpa)
Definition: dpa.c:396
HDPA WINAPI DPA_Create(INT nGrow)
Definition: dpa.c:950
#define MAX_PATH
Definition: compat.h:34
#define FAILED_UNEXPECTEDLY(hr)
Definition: precomp.h:121
HMODULE WINAPI GetModuleHandleW(LPCWSTR lpModuleName)
Definition: loader.c:838
BOOL WINAPI SHRegGetBoolUSValueW(LPCWSTR pszSubKey, LPCWSTR pszValue, BOOL fIgnoreHKCU, BOOL fDefault)
Definition: reg.c:770
static IShellFolder IShellItem **static IBindCtx LPITEMIDLIST SFGAOF
Definition: ebrowser.c:83
unsigned int BOOL
Definition: ntddk_ex.h:94
GLuint index
Definition: glext.h:6031
GLsizei GLenum const GLvoid GLsizei GLenum GLbyte GLbyte GLbyte GLdouble GLdouble GLdouble GLfloat GLfloat GLfloat GLint GLint GLint GLshort GLshort GLshort GLubyte GLubyte GLubyte GLuint GLuint GLuint GLushort GLushort GLushort GLbyte GLbyte GLbyte GLbyte GLdouble GLdouble GLdouble GLdouble GLfloat GLfloat GLfloat GLfloat GLint GLint GLint GLint GLshort GLshort GLshort GLshort GLubyte GLubyte GLubyte GLubyte GLuint GLuint GLuint GLuint GLushort GLushort GLushort GLushort GLboolean const GLdouble const GLfloat const GLint const GLshort const GLbyte const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLdouble const GLfloat const GLfloat const GLint const GLint const GLshort const GLshort const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLfloat const GLint const GLshort GLenum GLenum GLenum GLfloat GLenum GLint GLenum GLenum GLenum GLfloat GLenum GLenum GLint GLenum GLfloat GLenum GLint GLint GLushort GLenum GLenum GLfloat GLenum GLenum GLint GLfloat const GLubyte GLenum GLenum GLenum const GLfloat GLenum GLenum const GLint GLenum GLint GLint GLsizei GLsizei GLint GLenum GLenum const GLvoid GLenum GLenum const GLfloat GLenum GLenum const GLint GLenum GLenum const GLdouble GLenum GLenum const GLfloat GLenum GLenum const GLint GLsizei GLuint GLfloat GLuint GLbitfield GLfloat GLint GLuint GLboolean GLenum GLfloat GLenum GLbitfield GLenum GLfloat GLfloat GLint GLint const GLfloat GLenum GLfloat GLfloat GLint GLint GLfloat GLfloat GLint GLint const GLfloat GLint GLfloat GLfloat GLint GLfloat GLfloat GLint GLfloat GLfloat const GLdouble const GLfloat const GLdouble const GLfloat GLint i
Definition: glfuncs.h:248
int WINAPI SHMapPIDLToSystemImageListIndex(IShellFolder *sh, LPCITEMIDLIST pidl, int *pIndex)
Definition: iconcache.cpp:766
VOID WINAPI CoTaskMemFree(LPVOID ptr)
Definition: ifs.c:442
#define S_OK
Definition: intsafe.h:52
int WINAPI lstrcmpiW(LPCWSTR lpString1, LPCWSTR lpString2)
Definition: lstring.c:194
static HANDLE ULONG_PTR dwData
Definition: file.c:35
static ATOM item
Definition: dde.c:856
#define L(x)
Definition: ntvdm.h:50
#define DPA_AppendPtr(hdpa, pitem)
Definition: commctrl.h:4958
#define DPA_GetPtrCount(hdpa)
Definition: commctrl.h:4955
#define DPA_GetPtr
Definition: commctrl.h:5
HRESULT hr
Definition: shlfolder.c:183
#define StrRetToStr
Definition: shlwapi.h:1751
#define IDS_ADMINISTRATIVETOOLS
Definition: shresdef.h:273
ITEMIDLIST UNALIGNED * LPITEMIDLIST
Definition: shtypes.idl:41
@ STRRET_CSTR
Definition: shtypes.idl:87
const ITEMIDLIST UNALIGNED * LPCITEMIDLIST
Definition: shtypes.idl:42
#define _countof(array)
Definition: sndvol32.h:68
#define TRACE(s)
Definition: solgame.cpp:4
Definition: dpa.c:49
uint16_t * PWSTR
Definition: typedefs.h:56
uint32_t DWORD_PTR
Definition: typedefs.h:65
int32_t INT
Definition: typedefs.h:58
LONG_PTR LPARAM
Definition: windef.h:208
#define S_FALSE
Definition: winerror.h:2357
int WINAPI LoadStringW(_In_opt_ HINSTANCE hInstance, _In_ UINT uID, _Out_writes_to_(cchBufferMax, return+1) LPWSTR lpBuffer, _In_ int cchBufferMax)
__wchar_t WCHAR
Definition: xmlstorage.h:180

Referenced by CMenuBand::SetShellFolder(), and CMenuBand::SetSite().

◆ GetShellFolder()

HRESULT CMenuSFToolbar::GetShellFolder ( DWORD pdwFlags,
LPITEMIDLIST ppidl,
REFIID  riid,
void **  ppv 
)

Definition at line 1461 of file CMenuToolbars.cpp.

1462{
1463 HRESULT hr;
1464
1465 hr = m_shellFolder->QueryInterface(riid, ppv);
1467 return hr;
1468
1469 if (pdwFlags)
1470 *pdwFlags = m_dwMenuFlags;
1471
1472 if (ppidl)
1473 {
1474 LPITEMIDLIST pidl = NULL;
1475
1476 if (m_idList)
1477 {
1478 pidl = ILClone(m_idList);
1479 if (!pidl)
1480 {
1481 ERR("ILClone failed!\n");
1482 (*reinterpret_cast<IUnknown**>(ppv))->Release();
1483 return E_FAIL;
1484 }
1485 }
1486
1487 *ppidl = pidl;
1488 }
1489
1490 return hr;
1491}
#define ERR(fmt,...)
Definition: debug.h:110
#define E_FAIL
Definition: ddrawi.h:102
REFIID riid
Definition: atlbase.h:39
REFIID LPVOID * ppv
Definition: atlbase.h:39
LPITEMIDLIST WINAPI ILClone(LPCITEMIDLIST pidl)
Definition: pidl.c:237

Referenced by CMenuBand::_CallCB(), and CMenuBand::GetShellFolder().

◆ InternalContextMenu()

HRESULT CMenuSFToolbar::InternalContextMenu ( INT  iItem,
INT  index,
DWORD_PTR  dwData,
POINT  pt 
)
overrideprotectedvirtual

Reimplemented from CMenuToolbarBase.

Definition at line 1493 of file CMenuToolbars.cpp.

1494{
1495 HRESULT hr;
1496 CComPtr<IContextMenu> contextMenu = NULL;
1497 LPCITEMIDLIST pidl = reinterpret_cast<LPCITEMIDLIST>(dwData);
1498
1499 hr = m_shellFolder->GetUIObjectOf(GetToolbar(), 1, &pidl, IID_NULL_PPV_ARG(IContextMenu, &contextMenu));
1501 {
1502 return hr;
1503 }
1504
1505 hr = TrackContextMenu(contextMenu, pt);
1506
1507 return hr;
1508}
HRESULT TrackContextMenu(IContextMenu *contextMenu, POINT pt)
#define pt(x, y)
Definition: drawing.c:79
#define IID_NULL_PPV_ARG(Itype, ppType)

◆ InternalExecuteItem()

HRESULT CMenuSFToolbar::InternalExecuteItem ( INT  iItem,
INT  index,
DWORD_PTR  dwData 
)
overrideprotectedvirtual

Reimplemented from CMenuToolbarBase.

Definition at line 1510 of file CMenuToolbars.cpp.

1511{
1512 return m_menuBand->_CallCBWithItemPidl(reinterpret_cast<LPITEMIDLIST>(data), SMC_SFEXEC, 0, 0);
1513}
GLint GLenum GLsizei GLsizei GLsizei GLint GLsizei const GLvoid * data
Definition: gl.h:1950

◆ InternalGetTooltip()

HRESULT CMenuSFToolbar::InternalGetTooltip ( INT  iItem,
INT  index,
DWORD_PTR  dwData,
LPWSTR  pszText,
INT  cchTextMax 
)
overrideprotectedvirtual

Reimplemented from CMenuToolbarBase.

Definition at line 1435 of file CMenuToolbars.cpp.

1436{
1437 //ITEMIDLIST * pidl = reinterpret_cast<LPITEMIDLIST>(dwData);
1439 return E_NOTIMPL;
1440}
#define UNIMPLEMENTED
Definition: debug.h:115
#define E_NOTIMPL
Definition: ddrawi.h:99

◆ InternalHasSubMenu()

HRESULT CMenuSFToolbar::InternalHasSubMenu ( INT  iItem,
INT  index,
DWORD_PTR  dwData 
)
overrideprotectedvirtual

Reimplemented from CMenuToolbarBase.

Definition at line 1552 of file CMenuToolbars.cpp.

1553{
1554 HRESULT hr;
1555 LPCITEMIDLIST pidl = reinterpret_cast<LPITEMIDLIST>(dwData);
1556
1557 SFGAOF attrs = SFGAO_FOLDER;
1558 hr = m_shellFolder->GetAttributesOf(1, &pidl, &attrs);
1560 return hr;
1561
1562 return (attrs & SFGAO_FOLDER) ? S_OK : S_FALSE;
1563}

◆ InternalPopupItem()

HRESULT CMenuSFToolbar::InternalPopupItem ( INT  iItem,
INT  index,
DWORD_PTR  dwData,
BOOL  keyInitiated 
)
overrideprotectedvirtual

Reimplemented from CMenuToolbarBase.

Definition at line 1515 of file CMenuToolbars.cpp.

1516{
1517 HRESULT hr;
1518 UINT uId;
1519 UINT uIdAncestor;
1520 DWORD flags;
1521 CComPtr<IShellMenuCallback> psmc;
1522 CComPtr<IShellMenu> shellMenu;
1523
1524 LPITEMIDLIST pidl = reinterpret_cast<LPITEMIDLIST>(dwData);
1525
1526 if (!pidl)
1527 return E_FAIL;
1528
1531 return hr;
1532
1533 m_menuBand->GetMenuInfo(&psmc, &uId, &uIdAncestor, &flags);
1534
1535 // FIXME: not sure what to use as uId/uIdAncestor here
1536 hr = shellMenu->Initialize(psmc, 0, uId, SMINIT_VERTICAL);
1538 return hr;
1539
1540 CComPtr<IShellFolder> childFolder;
1541 hr = m_shellFolder->BindToObject(pidl, NULL, IID_PPV_ARG(IShellFolder, &childFolder));
1543 return hr;
1544
1545 hr = shellMenu->SetShellFolder(childFolder, NULL, NULL, SMSET_TOP);
1547 return hr;
1548
1549 return PopupSubMenu(iItem, index, shellMenu, keyInitiated);
1550}
STDMETHOD() GetMenuInfo(IShellMenuCallback **ppsmc, UINT *puId, UINT *puIdAncestor, DWORD *pdwFlags) override
Definition: CMenuBand.cpp:91
HRESULT PopupSubMenu(UINT itemId, UINT index, IShellMenu *childShellMenu, BOOL keyInitiated)
unsigned long DWORD
Definition: ntddk_ex.h:95
GLbitfield flags
Definition: glext.h:7161
unsigned int UINT
Definition: ndis.h:50
#define CMenuBand_CreateInstance
Definition: shellmenu.h:81
#define IID_PPV_ARG(Itype, ppType)

◆ OnDeletingButton()

HRESULT CMenuSFToolbar::OnDeletingButton ( const NMTOOLBAR tb)
overrideprotectedvirtual

Reimplemented from CMenuToolbarBase.

Definition at line 1442 of file CMenuToolbars.cpp.

1443{
1444 ILFree(reinterpret_cast<LPITEMIDLIST>(tb->tbButton.dwData));
1445 return S_OK;
1446}
static const WCHAR tb[]
Definition: suminfo.c:285
void WINAPI ILFree(LPITEMIDLIST pidl)
Definition: pidl.c:938

◆ SetShellFolder()

HRESULT CMenuSFToolbar::SetShellFolder ( IShellFolder psf,
LPCITEMIDLIST  pidlFolder,
HKEY  hKey,
DWORD  dwFlags 
)

Definition at line 1448 of file CMenuToolbars.cpp.

1449{
1450 m_shellFolder = psf;
1451 m_idList = ILClone(pidlFolder);
1452 m_hKey = hKey;
1454
1455 if (IsWindow())
1456 ClearToolbar();
1457
1458 return S_OK;
1459}
FxAutoRegKey hKey
_In_ PCCERT_CONTEXT _In_ DWORD dwFlags
Definition: wincrypt.h:1176
BOOL WINAPI IsWindow(_In_opt_ HWND)

Referenced by CMenuBand::SetShellFolder().

Member Data Documentation

◆ m_hKey

HKEY CMenuSFToolbar::m_hKey
private

Definition at line 173 of file CMenuToolbars.h.

Referenced by SetShellFolder().

◆ m_idList

LPCITEMIDLIST CMenuSFToolbar::m_idList
private

Definition at line 172 of file CMenuToolbars.h.

Referenced by FillToolbar(), GetShellFolder(), and SetShellFolder().

◆ m_shellFolder

CComPtr<IShellFolder> CMenuSFToolbar::m_shellFolder
private

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