Flash Controls

Functions

int SO3WidgetLoadFile (mmachine m)
 SO3WidgetLoadFile : Load a File/movie on a widget.
int SO3WidgetLoadUrl (mmachine m)
 SO3WidgetLoadUrl : Load an Url in a widget.
int SO3WidgetDestroy (mmachine m)
 SO3WidgetDestroy : Destroy a widget.
int SO3WidgetSetZOrder (mmachine m)
 SO3WidgetSetZOrder : defines Z order of a widget.
int SO3WidgetSetForeground (mmachine m)
 SO3WidgetSetForeground : defines foreground state of a widget.
int SO3WidgetGetForeground (mmachine m)
 SO3WidgetGetForeground : Get the foreground state of a widget.
int SO3WidgetSetTopOnFocus (mmachine m)
 SO3WidgetSetTopOnFocus : defines top On focus state a widget.
int SO3WidgetGetTopOnFocus (mmachine m)
 SO3WidgetGetTopOnFocus : Get the top On focus state of a widget.
int SO3WidgetSetIgnoreTransparentPixels (mmachine m)
 SO3WidgetSetIgnoreTransparentPixels : defines ignore transparent pixels state on a widget.
int SO3WidgetGetIgnoreTransparentPixels (mmachine m)
 SO3WidgetGetIgnoreTransparentPixels : Get the ignore transparent pixels state on a flash control.
int SO3WidgetSetFocus (mmachine m)
 SO3WidgetSetFocus : Force a widget to take focus.
int SO3WidgetGetZOrder (mmachine m)
 SO3WidgetGetZOrder : Get the Z order of a widget.
int SO3WidgetSetPosition (mmachine m)
 SO3WidgetSetPosition : defines position of a widget, in a viewport.
int SO3WidgetGetPosition (mmachine m)
 SO3WidgetGetPosition : Return the position of a widget, in the current viewport.
int SO3WidgetGetSize (mmachine m)
 SO3WidgetGetSize : Return the size of a widget.
int SO3WidgetSetSize (mmachine m)
 SO3WidgetSetSize : defines size of a widget.
int SO3WidgetGetName (mmachine m)
 SO3WidgetGetName : Return the name of a widget.
int SO3WidgetGetType (mmachine m)
 SO3WidgetGetType : Return the type of a widget.
int SO3WidgetSetVisibility (mmachine m)
 SO3WidgetSetVisibility : show or hide a widget.
int SO3WidgetGetVisibility (mmachine m)
 SO3WidgetGetVisibility : Retrieves if a widget is visible or not.
int SO3WidgetSetKeyboardEnable (mmachine m)
 SO3WidgetSetKeyboardEnable : enable or disable keyboard input on a widget.
int SO3WidgetGetKeyboardEnable (mmachine m)
 SO3WidgetGetKeyboardEnable : Retrieves if a widget take keyboard events or not.
int SO3WidgetSetMouseEnable (mmachine m)
 SO3WidgetSetMouseEnable : enable or disable mouse input on a widget.
int SO3WidgetGetMouseEnable (mmachine m)
 SO3WidgetGetMouseEnable : Retrieves if a widget take mouse events or not.
int SO3WidgetIsMouseOver (mmachine m)
 SO3WidgetIsMouseOver : Retrieves if the mouse is over a widget.
int SO3WidgetSetTransparency (mmachine m)
 SO3WidgetSetTransparency : Set transparency state of a widget (enable or not).
int SO3WidgetGetTransparency (mmachine m)
 SO3WidgetGetTransparency : Get transparency state of a widget.
int SO3WidgetSetOpacity (mmachine m)
 SO3WidgetSetOpacity : defines opacity coefficient of a widget.
int SO3WidgetGetOpacity (mmachine m)
 SO3WidgetGetOpacity : Get the opacity coefficient of a widget.
int SO3WidgetHasFocus (mmachine m)
 SO3WidgetHasFocus : Retrieves if a widget has the focus.
int SO3WidgetInsideCb (mmachine m)
 SO3WidgetInsideCb : Define the scol callback to call when the mouse is inside a widget.
