Custom Platform Support Development Kit  1.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
DOM::FrameElement Namespace Reference

Provides interfaces and definitions for Frame elements. More...

Classes

struct  AA_MODE_PROP
 Structure that consists of Anti-Alias mode and custom mode. More...
 
struct  CUSTOM_AA_MODE_PROP
 This structure defines a Custom Anti-Alias Mode properties. More...
 
class  IBitmapInstance
 Defines an interface that represents a bitmap instance present on the stage. More...
 
class  IButton
 Defines an interface that represents a "Button" instance on the stage. More...
 
class  IClassicText
 Defines an interface that represents the text element present on the stage. More...
 
class  IDynamicTextBehaviour
 Defines an interface that represents the dynamic text type of the text element present on the stage. More...
 
class  IFrameDisplayElement
 Defines the interface that represents a display item on the stage. More...
 
class  IGraphic
 Defines an interface that represents an instance of a "graphic" symbol present on the stage. More...
 
class  IGroup
 Defines an interface that represents a Group. More...
 
class  IInputTextBehaviour
 Defines an interface that represents the Input text type of the text element present on the stage. More...
 
class  IInstance
 Defines an interface that represents an instance of a library item that is present on the stage. More...
 
class  IModifiableTextBehaviour
 Defines an interface that represents the base class for the dynamic/input text type of the text element present on the stage. More...
 
class  IMovieClip
 Defines an interface that represents an instance of a "movie-clip" symbol present on the stage. More...
 
class  IParagraph
 IParagraph interface represents paragraph of text. More...
 
class  IShape
 Defines an interface that represents a shape. More...
 
class  ISound
 Defines the interface that represents a sound item attached to a frame. More...
 
class  IStaticTextBehaviour
 Defines an interface that represents the static text type of the text element present on the stage. More...
 
class  ISymbolInstance
 Defines an interface that represents an instance of a symbol present on the stage. More...
 
class  ITextBehaviour
 Defines an interface that represents type of the text element present on the stage. More...
 
class  ITextRun
 Defines an interface that represents a string of characters with the common text attributes. More...
 
class  ITextStyle
 Defines an interface that represents the properties that describe characters. More...
 
struct  PARAGRAPH_STYLE
 Describes the paragraph layout data of the text element. More...
 
struct  SOUND_LIMIT
 Defines the starting and ending points of the sound object. More...
 
struct  SOUND_LOOP_MODE
 Defines the loop mode for a sound. More...
 

Enumerations

enum  ButtonTrackMode { TRACK_AS_BUTTON, TRACK_AS_MENU_ITEM }
 Defines the different tracking options available for a Button instance. More...
 
enum  AAMode {
  ANTI_ALIAS_MODE_DEVICE, ANTI_ALIAS_MODE_BITMAP, ANTI_ALIAS_MODE_STANDARD, ANTI_ALIAS_MODE_ADVANCED,
  ANTI_ALIAS_MODE_CUSTOM
}
 This defines anti-alias mode. More...
 
enum  AnimationLoopMode { ANIMATION_LOOP, ANIMATION_PLAY_ONCE, ANIMATION_SINGLE_FRAME }
 This defines different modes of playing animation for graphic instance. More...
 
enum  BlendMode {
  NORMAL_BLEND_MODE, LAYER_BLEND_MODE, DARKEN_BLEND_MODE, MULTIPLY_BLEND_MODE,
  LIGHTEN_BLEND_MODE, SCREEN_BLEND_MODE, OVERLAY_BLEND_MODE, HARDLIGHT_BLEND_MODE,
  ADD_BLEND_MODE, SUBTRACT_BLEND_MODE, DIFFERENCE_BLEND_MODE, INVERT_BLEND_MODE,
  ALPHA_BLEND_MODE, ERASE_BLEND_MODE
}
 Defines the different Blend modes available for the MovieClip instance. More...
 
enum  AlignMode { ALIGN_MODE_LEFT, ALIGN_MODE_RIGHT, ALIGN_MODE_CENTER, ALIGN_MODE_JUSTIFY }
 This defines alignment mode of text. More...
 
enum  SoundRepeatMode { SOUND_REPEAT_INFINITE, SOUND_REPEAT_FINITE }
 This enum defines the repetition mode of a sound. More...
 
