Custom Platform Support Development Kit  1.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | List of all members
Exporter::Service::IResourcePalette Class Referenceabstract

An interface that defines a resource palette to hold all the resources encountered in the DOM traversal. More...

#include <IResourcePalette.h>

Inheritance diagram for Exporter::Service::IResourcePalette:

Public Member Functions

virtual FCM::Result _FCMCALL AddSymbol (FCM::U_Int32 resourceId, FCM::StringRep16 pName, Exporter::Service::PITimelineBuilder pTimelineBuilder)=0
 This function is invoked to add a symbol to the resource palette. More...
 
virtual FCM::Result _FCMCALL AddShape (FCM::U_Int32 resourceId, DOM::FrameElement::PIShape pShape)=0
 This function is invoked to add a shape to the resource palette. More...
 
virtual FCM::Result _FCMCALL AddSound (FCM::U_Int32 resourceId, DOM::LibraryItem::PIMediaItem pMediaItem)=0
 This function is invoked to add a sound object to the resource palette. More...
 
virtual FCM::Result _FCMCALL AddBitmap (FCM::U_Int32 resourceId, DOM::LibraryItem::PIMediaItem pMediaItem)=0
 This function is invoked to add a bitmap object to the resource palette. More...
 
virtual FCM::Result _FCMCALL AddClassicText (FCM::U_Int32 resourceId, DOM::FrameElement::PIClassicText pClassicText)=0
 This function is invoked to add a text object to the resource palette. More...
 
virtual FCM::Result _FCMCALL HasResource (FCM::U_Int32 resourceId, FCM::Boolean &hasResource)=0
 This function is invoked every time a resource is encountered during the DOM traversal to check if a resource is already added in the resource palette. More...
 

Detailed Description

An interface that defines a resource palette to hold all the resources encountered in the DOM traversal.

Member Function Documentation

virtual FCM::Result _FCMCALL Exporter::Service::IResourcePalette::AddBitmap ( FCM::U_Int32  resourceId,
DOM::LibraryItem::PIMediaItem  pMediaItem 
)
pure virtual

This function is invoked to add a bitmap object to the resource palette.

Parameters
resourceId(IN) Resource Id associated with the bitmap which is getting added to the palette.
pMediaItem(IN) Library object associated with bitmap through which bitmap information is extracted. This parameter can also be successfully queried for DOM::ILibraryItem.
Returns
On success, FCM_SUCCESS is returned, else an error code is returned.
Note
Bitmap service (FLA_BITMAP_SERVICE) can be used to export the media item to a known bitmap format.
virtual FCM::Result _FCMCALL Exporter::Service::IResourcePalette::AddClassicText ( FCM::U_Int32  resourceId,
DOM::FrameElement::PIClassicText  pClassicText 
)
pure virtual

This function is invoked to add a text object to the resource palette.

Parameters
resourceId(IN) Resource Id associated with the text which is getting added to the palette.
pClassicText(IN) Text object which contains the text related information.
Returns
On success, FCM_SUCCESS is returned, otherwise an error code is returned.
virtual FCM::Result _FCMCALL Exporter::Service::IResourcePalette::AddShape ( FCM::U_Int32  resourceId,
DOM::FrameElement::PIShape  pShape 
)
pure virtual

This function is invoked to add a shape to the resource palette.

Parameters
resourceId(IN) Resource Id associated with the shape, which is getting added to the palette.
pShape(IN) Shape object associated with resourceId via which shape information is extracted.
Returns
On success, FCM_SUCCESS is returned, else an error code is returned.
Note
Shape services (FLA_REGION_GENERATOR_SERVICE) can be used to extract the geometry information (such as the boundary and holes) along with fill and stroke style information.
virtual FCM::Result _FCMCALL Exporter::Service::IResourcePalette::AddSound ( FCM::U_Int32  resourceId,
DOM::LibraryItem::PIMediaItem  pMediaItem 
)
pure virtual

This function is invoked to add a sound object to the resource palette.

Parameters
resourceId(IN) Resource Id associated with the sound that is getting added to the palette.
pMediaItem(IN) Library object associated with sound through which sound information is extracted. This parameter can also be successfully queried for DOM::ILibraryItem.
Returns
On success, FCM_SUCCESS is returned, otherwise an error code is returned.
Note
Sound service (FLA_SOUND_SERVICE) can be used to export the media item to a known sound format.
See also
ILibraryItem
virtual FCM::Result _FCMCALL Exporter::Service::IResourcePalette::AddSymbol ( FCM::U_Int32  resourceId,
FCM::StringRep16  pName,
Exporter::Service::PITimelineBuilder  pTimelineBuilder 
)
pure virtual

This function is invoked to add a symbol to the resource palette.

Parameters
resourceId(IN) Resource Id associated with the symbol which is getting added to the palette.
pName(IN) Name of the symbol which is getting added to the palette. For graphic symbols, pName can be NULL.
pTimelineBuilder(IN) TimelineBuilder object for the symbol. Contains all the timeline commands.
Returns
On success, FCM_SUCCESS is returned, else an error code is returned.
virtual FCM::Result _FCMCALL Exporter::Service::IResourcePalette::HasResource ( FCM::U_Int32  resourceId,
FCM::Boolean &  hasResource 
)
pure virtual

This function is invoked every time a resource is encountered during the DOM traversal to check if a resource is already added in the resource palette.

Parameters
resourceId(IN) Resource Id .
hasResource(OUT) This param must be updated to true if the resource is already added to the the resource palette.
Returns
On success, FCM_SUCCESS is returned, else an error code is returned.
The documentation for this class was generated from the following file: