wdgExplorer

Detailed Description

Classes
struct	iExplorerItemContainer
	Explorer item container. {DispatchWrapper}. More...
struct	iExplorerItemContainerGeneric
	Generic explorer item container. {DispatchWrapper}. More...
struct	iExplorerItemContainerScene
	Scene file explorer item container. More...
struct	iExplorerItemTypeHandler
	Explorer item type handler. {DispatchWrapper}. More...
struct	iWidgetExplorer
	Widget Explorer. More...

Typedefs
typedef tU32	tExplorerItemTypeFlags
	Explorer item type flags type. More...

Enumerations
enum	eExplorerItemType {   eExplorerItemType_Unknown,   eExplorerItemType_Container,   eExplorerItemType_Up,   eExplorerItemType_Drive,   eExplorerItemType_ItemPath,   eExplorerItemType_ItemData,   eExplorerItemType_Info,   eExplorerItemType_Last,   eExplorerItemType_ForceDWORD }
	Explorer item type. More...
enum	eExplorerItemTypeFlags {   eExplorerItemTypeFlags_Unknown,   eExplorerItemTypeFlags_Container,   eExplorerItemTypeFlags_Up,   eExplorerItemTypeFlags_Drive,   eExplorerItemTypeFlags_ItemPath,   eExplorerItemTypeFlags_ItemData,   eExplorerItemTypeFlags_Info,   eExplorerItemTypeFlags_ForceDWORD }
	Explorer item type flags. More...
enum	eWidgetExplorerIconSize {   eWidgetExplorerIconSize_Smaller,   eWidgetExplorerIconSize_Small,   eWidgetExplorerIconSize_Normal,   eWidgetExplorerIconSize_Large,   eWidgetExplorerIconSize_Larger,   eWidgetExplorerIconSize_Last,   eWidgetExplorerIconSize_ForceDWORD }
	Explorer icon size. More...
enum	eWidgetExplorerCommand {   eWidgetExplorerCommand_Selected,   eWidgetExplorerCommand_Unselected,   eWidgetExplorerCommand_ContainerChanged,   eWidgetExplorerCommand_HoverItem,   eWidgetExplorerCommand_ForceDWORD }
	Explorer widget command. More...
enum	eWidgetExplorerStyle {   eWidgetExplorerStyle_MultiSelect,   eWidgetExplorerStyle_NoStandardTypeHandlers,   eWidgetExplorerStyle_ForceDWORD }
	Widget explorer style. More...
enum	eWidgetExplorerViewMessage {   eWidgetExplorerViewMessage_SetExplorerItemContainer,   eWidgetExplorerViewMessage_SetIconSize,   eWidgetExplorerViewMessage_ClearView,   eWidgetExplorerViewMessage_NotifySelect,   eWidgetExplorerViewMessage_NotifyUnselect,   eWidgetExplorerViewMessage_NotifyStyleChanged,   eWidgetExplorerViewMessage_NotifySetSelection,   eWidgetExplorerViewMessage_ForceDWORD }
	Explorer view messages. More...
enum	eExplorerItemContainerMessage {   eExplorerItemContainerMessage_ItemAdded,   eExplorerItemContainerMessage_ItemBeforeRemove,   eExplorerItemContainerMessage_ItemRemoved,   eExplorerItemContainerMessage_ItemsListed }
	Explore item container messages. More...

Variables
niConstValue achar *const	koidExplorerItemType_Unknown
	Explorer item type unknown object id. More...
niConstValue achar *const	koidExplorerItemType_Container
	Explorer item type container object id. More...
niConstValue achar *const	koidExplorerItemType_Up
	Explorer item type up object id. More...
niConstValue achar *const	koidExplorerItemType_DriveFixed
	Explorer item type fixed drive object id. More...
niConstValue achar *const	koidExplorerItemType_DriveFloppy
	Explorer item type floppy drive object id. More...
niConstValue achar *const	koidExplorerItemType_DriveRemovable
	Explorer item type removable drive object id. More...
niConstValue achar *const	koidExplorerItemType_DriveRemote
	Explorer item type remote drive object id. More...
niConstValue achar *const	koidExplorerItemType_DriveCDRom
	Explorer item type cdrom drive object id. More...
niConstValue achar *const	koidExplorerItemType_DriveRAM
	Explorer item type ram drive object id. More...
niConstValue achar *const	koidExplorerItemType_ItemPath
	Explorer item type item path object id. More...
niConstValue achar *const	koidExplorerItemType_ItemData
	Explorer item type item data object id. More...
niConstValue achar *const	koidExplorerItemType_Info
	Explorer item type info object id. More...
niConstValue achar *const	koidExplorerItemType_SceneUp
	Explorer item type scene up object id. More...
niConstValue achar *const	koidExplorerItemType_SceneUpDir
	Explorer item type scene up directory object id. More...
niConstValue achar *const	koidExplorerItemType_SceneUserData
	Explorer item type scene userdata object id. More...

Typedef Documentation

typedef tU32 tExplorerItemTypeFlags

Explorer item type flags type.

Enumeration Type Documentation

enum eExplorerItemType

Explorer item type.

Enumerator
eExplorerItemType_Unknown	Unknown type.
eExplorerItemType_Container	Container type.
eExplorerItemType_Up	Up type.
eExplorerItemType_Drive	Drive type.
eExplorerItemType_ItemPath	Item path type.
eExplorerItemType_ItemData	Item data type.
eExplorerItemType_Info	Info type.
eExplorerItemType_Last	Last type.
eExplorerItemType_ForceDWORD