enum  SoundSyncMode { SOUND_SYNC_EVENT, SOUND_SYNC_START, SOUND_SYNC_STOP, SOUND_SYNC_STREAM }
 This enum defines sync mode of a sound. More...
 
enum  OrientationMode { ORIENTATION_MODE_HORIZONTAL, ORIENTATION_MODE_VERTICAL }
 This defines orientation mode of the static text element. More...
 
enum  TextFlow { TEXT_FLOW_LEFT_TO_RIGHT, TEXT_FLOW_RIGHT_TO_LEFT }
 This defines static text flow. More...
 
enum  LineMode { LINE_MODE_SINGLE, LINE_MODE_MULTI, LINE_MODE_MULTI_NO_WRAP }
 This defines the paragraph behavior mode of the dynamic/input text element. More...
 
enum  BaseLineShiftStyle { BASE_LINE_SHIFT_STYLE_NORMAL, BASE_LINE_SHIFT_STYLE_SUPERSCRIPT, BASE_LINE_SHIFT_STYLE_SUBSCRIPT }
 This enumerates the base line shift styles. More...
 

Variables

FCM::ConstFCMIID IID_IBITMAP_INSTANCE
 Defines the universally-unique interface ID for IBitmapInstance. More...
 
FCM::ConstFCMIID IID_IBUTTON_INSTANCE
 Defines the universally-unique interface ID for IButton. More...
 
FCM::ConstFCMIID IID_ICLASSIC_TEXT_ELEMENT
 Defines the universally-unique interface ID for IClassicText. More...
 
FCM::ConstFCMIID IID_IFRAME_DISPLAY_ELEMENT
 Defines the universally-unique interface ID for IFrameDisplayElement. More...
 
FCM::ConstFCMIID IID_IGRAPHIC_INSTANCE
 Defines the universally-unique interface ID for IGraphic. More...
 
FCM::ConstFCMIID IID_IGROUP
 Defines the Interface ID (which is universally unique) for IGroup. More...
 
FCM::ConstFCMIID IID_IINSTANCE
 Defines the universally-unique interface ID for IInstance. More...
 
FCM::ConstFCMIID IID_IMOVIE_CLIP_INSTANCE
 Defines the universally-unique interface ID for IMovieClip. More...
 
FCM::ConstFCMIID IID_IPARAGRAPH
 Defines the universally-unique interface ID for IParagraph. More...
 
FCM::ConstFCMIID IID_ISHAPE
 Defines the universally-unique interface ID for IShape. More...
 
FCM::ConstFCMIID IID_ISOUND_ELEMENT
 Defines the universally-unique interface ID for ISound. More...
 
FCM::ConstFCMIID IID_ISYMBOL_INSTANCE
 Defines the universally-unique interface ID for ISymbolInstance. More...
 
FCM::ConstFCMIID IID_ITEXT_BEHAVIOUR
 Defines the universally-unique interface ID for ITextBehaviour. More...
 
FCM::ConstFCMIID IID_ISTATIC_TEXT_BEHAVIOUR
 Defines the universally-unique interface ID for IStaticTextBehaviour. More...
 
FCM::ConstFCMIID IID_IMODIFIABLE_TEXT_BEHAVIOUR
 Defines the universally-unique interface ID for ITextBehaviour. More...
 
FCM::ConstFCMIID IID_IDYNAMIC_TEXT_BEHAVIOUR
 Defines the universally-unique interface ID for IDynamicTextBehaviour. More...
 
FCM::ConstFCMIID IID_IINPUT_TEXT_BEHAVIOUR
 Defines the universally-unique interface ID for IInputTextBehaviour. More...
 
FCM::ConstFCMIID IID_ITEXT_RUN
 Defines the universally-unique interface ID for ITextRun. More...
 
FCM::ConstFCMIID IID_ITEXT_STYLE
 Defines the universally-unique interface ID for ITextStyle. More...
 
FCM::CStringRep8 const REGULAR_STYLE_STR = "RegularStyle"
 Defines the 'regular' text style.
 
FCM::CStringRep8 const ITALIC_STYLE_STR = "ItalicStyle"
 Defines the 'italic' text style.
 
FCM::CStringRep8 const BOLD_STYLE_STR = "BoldStyle"
 Defines the 'bold' text style.
 
FCM::CStringRep8 const BOLD_ITALIC_STYLE_STR = "BoldItalicStyle"
 Defines the 'bold-italic' text style.
 

