Custom Platform Support Development Kit  1.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
IFLADocument.h
Go to the documentation of this file.
1 /******************************************************************************
2 * ADOBE CONFIDENTIAL
3 * ___________________
4 *
5 * Copyright [2013] Adobe Systems Incorporated
6 * All Rights Reserved.
7 *
8 * NOTICE: All information contained herein is, and remains
9 * the property of Adobe Systems Incorporated and its suppliers,
10 * if any. The intellectual and technical concepts contained
11 * herein are proprietary to Adobe Systems Incorporated and its
12 * suppliers and are protected by all applicable intellectual
13 * property laws, including trade secret and copyright laws.
14 * Dissemination of this information or reproduction of this material
15 * is strictly forbidden unless prior written permission is obtained
16 * from Adobe Systems Incorporated.
17 ******************************************************************************/
18 
26 #ifndef IFLA_DOCUMENT_H_
27 #define IFLA_DOCUMENT_H_
28 
29 #include "FCMPreConfig.h"
30 #include "FCMPluginInterface.h"
31 #include "Utils/DOMTypes.h"
32 
33 /* -------------------------------------------------- Forward Decl */
34 
35 namespace FCM
36 {
37 
38  FORWARD_DECLARE_INTERFACE(IFCMList);
39 }
40 
41 
42 namespace DOM
43 {
44  FORWARD_DECLARE_INTERFACE(ITimeLine);
45  FORWARD_DECLARE_INTERFACE(ILibraryItem);
46 }
47 
48 
49 /* -------------------------------------------------- Enums */
50 
51 
52 /* -------------------------------------------------- Macros / Constants */
53 
54 namespace DOM
55 {
63  {0x9f54b497, 0x9471, 0x4c13, {0x98, 0x5b, 0x7c, 0xb1, 0xd4, 0x57, 0x60, 0x30}};
64 }
65 
66 
67 /* -------------------------------------------------- Structs / Unions */
68 
69 
70 /* -------------------------------------------------- Class Decl */
71 
72 namespace DOM
73 {
74 
81 
82 
90  virtual FCM::Result _FCMCALL GetBackgroundColor(Utils::COLOR& color) = 0;
91 
92 
102  virtual FCM::Result _FCMCALL GetFrameRate(FCM::Double& frameRate) = 0;
103 
104 
113  virtual FCM::Result _FCMCALL GetStageHeight(FCM::U_Int32& height) = 0;
114 
115 
124  virtual FCM::Result _FCMCALL GetStageWidth(FCM::U_Int32& width) = 0;
125 
126 
150  virtual FCM::Result _FCMCALL GetLibraryItems(FCM::PIFCMList& pLibItemsList) = 0;
151 
152 
169  virtual FCM::Result _FCMCALL GetLibraryItemByPath(
170  FCM::CStringRep16 pPath,
171  PILibraryItem& pLibItem) = 0;
172 
173 
184  virtual FCM::Result _FCMCALL GetTimelines(FCM::PIFCMList& pTimelineList) = 0;
185 
186 
196  virtual FCM::Result _FCMCALL GetTypeId(FCM::FCMGUID& docId) = 0;
197 
198 
211  virtual FCM::Result _FCMCALL GetPath(FCM::StringRep16* ppPath) = 0;
212 
214 };
215 
216 
217 /* -------------------------------------------------- Inline / Functions */
218 
219 
220 #include "FCMPostConfig.h"
221 
222 #endif // IFLA_DOCUMENT_H_
223 
#define FORWARD_DECLARE_INTERFACE(ifx)
Used to forward declare an interface ifx.
Definition: FCMMacros.h:114
unsigned _int32 U_Int32
Type to define an unsigned 32-bit value.
Definition: FCMTypes.h:81
#define BEGIN_DECLARE_INTERFACE(ifx, iid)
Used to begin the interface ifx with ID iid, which inherits from IFCMUnknown.
Definition: FCMMacros.h:147
The definitions contained in this namespace define a framework called Flash Component Model (FCM)...
Definition: IGroup.h:36
U_Int16 * StringRep16
Used to define a UTF16 (unicode) encoded string.
Definition: FCMTypes.h:161
Provides interfaces and other definitions to access the FLA authored contents in the form of a DOM (D...
Defines the interface that represents an FLA document.
Definition: IFLADocument.h:80
This file contains core definitions of the framework Flash Component Model (FCM). ...
#define _FCMCALL
Defines calling convention for interface methods.
Definition: FCMMacros.h:176
This file contains the types used for DOM traversal and access.
U_Int32 Result
Type to define a result. This is usually the return type for most APIs.
Definition: FCMTypes.h:126
Represents a 128 bit or 16-byte GUID (Globally Unique IDentifier) value.
Definition: FCMTypes.h:189
const U_Int16 * CStringRep16
Used to define a constant UTF16 (unicode) encoded string.
Definition: FCMTypes.h:168
FCM::ConstFCMIID IID_IFLA_DOCUMENT
Defines the universally-unique interface ID for IFLADocument.
Definition: IFLADocument.h:62
double Double
Type to define a IEEE double-precision floating point number.
Definition: FCMTypes.h:118
#define END_DECLARE_INTERFACE
Ends an interface.
Definition: FCMMacros.h:165