Project

General

Profile

SO3Engine
Widgets common

Functions

int SO3WidgetLoadFile (mmachine m)
 SO3WidgetLoadFile : Load a File/movie on a widget. More...
 
int SO3WidgetLoadUrl (mmachine m)
 SO3WidgetLoadUrl : Load an Url in a widget. More...
 
int SO3WidgetDestroy (mmachine m)
 SO3WidgetDestroy : Destroy a widget. More...
 
int SO3WidgetSetZOrder (mmachine m)
 SO3WidgetSetZOrder : defines Z order of a widget. More...
 
int SO3WidgetSetForeground (mmachine m)
 SO3WidgetSetForeground : defines foreground state of a widget. More...
 
int SO3WidgetGetForeground (mmachine m)
 SO3WidgetGetForeground : Get the foreground state of a widget. More...
 
int SO3WidgetSetTopOnFocus (mmachine m)
 SO3WidgetSetTopOnFocus : defines top On focus state a widget. More...
 
int SO3WidgetGetTopOnFocus (mmachine m)
 SO3WidgetGetTopOnFocus : Get the top On focus state of a widget. More...
 
int SO3WidgetSetIgnoreTransparentPixels (mmachine m)
 SO3WidgetSetIgnoreTransparentPixels : defines ignore transparent pixels state on a widget. More...
 
int SO3WidgetGetIgnoreTransparentPixels (mmachine m)
 SO3WidgetGetIgnoreTransparentPixels : Get the ignore transparent pixels state on a flash control. More...
 
int SO3WidgetSetFocus (mmachine m)
 SO3WidgetSetFocus : Force a widget to take focus. More...
 
int SO3WidgetUnFocus (mmachine m)
 SO3WidgetUnFocus : Force a widget to release focus. More...
 
int SO3WidgetGetZOrder (mmachine m)
 SO3WidgetGetZOrder : Get the Z order of a widget. More...
 
int SO3WidgetSetPosition (mmachine m)
 SO3WidgetSetPosition : defines position of a widget, in a viewport. More...
 
int SO3WidgetGetPosition (mmachine m)
 SO3WidgetGetPosition : Return the position of a widget, in the current viewport. More...
 
int SO3WidgetSetTextureRatio (mmachine m)
 SO3WidgetSetTextureRatio : defines the texture ratio of a widget, ie how the texture size will be scaled compare to the widget size. More...
 
int SO3WidgetGetTextureRatio (mmachine m)
 SO3WidgetGetTextureRatio : Return the texture ratio of a widget, ie how the texture size will be scaled compare to the widget size. More...
 
int SO3WidgetGetSize (mmachine m)
 SO3WidgetGetSize : Return the size of a widget. More...
 
int SO3WidgetSetSize (mmachine m)
 SO3WidgetSetSize : defines size of a widget. More...
 
int SO3WidgetGetName (mmachine m)
 SO3WidgetGetName : Return the name of a widget. More...
 
int SO3WidgetGetType (mmachine m)
 SO3WidgetGetType : Return the type of a widget. More...
 
int SO3WidgetGetMode (mmachine m)
 SO3WidgetGetMode : Return the mode of a widget. More...
 
int SO3WidgetSetVisibility (mmachine m)
 SO3WidgetSetVisibility : show or hide a widget. More...
 
int SO3WidgetGetVisibility (mmachine m)
 SO3WidgetGetVisibility : Retrieves if a widget is visible or not. More...
 
int SO3WidgetSetKeyboardEnable (mmachine m)
 SO3WidgetSetKeyboardEnable : enable or disable keyboard input on a widget. More...
 
int SO3WidgetGetKeyboardEnable (mmachine m)
 SO3WidgetGetKeyboardEnable : Retrieves if a widget take keyboard events or not. More...
 
int SO3WidgetSetMouseEnable (mmachine m)
 SO3WidgetSetMouseEnable : enable or disable mouse input on a widget. More...
 
int SO3WidgetGetMouseEnable (mmachine m)
 SO3WidgetGetMouseEnable : Retrieves if a widget take mouse events or not. More...
 
int SO3WidgetIsMouseOver (mmachine m)
 SO3WidgetIsMouseOver : Retrieves if the mouse is over a widget. More...
 
int SO3WidgetSetTransparency (mmachine m)
 SO3WidgetSetTransparency : Set transparency state of a widget (enable or not) More...
 
int SO3WidgetGetTransparency (mmachine m)
 SO3WidgetGetTransparency : Get transparency state of a widget. More...
 
