InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | List of all members
ILibraryAssetContents Class Referenceabstract

#include <ILibraryAssetContents.h>

Inheritance diagram for ILibraryAssetContents:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ILIBRARYASSETCONTENTS }
 
enum  AssetMakeup {
  kAllUntaggedPageItems = 0, kAllTaggedPageItems, kMixedTaggedAndUntaggedPageItems, kAllStructureElements,
  kUnknownAssetMakeup
}
 

Public Member Functions

virtual IPMStream * QueryDataReadStream ()=0
 
virtual IPMStream * QueryDataWriteStream ()=0
 
virtual void DeleteData ()=0
 
virtual void SetAssetData (const uchar *assetData, int32 assetDatalength)=0
 
virtual void SetAssetData (IXferBytes *assetData, int32 assetDatalength)=0
 
virtual uchar * GetAssetData () const =0
 
virtual int32 GetAssetDatalength () const =0
 
virtual IDirInfo * QueryDirInfo ()
 
virtual AssetMakeup GetAssetMakeup ()=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknown * QueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

A secondary interface to the LibraryAsset boss, this controls reading and writing of the "content" data of an asset.

See Also
IDirInfo

Member Enumeration Documentation

enum ILibraryAssetContents::AssetMakeup

What's in an asset, with respect to pageitems and/or structure.
Enumerator
kAllUntaggedPageItems 

All untagged pageitems

kAllTaggedPageItems 

All tagged pageitems

kMixedTaggedAndUntaggedPageItems 

Mixed tagged and untagged pageitems

kAllStructureElements 

All structure elements

kUnknownAssetMakeup 

Unknown makeup

Member Function Documentation

virtual void ILibraryAssetContents::DeleteData ()
pure virtual

Deletes the current contents of the asset.

virtual uchar* ILibraryAssetContents::GetAssetData () const
pure virtual

Get a pointer to the data block for the asset.

Returns
a pointer to the first data character
virtual int32 ILibraryAssetContents::GetAssetDatalength () const
pure virtual

Get the length of the data block.

Returns
the length of the data block
virtual AssetMakeup ILibraryAssetContents::GetAssetMakeup ()
pure virtual

Get pageitem/structure mixture data on the asset.

Returns
an AssetMakeup telling what's in the asset.
virtual IPMStream* ILibraryAssetContents::QueryDataReadStream ()
pure virtual

Returns a pointer to a stream from which the asset's contents can be read. Pointer must be released by caller. May return nil if no content data exists.

Returns
an IPMStream interface pointer or nil
virtual IPMStream* ILibraryAssetContents::QueryDataWriteStream ()
pure virtual

Returns a pointer to a stream to which the asset's contents can be written. Pointer must be released by caller. May return nil if no content data exists.

Returns
an IPMStream interface pointer or nil
virtual IDirInfo* ILibraryAssetContents::QueryDirInfo ()
inlinevirtual

Get general information on what's in the asset.

Returns
an interface pointer to the IDirInfo for the asset. Must be released by caller.
virtual void ILibraryAssetContents::SetAssetData (const uchar * assetData,
int32 assetDatalength 
)
pure virtual

Sets the data of an asset.

Parameters
assetDataIN a pointer to the asset data, in INX snippet form
assetDatalengthIN the length of the data block
virtual void ILibraryAssetContents::SetAssetData (IXferBytes * assetData,
int32 assetDatalength 
)
pure virtual

Sets the data of an asset.

Parameters
assetDataIN a pointer to the asset data, in INX snippet form
assetDatalengthIN the length of the data block