Detailed Description

Provides interfaces and definitions for Frame elements.

Enumeration Type Documentation

This defines anti-alias mode.

Enumerator
ANTI_ALIAS_MODE_DEVICE 

Device anti-alias mode

ANTI_ALIAS_MODE_BITMAP 

Bitmap anti-alias mode

ANTI_ALIAS_MODE_STANDARD 

Standard anti-alias mode

ANTI_ALIAS_MODE_ADVANCED 

Advanced anti-alias mode

ANTI_ALIAS_MODE_CUSTOM 

Custom anti-alias mode

This defines alignment mode of text.

Enumerator
ALIGN_MODE_LEFT 

Left align if orientation is horizontal. Top align if orientation is vertical.

ALIGN_MODE_RIGHT 

Right align if orientation is horizontal. Bottom align if orientation is vertical.

ALIGN_MODE_CENTER 

Center Align

ALIGN_MODE_JUSTIFY 

Justify Align

This defines different modes of playing animation for graphic instance.

Enumerator
ANIMATION_LOOP 

Loop

ANIMATION_PLAY_ONCE 

Play once

ANIMATION_SINGLE_FRAME 

Single frame

This enumerates the base line shift styles.

Enumerator
BASE_LINE_SHIFT_STYLE_NORMAL 

Normal base line shift style

BASE_LINE_SHIFT_STYLE_SUPERSCRIPT 

Superscript base line shift style

BASE_LINE_SHIFT_STYLE_SUBSCRIPT 

Subscript base line shift style

Defines the different Blend modes available for the MovieClip instance.

Enumerator
NORMAL_BLEND_MODE 

Normal

LAYER_BLEND_MODE 

Layer

DARKEN_BLEND_MODE 

Darken

MULTIPLY_BLEND_MODE 

Multiply

LIGHTEN_BLEND_MODE 

Lighten

SCREEN_BLEND_MODE 

Screen

OVERLAY_BLEND_MODE 

Overlay

HARDLIGHT_BLEND_MODE 

Hardlight

ADD_BLEND_MODE 

Add

SUBTRACT_BLEND_MODE 

Substract

DIFFERENCE_BLEND_MODE 

Difference

INVERT_BLEND_MODE 

Invert

ALPHA_BLEND_MODE 

Alpha

ERASE_BLEND_MODE 

Erase

Defines the different tracking options available for a Button instance.

Enumerator
TRACK_AS_BUTTON 

Track as button

TRACK_AS_MENU_ITEM 

Track as menu item

This defines the paragraph behavior mode of the dynamic/input text element.

Enumerator
LINE_MODE_SINGLE 

single line

LINE_MODE_MULTI 

multi line

LINE_MODE_MULTI_NO_WRAP 

multi-line with no wrap

This defines orientation mode of the static text element.

Enumerator
ORIENTATION_MODE_HORIZONTAL 

Horizontal orientation

ORIENTATION_MODE_VERTICAL 

Vertical orientation

This enum defines the repetition mode of a sound.

Enumerator
SOUND_REPEAT_INFINITE 

Sound is looped infinitely

SOUND_REPEAT_FINITE 

Sound is looped for a finite number of times

This enum defines sync mode of a sound.

Enumerator
SOUND_SYNC_EVENT 

Synchronizes the sound to the occurrence of an event. An event sound plays when its starting keyframe first appears and plays in its entirety, independently of the playhead in the Timeline. An event sound continues playing until explicitly stopped.

If an event sound is playing and the sound is instantiated again (for example, by the user clicking a button again, or the playhead passing the starting keyframe of the sound), the first instance of the sound continues to play and another instance of the same sound begins to play simultaneously.

SOUND_SYNC_START 

Same as SOUND_SYNC_EVENT, except that if the sound is already being played, no new instance of the sound is played.

SOUND_SYNC_STOP 

Silences the specified sound.

SOUND_SYNC_STREAM 

Stream sounds begin playing as soon as enough data for the first few frames has been downloaded; stream sounds are synchronized to the Timeline.

An example of a stream sound is the voice of a character in an animation that plays in multiple frames.

This defines static text flow.

Enumerator
TEXT_FLOW_LEFT_TO_RIGHT 

Left to right

TEXT_FLOW_RIGHT_TO_LEFT 

