Facade::IImportExportFacade Class Reference

Inheritance diagram for Facade::IImportExportFacade:

Public Types
enum	{ kDefaultIID = IID_IIMPORTEXPORTFACADE }

Public Member Functions
virtual ErrorCode	ReplacePageItem (IDataBase *db, UID oldPageItem, UID newPageItem, bool16 useClippingFrame, UIDList &replaceList) const =0
virtual ErrorCode	PlaceExternalFile (ISpread *spread, const IDFile &filePath, const PBPMPoint &pbPoint) const =0
virtual ErrorCode	PlaceExternalFileWithUIFlags (ISpread *spread, const IDFile &filePath, const PBPMPoint &pbPoint, const UIFlags uiFlags) 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

Place Gun command methods
enum	PlaceGunContent { kFirstItem, kAllItems }
virtual ErrorCode	LoadPlaceGun (const UIDList &itemList, IPlaceGun::PlaceGunLocation location) const =0
virtual ErrorCode	LoadPlaceGun (ICmdCollection *cmdCollection, IPlaceGun::PlaceGunLocation location) const =0
virtual ErrorCode	ClearPlaceGun (IPlaceGun *placeGun, PlaceGunContent what) const =0
virtual ErrorCode	AbortPlaceGun (IPlaceGun *placeGun, PlaceGunContent what) const =0
virtual ErrorCode	ImportAndLoadPlaceGun (IDataBase *db, const URI &uri, UIFlags flags, bool16 retainFormat, bool16 convertQuotes, bool16 applyCJKGrid, UID uidPreview, IPlaceGun::PlaceGunLocation location) const =0
virtual ErrorCode	ImportAndLoadPlaceGun (IImportResourceCmdData *cmdData, IPlaceGun::PlaceGunLocation location) const =0
virtual ErrorCode	ImportAndLoadPlaceGun (IDataBase *db, const URI &uri, UIFlags flags, bool16 retainFormat, bool16 convertQuotes, bool16 applyCJKGrid, bool16 &useClippingFrame, bool16 &skipPlace) const =0
virtual ErrorCode	ImportAndLoadPlaceGun (IDataBase *db, UID linkResourceUID, UIFlags flags, bool16 retainFormat, bool16 convertQuotes, bool16 applyCJKGrid, bool16 &useClippingFrame, bool16 &skipPlace) const =0
virtual ErrorCode	RotatePlaceGun (IPlaceGun *placeGun, bool16 forward) const =0

Member Function Documentation

virtual ErrorCode Facade::IImportExportFacade::AbortPlaceGun ( IPlaceGun *  placeGun, PlaceGunContent  what  ) const

pure virtual

Abort the place gun by clearing one or all items and deleting them.

Parameters

placeGun	[IN] The place gun to abort.
what	[IN] Whether to abort just the first or all items in the place gun.

Returns

kSuccess if the place gun is aborted, else an error code.

virtual ErrorCode Facade::IImportExportFacade::ClearPlaceGun ( IPlaceGun *  placeGun, PlaceGunContent  what  ) const

pure virtual

Clear one or all items from the place gun. The cleared items are not deleted.

Parameters

placeGun	[IN] The place gun to clear.
what	[IN] Whether to clear just the first or all items in the place gun.

Returns

kSuccess if the place gun is cleared, else an error code.

virtual ErrorCode Facade::IImportExportFacade::ImportAndLoadPlaceGun ( IDataBase *  db, const URI &  uri, UIFlags  flags, bool16  retainFormat, bool16  convertQuotes, bool16  applyCJKGrid, UID  uidPreview, IPlaceGun::PlaceGunLocation  location  ) const

pure virtual

Load the place gun with one or more items.

Parameters

db	[IN] database to be imported into (required)
uri	[IN] identifying the resource to import.
flags	[IN] specifies how much UI to show during import
retainFormat	[IN] retain text format, applies to text import
convertQuotes[IN]	convert quotation mark types, applies to text import
applyCJKGrid	[IN] apply CJK grid if present, applies to text import
uidPreview	[IN] UID of preview object
location	[IN] Where to load the items.

Returns

kSuccess if the place gun is loaded, else an error code.

virtual ErrorCode Facade::IImportExportFacade::ImportAndLoadPlaceGun ( IImportResourceCmdData *  cmdData, IPlaceGun::PlaceGunLocation  location  ) const

pure virtual

Load the place gun with one or more items.

Parameters

cmdData	[IN] Existing command data to reuse (required)
location	[IN] Where to load the items.

Returns

kSuccess if the place gun is loaded, else an error code.

