SO3Engine/SCOLPack/SCOLWidget.cpp File Reference

#include "SO3SCOL.h"
#include "../SO3Renderer/SO3Widget.h"
#include "../SCOLBasic/SO3Prerequisites.h"
#include "../SCOLBasic/SO3DataScol.h"
#include "../SO3Material/SO3Material.h"
#include "../SO3Renderer/SO3ViewPort.h"
#include "../SO3Utils/SO3Point.h"
#include "OgrePanelOverlayElement.h"
#include "../SO3Renderer/SO3WidgetManager.h"
#include "../SO3Renderer/SO3Root.h"
#include "../SO3SceneGraph/SO3Scene.h"

Go to the source code of this file.

Defines

#define WIDGET_NB_PKG   38

Functions

int getWidgetCallbackOnScriptCallback (mmachine m, WindowHandle h, unsigned msg, UINT id, LONG param, int *ret)
 C function that prepares the VM for the execution of script function callback.
int getWidgetCallbackIsInside (mmachine m, WindowHandle h, unsigned msg, UINT id, LONG param, int *ret)
 C function that prepares the VM for the execution of the callback when mouse is inside a widget (continuous event).
int getWidgetCallbackOnEnterEvent (mmachine m, WindowHandle h, unsigned msg, UINT id, LONG param, int *ret)
 C function that prepares the VM for the execution of the callback when mouse enters inside a widget (one event).
int getWidgetCallbackOnExitEvent (mmachine m, WindowHandle h, unsigned msg, UINT id, LONG param, int *ret)
 C function that prepares the VM for the execution of the callback when mouse gets outside a widget (single event).
int getWidgetCallbackMouseDownEvent (mmachine m, WindowHandle h, unsigned msg, UINT id, LONG param, int *ret)
 C function that prepares the VM for the execution of the callback when a mouse down event occurs on a widget.
int getWidgetCallbackMouseUpEvent (mmachine m, WindowHandle h, unsigned msg, UINT id, LONG param, int *ret)
 C function that prepares the VM for the execution of the callback when a mouse up event occurs on a widget.
int getWidgetCallbackMouseWheelEvent (mmachine m, WindowHandle h, unsigned msg, UINT id, LONG param, int *ret)
 C function that prepares the VM for the execution of the callback when a mouse wheel event occurs on a widget.
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 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 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.
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.
int SCOLloadWidget (mmachine m, cbmachine w)
 Load the SO3Engine Widgets function.
int SCOLfreeWidget ()
 free the SO3Engine Viewport function

Variables

int WIDGET_IS_INSIDE_EVENT
 main include
int WIDGET_ENTER_EVENT
int WIDGET_EXIT_EVENT
int WIDGET_MOUSEDOWN_EVENT
int WIDGET_MOUSEUP_EVENT
int WIDGET_MOUSEWHEEL_EVENT
int WIDGET_SCRIPT_EVENT
WindowHandle hwndScol
 main include
char * WIDGET_FUNCTIONS_NAMES [WIDGET_NB_PKG]
int(* WIDGET_FUNCTIONS [WIDGET_NB_PKG])(mmachine m)
int WIDGET_FUNCTIONS_NB_ARGS [WIDGET_NB_PKG]
char * WIDGET_FUNCTIONS_SIGNATURES [WIDGET_NB_PKG]
ScolWidgetEventsListener * scolWidgetEventsListener = 0

Define Documentation

#define WIDGET_NB_PKG   38

Nb of Scol functions or types

Definition at line 1837 of file SCOLWidget.cpp.


Function Documentation

int getWidgetCallbackIsInside ( mmachine  m,
WindowHandle  h,
unsigned  msg,
UINT  id,
LONG  param,
int *  ret 
)

C function that prepares the VM for the execution of the callback when mouse is inside a widget (continuous event).

Parameters:
m : current machine
h : main scol window
msg : message
id : pointer of the obj
param : data pointer
ret : user parameter
Returns:
res : 0 if success

Definition at line 201 of file SCOLWidget.cpp.

int getWidgetCallbackMouseDownEvent ( mmachine  m,
WindowHandle  h,
unsigned  msg,
UINT  id,
LONG  param,
int *  ret 
)

C function that prepares the VM for the execution of the callback when a mouse down event occurs on a widget.

Parameters:
m : current machine
h : main scol window
msg : message
id : pointer of the obj
param : data pointer
ret : user parameter
Returns:
res : 0 if success

