Facade::IContentDropperFacade Class Reference

Inheritance diagram for Facade::IContentDropperFacade:

Public Types
enum	{ kDefaultIID = IID_ICONTENTDROPPERFACADE }

Public Member Functions
virtual ErrorCode	LoadContentDropper (const UIDList &items, ContentDropperTypes::LinkPolicy linkPolicy=ContentDropperTypes::kUnknownPolicy)=0
virtual ErrorCode	LoadContentDropperWithNeedfulSet (const UIDList *items, ContentDropperTypes::LinkPolicy linkPolicy=ContentDropperTypes::kUnknownPolicy)=0
virtual ErrorCode	LoadItemsFromPage (IDataBase *db, const UIDList &pageUIDList, bool16 makeOneCollection=kFalse)=0
virtual ErrorCode	LoadItemsFromSpreads (IDataBase *db, const UIDList &spreadUIDList, bool16 makeOneCollection)=0
virtual ErrorCode	PlaceContent (const UIDList &itemsToPlace, const UIDRef &targetRef, ContentDropperTypes::LinkPolicy linkPolicy=ContentDropperTypes::kUnknownPolicy, bool16 mapStyles=kFalse)=0
virtual ErrorCode	PlaceContentFromConveyor (const UIDRef &targetRef, ContentDropperTypes::LinkPolicy linkPolicy=ContentDropperTypes::kUnknownPolicy, bool16 mapStyles=kFalse)=0
virtual ErrorCode	ClearItemsFromConveyor (bool16 allItems=kFalse)=0
virtual bool16	RotateItemsBy (const int32 byNoOfItems, const bool16 isForwardDirection=kTrue)=0
virtual bool16	ExpandCollapseItemAtHead (bool16 expand=kTrue)=0
virtual bool16	MoveHeadToFirstLastItem (bool16 moveToFirst=kTrue)=0
virtual bool16	IsConveyorLoaded ()=0
virtual UIDList	GetNthItems (uint32 n)=0
virtual UIDList	GetPlaceHeadItems ()=0
virtual int32	GetNeedfulSetForItem (UID root, UIDList &needfulSet)=0
virtual bool16	IsUniqueCollectionInDoc (const UIDList &uidListToAdd) const =0
virtual ContentDropperTypes::eAfterDrop	GetCDUIPrefsAfterPlaceOption () const =0
virtual ErrorCode	SetCDUIPrefsAfterPlaceOption (ContentDropperTypes::eAfterDrop option)=0
virtual bool16	GetCDUIPrefsLinkOption ()=0
virtual void	SetCDUIPrefsLinkOption (bool16 link=kTrue)=0
virtual bool16	GetCDUIPrefsMapStyles ()=0
virtual void	SetCDUIPrefsMapStyles (bool16 mapStyle=kTrue)=0
virtual bool16	GetCDUIPrefsCollectAllThreadedFrames ()=0
virtual void	SetCDUIPrefsCollectAllThreadedFrames (bool16 collectAllFrames=kTrue)=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 ErrorCode Facade::IContentDropperFacade::ClearItemsFromConveyor ( bool16  allItems = kFalse )

pure virtual

Clears items from the Conveyor. pass kTrue to clear all items, only the item at PlayHead gets cleared otherwise.

Parameters

[in]

allItems

kFalse to remove the item at PlayHead, kTrue to remove all items from Conveyor

Returns

ErrorCode returned from the Remove Command(s) executed in the API.

virtual bool16 Facade::IContentDropperFacade::ExpandCollapseItemAtHead ( bool16  expand = kTrue )

pure virtual

If item on PlaceHead is a collection, API can be used to show the items in the Set. If they are already shown, use this to go back to up level

Parameters

[in]

expand

kTrue to expand the set, kFalse to collapse(go up one level).

Returns

kTrue if operation could be performed

virtual ContentDropperTypes::eAfterDrop Facade::IContentDropperFacade::GetCDUIPrefsAfterPlaceOption ( ) const

pure virtual

Get the after place option from Conveyor.