enum eExplorerItemTypeFlags

Explorer item type flags.

Enumerator
eExplorerItemTypeFlags_Unknown	Unknown type.
eExplorerItemTypeFlags_Container	Container type.
eExplorerItemTypeFlags_Up	Up type.
eExplorerItemTypeFlags_Drive	Drive type.
eExplorerItemTypeFlags_ItemPath	Item path type.
eExplorerItemTypeFlags_ItemData	Item data type.
eExplorerItemTypeFlags_Info	Info type.
eExplorerItemTypeFlags_ForceDWORD

enum eWidgetExplorerIconSize

Explorer icon size.

Enumerator
eWidgetExplorerIconSize_Smaller	Smaller, by default 16x16 pixels.
eWidgetExplorerIconSize_Small	Small, by default 32x32 pixels.
eWidgetExplorerIconSize_Normal	Normal, by default 48x48 pixels.
eWidgetExplorerIconSize_Large	Large, by default 64x64 pixels.
eWidgetExplorerIconSize_Larger	Larger, by default 128x128 pixels.
eWidgetExplorerIconSize_Last
eWidgetExplorerIconSize_ForceDWORD

enum eWidgetExplorerCommand

Explorer widget command.

Enumerator
eWidgetExplorerCommand_Selected	Item selected. Parameters A is the ID of the selected item. B unused
eWidgetExplorerCommand_Unselected	Item unselected. Parameters A is the ID of the unselected item. B unused
eWidgetExplorerCommand_ContainerChanged	Changed the active container. Parameters A unused B unused
eWidgetExplorerCommand_HoverItem	Hovering the specified item. Parameters A is the ID of the hovered item. B unused
eWidgetExplorerCommand_ForceDWORD

enum eWidgetExplorerStyle

Widget explorer style.

Enumerator
eWidgetExplorerStyle_MultiSelect	Multiple selection.
eWidgetExplorerStyle_NoStandardTypeHandlers	Don't register the standard type handlers and icons in SinkAttached. Remarks This style is only used in SinkAttached and has no effect afterward. iWidgetExplorer::RegisterStandardTypeHandlers can be later called manually to register the standard types.
eWidgetExplorerStyle_ForceDWORD

enum eWidgetExplorerViewMessage

Explorer view messages.

Enumerator
eWidgetExplorerViewMessage_SetExplorerItemContainer	Set the item container. Parameters A the item container.
eWidgetExplorerViewMessage_SetIconSize	Set the icon size. Parameters A the icon size to set.
eWidgetExplorerViewMessage_ClearView	Clear the view.
eWidgetExplorerViewMessage_NotifySelect	An item has been selected.
eWidgetExplorerViewMessage_NotifyUnselect	An item has been unselected.
eWidgetExplorerViewMessage_NotifyStyleChanged	The explorer style has changed.
eWidgetExplorerViewMessage_NotifySetSelection	fire at SetSelection
eWidgetExplorerViewMessage_ForceDWORD

enum eExplorerItemContainerMessage

Explore item container messages.

Enumerator
eExplorerItemContainerMessage_ItemAdded	A new item has been added. Parameters A is the explorer item container instance. B is the index of the item added.
eExplorerItemContainerMessage_ItemBeforeRemove	An item is going to be removed. Parameters A is the explorer item container instance. B is the index of the item that is going to be removed Remarks This message is sent before the item is actually removed from the container.
eExplorerItemContainerMessage_ItemRemoved	An item has been removed. Parameters A is the explorer item container instance. B is the index of the item that has been removed. Remarks This message is sent after the item has been removed from the container.
eExplorerItemContainerMessage_ItemsListed	The content of the container has been changed. Parameters A is the explorer item container instance.

Variable Documentation

niConstValue achar* const koidExplorerItemType_Unknown

Explorer item type unknown object id.

niConstValue achar* const koidExplorerItemType_Container

Explorer item type container object id.

niConstValue achar* const koidExplorerItemType_Up

Explorer item type up object id.

niConstValue achar* const koidExplorerItemType_DriveFixed

Explorer item type fixed drive object id.

niConstValue achar* const koidExplorerItemType_DriveFloppy

Explorer item type floppy drive object id.

niConstValue achar* const koidExplorerItemType_DriveRemovable

Explorer item type removable drive object id.

niConstValue achar* const koidExplorerItemType_DriveRemote

Explorer item type remote drive object id.

niConstValue achar* const koidExplorerItemType_DriveCDRom

Explorer item type cdrom drive object id.

niConstValue achar* const koidExplorerItemType_DriveRAM

Explorer item type ram drive object id.

niConstValue achar* const koidExplorerItemType_ItemPath

Explorer item type item path object id.

niConstValue achar* const koidExplorerItemType_ItemData

Explorer item type item data object id.

niConstValue achar* const koidExplorerItemType_Info

Explorer item type info object id.

niConstValue achar* const koidExplorerItemType_SceneUp

Explorer item type scene up object id.

niConstValue achar* const koidExplorerItemType_SceneUpDir

Explorer item type scene up directory object id.

niConstValue achar* const koidExplorerItemType_SceneUserData

Explorer item type scene userdata object id.