Facade::IPageItemNameFacade Class Reference

Inheritance diagram for Facade::IPageItemNameFacade:

Public Types
enum	{ kDefaultIID = IID_IPAGEITEMNAMEFACADE }

Public Member Functions
virtual PMString	GetUserAssignedPageItemName (const UIDRef &targetItem) const =0
virtual PMString	GetDefaultPageItemName (const UIDRef &targetItem) const =0
virtual ErrorCode	SetUserAssignedPageItemName (const UIDRef &targetItem, const PMString &newName)=0
virtual bool16	IsPageItemNameUserAssignable (const UIDRef &targetItem) const =0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Member Function Documentation

virtual PMString Facade::IPageItemNameFacade::GetDefaultPageItemName ( const UIDRef &  targetItem ) const

pure virtual

Get the default name for the page item.

Parameters

targetItem

- the page item in question

Returns

PMString - the default name for the page item

virtual PMString Facade::IPageItemNameFacade::GetUserAssignedPageItemName ( const UIDRef &  targetItem ) const

pure virtual

Get the current name for the page item assigned by the user. Will return empty string if no name has been assigned.

Parameters

targetItem

- the page item in question

Returns

PMString - the name for the page item

virtual bool16 Facade::IPageItemNameFacade::IsPageItemNameUserAssignable ( const UIDRef &  targetItem ) const

pure virtual

Determine if this page item supports custom names.

Returns

bool16 - whether this page item supports custom names

virtual ErrorCode Facade::IPageItemNameFacade::SetUserAssignedPageItemName ( const UIDRef &  targetItem, const PMString &  newName  )

pure virtual

Set the current name for the page item. Setting a name to an empty string will result in the default name being used.

Parameters

targetItem	- the page item in question
newName	- the new name for the page item