int SO3WidgetInsideEventCb (mmachine m)
 SO3WidgetInsideEventCb : Define the scol callback to call when the mouse enter a widget.
int SO3WidgetOutsideEventCb (mmachine m)
 SO3WidgetOutsideEventCb : Define the scol callback to call when the mouse exit a widget.
int SO3WidgetMouseDownEventCb (mmachine m)
 SO3WidgetMouseDownEventCb : Define the scol callback to call when a mouse button is "downed" on a widget.
int SO3WidgetMouseUpEventCb (mmachine m)
 SO3WidgetMouseUpEventCb : Define the scol callback to call when a mouse button is "released" over a widget.
int SO3WidgetMouseWheelEvent (mmachine m)
 SO3WidgetMouseWheelEvent : Define the scol callback to call when the mouse wheel is moved (scrolling event) over a widget.

Detailed Description

Scol functions definition

Function Documentation

int SO3WidgetDestroy ( mmachine  m  ) 

SO3WidgetDestroy : Destroy a widget.

Prototype: fun [SO3_WIDGET] I

Parameters:
SO3_WIDGET : widget to be destroyed
Returns:
I : 1 if success , NIL otherwise

Definition at line 533 of file SCOLWidget.cpp.

int SO3WidgetGetForeground ( mmachine  m  ) 

SO3WidgetGetForeground : Get the foreground state of a widget.

Prototype: fun [SO3_WIDGET] I

Parameters:
SO3_WIDGET : targeted widget
Returns:
I : foreground state (1 enable, 0 disable) if success , NIL otherwise

Definition at line 653 of file SCOLWidget.cpp.

int SO3WidgetGetIgnoreTransparentPixels ( mmachine  m  ) 

SO3WidgetGetIgnoreTransparentPixels : Get the ignore transparent pixels state on a flash control.

Prototype: fun [SO3_WIDGET] [I I]

Parameters:
SO3_WIDGET : current flash control
Returns:
I : ignore transparent pixels state and treshold if success , NIL otherwise

Definition at line 814 of file SCOLWidget.cpp.

int SO3WidgetGetKeyboardEnable ( mmachine  m  ) 

SO3WidgetGetKeyboardEnable : Retrieves if a widget take keyboard events or not.

Prototype: fun [SO3_WIDGET] I

Parameters:
SO3_WIDGET : targeted widget
Returns:
I : widget take keyboard in count or not, NIL on error

Definition at line 1283 of file SCOLWidget.cpp.

int SO3WidgetGetMouseEnable ( mmachine  m  ) 

SO3WidgetGetMouseEnable : Retrieves if a widget take mouse events or not.

Prototype: fun [SO3_WIDGET] I

Parameters:
SO3_WIDGET : targeted widget
Returns:
I : widget take mouse in count or not, NIL on error

Definition at line 1360 of file SCOLWidget.cpp.

int SO3WidgetGetName ( mmachine  m  ) 

SO3WidgetGetName : Return the name of a widget.

Prototype: fun [SO3_WIDGET] S

Parameters:
SO3_WIDGET : targeted widget
Returns:
S : name of the widget if success , NIL otherwise

Definition at line 1097 of file SCOLWidget.cpp.

int SO3WidgetGetOpacity ( mmachine  m  ) 

SO3WidgetGetOpacity : Get the opacity coefficient of a widget.

Prototype: fun [SO3_WIDGET] F

Parameters:
SO3_WIDGET : targeted widget
Returns:
F : opacity coefficient if success , NIL otherwise

Definition at line 1551 of file SCOLWidget.cpp.

int SO3WidgetGetPosition ( mmachine  m  ) 

SO3WidgetGetPosition : Return the position of a widget, in the current viewport.

Prototype: fun [SO3_WIDGET] [I I]

Parameters:
SO3_WIDGET : targeted widget
Returns:
[I I] : X and Y position if success , NIL otherwise

Definition at line 971 of file SCOLWidget.cpp.

int SO3WidgetGetSize ( mmachine  m  ) 