Right to left

Variable Documentation

FCM::ConstFCMIID DOM::FrameElement::IID_IBITMAP_INSTANCE
Initial value:
=
{0xe45b963e, 0xa428, 0x4d20, {0xb9, 0x1a, 0xe8, 0x91, 0x6, 0x84, 0xd8, 0xab}}

Defines the universally-unique interface ID for IBitmapInstance.

Note
Textual Representation: {E45B963E-A428-4D20-B91A-E8910684D8AB}
FCM::ConstFCMIID DOM::FrameElement::IID_IBUTTON_INSTANCE
Initial value:
=
{0x1e104164, 0x6508, 0x4cf9, {0xb5, 0x37, 0xe5, 0x05, 0x7a, 0x3f, 0x3c, 0x8b}}

Defines the universally-unique interface ID for IButton.

Note
Textual Representation: {1E104164-6508-4CF9-B537-E5057A3F3C8B}
FCM::ConstFCMIID DOM::FrameElement::IID_ICLASSIC_TEXT_ELEMENT
Initial value:
=
{0x5c41008c, 0x3fbd, 0x496d, {0xa3, 0xd1, 0xee, 0x75, 0x2d, 0x9, 0x1d, 0xda}}

Defines the universally-unique interface ID for IClassicText.

Note
Textual Representation: {5C41008C-3FBD-496D-A3D1-EE752D091DDA}
FCM::ConstFCMIID DOM::FrameElement::IID_IDYNAMIC_TEXT_BEHAVIOUR
Initial value:
=
{0x94655a95, 0x990b, 0x4540, {0x91, 0x5b, 0x70, 0x52, 0x93, 0x32, 0x31, 0xf8}}

Defines the universally-unique interface ID for IDynamicTextBehaviour.

Note
Textual Representation: {94655A95-990B-4540-915B-7052933231F8}
FCM::ConstFCMIID DOM::FrameElement::IID_IFRAME_DISPLAY_ELEMENT
Initial value:
=
{0x800f6ff6, 0x59c5, 0x4fe3, {0xab, 0xbb, 0xce, 0xe2, 0x62, 0x61, 0xa6, 0xb8}}

Defines the universally-unique interface ID for IFrameDisplayElement.

Note
Textual Representation: {800F6FF6-59C5-4FE3-ABBB-CEE26261A6B8}
FCM::ConstFCMIID DOM::FrameElement::IID_IGRAPHIC_INSTANCE
Initial value:
=
{0xe8e5694b, 0x749b, 0x411e, {0x9a, 0x1c, 0x50, 0x35, 0xf3, 0x7d, 0x10, 0x32}}

Defines the universally-unique interface ID for IGraphic.

Note
Textual Representation: {E8E5694B-749B-411E-9A1C-5035F37D1032}
FCM::ConstFCMIID DOM::FrameElement::IID_IGROUP
Initial value:
=
{0xe43e72e4, 0xb425, 0x46a4, {0x91, 0x23, 0xf3, 0x36, 0x3a, 0xa5, 0x9a, 0x37}}

Defines the Interface ID (which is universally unique) for IGroup.

Note
Textual Representation: {E43E72E4-B425-46A4-9123-F3363AA59A37}
FCM::ConstFCMIID DOM::FrameElement::IID_IINPUT_TEXT_BEHAVIOUR
Initial value:
=
{0x9d1e6460, 0x990f, 0x4d81, {0xbb, 0x24, 0x8d, 0x91, 0x59, 0xcd, 0x96, 0xf9}}

Defines the universally-unique interface ID for IInputTextBehaviour.

Note
Textual Representation: {9D1E6460-990F-4D81-BB24-8D9159CD96F9}
FCM::ConstFCMIID DOM::FrameElement::IID_IINSTANCE
Initial value:
=
{0xfaaac715, 0xfa2b, 0x43e2, {0x8b, 0x33, 0x62, 0xa1, 0xc4, 0x5, 0x9d, 0x1e}}

Defines the universally-unique interface ID for IInstance.

Note
Textual Representation: {FAAAC715-FA2B-43E2-8B33-62A1C4059D1E}
FCM::ConstFCMIID DOM::FrameElement::IID_IMODIFIABLE_TEXT_BEHAVIOUR
Initial value:
=
{0x6499d11f, 0x6af1, 0x4403, {0xbd, 0xb1, 0x76, 0x2, 0x14, 0xf3, 0x9d, 0x95}}

Defines the universally-unique interface ID for ITextBehaviour.

Note
Textual Representation: {6499D11F-6AF1-4403-BDB1-760214F39D95}
FCM::ConstFCMIID DOM::FrameElement::IID_IMOVIE_CLIP_INSTANCE
Initial value:
=
{0x80f09ff2, 0x2894, 0x4d72, {0xbc, 0xe7, 0x0, 0xe7, 0xef, 0xeb, 0x68, 0x3f}}

Defines the universally-unique interface ID for IMovieClip.

Note
Textual Representation: {80F09FF2-2894-4D72-BCE7-00E7EFEB683F}
FCM::ConstFCMIID DOM::FrameElement::IID_IPARAGRAPH
Initial value:
=
{0xbb9b73ea, 0x6f7, 0x4ac8, {0xb5, 0x1b, 0x2e, 0x5a, 0x47, 0xbf, 0xc3, 0xb1}}

Defines the universally-unique interface ID for IParagraph.

Note
Textual Representation: {BB9B73EA-06F7-4AC8-B51B-2E5A47BFC3B1}
FCM::ConstFCMIID DOM::FrameElement::IID_ISHAPE
Initial value:
=
{0x2f540def, 0xc6db, 0x45a2, {0xa2, 0x54, 0x71, 0x28, 0xae, 0x2d, 0x8a, 0x1e}}

Defines the universally-unique interface ID for IShape.

Note
Textual Representation: {2F540DEF-C6DB-45A2-A254-7128AE2D8A1E}
FCM::ConstFCMIID DOM::FrameElement::IID_ISOUND_ELEMENT
Initial value:
=
{0xef9dff11, 0x1b84, 0x41ba, {0xac, 0x7f, 0xc2, 0x56, 0xf, 0x69, 0x2f, 0x30}}

Defines the universally-unique interface ID for ISound.

Note
Textual Representation: {EF9DFF11-1B84-41BA-AC7F-C2560F692F30}
FCM::ConstFCMIID DOM::FrameElement::IID_ISTATIC_TEXT_BEHAVIOUR
Initial value:
=
{0x6327c2d6, 0xb763, 0x4ac9, {0x8f, 0xbd, 0xf4, 0xc2, 0x91, 0x34, 0xd1, 0x7c}}

Defines the universally-unique interface ID for IStaticTextBehaviour.

Note
Textual Representation: {6327C2D6-B763-4AC9-8FBD-F4C29134D17C}
FCM::ConstFCMIID DOM::FrameElement::IID_ISYMBOL_INSTANCE
Initial value:
=
{0xb1f1a4aa, 0xbb67, 0x4bb7, {0xbb, 0xaf, 0x95, 0xff, 0x67, 0x40, 0x8e, 0x42}}

Defines the universally-unique interface ID for ISymbolInstance.

Note
Textual Representation: {B1F1A4AA-BB67-4BB7-BBAF-95FF67408E42}
FCM::ConstFCMIID DOM::FrameElement::IID_ITEXT_BEHAVIOUR
Initial value:
=
{0xcd4a280, 0x95e3, 0x4476, {0xa0, 0x64, 0x41, 0x98, 0x4a, 0x58, 0x94, 0x33}}

Defines the universally-unique interface ID for ITextBehaviour.

Note
Textual Representation: {CD4A280-95E3-4476-A064-41984A589433}
FCM::ConstFCMIID DOM::FrameElement::IID_ITEXT_RUN
Initial value:
=
{0x72330363, 0xcbbb, 0x4635, {0xbd, 0xcc, 0x4, 0xba, 0xc5, 0x83, 0x78, 0x71}}

Defines the universally-unique interface ID for ITextRun.

Note
Textual Representation: {72330363-CBBB-4635-BDCC-04BAC5837871}
FCM::ConstFCMIID DOM::FrameElement::IID_ITEXT_STYLE
Initial value:
=
{0xc8538de2, 0x7d59, 0x4e0b, {0xb1, 0xed, 0xef, 0x4a, 0x5c, 0x55, 0xcc, 0x9}}

Defines the universally-unique interface ID for ITextStyle.

Note
Textual Representation: {C8538DE2-7D59-4E0B-B1ED-EF4A5C55CC09}