int SO3WidgetSetOpacity (mmachine m)
 SO3WidgetSetOpacity : defines opacity coefficient of a widget. More...
 
int SO3WidgetGetOpacity (mmachine m)
 SO3WidgetGetOpacity : Get the opacity coefficient of a widget. More...
 
int SO3WidgetHasFocus (mmachine m)
 SO3WidgetHasFocus : Retrieves if a widget has the focus. More...
 
int SO3WidgetEnterEventCb (mmachine m)
 SO3WidgetEnterEventCb : Define the scol callback to call when the mouse enter a widget. More...
 
int SO3WidgetExitEventCb (mmachine m)
 SO3WidgetExitEventCb : Define the scol callback to call when the mouse exit a widget. More...
 
int SO3WidgetMouseMoveEventCb (mmachine m)
 SO3WidgetMouseMoveEventCb : Define the scol callback to call when a mouse button is "downed" on a widget. More...
 
int SO3WidgetMouseDownEventCb (mmachine m)
 SO3WidgetMouseDownEventCb : Define the scol callback to call when a mouse button is "downed" on a widget. More...
 
int SO3WidgetMouseUpEventCb (mmachine m)
 SO3WidgetMouseUpEventCb : Define the scol callback to call when a mouse button is "released" over a widget. More...
 
int SO3WidgetMouseWheelEventCb (mmachine m)
 SO3WidgetMouseWheelEventCb : Define the scol callback to call when the mouse wheel is moved (scrolling event) over a widget. More...
 
int SO3WidgetTouchAddEventCb (mmachine m)
 SO3WidgetTouchAddEventCb : Define the scol callback to call when a touch point is added on a widget. More...
 
int SO3WidgetTouchRemoveEventCb (mmachine m)
 SO3WidgetTouchRemoveEventCb : Define the scol callback to call when a touch point is removed on a widget. More...
 
int SO3WidgetTouchUpdateEventCb (mmachine m)
 SO3WidgetTouchUpdateEventCb : Define the scol callback to call when a touch point is updated over a widget. More...
 
int SO3WidgetInputDownEventCb (mmachine m)
 SO3WidgetInputDownEventCb : Define the scol callback to call when an input down button occure on a widget. More...
 
int SO3WidgetInputUpEventCb (mmachine m)
 SO3WidgetInputUpEventCb : Define the scol callback to call when an input up button occure on a widget. More...
 
int SO3WidgetInputUpdateEventCb (mmachine m)
 SO3WidgetInputUpdateEventCb : Define the scol callback to call when an input is updated over a widget. More...
 
int SO3WidgetInputWheelEventCb (mmachine m)
 SO3WidgetInputWheelEventCb : Define the scol callback to call when an input wheel is updated over a widget. More...
 
int SO3WidgetKeyDownEventCb (mmachine m)
 SO3WidgetKeyDownEventCb : Define the scol callback to call when a key is "downed" on a widget. More...
 
int SO3WidgetKeyUpEventCb (mmachine m)
 SO3WidgetKeyUpEventCb : Define the scol callback to call when a key is "up" on a widget. More...
 
int SO3WidgetKeyEventCb (mmachine m)
 SO3WidgetKeyEventCb : Define the scol callback to call when a key event is thow on a widget. More...
 
int SO3WidgetFocusEventCb (mmachine m)
 SO3WidgetFocusEventCb : Define the scol callback to call when a widget take or loose focus. More...
 
int SO3WidgetOnLoadStartEventCb (mmachine m)
 SO3WidgetOnLoadStartEventCb : Define the scol callback to call when a widget start to load content. More...
 
int SO3WidgetOnLoadEndEventCb (mmachine m)
 SO3WidgetOnLoadEndEventCb : Define the scol callback to call when a widget has finished to load content. More...
 
int SO3WidgetOnLoadErrorEventCb (mmachine m)
 SO3WidgetOnLoadErrorEventCb : Define the scol callback to call when a widget throw an error while loading content. More...
 

Detailed Description

Scol functions definition

Function Documentation

◆ SO3WidgetDestroy()

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 1320 of file SCOLWidget.cpp.

◆ SO3WidgetEnterEventCb()

int SO3WidgetEnterEventCb ( mmachine  m)

SO3WidgetEnterEventCb : 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 2713 of file SCOLWidget.cpp.

◆ SO3WidgetExitEventCb()

int SO3WidgetExitEventCb ( mmachine  m)

SO3WidgetExitEventCb : 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 2733 of file SCOLWidget.cpp.

◆ SO3WidgetFocusEventCb()

