Inheritance diagram for iWidgetExplorer:

Detailed Description

Widget Explorer.

View
virtual void	SetIconSize (eWidgetExplorerIconSize aSize)=0
	Set the current icon size. {Property}. More...

virtual eWidgetExplorerIconSize	GetIconSize () const =0
	Get the current icon size. {Property}. More...

virtual void	SetViewType (iHString *ahspType)=0
	Set the type of view. {Property}. More...

virtual iHString *	GetViewType () const =0
	Get the current view type. {Property}. More...

virtual void	SetIconSet (iHString *ahspPath)=0
	Set the explorer's icon set. {Property}. More...

virtual iHString *	GetIconSet () const =0
	Get the explorer's icon set. {Property}. More...

virtual iImageMap *	GetImageMap () const =0
	Get the explorer's image map. {Property}. More...

Type handlers
virtual tBool	RegisterStandardTypeHandlers ()=0
	Register the standard type handlers and icons. More...

virtual ni::tU32	GetNumTypeHandlers () const =0
	Get the number of type handlers. {Property}. More...

virtual iExplorerItemTypeHandler *	GetTypeHandler (tU32 anIndex) const =0
	Get the type handler at the specified index. {Property}. More...

virtual tU32	GetTypeHandlerIndex (iExplorerItemTypeHandler *apHandler) const =0
	Get the index of the specified type handler. {Property}. More...

virtual ni::tBool	ClearTypeHandlers ()=0
	Remove all type handlers. More...

virtual ni::tBool	AddTypeHandler (iExplorerItemTypeHandler *apHandler)=0
	Add a type handler. More...

virtual ni::tBool	AddTypeHandlerGeneric (iHString ahspType, iHString ahspIconPath, iHString *ahspTypes)=0
	Add a generic type handler that will set icons in function of the their type. More...

virtual ni::tBool	RemoveTypeHandler (iExplorerItemTypeHandler *apHandler)=0
	Remove the type handler at the specified index. More...

virtual iExplorerItemTypeHandler *	FindTypeHandler (tU32 anItem) const =0
	Find the first type handler that can handle the specified item. More...

virtual iExplorerItemTypeHandler *	FindTypeHandlerEx (iExplorerItemContainer *apRC, tU32 anItem) const =0
	Find the first type handler that can handle the specified item in the specified container. More...

virtual iOverlay *	GetTypeIconEx (iExplorerItemContainer *apContainer, tU32 anItemID) const =0
	Get the associated with the specified item in the specified container. More...

virtual iOverlay *	GetTypeIcon (tU32 anItemID) const =0
	Get the associated with the specified item in the current container. More...

virtual iHString *	GetTypeInfos (tU32 anItemID) const =0

Container
virtual ni::tBool	SetContainer (iExplorerItemContainer *apRC)=0
	Set the current container that is explored. {Property}. More...

virtual iExplorerItemContainer *	GetContainer () const =0
	Get the current explored items containers. {Property}. More...

virtual iExplorerItemContainer *	CreateContainerDirectory (iHString ahspDirectory, iHString ahspFilter, tFileAttrFlags aAttrs)=0
	Create a container that explores the specified directory. More...

virtual iExplorerItemContainer *	CreateContainerGeneric (iHString ahspPath, iHString ahspFilter)=0
	Create a generic container, aka filled manually by the user. More...

virtual tBool	CanCreateExplorerItemContainer (iExplorerItemContainer *apContainer, tU32 anItemID)=0
	Check whether we can create a container which explores the specified item in the specified container. More...

virtual iExplorerItemContainer *	CreateExplorerItemContainer (iExplorerItemContainer *apContainer, tU32 anItemID)=0
	Create a container which explores the specified item in the specified container. More...

Selection
virtual tU32	GetNumSelections () const =0
	Get the number of items selected. {Property}. More...

virtual ni::tBool	SetSelection (tU32 anItemID)=0
	Set the selection to the specified item. {Property}. More...

