Flash Controls

Functions

int SO3FlashControlCreate (mmachine m)
 SO3FlashControlCreate : Create a new flash control.
int SO3FlashControlCreateBackground (mmachine m)
 SO3FlashControlCreateBackground : Create a new flash control.
int SO3FlashControlSetQuality (mmachine m)
 SO3FlashControlSetQuality : defines the rendering quality for a flash control.
int SO3FlashControlGetQuality (mmachine m)
 SO3FlashControlGetQuality : Get the rendering quality of a flash control.
int SO3FlashControlGetScaleMode (mmachine m)
 SO3FlashControlGetScaleMode : Get the scale mode of a flash control.
int SO3FlashControlSetScaleMode (mmachine m)
 SO3FlashControlSetScaleMode : defines scale mode for a flash control.
int SO3FlashControlPlay (mmachine m)
 SO3FlashControlPlay : To play a flash control.
int SO3FlashControlRewind (mmachine m)
 SO3FlashControlRewind : To Rewind a flash control.
int SO3FlashControlGoToFrame (mmachine m)
 SO3FlashControlGoToFrame : Go to a given flash frame.
int SO3FlashControlStop (mmachine m)
 SO3FlashControlStop : To Stop a flash control.
int SO3WidgetCallFunction (mmachine m)
 SO3WidgetCallFunction : Call script function of a widgets. Script type may depend of widget type, ActionScript for Flash widgets, JavaScript for WebNavigator widgets.
int SO3WidgetOnScriptEventCb (mmachine m)
 SO3WidgetOnScriptEventCb : Define the callback scol had to call when there is a script event on a widget. Script event are defined by widget type, for example, it's action script event for Flash widget and javascript functions for Web Navigator widget.

Detailed Description

Scol functions definition

Function Documentation

int SO3FlashControlCreate ( mmachine  m  ) 

SO3FlashControlCreate : Create a new flash control.

Prototype: fun [SO3_SCENE SO3_VIEWPORT S I I I I I] SO3_WIDGET

Parameters:
SO3_SCENE : current scene
SO3_VIEWPORT : viewport
S : given name for the new flash Control
I : top Position
I : left position
I : width
I : height
I : Z order

For flags, values are :

  • SO3_FLASH_FOREGROUND
  • SO3_FLASH_TOPONFOCUS
  • SO3_FLASH_ENABLE_KEYBOARD
  • SO3_FLASH_ENABLE_MOUSE
Returns:
SO3_FLASH_CONTROL : Created flash control if success , NIL otherwise

Definition at line 72 of file SCOLFlashControl.cpp.

int SO3FlashControlCreateBackground ( mmachine  m  ) 

SO3FlashControlCreateBackground : Create a new flash control.

Prototype: fun [SO3_SCENE SO3_VIEWPORT S I I I I I] SO3_WIDGET

Parameters:
SO3_SCENE : current scene
SO3_VIEWPORT : viewport
S : given name for the new flash Control
I : top Position
I : left position
I : width
I : height

For flags, values are :

  • SO3_FLASH_ENABLE_KEYBOARD
  • SO3_FLASH_ENABLE_MOUSE
Returns:
SO3_FLASH_CONTROL : Created flash control if success , NIL otherwise

Definition at line 166 of file SCOLFlashControl.cpp.

int SO3FlashControlGetQuality ( mmachine  m  ) 

SO3FlashControlGetQuality : Get the rendering quality of a flash control.

Prototype: fun [SO3_WIDGET] I

Parameters:
SO3_WIDGET : targeted flash control
Returns:
I : quality mode if success , NIL otherwise

For quality mode, values are :

  • SO3_FLASH_QUALITY_LOW
  • SO3_FLASH_QUALITY_MEDIUM
  • SO3_FLASH_QUALITY_HIGH
  • SO3_FLASH_QUALITY_BEST
  • SO3_FLASH_QUALITY_AUTOLOW
  • SO3_FLASH_QUALITY_AUTOHIGH

Definition at line 439 of file SCOLFlashControl.cpp.

int SO3FlashControlGetScaleMode ( mmachine  m  ) 

SO3FlashControlGetScaleMode : Get the scale mode of a flash control.

Prototype: fun [SO3_WIDGET] I

Parameters:
SO3_WIDGET : targeted flash control
Returns:
I : scale mode if success, NIL otherwise