Returns

Option for item placed to be:

1. Removed
2. Retained on PlaceHead
3. Retained in Conveyor but moved to last place

virtual bool16 Facade::IContentDropperFacade::GetCDUIPrefsCollectAllThreadedFrames ( )

pure virtual

Get the state of Collect All Threaded Frames option from Conveyor.

Returns

kTrue if the conveyor is set to collect all threaded frames

virtual bool16 Facade::IContentDropperFacade::GetCDUIPrefsLinkOption ( )

pure virtual

Get the state of Link option from Conveyor.

Returns

kTrue if link creation is enabled, kFalse otherwise.

virtual bool16 Facade::IContentDropperFacade::GetCDUIPrefsMapStyles ( )

pure virtual

Get the state of Map Styles option from Conveyor.

Returns

kTrue if mapping of styles is enabled, kFalse otherwise

virtual int32 Facade::IContentDropperFacade::GetNeedfulSetForItem ( UID  root, UIDList &  needfulSet  )

pure virtual

Items in a document may refer to other items like threaded text frames or buttons referring to MSO. These items shall be dropped together to maintain the references. This API returns the set created by such references of the given item.

Parameters

[in]	root	item for which the NeedfulSet is to be created
[out]	needfulSet	UIDList containing UIDs of all the items in set.

Returns

number of items in the set.

virtual UIDList Facade::IContentDropperFacade::GetNthItems ( uint32  n )

pure virtual

Get the list of items that are part of Nth collection in Conveyor

Parameters

[in]

n

The index of the collection

Returns

UIDList of the items in the collection

virtual UIDList Facade::IContentDropperFacade::GetPlaceHeadItems ( )

pure virtual

Get the list of items that are part of collection at PlaceHead in Conveyor

Returns

UIDList of the items in the collection at the PlaceHead

virtual bool16 Facade::IContentDropperFacade::IsConveyorLoaded ( )

pure virtual

Returns

kTrue if there items loaded in Conveyor

virtual bool16 Facade::IContentDropperFacade::IsUniqueCollectionInDoc ( const UIDList &  uidListToAdd ) const

pure virtual

Checks if a same set of items from the document already exists in Conveyor.

Parameters

[in]

uidListToAdd

set of items to check for.

Returns

kTrue if no other set with same item exists.

virtual ErrorCode Facade::IContentDropperFacade::LoadContentDropper ( const UIDList &  items, ContentDropperTypes::LinkPolicy  linkPolicy = ContentDropperTypes::kUnknownPolicy  )

pure virtual

Loads Conveyor with items in the list, as one set.

Parameters

[in]	items	UIDList of items to be loaded in the conveyor
[in]	linkPolicy	LinkPolicy (if any) for the items.

Returns

ErrorCode returned from the last Grab Command executed in the API

virtual ErrorCode Facade::IContentDropperFacade::LoadContentDropperWithNeedfulSet ( const UIDList *  items, ContentDropperTypes::LinkPolicy  linkPolicy = ContentDropperTypes::kUnknownPolicy  )

pure virtual

Loads Conveyor with items and items referred by them

Parameters

[in]	items	UIDList of items to be loaded in the conveyor
[in]	linkPolicy	LinkPolicy(if any) for the items.

Returns

ErrorCode returned from the last Grab Command executed in the API

virtual ErrorCode Facade::IContentDropperFacade::LoadItemsFromPage ( IDataBase *  db, const UIDList &  pageUIDList, bool16  makeOneCollection = kFalse  )

pure virtual

Loads Conveyor with items from Pages of the document

Parameters

[in]	db	DataBase ptr to the document from which items are to be grabbed.
[in]	pageUIDList	UIDList of pages from which items are to be grabbed.
[in]	makeOneCollection	when grabbing from more than one page, kTrue - to make one collection from all pages, kFalse - grab diff collectons pagewise.

Returns

ErrorCode returned from the last Grab Command executed in the API. If any command fails, it does not execute further commands.