SO3WidgetGetSize : Return the size of a widget.

Prototype: fun [SO3_WIDGET] [I I]

Parameters:
SO3_WIDGET : targeted widget
Returns:
[I I] : width and height if success , NIL otherwise

Definition at line 1015 of file SCOLWidget.cpp.

int SO3WidgetGetTopOnFocus ( mmachine  m  ) 

SO3WidgetGetTopOnFocus : Get the top On focus state of a widget.

Prototype: fun [SO3_WIDGET] I

Parameters:
SO3_WIDGET : targeted widget
Returns:
I : Top on focus state (1 enable, 0 disable) if success , NIL otherwise

Definition at line 733 of file SCOLWidget.cpp.

int SO3WidgetGetTransparency ( mmachine  m  ) 

SO3WidgetGetTransparency : Get transparency state of a widget.

Prototype: fun [SO3_WIDGET] I

Parameters:
SO3_WIDGET : targeted widget
Returns:
I : true if widget has transparency enabled, false if disabled, NIL otherwise (error).

Definition at line 1476 of file SCOLWidget.cpp.

int SO3WidgetGetType ( mmachine  m  ) 

SO3WidgetGetType : Return the type of a widget.

Prototype: fun [SO3_WIDGET] S

Parameters:
SO3_WIDGET : targeted widget
Returns:
S : type of the widget if success , NIL otherwise

Definition at line 1131 of file SCOLWidget.cpp.

int SO3WidgetGetVisibility ( mmachine  m  ) 

SO3WidgetGetVisibility : Retrieves if a widget is visible or not.

Prototype: fun [SO3_WIDGET] I

Parameters:
SO3_WIDGET : targeted widget
Returns:
I : visible state of the widget if success , NIL otherwise

Definition at line 1206 of file SCOLWidget.cpp.

int SO3WidgetGetZOrder ( mmachine  m  ) 

SO3WidgetGetZOrder : Get the Z order of a widget.

Prototype: fun [SO3_WIDGET] I

Parameters:
SO3_WIDGET : targeted widget
Returns:
I : Z order if success , NIL otherwise

Definition at line 898 of file SCOLWidget.cpp.

int SO3WidgetHasFocus ( mmachine  m  ) 

SO3WidgetHasFocus : Retrieves if a widget has the focus.

Prototype: fun [SO3_WIDGET] I

Parameters:
SO3_WIDGET : targeted widget
Returns:
I : focus state (1 enable, 0 disable) if success , NIL otherwise

Definition at line 1585 of file SCOLWidget.cpp.

int SO3WidgetInsideCb ( mmachine  m  ) 

SO3WidgetInsideCb : Define the scol callback to call when the mouse is inside a widget.

Prototype: fun [SO3_WIDGET fun [SO3_WIDGET u0 [I I]] u1 u0] SO3_WIDGET

Parameters:
SO3_WIDGET : The widget that triggered the event.
fun [SO3_WIDGET u0 [I I]] u1 : scol function to call

  • SO3_WIDGET : The widget that triggered the event.
  • [I I] : (x;y) mouse position, relative to the widget
u0 : user parameter
Returns:
SO3_WIDGET : Widget that triggered the event if success, NIL otherwise

Definition at line 1692 of file SCOLWidget.cpp.

int SO3WidgetInsideEventCb ( mmachine  m  ) 

SO3WidgetInsideEventCb : Define the scol callback to call when the mouse enter a widget.

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

Parameters:
SO3_WIDGET : The widget that triggered the event.
fun [SO3_WIDGET u0] u1 : scol function to call
u0 : user parameter
Returns:
SO3_WIDGET : Widget that triggered the event if success, NIL otherwise

Definition at line 1712 of file SCOLWidget.cpp.

int SO3WidgetIsMouseOver ( mmachine  m  ) 

SO3WidgetIsMouseOver : Retrieves if the mouse is over a widget.

Prototype: fun [SO3_WIDGET] I

Parameters:
SO3_WIDGET : targeted widget
Returns:
I : mouse over state if success , NIL otherwise