int SO3WidgetFocusEventCb ( mmachine  m)

SO3WidgetFocusEventCb : Define the scol callback to call when a widget take or loose focus.

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 : 1 if focused, 0 otherwise
u0: user parameter
Returns
SO3_WIDGET : Widget that triggered the event if success, NIL otherwise

Definition at line 3094 of file SCOLWidget.cpp.

◆ SO3WidgetGetForeground()

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 1440 of file SCOLWidget.cpp.

◆ SO3WidgetGetIgnoreTransparentPixels()

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 1601 of file SCOLWidget.cpp.

◆ SO3WidgetGetKeyboardEnable()

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 2229 of file SCOLWidget.cpp.

◆ SO3WidgetGetMode()

int SO3WidgetGetMode ( mmachine  m)

SO3WidgetGetMode : Return the mode of a widget.

Prototype: fun [SO3_WIDGET] I

Parameters
SO3_WIDGET: targeted widget
Returns
I : 1 for overlay, 2 for background, 3 for material if success , NIL otherwise

Definition at line 2071 of file SCOLWidget.cpp.

◆ SO3WidgetGetMouseEnable()

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 2306 of file SCOLWidget.cpp.

◆ SO3WidgetGetName()

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 2003 of file SCOLWidget.cpp.

◆ SO3WidgetGetOpacity()

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 2497 of file SCOLWidget.cpp.

◆ SO3WidgetGetPosition()

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 1791 of file SCOLWidget.cpp.

◆ SO3WidgetGetSize()

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 1911 of file SCOLWidget.cpp.

◆ SO3WidgetGetTextureRatio()

int SO3WidgetGetTextureRatio ( mmachine  m)

SO3WidgetGetTextureRatio : Return the texture ratio of a widget, ie how the texture size will be scaled compare to the widget size.

Prototype: fun [SO3_WIDGET] F

Parameters
SO3_WIDGET: targeted widget
Returns
F : Texture ratio, between [0.0 ; 1.0] if success , NIL otherwise

Definition at line 1878 of file SCOLWidget.cpp.

◆ SO3WidgetGetTopOnFocus()

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 1520 of file SCOLWidget.cpp.

◆ SO3WidgetGetTransparency()

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 2422 of file SCOLWidget.cpp.

◆ SO3WidgetGetType()

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 2037 of file SCOLWidget.cpp.

◆ SO3WidgetGetVisibility()

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 2152 of file SCOLWidget.cpp.

◆ SO3WidgetGetZOrder()

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 1718 of file SCOLWidget.cpp.

◆ SO3WidgetHasFocus()

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 2531 of file SCOLWidget.cpp.

◆ SO3WidgetInputDownEventCb()

int SO3WidgetInputDownEventCb ( mmachine  m)

SO3WidgetInputDownEventCb : Define the scol callback to call when an input down button occure on a widget.

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

Parameters
SO3_WIDGET: The widget that triggered the event.
fun[SO3_WIDGET u0 I I I I] u1 : scol function to call
  • SO3_WIDGET : The widget that triggered the event.
  • I : input id
  • I : x position, relative to the widget
  • I : y position, relative to the widget
  • I : input btn
u0: user parameter
Returns
SO3_WIDGET : Widget that triggered the event if success, NIL otherwise

Definition at line 2928 of file SCOLWidget.cpp.

◆ SO3WidgetInputUpdateEventCb()

int SO3WidgetInputUpdateEventCb ( mmachine  m)

SO3WidgetInputUpdateEventCb : Define the scol callback to call when an input is updated over a widget.

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

Parameters
SO3_WIDGET: The widget that triggered the event.
fun[SO3_WIDGET u0 I I I I] u1 : scol function to call
  • SO3_WIDGET : The widget that triggered the event.
  • I : input id
  • I : x position, relative to the widget
  • I : y position, relative to the widget
  • I : input btn
u0: user parameter
Returns
SO3_WIDGET : Widget that triggered the event if success, NIL otherwise

Definition at line 2978 of file SCOLWidget.cpp.

◆ SO3WidgetInputUpEventCb()

int SO3WidgetInputUpEventCb ( mmachine  m)

SO3WidgetInputUpEventCb : Define the scol callback to call when an input up button occure on a widget.

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

Parameters
SO3_WIDGET: The widget that triggered the event.
fun[SO3_WIDGET u0 I I I I] u1 : scol function to call
  • SO3_WIDGET : The widget that triggered the event.
  • I : input id
  • I : x position, relative to the widget
  • I : y position, relative to the widget
  • I : input btn