virtual ErrorCode Facade::IContentDropperFacade::LoadItemsFromSpreads ( IDataBase *  db, const UIDList &  spreadUIDList, bool16  makeOneCollection  )

pure virtual

Loads Conveyor with items from Spreads of the document

Parameters

[in]	db	DataBase ptr to the document from which items are to be grabbed.
[in]	spreadUIDList	UIDList of spreads from which items are to be grabbed.
[in]	makeOneCollection	when grabbing from more than one spread, kTrue - to make one collection from all spreads, kFalse - grab diff collectons spreadwise.

Returns

ErrorCode returned from the last Grab Command executed in the API. If any command fails, it does not execute further commands.

virtual bool16 Facade::IContentDropperFacade::MoveHeadToFirstLastItem ( bool16  moveToFirst = kTrue )

pure virtual

Items in Conveyor are sorted in their pck order. API gets the first/last item that was picked on PlaceHead.

Parameters

[in]

moveToFirst

kTrue to get the first item on PlaceHead, kFalse get the last item on PlaceHead.

Returns

kTrue if operation could be performed

virtual ErrorCode Facade::IContentDropperFacade::PlaceContent ( const UIDList &  itemsToPlace, const UIDRef &  targetRef, ContentDropperTypes::LinkPolicy  linkPolicy = ContentDropperTypes::kUnknownPolicy, bool16  mapStyles = kFalse  )

pure virtual

Places items onto a specific spread, and applies link policy

Parameters

[in]	itemsToPlace	UIDListof items to be placed
[in]	targetRef	UIDRef of spread under whose heirarchy the items are to be added.
[in]	linkPolicy	LinkPolicy (if any) for the items.
[in]	mapStyles	map styles.

Returns

ErrorCode returned from the Drop Command executed in the API.

virtual ErrorCode Facade::IContentDropperFacade::PlaceContentFromConveyor ( const UIDRef &  targetRef, ContentDropperTypes::LinkPolicy  linkPolicy = ContentDropperTypes::kUnknownPolicy, bool16  mapStyles = kFalse  )

pure virtual

Place items from Conveyor PlayHead onto a specific spread, and applies link policy

Parameters

[in]	targetRef	UIDRef of spread under whose heirarchy the items are to be added.
[in]	linkPolicy	LinkPolicy(if any) for the items.
[in]	mapStyles	map styles.

Returns

ErrorCode returned from the Drop Command executed in the API.

virtual bool16 Facade::IContentDropperFacade::RotateItemsBy ( const int32  byNoOfItems, const bool16  isForwardDirection = kTrue  )

pure virtual

Moves PlaceHead(the left most position in Conveyor) in Conveyor, by 'byNoOfItems'

Parameters

[in]	byNoOfItems	count of positions by which items are to be moved
[in]	isForwardDirection	kTrue to move item on right of PlaceHead to PlaceHead

Returns

kTrue if items got rotated.

virtual ErrorCode Facade::IContentDropperFacade::SetCDUIPrefsAfterPlaceOption ( ContentDropperTypes::eAfterDrop  option )

pure virtual

Set the after place option from Conveyor.

Parameters

[in]

option

The after drop option

Returns

kSuccess if successful, or other error code

virtual void Facade::IContentDropperFacade::SetCDUIPrefsCollectAllThreadedFrames ( bool16  collectAllFrames = kTrue )

pure virtual

Set the state of Collect All Threaded Frames option from Conveyor.

Parameters

[in]

collectAllFrames

kTrue to collect all threaded frames, kFalse otherwise

virtual void Facade::IContentDropperFacade::SetCDUIPrefsLinkOption ( bool16  link = kTrue )

pure virtual

Set the state of Link option for Conveyor.

Parameters

[in]

link

kTrue to enable link creation, kFalse otherwise.

virtual void Facade::IContentDropperFacade::SetCDUIPrefsMapStyles ( bool16  mapStyle = kTrue )

pure virtual

Set the state of Map Styles option for Conveyor.

Parameters

[in]

mapStyle

kTrue to enable map styles, kFalse otherwise