Intravision/reactos
1
0
Fork 0
mirror of https://github.com/reactos/reactos.git synced 2024-12-28 01:55:19 +00:00
Code Issues Projects Releases Packages Wiki Activity

Completed Doxygen documentation of all compounds in Explorer

Browse source 
svn path=/trunk/; revision=6611
This commit is contained in:
Martin Fuchs 2003-11-10 22:38:03 +00:00
parent 8aedeab84e
commit 4961049825
22 changed files with 153 additions and 101 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
reactos/subsys/system/explorer/Seashell/.cvsignore
View file

@ -1,3 +1,5 @@
Debug
Release
*.coff *.coff
*.exe *.exe
*.d *.d

8
reactos/subsys/system/explorer/buildno.h
View file

@ -1,10 +1,10 @@
/* Do not edit - Machine generated */ /* Do not edit - Machine generated */
#ifndef _INC_REACTOS_BUILDNO #ifndef _INC_REACTOS_BUILDNO
#define _INC_REACTOS_BUILDNO #define _INC_REACTOS_BUILDNO
#define KERNEL_VERSION_BUILD 4 #define KERNEL_VERSION_BUILD 23
#define KERNEL_VERSION_BUILD_STR "4" #define KERNEL_VERSION_BUILD_STR "23"
#define KERNEL_RELEASE_RC "0.1.4.4\0" #define KERNEL_RELEASE_RC "0.1.4.23\0"
#define KERNEL_RELEASE_STR "0.1.4.4" #define KERNEL_RELEASE_STR "0.1.4.23"
#define KERNEL_VERSION_RC "0.1.4\0" #define KERNEL_VERSION_RC "0.1.4\0"
#define KERNEL_VERSION_STR "0.1.4" #define KERNEL_VERSION_STR "0.1.4"
#endif #endif

2
reactos/subsys/system/explorer/desktop/desktop.h
View file