u0: user parameter
Returns
SO3_WIDGET : Widget that triggered the event if success, NIL otherwise

Definition at line 2953 of file SCOLWidget.cpp.

◆ SO3WidgetInputWheelEventCb()

int SO3WidgetInputWheelEventCb ( mmachine  m)

SO3WidgetInputWheelEventCb : Define the scol callback to call when an input wheel is updated over a widget.

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

Parameters
SO3_WIDGET: The widget that triggered the event.
fun[SO3_WIDGET u0 I I I I] u1 : scol function to call
  • SO3_WIDGET : The widget that triggered the event.
  • I : input id
  • I : x position
  • I : y position
  • I : Wheel delta
u0: user parameter
Returns
SO3_WIDGET : Widget that triggered the event if success, NIL otherwise

Definition at line 3003 of file SCOLWidget.cpp.

◆ SO3WidgetIsMouseOver()

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 2343 of file SCOLWidget.cpp.

◆ SO3WidgetKeyDownEventCb()

int SO3WidgetKeyDownEventCb ( mmachine  m)

SO3WidgetKeyDownEventCb : Define the scol callback to call when a key is "downed" on 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.
u0: user parameter
I: key scancode (keyboad key code)
I: ascii character
Returns
SO3_WIDGET : Widget that triggered the event if success, NIL otherwise

Definition at line 3026 of file SCOLWidget.cpp.

◆ SO3WidgetKeyEventCb()

int SO3WidgetKeyEventCb ( mmachine  m)

SO3WidgetKeyEventCb : Define the scol callback to call when a key event is thow 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] u1 : scol function to call
  • SO3_WIDGET : The widget that triggered the event.
u0: user parameter
I: window message
I: lparam
I: wparam
Returns
SO3_WIDGET : Widget that triggered the event if success, NIL otherwise

Definition at line 3073 of file SCOLWidget.cpp.

◆ SO3WidgetKeyUpEventCb()

int SO3WidgetKeyUpEventCb ( mmachine  m)

SO3WidgetKeyUpEventCb : Define the scol callback to call when a key is "up" on 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.
u0: user parameter
I: key scancode (keyboad key code)
I: ascii character
Returns
SO3_WIDGET : Widget that triggered the event if success, NIL otherwise

Definition at line 3049 of file SCOLWidget.cpp.

◆ SO3WidgetLoadFile()

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 1199 of file SCOLWidget.cpp.

◆ SO3WidgetLoadUrl()

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 1260 of file SCOLWidget.cpp.

◆ SO3WidgetMouseDownEventCb()

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 : x mouse position, relative to the widget
  • I : y mouse position, relative to the widget
  • I : mouse button
u0: user parameter
Returns
SO3_WIDGET : Widget that triggered the event if success, NIL otherwise

Definition at line 2781 of file SCOLWidget.cpp.

◆ SO3WidgetMouseMoveEventCb()

int SO3WidgetMouseMoveEventCb ( mmachine  m)

SO3WidgetMouseMoveEventCb : 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 : x mouse position, relative to the widget
  • I : y mouse position, relative to the widget
  • I : mouse button
u0: user parameter
Returns
SO3_WIDGET : Widget that triggered the event if success, NIL otherwise

Definition at line 2757 of file SCOLWidget.cpp.

◆ SO3WidgetMouseUpEventCb()

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 : x mouse position, relative to the widget
  • I : y mouse position, relative to the widget
  • I : mouse button
u0: user parameter
Returns
SO3_WIDGET : Widget that triggered the event if success, NIL otherwise

Definition at line 2805 of file SCOLWidget.cpp.

◆ SO3WidgetMouseWheelEventCb()

int SO3WidgetMouseWheelEventCb ( mmachine  m)

SO3WidgetMouseWheelEventCb : 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 I 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 : x position
  • I : y position
  • I : Wheel delta
u0: user parameter
Returns
SO3_WIDGET : Widget that triggered the event if success, NIL otherwise

Definition at line 2829 of file SCOLWidget.cpp.

◆ SO3WidgetOnLoadEndEventCb()

int SO3WidgetOnLoadEndEventCb ( mmachine  m)

SO3WidgetOnLoadEndEventCb : Define the scol callback to call when a widget has finished to load content.

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
  • SO3_WIDGET : The widget that triggered the event.
u0: user parameter
Returns
SO3_WIDGET : Widget that triggered the event if success, NIL otherwise

Definition at line 3157 of file SCOLWidget.cpp.

◆ SO3WidgetOnLoadErrorEventCb()