Definition at line 1397 of file SCOLWidget.cpp.

int SO3WidgetLoadFile ( mmachine  m  ) 

SO3WidgetLoadFile : Load a File/movie on a widget.

Prototype: fun [SO3_WIDGET P] I

Parameters:
SO3_WIDGET : targeted widget
P : Movie/File path
Returns:
I : 1 if success , NIL otherwise

Definition at line 412 of file SCOLWidget.cpp.

int SO3WidgetLoadUrl ( mmachine  m  ) 

SO3WidgetLoadUrl : Load an Url in a widget.

Prototype: fun [SO3_WIDGET S] I

Parameters:
SO3_WIDGET : targeted widget
S : Url
Returns:
I : 1 if success , NIL otherwise

Definition at line 473 of file SCOLWidget.cpp.

int SO3WidgetMouseDownEventCb ( mmachine  m  ) 

SO3WidgetMouseDownEventCb : Define the scol callback to call when a mouse button is "downed" on a widget.

Prototype: fun [SO3_WIDGET fun [SO3_WIDGET u0 I [I I]] u1 u0] SO3_WIDGET

Parameters:
SO3_WIDGET : The widget that triggered the event.
fun [SO3_WIDGET u0 I [I I]] u1 : scol function to call

  • SO3_WIDGET : The widget that triggered the event.
  • I : mouse button
  • [I I] : (x;y) mouse position, relative to the widget
u0 : user parameter
Returns:
SO3_WIDGET : Widget that triggered the event if success, NIL otherwise

Definition at line 1755 of file SCOLWidget.cpp.

int SO3WidgetMouseUpEventCb ( mmachine  m  ) 

SO3WidgetMouseUpEventCb : Define the scol callback to call when a mouse button is "released" over a widget.

Prototype: fun [SO3_WIDGET fun [SO3_WIDGET u0 I [I I]] u1 u0] SO3_WIDGET

Parameters:
SO3_WIDGET : The widget that triggered the event.
fun [SO3_WIDGET u0 I [I I]] u1 : scol function to call

  • SO3_WIDGET : The widget that triggered the event.
  • I : mouse button
  • [I I] : (x;y) mouse position, relative to the widget
u0 : user parameter
Returns:
SO3_WIDGET : Widget that triggered the event if success, NIL otherwise

Definition at line 1778 of file SCOLWidget.cpp.

int SO3WidgetMouseWheelEvent ( mmachine  m  ) 

SO3WidgetMouseWheelEvent : Define the scol callback to call when the mouse wheel is moved (scrolling event) over a widget.

Prototype: fun [SO3_WIDGET fun [SO3_WIDGET u0 I] u1 u0] SO3_WIDGET

Parameters:
SO3_WIDGET : The widget that triggered the event.
fun [SO3_WIDGET u0 I] u1 : scol function to call

  • SO3_WIDGET : The widget that triggered the event.
  • I : Wheel delta
u0 : user parameter
Returns:
SO3_WIDGET : Widget that triggered the event if success, NIL otherwise

Definition at line 1800 of file SCOLWidget.cpp.

int SO3WidgetOutsideEventCb ( mmachine  m  ) 

SO3WidgetOutsideEventCb : Define the scol callback to call when the mouse exit a widget.

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

Parameters:
SO3_WIDGET : The widget that triggered the event.
fun [SO3_WIDGET u0] u1 : scol function to call
u0 : user parameter
Returns:
SO3_WIDGET : Widget that triggered the event if success, NIL otherwise

Definition at line 1732 of file SCOLWidget.cpp.

int SO3WidgetSetFocus ( mmachine  m  ) 

SO3WidgetSetFocus : Force a widget to take focus.

Prototype: fun [SO3_WIDGET] I

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

Definition at line 863 of file SCOLWidget.cpp.

int SO3WidgetSetForeground ( mmachine  m  ) 

SO3WidgetSetForeground : defines foreground state of a widget.

Prototype: fun [SO3_WIDGET I] I

Parameters:
SO3_WIDGET : targeted widget
I : foreground state (1 enable, 0 disable)
Returns:
I : 1 if success , NIL otherwise

