DOM::IFLADocument Class Reference

Defines the interface that represents an FLA document. More...

#include <IFLADocument.h>

Inheritance diagram for DOM::IFLADocument:

Public Member Functions
virtual FCM::Result _FCMCALL	GetBackgroundColor (Utils::COLOR &color)=0
	This function provides the background color of the stage. More...
virtual FCM::Result _FCMCALL	GetFrameRate (FCM::Double &frameRate)=0
	This function provides the frame-rate when the published file is played back. More...
virtual FCM::Result _FCMCALL	GetStageHeight (FCM::U_Int32 &height)=0
	This function returns the stage height (in pixels). More...
virtual FCM::Result _FCMCALL	GetStageWidth (FCM::U_Int32 &width)=0
	This function returns the stage width (in pixels). More...
virtual FCM::Result _FCMCALL	GetLibraryItems (FCM::PIFCMList &pLibItemsList)=0
	This returns the items which are part of the Library. More...
virtual FCM::Result _FCMCALL	GetLibraryItemByPath (FCM::CStringRep16 pPath, PILibraryItem &pLibItem)=0
	This function finds the library item from its path. More...
virtual FCM::Result _FCMCALL	GetTimelines (FCM::PIFCMList &pTimelineList)=0
	This function returns the list of timelines (scenes). More...
virtual FCM::Result _FCMCALL	GetTypeId (FCM::FCMGUID &docId)=0
	This function returns the document type identification of the FLA document. More...
virtual FCM::Result _FCMCALL	GetPath (FCM::StringRep16 *ppPath)=0
	This function returns the path of the FLA document. If the document is never been saved, NULL will be returned. More...

Detailed Description

Defines the interface that represents an FLA document.

Member Function Documentation

virtual FCM::Result _FCMCALL DOM::IFLADocument::GetBackgroundColor ( Utils::COLOR &  color )

pure virtual

This function provides the background color of the stage.

Parameters

color

(OUT) Background color of the stage.

Returns

On success, FCM_SUCCESS is returned, else an error code is returned.

virtual FCM::Result _FCMCALL DOM::IFLADocument::GetFrameRate ( FCM::Double &  frameRate )

pure virtual

This function provides the frame-rate when the published file is played back.

Parameters

frameRate

(OUT) Frame rate - Number of frames displayed per second.

Returns

On success, FCM_SUCCESS is returned, else an error code is returned.

virtual FCM::Result _FCMCALL DOM::IFLADocument::GetLibraryItemByPath ( FCM::CStringRep16  pPath, PILibraryItem &  pLibItem  )

pure virtual

This function finds the library item from its path.

Parameters

pPath	(IN) The full path of the item in the library.
pLibItem	(OUT) Library item. The library item can queried for following depending on its type: Folder - ILibraryItem, IFolder Font - ILibraryItem, IFont Sound/Bitmap - ILibraryItem, IMediaItem MovieClip/Graphic - ILibraryItem, ISymbolItem

Returns

On success, FCM_SUCCESS is returned, else an error code is returned.

virtual FCM::Result _FCMCALL DOM::IFLADocument::GetLibraryItems ( FCM::PIFCMList &  pLibItemsList )

pure virtual

This returns the items which are part of the Library.

Parameters

pLibItemsList

(OUT) List of library items. Each item in the list can queried for following depending on its type: Folder - ILibraryItem, IFolder Font - ILibraryItem, IFont Sound/Bitmap - ILibraryItem, IMediaItem MovieClip/Graphic - ILibraryItem, ISymbolItem

Returns

On success, FCM_SUCCESS is returned, else an error code is returned.

See also

DOM::ILibraryItem

DOM::LibraryItem::IFolderItem

DOM::LibraryItem::IFontItem

DOM::LibraryItem::IMediaItem

DOM::LibraryItem::ISymbolItem

virtual FCM::Result _FCMCALL DOM::IFLADocument::GetPath ( FCM::StringRep16 *  ppPath )

pure virtual

This function returns the path of the FLA document. If the document is never been saved, NULL will be returned.

Parameters

ppPath

(OUT) Path of the document.

Returns

On success, FCM_SUCCESS is returned, else an error code is returned.

Note

Memory allocated for ppPath must be released by the caller using FCM::IFCMCalloc.

virtual FCM::Result _FCMCALL DOM::IFLADocument::GetStageHeight ( FCM::U_Int32 &  height )

pure virtual

This function returns the stage height (in pixels).

Parameters

height

(OUT) Height of the stage.

Returns

On success, FCM_SUCCESS is returned, else an error code is returned.

virtual FCM::Result _FCMCALL DOM::IFLADocument::GetStageWidth ( FCM::U_Int32 &  width )

pure virtual

This function returns the stage width (in pixels).

Parameters

width

(OUT) Width of the stage.

Returns

On success, FCM_SUCCESS is returned, else an error code is returned.

virtual FCM::Result _FCMCALL DOM::IFLADocument::GetTimelines ( FCM::PIFCMList &  pTimelineList )

pure virtual

This function returns the list of timelines (scenes).

Parameters

pTimelineList

(OUT) List of timelines or scenes (ITimeline).

Returns

On success, FCM_SUCCESS is returned, else an error code is returned.

See also

DOM::ITimeline

virtual FCM::Result _FCMCALL DOM::IFLADocument::GetTypeId ( FCM::FCMGUID &  docId )

pure virtual

This function returns the document type identification of the FLA document.

Parameters

docId

(OUT) Id to identify the document type.

Returns

On success, FCM_SUCCESS is returned, else an error code is returned.

---

The documentation for this class was generated from the following file:

• app/include/interfaces/DOM/IFLADocument.h