virtual tU32	GetSelection () const =0
	Get the first selection. {Property}. More...

virtual tBool	SetSelectionRange (tU32 anFirst, tU32 anLast)=0
	Set the selection to the specified range of item. More...

virtual tU32	GetLowestSelection () const =0
	Get the lowest index in the selection. {Property}. More...

virtual tU32	GetLastSetSelection () const =0
	Get the last selection set. {Property}. More...

virtual void	ClearSelection ()=0
	Clear the selection. More...

virtual tBool	AddSelection (tU32 anItemID)=0
	Add an item to the selection. More...

virtual tBool	AddSelectionRange (tU32 anFirst, tU32 anLast)=0
	Add a range of item to the selection. More...

virtual tBool	RemoveSelection (tU32 anItemID)=0
	Remove an item from the selection. More...

virtual tBool	GetIsSelected (tU32 anItemID) const =0
	Get whether the specified item is selected. {Property}. More...

virtual tBool	ToggleSelection (tU32 anItemID)=0
	Toggle the selection of the specified item. More...

virtual tBool	ExploreItem (tU32 anItemID)=0
	Try to explore inside the specified item. More...

Additional Inherited Members
Public Member Functions inherited from iUnknown
virtual tBool	IsOK () const =0
	Check if the object is valid. More...

virtual tI32	AddRef ()=0
	Signal that one more reference of the object has been created. More...

virtual tI32	Release ()=0
	Release a reference of the object. More...

virtual void	DeleteThis ()=0
	Bypass any reference counting and delete this object. More...

virtual void	Invalidate ()=0
	Invalidate the object. More...

virtual iUnknown *	QueryInterface (const tUUID &aIID)=0
	Query an interface. More...

virtual void	ListInterfaces (iMutableCollection *apLst, tU32 anFlags) const =0
	Fill a UUID list containing the UUIDs of the implemented interfaces. More...

virtual tI32	SetNumRefs (tI32 anNumRefs)=0
	Set the reference counter directly. More...

virtual tI32	GetNumRefs () const =0
	Get the number of references to this object. More...

Member Function Documentation

virtual void SetIconSize ( eWidgetExplorerIconSize aSize )

pure virtual

Set the current icon size. {Property}.

virtual eWidgetExplorerIconSize GetIconSize ( ) const

pure virtual

Get the current icon size. {Property}.

virtual void SetViewType ( iHString * ahspType )

pure virtual

Set the type of view. {Property}.

Remarks: The type of view is the Widget Class of the view to use, the class must handle the widget explorer messages to work properly with the explorer. ExplorerViewList, ExplorerViewThumbnails, ExplorerViewIconList and ExplorerViewTree are available by default.

virtual iHString* GetViewType ( ) const

pure virtual

Get the current view type. {Property}.

virtual void SetIconSet ( iHString * ahspPath )

pure virtual

Set the explorer's icon set. {Property}.

virtual iHString* GetIconSet ( ) const

pure virtual

Get the explorer's icon set. {Property}.

virtual iImageMap* GetImageMap ( ) const

pure virtual

Get the explorer's image map. {Property}.

virtual tBool RegisterStandardTypeHandlers ( )

pure virtual

Register the standard type handlers and icons.

Remarks: This is meant to be used by a "file/resource" explorer.

virtual ni::tU32 GetNumTypeHandlers ( ) const

pure virtual

Get the number of type handlers. {Property}.

virtual iExplorerItemTypeHandler* GetTypeHandler ( tU32 anIndex ) const

pure virtual

Get the type handler at the specified index. {Property}.

virtual tU32 GetTypeHandlerIndex ( iExplorerItemTypeHandler * apHandler ) const

pure virtual

Get the index of the specified type handler. {Property}.

virtual ni::tBool ClearTypeHandlers ( )

pure virtual

Remove all type handlers.

virtual ni::tBool AddTypeHandler ( iExplorerItemTypeHandler * apHandler )