int SO3WidgetOnLoadErrorEventCb ( mmachine  m)

SO3WidgetOnLoadErrorEventCb : Define the scol callback to call when a widget throw an error while loading content.

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
  • SO3_WIDGET : The widget that triggered the event.
u0: user parameter
Returns
SO3_WIDGET : Widget that triggered the event if success, NIL otherwise

Definition at line 3177 of file SCOLWidget.cpp.

◆ SO3WidgetOnLoadStartEventCb()

int SO3WidgetOnLoadStartEventCb ( mmachine  m)

SO3WidgetOnLoadStartEventCb : Define the scol callback to call when a widget start to load content.

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
  • SO3_WIDGET : The widget that triggered the event.
u0: user parameter
Returns
SO3_WIDGET : Widget that triggered the event if success, NIL otherwise

Definition at line 3137 of file SCOLWidget.cpp.

◆ SO3WidgetSetFocus()

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 1650 of file SCOLWidget.cpp.

◆ SO3WidgetSetForeground()

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 1400 of file SCOLWidget.cpp.

◆ SO3WidgetSetIgnoreTransparentPixels()

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 1560 of file SCOLWidget.cpp.

◆ SO3WidgetSetKeyboardEnable()

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 2190 of file SCOLWidget.cpp.

◆ SO3WidgetSetMouseEnable()

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 2267 of file SCOLWidget.cpp.

◆ SO3WidgetSetOpacity()

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 2461 of file SCOLWidget.cpp.

◆ SO3WidgetSetPosition()

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 1754 of file SCOLWidget.cpp.

◆ SO3WidgetSetSize()

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 1956 of file SCOLWidget.cpp.

◆ SO3WidgetSetTextureRatio()

int SO3WidgetSetTextureRatio ( mmachine  m)

SO3WidgetSetTextureRatio : defines the texture ratio of a widget, ie how the texture size will be scaled compare to the widget size.

Prototype: fun [SO3_WIDGET F] I

Parameters
SO3_WIDGET: targeted widget
F: texture scale, must be > to 0.0 and <= to 1.0
Returns
I : 1 if success , NIL otherwise

Definition at line 1835 of file SCOLWidget.cpp.

◆ SO3WidgetSetTopOnFocus()

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 1479 of file SCOLWidget.cpp.

◆ SO3WidgetSetTransparency()

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 2382 of file SCOLWidget.cpp.

◆ SO3WidgetSetVisibility()

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 2112 of file SCOLWidget.cpp.

◆ SO3WidgetSetZOrder()

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 1361 of file SCOLWidget.cpp.

◆ SO3WidgetTouchAddEventCb()

int SO3WidgetTouchAddEventCb ( mmachine  m)

SO3WidgetTouchAddEventCb : Define the scol callback to call when a touch point is added 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 : touch id
  • I : x position, relative to the widget
  • I : y position, relative to the widget
u0: user parameter
Returns
SO3_WIDGET : Widget that triggered the event if success, NIL otherwise

Definition at line 2853 of file SCOLWidget.cpp.

◆ SO3WidgetTouchRemoveEventCb()

int SO3WidgetTouchRemoveEventCb ( mmachine  m)

SO3WidgetTouchRemoveEventCb : Define the scol callback to call when a touch point is removed 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 : touch id
  • I : x position, relative to the widget
  • I : y position, relative to the widget
u0: user parameter
Returns
SO3_WIDGET : Widget that triggered the event if success, NIL otherwise

Definition at line 2877 of file SCOLWidget.cpp.

◆ SO3WidgetTouchUpdateEventCb()

int SO3WidgetTouchUpdateEventCb ( mmachine  m)

SO3WidgetTouchUpdateEventCb : Define the scol callback to call when a touch point is updated over a widget.

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

Parameters
SO3_WIDGET: The widget that triggered the event.
fun[SO3_WIDGET u0 I I I I I] u1 : scol function to call
  • SO3_WIDGET : The widget that triggered the event.
  • I : touch id
  • I : x position, relative to the widget
  • I : y position, relative to the widget
  • I : x velocity, relative to the widget
  • I : y velocity, relative to the widget
u0: user parameter
Returns
SO3_WIDGET : Widget that triggered the event if success, NIL otherwise

Definition at line 2903 of file SCOLWidget.cpp.

◆ SO3WidgetUnFocus()

int SO3WidgetUnFocus ( mmachine  m)

SO3WidgetUnFocus : Force a widget to release focus.

Prototype: fun [SO3_WIDGET] I

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

Definition at line 1684 of file SCOLWidget.cpp.