Definition at line 613 of file SCOLWidget.cpp.

int SO3WidgetSetIgnoreTransparentPixels ( mmachine  m  ) 

SO3WidgetSetIgnoreTransparentPixels : defines ignore transparent pixels state on a widget.

Prototype: fun [SO3_WIDGET I I] I

Parameters:
SO3_WIDGET : targeted widget
I : ignore transparent pixels state
I : color treshold
Returns:
I : 1 if success , NIL otherwise

Definition at line 773 of file SCOLWidget.cpp.

int SO3WidgetSetKeyboardEnable ( mmachine  m  ) 

SO3WidgetSetKeyboardEnable : enable or disable keyboard input on a widget.

Prototype: fun [SO3_WIDGET I] I

Parameters:
SO3_WIDGET : targeted widget
I : take keyboard events.
Returns:
I : 1 if success , NIL otherwise

Definition at line 1244 of file SCOLWidget.cpp.

int SO3WidgetSetMouseEnable ( mmachine  m  ) 

SO3WidgetSetMouseEnable : enable or disable mouse input on a widget.

Prototype: fun [SO3_WIDGET I] I

Parameters:
SO3_WIDGET : targeted widget
I : take mouse events.
Returns:
I : 1 if success , NIL otherwise

Definition at line 1321 of file SCOLWidget.cpp.

int SO3WidgetSetOpacity ( mmachine  m  ) 

SO3WidgetSetOpacity : defines opacity coefficient of a widget.

Prototype: fun [SO3_WIDGET F] I

Parameters:
SO3_WIDGET : targeted widget
F : opacity coefficient, must be between 0.0 and 1.0
Returns:
I : 1 if success , NIL otherwise

Definition at line 1515 of file SCOLWidget.cpp.

int SO3WidgetSetPosition ( mmachine  m  ) 

SO3WidgetSetPosition : defines position of a widget, in a viewport.

Prototype: fun [SO3_WIDGET I I] I

Parameters:
SO3_WIDGET : targeted widget
I : X position
I : Y position
Returns:
I : 1 if success , NIL otherwise

Definition at line 934 of file SCOLWidget.cpp.

int SO3WidgetSetSize ( mmachine  m  ) 

SO3WidgetSetSize : defines size of a widget.

Prototype: fun [SO3_WIDGET I I] I

Parameters:
SO3_WIDGET : widget to resize
I : width
I : height
Returns:
I : 1 if success , NIL otherwise

Definition at line 1060 of file SCOLWidget.cpp.

int SO3WidgetSetTopOnFocus ( mmachine  m  ) 

SO3WidgetSetTopOnFocus : defines top On focus state a widget.

Prototype: fun [SO3_WIDGET I] I

Parameters:
SO3_WIDGET : targeted widget
I : top on focus state (1 enable, 0 disable)
Returns:
I : 1 if success , NIL otherwise

Definition at line 692 of file SCOLWidget.cpp.

int SO3WidgetSetTransparency ( mmachine  m  ) 

SO3WidgetSetTransparency : Set transparency state of a widget (enable or not).

Prototype: fun [SO3_WIDGET I] I

Parameters:
SO3_WIDGET : targeted widget
I : transparency state
Returns:
I : 1 if success , NIL otherwise

Definition at line 1436 of file SCOLWidget.cpp.

int SO3WidgetSetVisibility ( mmachine  m  ) 

SO3WidgetSetVisibility : show or hide a widget.

Prototype: fun [SO3_WIDGET I] I

Parameters:
SO3_WIDGET : targeted widget
I : visible state
Returns:
I : 1 if success , NIL otherwise

Definition at line 1166 of file SCOLWidget.cpp.

int SO3WidgetSetZOrder ( mmachine  m  ) 

SO3WidgetSetZOrder : defines Z order of a widget.

Prototype: fun [SO3_WIDGET I] I

Parameters:
SO3_WIDGET : targeted widget
I : Z order
Returns:
I : 1 if success , NIL otherwise

Definition at line 574 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