pure virtual

Add a type handler.

virtual ni::tBool AddTypeHandlerGeneric	(	iHString *	ahspType,
		iHString *	ahspIconPath,
		iHString *	ahspTypes
	)

pure virtual

Add a generic type handler that will set icons in function of the their type.

virtual ni::tBool RemoveTypeHandler ( iExplorerItemTypeHandler * apHandler )

pure virtual

Remove the type handler at the specified index.

virtual iExplorerItemTypeHandler* FindTypeHandler ( tU32 anItem ) const

pure virtual

Find the first type handler that can handle the specified item.

virtual iExplorerItemTypeHandler* FindTypeHandlerEx	(	iExplorerItemContainer *	apRC,
		tU32	anItem
	)		const

pure virtual

Find the first type handler that can handle the specified item in the specified container.

virtual iOverlay* GetTypeIconEx	(	iExplorerItemContainer *	apContainer,
		tU32	anItemID
	)		const

pure virtual

Get the associated with the specified item in the specified container.

virtual iOverlay* GetTypeIcon ( tU32 anItemID ) const

pure virtual

Get the associated with the specified item in the current container.

virtual iHString* GetTypeInfos ( tU32 anItemID ) const

pure virtual

virtual ni::tBool SetContainer ( iExplorerItemContainer * apRC )

pure virtual

Set the current container that is explored. {Property}.

virtual iExplorerItemContainer* GetContainer ( ) const

pure virtual

Get the current explored items containers. {Property}.

virtual iExplorerItemContainer* CreateContainerDirectory	(	iHString *	ahspDirectory,
		iHString *	ahspFilter,
		tFileAttrFlags	aAttrs
	)

pure virtual

Create a container that explores the specified directory.

virtual iExplorerItemContainer* CreateContainerGeneric	(	iHString *	ahspPath,
		iHString *	ahspFilter
	)

pure virtual

Create a generic container, aka filled manually by the user.

virtual tBool CanCreateExplorerItemContainer	(	iExplorerItemContainer *	apContainer,
		tU32	anItemID
	)

pure virtual

Check whether we can create a container which explores the specified item in the specified container.

virtual iExplorerItemContainer* CreateExplorerItemContainer	(	iExplorerItemContainer *	apContainer,
		tU32	anItemID
	)

pure virtual

Create a container which explores the specified item in the specified container.

virtual tU32 GetNumSelections ( ) const

pure virtual

Get the number of items selected. {Property}.

virtual ni::tBool SetSelection ( tU32 anItemID )

pure virtual

Set the selection to the specified item. {Property}.

virtual tU32 GetSelection ( ) const

pure virtual

Get the first selection. {Property}.

virtual tBool SetSelectionRange	(	tU32	anFirst,
		tU32	anLast
	)

pure virtual

Set the selection to the specified range of item.

virtual tU32 GetLowestSelection ( ) const

pure virtual

Get the lowest index in the selection. {Property}.

virtual tU32 GetLastSetSelection ( ) const

pure virtual

Get the last selection set. {Property}.

virtual void ClearSelection ( )

pure virtual

Clear the selection.

virtual tBool AddSelection ( tU32 anItemID )

pure virtual

Add an item to the selection.

virtual tBool AddSelectionRange	(	tU32	anFirst,
		tU32	anLast
	)

pure virtual

Add a range of item to the selection.

virtual tBool RemoveSelection ( tU32 anItemID )

pure virtual

Remove an item from the selection.

virtual tBool GetIsSelected ( tU32 anItemID ) const

pure virtual

Get whether the specified item is selected. {Property}.

virtual tBool ToggleSelection ( tU32 anItemID )

pure virtual

Toggle the selection of the specified item.

virtual tBool ExploreItem ( tU32 anItemID )

pure virtual

Try to explore inside the specified item.

Detailed Description

View

Type handlers

Container

Selection

Additional Inherited Members

Member Function Documentation