Definition at line 295 of file SCOLWidget.cpp.

int getWidgetCallbackMouseUpEvent ( mmachine  m,
WindowHandle  h,
unsigned  msg,
UINT  id,
LONG  param,
int *  ret 
)

C function that prepares the VM for the execution of the callback when a mouse up event occurs on a widget.

Parameters:
m : current machine
h : main scol window
msg : message
id : pointer of the obj
param : data pointer
ret : user parameter
Returns:
res : 0 if success

Definition at line 338 of file SCOLWidget.cpp.

int getWidgetCallbackMouseWheelEvent ( mmachine  m,
WindowHandle  h,
unsigned  msg,
UINT  id,
LONG  param,
int *  ret 
)

C function that prepares the VM for the execution of the callback when a mouse wheel event occurs on a widget.

Parameters:
m : current machine
h : main scol window
msg : message
id : pointer of the obj
param : data pointer
ret : user parameter
Returns:
res : 0 if success

Definition at line 381 of file SCOLWidget.cpp.

int getWidgetCallbackOnEnterEvent ( mmachine  m,
WindowHandle  h,
unsigned  msg,
UINT  id,
LONG  param,
int *  ret 
)

C function that prepares the VM for the execution of the callback when mouse enters inside a widget (one event).

Parameters:
m : current machine
h : main scol window
msg : message
id : pointer of the obj
param : data pointer
ret : user parameter
Returns:
res : 0 if success

Definition at line 241 of file SCOLWidget.cpp.

int getWidgetCallbackOnExitEvent ( mmachine  m,
WindowHandle  h,
unsigned  msg,
UINT  id,
LONG  param,
int *  ret 
)

C function that prepares the VM for the execution of the callback when mouse gets outside a widget (single event).

Parameters:
m : current machine
h : main scol window
msg : message
id : pointer of the obj
param : data pointer
ret : user parameter
Returns:
res : 0 if success

Definition at line 268 of file SCOLWidget.cpp.

int getWidgetCallbackOnScriptCallback ( mmachine  m,
WindowHandle  h,
unsigned  msg,
UINT  id,
LONG  param,
int *  ret 
)

C function that prepares the VM for the execution of script function callback.

Parameters:
m : current machine
h : main scol window
msg : message
id : pointer of the obj
param : data pointer
ret : user parameter
Returns:
res : 0 if success

Definition at line 150 of file SCOLWidget.cpp.

int SCOLfreeWidget (  ) 

free the SO3Engine Viewport function

Parameters:
m : The VM

Definition at line 2070 of file SCOLWidget.cpp.

int SCOLloadWidget ( mmachine  m,
cbmachine  w 
)

Load the SO3Engine Widgets function.

Parameters:
m : The VM
w : The Callback VM

Definition at line 2035 of file SCOLWidget.cpp.


Variable Documentation

WindowHandle hwndScol

main include

global declarations

Definition at line 48 of file SCOLFlashControl.cpp.

ScolWidgetEventsListener* scolWidgetEventsListener = 0

Global instance.

Definition at line 2027 of file SCOLWidget.cpp.

Definition at line 49 of file SCOLWidget.cpp.

Definition at line 50 of file SCOLWidget.cpp.

int(* WIDGET_FUNCTIONS[WIDGET_NB_PKG])(mmachine m)

Pointers to C functions that manipulate the VM for each scol function previously defined

Definition at line 1889 of file SCOLWidget.cpp.

char* WIDGET_FUNCTIONS_NAMES[WIDGET_NB_PKG]

Names of functions as they'll be in scol scripts.

Definition at line 1843 of file SCOLWidget.cpp.

int WIDGET_FUNCTIONS_NB_ARGS[WIDGET_NB_PKG]

Nb of arguments of each scol function

Definition at line 1935 of file SCOLWidget.cpp.

char* WIDGET_FUNCTIONS_SIGNATURES[WIDGET_NB_PKG]

Prototypes of the scol functions

Definition at line 1981 of file SCOLWidget.cpp.

main include

global declarations

Definition at line 48 of file SCOLWidget.cpp.

Definition at line 51 of file SCOLWidget.cpp.

Definition at line 52 of file SCOLWidget.cpp.

Definition at line 53 of file SCOLWidget.cpp.

Definition at line 54 of file SCOLWidget.cpp.

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