InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ILibraryCmdData Class Referenceabstract

#include <ILibraryCmdData.h>

Inheritance diagram for ILibraryCmdData:
IPMUnknown

Public Member Functions

virtual void SetLibraryFile (const IDFile &libraryFile)=0
 
virtual IDFile GetLibraryFile ()=0
 
virtual void SetSourceLibrary (ILibrary *library)=0
 
virtual ILibraryGetSourceLibrary ()=0
 
virtual void SetDestLibrary (ILibrary *library)=0
 
virtual ILibraryGetDestLibrary ()=0
 
virtual void SetAssetList (const AssetIDList &assetList)=0
 
virtual AssetIDListGetAssetList ()=0
 
virtual void SetUseOldName (const bool16 bUseOldName)=0
 
virtual bool16 GetUseOldName ()=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Used to pass library reference data with various library command bosses.

Member Function Documentation

virtual AssetIDList& ILibraryCmdData::GetAssetList ()
pure virtual

Get the asset list for the command.

Returns
the list of AssetID's for the command
virtual ILibrary* ILibraryCmdData::GetDestLibrary ()
pure virtual

Gets the destination library for the command.

Returns
the ILibrary interface for the destination library
virtual IDFile ILibraryCmdData::GetLibraryFile ()
pure virtual

Gets the file specification.

Returns
the IDFile file specification
virtual ILibrary* ILibraryCmdData::GetSourceLibrary ()
pure virtual

Gets the source library for the command.

Returns
the ILibrary interface for the source library
virtual bool16 ILibraryCmdData::GetUseOldName ()
pure virtual

Get whether to use the original filename if old-asset-format conversion occurs. FOR INTERNAL USE ONLY

Returns
whether to use the original name (kFalse is the default)
virtual void ILibraryCmdData::SetAssetList (const AssetIDListassetList)
pure virtual

Set the asset list for the command.

Parameters
assetListlist of AssetID's for the assets
virtual void ILibraryCmdData::SetDestLibrary (ILibrarylibrary)
pure virtual

Sets the destination library for the command.

Parameters
libraryIN the ILibrary interface for the destination library
virtual void ILibraryCmdData::SetLibraryFile (const IDFilelibraryFile)
pure virtual

Sets the file specification.

Parameters
libraryFileIN the specification for the library file
virtual void ILibraryCmdData::SetSourceLibrary (ILibrarylibrary)
pure virtual

Sets the source library for the command.

Parameters
libraryIN the ILibrary interface for the source library
virtual void ILibraryCmdData::SetUseOldName (const bool16 bUseOldName)
pure virtual

Set whether to use the original filename if old-asset-format conversion occurs. FOR INTERNAL USE ONLY

Parameters
bUseOldNamekTrue to use the original name (kFalse is the default)