For scale mode, values are :

  • SO3_FLASH_SCALE_SHOWALL
  • SO3_FLASH_SCALE_NOBORDER
  • SO3_FLASH_SCALE_EXACTFIT

Definition at line 488 of file SCOLFlashControl.cpp.

int SO3FlashControlGoToFrame ( mmachine  m  ) 

SO3FlashControlGoToFrame : Go to a given flash frame.

Prototype: fun [SO3_WIDGET I] I

Parameters:
SO3_WIDGET : targeted flash control
I : given flash frame
Returns:
I : 1 if success , NIL otherwise

Definition at line 673 of file SCOLFlashControl.cpp.

int SO3FlashControlPlay ( mmachine  m  ) 

SO3FlashControlPlay : To play a flash control.

Prototype: fun [SO3_WIDGET] I

Parameters:
SO3_WIDGET : targeted flash control
Returns:
I : 1 if success , NIL otherwise

Definition at line 582 of file SCOLFlashControl.cpp.

int SO3FlashControlRewind ( mmachine  m  ) 

SO3FlashControlRewind : To Rewind a flash control.

Prototype: fun [SO3_WIDGET] I

Parameters:
SO3_WIDGET : targeted flash control
Returns:
I : 1 if success , NIL otherwise

Definition at line 627 of file SCOLFlashControl.cpp.

int SO3FlashControlSetQuality ( mmachine  m  ) 

SO3FlashControlSetQuality : defines the rendering quality for a flash control.

Prototype: fun [SO3_WIDGET I] I

Parameters:
SO3_WIDGET : targeted flash control
I : quality flag

For quality flags, values are :

  • SO3_FLASH_QUALITY_LOW
  • SO3_FLASH_QUALITY_MEDIUM
  • SO3_FLASH_QUALITY_HIGH
  • SO3_FLASH_QUALITY_BEST
  • SO3_FLASH_QUALITY_AUTOLOW
  • SO3_FLASH_QUALITY_AUTOHIGH
Returns:
I : 1 if success , NIL otherwise

Definition at line 385 of file SCOLFlashControl.cpp.

int SO3FlashControlSetScaleMode ( mmachine  m  ) 

SO3FlashControlSetScaleMode : defines scale mode for a flash control.

Prototype: fun [SO3_WIDGET I] I

Parameters:
SO3_WIDGET : targeted flash control
I : scale mode

For scale Mode, values are :

  • SO3_FLASH_SCALE_SHOWALL
  • SO3_FLASH_SCALE_NOBORDER
  • SO3_FLASH_SCALE_EXACTFIT
Returns:
I : 1 if sucess, NIL otherwise

Definition at line 536 of file SCOLFlashControl.cpp.

int SO3FlashControlStop ( mmachine  m  ) 

SO3FlashControlStop : To Stop a flash control.

Prototype: fun [SO3_WIDGET] I

Parameters:
SO3_WIDGET : targeted flash control
Returns:
I : 1 if success , NIL otherwise

Definition at line 719 of file SCOLFlashControl.cpp.

int SO3WidgetCallFunction ( mmachine  m  ) 

SO3WidgetCallFunction : Call script function of a widgets. Script type may depend of widget type, ActionScript for Flash widgets, JavaScript for WebNavigator widgets.

Prototype: fun [SO3_WIDGET S [S r1]] I

Parameters:
SO3_WIDGET : targeted widget
S : name of the script function
[S r1] : arguments of the script function
Returns:
I : 1 if success , NIL otherwise

Definition at line 1626 of file SCOLWidget.cpp.

int SO3WidgetOnScriptEventCb ( mmachine  m  ) 

SO3WidgetOnScriptEventCb : Define the callback scol had to call when there is a script event on a widget. Script event are defined by widget type, for example, it's action script event for Flash widget and javascript functions for Web Navigator widget.

Prototype: fun [SO3_WIDGET fun [SO3_WIDGET u0 S [S r1 ]] u1 u0] SO3_WIDGET

Parameters:
SO3_WIDGET : targeted widget.
fun [SO3_WIDGET u0 S [S r1]] u1 : scol function to call

  • SO3_WIDGET : widget that receive the event
  • S script function name
  • S script function parameters
u0 : user parameter
Returns:
SO3_WIDGET : Widget that manage the event if success, NIL otherwise

Definition at line 1824 of file SCOLWidget.cpp.

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Mon Oct 31 14:42:34 2011 for SO3Engine by  doxygen 1.6.3