virtual ErrorCode Facade::IImportExportFacade::ImportAndLoadPlaceGun ( IDataBase *  db, const URI &  uri, UIFlags  flags, bool16  retainFormat, bool16  convertQuotes, bool16  applyCJKGrid, bool16 &  useClippingFrame, bool16 &  skipPlace  ) const

pure virtual

Load the place gun with one or more items.

Parameters

db	[IN] database to be imported into (required)
uri	[IN] identifying the resource to import.
flags	[IN] specifies how much UI to show during import
retainFormat	[IN] retain text format, applies to text import
convertQuotes[IN]	convert quotation mark types, applies to text import
applyCJKGrid	[IN] apply CJK grid if present, applies to text import
useClippingFrame	[OUT] Whether the command indicated to use the clipping frame
skipPlace	[OUT] Whether the command indicated to skip place

Returns

kSuccess if the place gun is loaded, else an error code.

virtual ErrorCode Facade::IImportExportFacade::ImportAndLoadPlaceGun ( IDataBase *  db, UID  linkResourceUID, UIFlags  flags, bool16  retainFormat, bool16  convertQuotes, bool16  applyCJKGrid, bool16 &  useClippingFrame, bool16 &  skipPlace  ) const

pure virtual

Load the place gun with one or more items.

Parameters

db	[IN] database to be imported into (required)
linkResourceUID	[IN] identifying the resource to import.
flags	[IN] specifies how much UI to show during import
retainFormat	[IN] retain text format, applies to text import
convertQuotes[IN]	convert quotation mark types, applies to text import
applyCJKGrid	[IN] apply CJK grid if present, applies to text import
useClippingFrame	[OUT] Whether the command indicated to use the clipping frame
skipPlace	[OUT] Whether the command indicated to skip place

Returns

kSuccess if the place gun is loaded, else an error code.

virtual ErrorCode Facade::IImportExportFacade::LoadPlaceGun ( const UIDList &  itemList, IPlaceGun::PlaceGunLocation  location  ) const

pure virtual

Load the place gun with one or more items.

Parameters

itemList	[IN] The items to load. The items will be loaded into the place gun associated with the items' database.
location	[IN] Where to load the items.

Returns

kSuccess if the place gun is loaded, else an error code.

virtual ErrorCode Facade::IImportExportFacade::LoadPlaceGun ( ICmdCollection *  cmdCollection, IPlaceGun::PlaceGunLocation  location  ) const

pure virtual

Load the place gun with items from a pipeline command. Executes the pipeline command.

Parameters

itemList	[IN] The pipeline command that will supply the items to load. The items will be loaded into the place gun associated with the items' database.
location	[IN] Where to load the items.

Returns

kSuccess if the place gun is loaded, else an error code.

virtual ErrorCode Facade::IImportExportFacade::PlaceExternalFile ( ISpread *  spread, const IDFile &  filePath, const PBPMPoint &  pbPoint  ) const

pure virtual

Place an external file on the specified point on pasteboard

Parameters

spread	[IN] spread of the document where file has to be placed
filePath	[IN] file path of the file to be placed
pbPoint	[IN] position to be placed with respect to the pasteboard coordinates

virtual ErrorCode Facade::IImportExportFacade::PlaceExternalFileWithUIFlags ( ISpread *  spread, const IDFile &  filePath, const PBPMPoint &  pbPoint, const UIFlags  uiFlags  ) const

pure virtual

Place an external file on the specified point on pasteboard

Parameters

spread	[IN] spread of the document where file has to be placed
filePath	[IN] file path of the file to be placed
pbPoint	[IN] position to be placed with respect to the pasteboard coordinates
uiFlags	[IN] specifies how much UI to show during import

virtual ErrorCode Facade::IImportExportFacade::ReplacePageItem ( IDataBase *  db, UID  oldPageItem, UID  newPageItem, bool16  useClippingFrame, UIDList &  replaceList  ) const

pure virtual

Replace one page item with another.

See Also

IPlaceBehavior::ProcessReplace

Parameters

db	[IN] database where the replace will occur.
oldPageItem	[IN] UID of the page item to be replaced.
newPageItem	[IN] UID of the new page item.
useClippingFrame	[IN] retain the clipping frame.
replaceList	[OUT] the placed item(s)

Returns

kSuccess if replace is successful, else an error code.

virtual ErrorCode Facade::IImportExportFacade::RotatePlaceGun ( IPlaceGun *  placeGun, bool16  forward  ) const

pure virtual

Rotate the items in theplace gun.

Parameters

placeGun	[IN] The place gun to rotate.
forward	[IN] Rotate the list forward (i.e. move the front item to end) or backward (move backmost item to front)

Returns

kSuccess if the place gun is rotated, else an error code.