@ -26,6 +26,7 @@
// //
/// subclassed Background window behind the visible desktop window
struct BackgroundWindow : public SubclassedWindow struct BackgroundWindow : public SubclassedWindow
{ {
typedef SubclassedWindow super; typedef SubclassedWindow super;
@ -37,6 +38,7 @@ protected:
}; };
/// Implementation of the Explorer desktop window
struct DesktopWindow : public Window, public IShellBrowserImpl struct DesktopWindow : public Window, public IShellBrowserImpl
{ {
typedef Window super; typedef Window super;

1
reactos/subsys/system/explorer/dialogs/searchprogram.h
View file

@ -64,6 +64,7 @@ protected:
}; };
/// entry for the list in "find program" dialogs
struct FPDEntry struct FPDEntry
{ {
ShellEntry* _shell_entry; ShellEntry* _shell_entry;

2
reactos/subsys/system/explorer/doxy-footer.html
View file

@ -3,7 +3,7 @@
<tr> <tr>
<td><address style="align: right;"><small> <td><address style="align: right;"><small>
ROS Explore Source Code Documentation ROS Explore Source Code Documentation
<br>generated on 02.11.2003 by <a href="http://www.doxygen.org/index.html"> <br>generated on 09.11.2003 by <a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0> <img src="doxygen.png" alt="doxygen" align="middle" border=0>
</small></address> </small></address>
</td> </td>

4
reactos/subsys/system/explorer/explorer.dsp
View file

@ -362,6 +362,10 @@ SOURCE=.\res\logov.bmp
# End Source File # End Source File
# Begin Source File # Begin Source File
SOURCE=.\res\logov256.bmp
# End Source File
# Begin Source File
SOURCE=.\res\reactos.ico SOURCE=.\res\reactos.ico
# End Source File # End Source File
# Begin Source File # Begin Source File

4
reactos/subsys/system/explorer/globals.h
View file

@ -26,6 +26,7 @@
// //
/// structure containing global variable of Explorer
extern struct ExplorerGlobals extern struct ExplorerGlobals
{ {
ExplorerGlobals(); ExplorerGlobals();
@ -75,6 +76,7 @@ protected:
HICON _hIcon; HICON _hIcon;
}; };
/// convenient loading of icon resources with specified sizes
struct ResIconEx struct ResIconEx
{ {
ResIconEx(UINT nid, int w, int h); ResIconEx(UINT nid, int w, int h);
@ -85,8 +87,10 @@ protected:
HICON _hIcon; HICON _hIcon;
}; };
/// set big and small icons out of the resources for a window
extern void SetWindowIcon(HWND hwnd, UINT nid); extern void SetWindowIcon(HWND hwnd, UINT nid);
/// convenient loading of bitmap resources
struct ResBitmap struct ResBitmap
{ {
ResBitmap(UINT nid); ResBitmap(UINT nid);

3
reactos/subsys/system/explorer/shell/entries.h
View file

@ -85,6 +85,8 @@ public:
virtual BOOL launch_entry(HWND hwnd, UINT nCmdShow=SW_SHOWNORMAL); virtual BOOL launch_entry(HWND hwnd, UINT nCmdShow=SW_SHOWNORMAL);
}; };
/// base for all directory entries
struct Directory { struct Directory {
protected: protected:
Directory() : _path(NULL) {} Directory() : _path(NULL) {}
@ -94,6 +96,7 @@ protected:
}; };
/// root entry for file system trees
struct Root { struct Root {
Root(); Root();
~Root(); ~Root();

2
reactos/subsys/system/explorer/shell/filechild.h
View file

@ -38,6 +38,7 @@ struct FileChildWndInfo
int _open_mode; //OPEN_WINDOW_MODE int _open_mode; //OPEN_WINDOW_MODE
}; };
/// information structure for creation of ShellBrowserChild
struct ShellChildWndInfo : public FileChildWndInfo struct ShellChildWndInfo : public FileChildWndInfo
{ {
ShellChildWndInfo(LPCTSTR path, const ShellPath& root_shell_path); ShellChildWndInfo(LPCTSTR path, const ShellPath& root_shell_path);
@ -91,6 +92,7 @@ public:
}; };
/// The "Execute..."-dialog lets the user enter a command line to launch.
struct ExecuteDialog { ///@todo use class Dialog struct ExecuteDialog { ///@todo use class Dialog
TCHAR cmd[MAX_PATH]; TCHAR cmd[MAX_PATH];
int cmdshow; int cmdshow;

1
reactos/subsys/system/explorer/shell/pane.h
View file

@ -44,6 +44,7 @@ enum COLUMN_FLAGS {
}; };
/// Worker for drawing contents of file lists in child pane
struct OutputWorker struct OutputWorker
{ {
OutputWorker(); OutputWorker();

1
reactos/subsys/system/explorer/shell/shellbrowser.h
View file

@ -29,6 +29,7 @@
#include "../utility/shellbrowserimpl.h" #include "../utility/shellbrowserimpl.h"
/// Implementation of IShellBrowserImpl interface in explorer child windows
struct ShellBrowserChild : public ChildWindow, public IShellBrowserImpl struct ShellBrowserChild : public ChildWindow, public IShellBrowserImpl
{ {
typedef ChildWindow super; typedef ChildWindow super;

1
reactos/subsys/system/explorer/shell/shellfs.h
View file

@ -46,6 +46,7 @@ protected:
}; };
/// shell folder entry
struct ShellDirectory : public ShellEntry, public Directory struct ShellDirectory : public ShellEntry, public Directory
{ {
ShellDirectory(ShellFolder& root_folder, const ShellPath& shell_path, HWND hwnd) ShellDirectory(ShellFolder& root_folder, const ShellPath& shell_path, HWND hwnd)

14
reactos/subsys/system/explorer/shell/startup.c
View file

@ -16,6 +16,7 @@
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/ */
/* Based on the Wine "bootup" handler application /* Based on the Wine "bootup" handler application
* *
* This app handles the various "hooks" windows allows for applications to perform * This app handles the various "hooks" windows allows for applications to perform
@ -55,7 +56,8 @@
#include <windows.h> #include <windows.h>
#include <ctype.h> #include <ctype.h>
/* Performs the rename operations dictated in %SystemRoot%\Wininit.ini. /**
* Performs the rename operations dictated in %SystemRoot%\Wininit.ini.
* Returns FALSE if there was an error, or otherwise if all is ok. * Returns FALSE if there was an error, or otherwise if all is ok.
*/ */
static BOOL wininit() static BOOL wininit()
@ -222,7 +224,7 @@ const WCHAR runkeys_names[][30]=
}; };
#define INVALID_RUNCMD_RETURN -1 #define INVALID_RUNCMD_RETURN -1
/* /**
* This function runs the specified command in the specified dir. * This function runs the specified command in the specified dir.
* [in,out] cmdline - the command line to run. The function may change the passed buffer. * [in,out] cmdline - the command line to run. The function may change the passed buffer.
* [in] dir - the dir to run the command in. If it is NULL, then the current dir is used. * [in] dir - the dir to run the command in. If it is NULL, then the current dir is used.
@ -270,7 +272,7 @@ static int runCmd(LPWSTR cmdline, LPCWSTR dir, BOOL wait, BOOL minimized)
return exit_code; return exit_code;
} }
/* /**
* Process a "Run" type registry key. * Process a "Run" type registry key.
* hkRoot is the HKEY from which "Software\Microsoft\Windows\CurrentVersion" is * hkRoot is the HKEY from which "Software\Microsoft\Windows\CurrentVersion" is
* opened. * opened.
@ -399,6 +401,7 @@ end:
return res==ERROR_SUCCESS?TRUE:FALSE; return res==ERROR_SUCCESS?TRUE:FALSE;
} }
/// structure holding startup flags
struct op_mask { struct op_mask {
BOOL w9xonly; /* Perform only operations done on Windows 9x */ BOOL w9xonly; /* Perform only operations done on Windows 9x */
BOOL ntonly; /* Perform only operations done on Windows NT */ BOOL ntonly; /* Perform only operations done on Windows NT */
@ -408,8 +411,9 @@ struct op_mask {
BOOL postlogin; /* Operations done after login */ BOOL postlogin; /* Operations done after login */
}; };
static const struct op_mask SESSION_START={FALSE, FALSE, TRUE, TRUE, TRUE, TRUE}, static const struct op_mask
SETUP={FALSE, FALSE, FALSE, TRUE, TRUE, TRUE}; SESSION_START = {FALSE, FALSE, TRUE, TRUE, TRUE, TRUE},
SETUP = {FALSE, FALSE, FALSE, TRUE, TRUE, TRUE};
#define DEFAULT SESSION_START #define DEFAULT SESSION_START
int startup(int argc, char *argv[]) int startup(int argc, char *argv[])

3
reactos/subsys/system/explorer/shell/winfs.h
View file

@ -26,6 +26,7 @@
// //
/// Windows File System file-entry
struct WinEntry : public Entry struct WinEntry : public Entry
{ {
WinEntry(Entry* parent) : Entry(parent) {} WinEntry(Entry* parent) : Entry(parent) {}
@ -36,6 +37,8 @@ protected:
virtual void get_path(PTSTR path) const; virtual void get_path(PTSTR path) const;
}; };
/// Windows File System directory-entry
struct WinDirectory : public WinEntry, public Directory struct WinDirectory : public WinEntry, public Directory
{ {
WinDirectory(LPCTSTR root_path) WinDirectory(LPCTSTR root_path)

16
reactos/subsys/system/explorer/taskbar/startmenu.h
View file

@ -42,6 +42,7 @@
#define PM_STARTENTRY_LAUNCHED (WM_APP+0x13) #define PM_STARTENTRY_LAUNCHED (WM_APP+0x13)
/// StartMenuDirectory is used to store the base directory of start menus.
struct StartMenuDirectory struct StartMenuDirectory
{ {
StartMenuDirectory(const ShellDirectory& dir, bool subfolders=true) StartMenuDirectory(const ShellDirectory& dir, bool subfolders=true)
@ -61,6 +62,7 @@ struct StartMenuDirectory
typedef list<StartMenuDirectory> StartMenuShellDirs; typedef list<StartMenuDirectory> StartMenuShellDirs;
typedef set<const ShellEntry*> ShellEntrySet; typedef set<const ShellEntry*> ShellEntrySet;
/// structure holding information about one start menu entry
struct StartMenuEntry struct StartMenuEntry
{ {
StartMenuEntry() : _hIcon(0) {} StartMenuEntry() : _hIcon(0) {}
@ -72,7 +74,7 @@ struct StartMenuEntry
/** /**
StartMenuButton draws to face of a StartMenuCtrl button control. StartMenuButton draws the face of a StartMenuCtrl button control.
*/ */
struct StartMenuButton : public OwnerdrawnButton struct StartMenuButton : public OwnerdrawnButton
{ {
@ -108,6 +110,7 @@ struct StartMenuCtrl : public Button
}; };
/// separator between start menu entries
struct StartMenuSeparator : public Static struct StartMenuSeparator : public Static
{ {
StartMenuSeparator(HWND parent, int x, int y, int w, DWORD style=WS_VISIBLE|WS_CHILD|WS_DISABLED|SS_ETCHEDHORZ, DWORD exStyle=0) StartMenuSeparator(HWND parent, int x, int y, int w, DWORD style=WS_VISIBLE|WS_CHILD|WS_DISABLED|SS_ETCHEDHORZ, DWORD exStyle=0)
@ -119,6 +122,7 @@ struct StartMenuSeparator : public Static
typedef list<ShellPath> StartMenuFolders; typedef list<ShellPath> StartMenuFolders;
/// structor containing information for creating start menus
struct StartMenuCreateInfo struct StartMenuCreateInfo
{ {
StartMenuCreateInfo() : _border_top(0) {} StartMenuCreateInfo() : _border_top(0) {}
@ -136,7 +140,8 @@ typedef map<UINT, StartMenuEntry> ShellEntryMap;
/** /**
Startmenu window Startmenu window.
To create a start menu call its Create() function.
*/ */
struct StartMenu : public OwnerDrawParent<DialogWindow> struct StartMenu : public OwnerDrawParent<DialogWindow>
{ {
@ -221,7 +226,7 @@ typedef BOOL (WINAPI* SHFINDFILES)(LPCITEMIDLIST pidlRoot, LPCITEMIDLIST pidlSav
typedef BOOL (WINAPI* SHFINDCOMPUTER)(LPCITEMIDLIST pidlRoot, LPCITEMIDLIST pidlSavedSearch); typedef BOOL (WINAPI* SHFINDCOMPUTER)(LPCITEMIDLIST pidlRoot, LPCITEMIDLIST pidlSavedSearch);
// Startmenu root window /// Startmenu root window
struct StartMenuRoot : public StartMenu struct StartMenuRoot : public StartMenu
{ {
typedef StartMenu super; typedef StartMenu super;
@ -248,7 +253,7 @@ protected:
}; };
// Settings sub-startmenu /// Settings sub-startmenu
struct SettingsMenu : public StartMenu struct SettingsMenu : public StartMenu
{ {
typedef StartMenu super; typedef StartMenu super;
@ -266,7 +271,7 @@ protected:
}; };
// "Browse Files..." sub-start menu /// "Browse Files..." sub-start menu
struct BrowseMenu : public StartMenu struct BrowseMenu : public StartMenu
{ {
typedef StartMenu super; typedef StartMenu super;
@ -284,6 +289,7 @@ protected:
}; };
/// "Recent Files" sub-start menu
struct RecentStartMenu : public StartMenu struct RecentStartMenu : public StartMenu
{ {
typedef StartMenu super; typedef StartMenu super;

4
reactos/subsys/system/explorer/utility/dragdropimpl.h
View file

@ -14,6 +14,7 @@ using std::vector;
typedef vector<FORMATETC> FormatArray; typedef vector<FORMATETC> FormatArray;
/// structure containing information for one format of EnumFormatEtcImpl
struct DataStorage { struct DataStorage {
FORMATETC* _format; FORMATETC* _format;
STGMEDIUM* _medium; STGMEDIUM* _medium;
@ -209,6 +210,7 @@ public:
/* [out][in] */ DWORD __RPC_FAR *pdwEffect); /* [out][in] */ DWORD __RPC_FAR *pdwEffect);
}; };
/// implementation of IDragSourceHelper interface
class DragSourceHelper class DragSourceHelper
{ {
IDragSourceHelper* pDragSourceHelper; IDragSourceHelper* pDragSourceHelper;
@ -226,7 +228,7 @@ public:
virtual ~DragSourceHelper() virtual ~DragSourceHelper()
{ {
if ( pDragSourceHelper!= NULL ) if (pDragSourceHelper != NULL)
{ {
pDragSourceHelper->Release(); pDragSourceHelper->Release();
pDragSourceHelper=NULL; pDragSourceHelper=NULL;

1
reactos/subsys/system/explorer/utility/shellbrowserimpl.h
View file

@ -28,6 +28,7 @@
// //
/// Implementation of IShellBrowser and ICommDlgBrowser interfaces for explorer child windows (see ShellBrowserChild)
struct IShellBrowserImpl : public IShellBrowser, public ICommDlgBrowser struct IShellBrowserImpl : public IShellBrowser, public ICommDlgBrowser
{ {
IShellBrowserImpl() IShellBrowserImpl()

14
reactos/subsys/system/explorer/utility/shellclasses.h
View file

@ -175,7 +175,7 @@ struct CommonShellMalloc
}; };
// wrapper class for IMalloc with usage of common allocator /// wrapper class for IMalloc with usage of common allocator
struct ShellMalloc struct ShellMalloc
{ {
@ -194,7 +194,7 @@ struct ShellMalloc
}; };
// wrapper template class for pointers to shell objects managed by IMalloc /// wrapper template class for pointers to shell objects managed by IMalloc
template<typename T> struct SShellPtr template<typename T> struct SShellPtr
{ {
@ -255,7 +255,7 @@ private:
}; };
// wrapper class for COM interface pointers /// wrapper class for COM interface pointers
template<typename T> struct SIfacePtr template<typename T> struct SIfacePtr
{ {
@ -473,7 +473,7 @@ extern "C" UINT ILGetSize(LPCITEMIDLIST pidl);
#endif #endif
// wrapper class for item ID lists /// wrapper class for item ID lists
struct ShellPath : public SShellPtr<ITEMIDLIST> struct ShellPath : public SShellPtr<ITEMIDLIST>
{ {
@ -673,6 +673,7 @@ struct ShellPath : public SShellPtr<ITEMIDLIST>
extern LPSTR strcpyn(LPSTR dest, LPCSTR source, size_t count); extern LPSTR strcpyn(LPSTR dest, LPCSTR source, size_t count);
extern LPWSTR wcscpyn(LPWSTR dest, LPCWSTR source, size_t count); extern LPWSTR wcscpyn(LPWSTR dest, LPCWSTR source, size_t count);
/// easy retrieval of multi byte strings out of STRRET structures
struct StrRetA : public STRRET struct StrRetA : public STRRET
{ {
~StrRetA() ~StrRetA()
@ -698,6 +699,7 @@ struct StrRetA : public STRRET
} }
}; };
/// easy retrieval of wide char strings out of STRRET structures
struct StrRetW : public STRRET struct StrRetW : public STRRET
{ {
~StrRetW() ~StrRetW()
@ -724,6 +726,7 @@ struct StrRetW : public STRRET
}; };
/// Retreival of file system paths of ShellPath objects
class FileSysShellPath : public ShellPath class FileSysShellPath : public ShellPath
{ {
TCHAR _fullpath[MAX_PATH]; TCHAR _fullpath[MAX_PATH];
@ -829,6 +832,7 @@ protected:
#else // _WIN32_IE<0x400 -> use SHGetSpecialFolderLocation() #else // _WIN32_IE<0x400 -> use SHGetSpecialFolderLocation()
/// file system path of special folder
struct SpecialFolderFSPath : public FileSysShellPath struct SpecialFolderFSPath : public FileSysShellPath
{ {
SpecialFolderFSPath(int folder, HWND hwnd) SpecialFolderFSPath(int folder, HWND hwnd)
@ -841,7 +845,7 @@ struct SpecialFolderFSPath : public FileSysShellPath
#endif #endif
// wrapper class for enumerating shell namespace objects /// wrapper class for enumerating shell namespace objects
struct ShellItemEnumerator : public SIfacePtr<IEnumIDList> struct ShellItemEnumerator : public SIfacePtr<IEnumIDList>
{ {

1
reactos/subsys/system/explorer/utility/treedroptarget.h
View file

@ -9,6 +9,7 @@
#include "dragdropimpl.h" #include "dragdropimpl.h"
/// OLE drop target for tree controls
class TreeDropTarget : public IDropTargetImpl class TreeDropTarget : public IDropTargetImpl
{ {
public: public:

10
reactos/subsys/system/explorer/utility/window.h
View file

@ -114,6 +114,7 @@ protected:
static CREATORFUNC s_window_creator; static CREATORFUNC s_window_creator;
/// structure for managing critical sections as static class information in struct Window
struct StaticWindowData { struct StaticWindowData {
CritSect _map_crit_sect; CritSect _map_crit_sect;
CritSect _create_crit_sect; CritSect _create_crit_sect;
@ -142,6 +143,7 @@ template<typename CLASS> struct GetWindowHelper
#endif #endif
/// dynamic casting of Window pointers
template<typename CLASS> struct TypeCheck template<typename CLASS> struct TypeCheck
{ {
static CLASS* dyn_cast(Window* wnd) static CLASS* dyn_cast(Window* wnd)
@ -171,6 +173,7 @@ protected:
}; };
/// template class used in macro WINDOW_CREATOR to the define creater functions for Window objects
template<typename WND_CLASS> struct WindowCreator template<typename WND_CLASS> struct WindowCreator
{ {
static WND_CLASS* window_creator(HWND hwnd) static WND_CLASS* window_creator(HWND hwnd)
@ -183,6 +186,7 @@ template<typename WND_CLASS> struct WindowCreator
(Window::CREATORFUNC) WindowCreator<WND_CLASS>::window_creator (Window::CREATORFUNC) WindowCreator<WND_CLASS>::window_creator
/// template class used in macro WINDOW_CREATOR_INFO to the define creater functions for Window objects with additional creation information
template<typename WND_CLASS, typename INFO_CLASS> struct WindowCreatorInfo template<typename WND_CLASS, typename INFO_CLASS> struct WindowCreatorInfo
{ {
static WND_CLASS* window_creator(HWND hwnd, const void* info) static WND_CLASS* window_creator(HWND hwnd, const void* info)
@ -348,6 +352,7 @@ protected:
// Layouting of resizable windows // Layouting of resizable windows
/// Flags to specify how to move and resize controls when resizing their parent window
enum RESIZE_FLAGS { enum RESIZE_FLAGS {
MOVE_LEFT = 0x1, MOVE_LEFT = 0x1,
MOVE_RIGHT = 0x2, MOVE_RIGHT = 0x2,
@ -363,6 +368,7 @@ enum RESIZE_FLAGS {
RESIZE = RESIZE_X | RESIZE_Y RESIZE = RESIZE_X | RESIZE_Y
}; };
/// structure to assign RESIZE_FLAGS to dialogs control
struct ResizeEntry struct ResizeEntry
{ {
ResizeEntry(UINT id, int flags) ResizeEntry(UINT id, int flags)
@ -375,6 +381,8 @@ struct ResizeEntry
int _flags; int _flags;
}; };
/// Management of controls in resizable dialogs
struct ResizeManager : public std::list<ResizeEntry> struct ResizeManager : public std::list<ResizeEntry>
{ {
typedef std::list<ResizeEntry> super; typedef std::list<ResizeEntry> super;
@ -403,6 +411,8 @@ protected:
SIZE _last_size; SIZE _last_size;
}; };
/// Controller base template class for resizable dialogs
template<typename BASE> struct ResizeController : public BASE template<typename BASE> struct ResizeController : public BASE
{ {
typedef BASE super; typedef BASE super;