Functions
int	SO3WebNavigatorWidgetCreate (mmachine m)
	SO3WebNavigatorWidgetCreate : Create a new web navigator widget.

int	SO3WebNavigatorWidgetCreateBackground (mmachine m)
	SO3WebNavigatorWidgetCreateBackground : Create a new web navigator widget.

int	SO3WebNavigatorWidgetCreateOnMaterial (mmachine m)
	SO3WebNavigatorWidgetCreateOnMaterial : Set a texture web navigator on a material.

int	SO3WebNavigatorWidgetLoadHTML (mmachine m)
	SO3WebNavigatorWidgetLoadHTML : Load a html content in a web navigator widget.

int	SO3WebNavigatorWidgetActionUndo (mmachine m)
	SO3WebNavigatorWidgetActionUndo : Execute undo on a frame.

int	SO3WebNavigatorWidgetActionRedo (mmachine m)
	SO3WebNavigatorWidgetActionRedo : Execute redo on a frame.

int	SO3WebNavigatorWidgetActionCut (mmachine m)
	SO3WebNavigatorWidgetActionCut : Execute cut on a frame.

int	SO3WebNavigatorWidgetActionCopy (mmachine m)
	SO3WebNavigatorWidgetActionCopy : Execute copy on a frame.

int	SO3WebNavigatorWidgetActionPaste (mmachine m)
	SO3WebNavigatorWidgetActionPaste : Execute paste on a frame.

int	SO3WebNavigatorWidgetActionDelete (mmachine m)
	SO3WebNavigatorWidgetActionDelete : Execute delete on a frame.

int	SO3WebNavigatorWidgetActionSelectAll (mmachine m)
	SO3WebNavigatorWidgetActionSelectAll : Execute select all on a frame.

int	SO3WebNavigatorWidgetPrint (mmachine m)
	SO3WebNavigatorWidgetPrint : Execute printing on a frame. The user will be prompted with the print dialog appropriate to the operating system.

int	SO3WebNavigatorWidgetViewSource (mmachine m)
	SO3WebNavigatorWidgetViewSource : Save a frame's HTML source to a temporary file and open it in the default text viewing application.

int	SO3WebNavigatorWidgetGetSource (mmachine m)
	SO3WebNavigatorWidgetGetSource : Returns a frame's HTML source as a string.

int	SO3WebNavigatorWidgetGetText (mmachine m)
	SO3WebNavigatorWidgetGetText : Returns a frame's display text as a string.

int	SO3WebNavigatorWidgetGetURL (mmachine m)
	SO3WebNavigatorWidgetGetURL : Returns the URL currently loaded in a frame.

int	SO3WebNavigatorWidgetCanGoBack (mmachine m)
	SO3WebNavigatorWidgetCanGoBack : Does the browser can navigate backward?

int	SO3WebNavigatorWidgetGoBack (mmachine m)
	SO3WebNavigatorWidgetGoBack : Navigate backward.

int	SO3WebNavigatorWidgetCanGoForward (mmachine m)
	SO3WebNavigatorWidgetCanGoForward : Does the browser can navigate forward?

int	SO3WebNavigatorWidgetGoForward (mmachine m)
	SO3WebNavigatorWidgetGoForward : Navigate forward.

int	SO3WebNavigatorWidgetReload (mmachine m)
	SO3WebNavigatorWidgetReload : Reload the current page.

int	SO3WebNavigatorWidgetReloadIgnoreCache (mmachine m)
	SO3WebNavigatorWidgetReloadIgnoreCache : Reload the current page ignoring any cached data.

int	SO3WebNavigatorWidgetStopLoad (mmachine m)
	SO3WebNavigatorWidgetStopLoad : Stop loading the page.

int	SO3WebNavigatorWidgetFind (mmachine m)
	SO3WebNavigatorWidgetFind : Search for text in the current page.

int	SO3WebNavigatorWidgetStopFinding (mmachine m)
	SO3WebNavigatorWidgetStopFinding : Cancel all searches that are currently going on.

int	SO3WebNavigatorWidgetGetZoomLevel (mmachine m)
	SO3WebNavigatorWidgetGetZoomLevel : Get the zoom level.

int	SO3WebNavigatorWidgetSetZoomLevel (mmachine m)
	SO3WebNavigatorWidgetSetZoomLevel : Change the zoom level.

int	SO3WebNavigatorWidgetClearHistory (mmachine m)
	SO3WebNavigatorWidgetClearHistory : Clear the back/forward browsing history.

int	SO3WebNavigatorWidgetShowDevTools (mmachine m)
	SO3WebNavigatorWidgetShowDevTools : Open developer tools window.

int	SO3WebNavigatorWidgetCloseDevTools (mmachine m)
	SO3WebNavigatorWidgetCloseDevTools : Close the developer tools window if one exists for this browser instance.

Detailed Description

Scol functions definition

Function Documentation

◆ SO3WebNavigatorWidgetActionCopy()

int SO3WebNavigatorWidgetActionCopy ( mmachine m )

SO3WebNavigatorWidgetActionCopy : Execute copy on a frame.

Prototype: fun [SO3_WIDGET S] I

Parameters

SO3_WIDGET	: the web navigator object
S	: The target frame name. If NIL, the target is the web navigator main frame.

Returns: I : 1 if success, NIL otherwise

Definition at line 619 of file SCOLWebNavigatorWidget.cpp.

◆ SO3WebNavigatorWidgetActionCut()

int SO3WebNavigatorWidgetActionCut ( mmachine m )

SO3WebNavigatorWidgetActionCut : Execute cut on a frame.

Prototype: fun [SO3_WIDGET S] I

Parameters

SO3_WIDGET	: the web navigator object
S	: The target frame name. If NIL, the target is the web navigator main frame.

Returns: I : 1 if success, NIL otherwise

Definition at line 567 of file SCOLWebNavigatorWidget.cpp.

◆ SO3WebNavigatorWidgetActionDelete()

int SO3WebNavigatorWidgetActionDelete ( mmachine m )

SO3WebNavigatorWidgetActionDelete : Execute delete on a frame.

Prototype: fun [SO3_WIDGET S] I

Parameters

SO3_WIDGET	: the web navigator object
S	: The target frame name. If NIL, the target is the web navigator main frame.

Returns: I : 1 if success, NIL otherwise

Definition at line 723 of file SCOLWebNavigatorWidget.cpp.

◆ SO3WebNavigatorWidgetActionPaste()

int SO3WebNavigatorWidgetActionPaste ( mmachine m )

SO3WebNavigatorWidgetActionPaste : Execute paste on a frame.

Prototype: fun [SO3_WIDGET S] I

Parameters

SO3_WIDGET	: the web navigator object
S	: The target frame name. If NIL, the target is the web navigator main frame.

Returns: I : 1 if success, NIL otherwise

Definition at line 671 of file SCOLWebNavigatorWidget.cpp.

◆ SO3WebNavigatorWidgetActionRedo()

int SO3WebNavigatorWidgetActionRedo ( mmachine m )

SO3WebNavigatorWidgetActionRedo : Execute redo on a frame.

Prototype: fun [SO3_WIDGET S] I

Parameters

SO3_WIDGET	: the web navigator object
S	: The target frame name. If NIL, the target is the web navigator main frame.

Returns: I : 1 if success, NIL otherwise

Definition at line 515 of file SCOLWebNavigatorWidget.cpp.

◆ SO3WebNavigatorWidgetActionSelectAll()

int SO3WebNavigatorWidgetActionSelectAll ( mmachine m )

SO3WebNavigatorWidgetActionSelectAll : Execute select all on a frame.

Prototype: fun [SO3_WIDGET S] I

Parameters

SO3_WIDGET	: the web navigator object
S	: The target frame name. If NIL, the target is the web navigator main frame.

Returns: I : 1 if success, NIL otherwise

Definition at line 775 of file SCOLWebNavigatorWidget.cpp.

◆ SO3WebNavigatorWidgetActionUndo()

int SO3WebNavigatorWidgetActionUndo ( mmachine m )

SO3WebNavigatorWidgetActionUndo : Execute undo on a frame.

Prototype: fun [SO3_WIDGET S] I

Parameters

SO3_WIDGET	: the web navigator object
S	: The target frame name. If NIL, the target is the web navigator main frame.

Returns: I : 1 if success, NIL otherwise

Definition at line 463 of file SCOLWebNavigatorWidget.cpp.

◆ SO3WebNavigatorWidgetCanGoBack()

int SO3WebNavigatorWidgetCanGoBack ( mmachine m )

SO3WebNavigatorWidgetCanGoBack : Does the browser can navigate backward?

Prototype: fun [SO3_WIDGET] I

Parameters

SO3_WIDGET : the web navigator object

Returns: I : 1 if the go back action can be performed on the web navigator, false otherwise. NIL if an error occurs.

Definition at line 1087 of file SCOLWebNavigatorWidget.cpp.

◆ SO3WebNavigatorWidgetCanGoForward()

int SO3WebNavigatorWidgetCanGoForward ( mmachine m )

SO3WebNavigatorWidgetCanGoForward : Does the browser can navigate forward?

Prototype: fun [SO3_WIDGET] I

Parameters

SO3_WIDGET : the web navigator object

Returns: I : 1 if the go forward action can be performed on the web navigator, false otherwise. NIL if an error occurs.

Definition at line 1179 of file SCOLWebNavigatorWidget.cpp.

◆ SO3WebNavigatorWidgetClearHistory()

int SO3WebNavigatorWidgetClearHistory ( mmachine m )

SO3WebNavigatorWidgetClearHistory : Clear the back/forward browsing history.

Prototype: fun [SO3_WIDGET] I

Parameters

SO3_WIDGET : the web navigator object

Returns: I : 1 if success, NIL if an error occurs.

Definition at line 1631 of file SCOLWebNavigatorWidget.cpp.

◆ SO3WebNavigatorWidgetCloseDevTools()

int SO3WebNavigatorWidgetCloseDevTools ( mmachine m )

SO3WebNavigatorWidgetCloseDevTools : Close the developer tools window if one exists for this browser instance.

Prototype: fun [SO3_WIDGET] I

Parameters

SO3_WIDGET : the web navigator object

Returns: I : 1 if success, NIL if an error occurs.

Definition at line 1721 of file SCOLWebNavigatorWidget.cpp.

◆ SO3WebNavigatorWidgetCreate()

int SO3WebNavigatorWidgetCreate ( mmachine m )

SO3WebNavigatorWidgetCreate : Create a new web navigator widget.

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 web navigator widget
I	: top Position
I	: left position
I	: width
I	: height
I	: Z order

Returns: SO3_WIDGET : Created web navigator widget if success , NIL otherwise

Definition at line 65 of file SCOLWebNavigatorWidget.cpp.

◆ SO3WebNavigatorWidgetCreateBackground()

int SO3WebNavigatorWidgetCreateBackground ( mmachine m )

SO3WebNavigatorWidgetCreateBackground : Create a new web navigator widget.

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 web navigator widget
I	: top Position
I	: left position
I	: width
I	: height

Returns: SO3_WIDGET : Created web navigator widget if success , NIL otherwise

Definition at line 164 of file SCOLWebNavigatorWidget.cpp.

◆ SO3WebNavigatorWidgetCreateOnMaterial()

int SO3WebNavigatorWidgetCreateOnMaterial ( mmachine m )

SO3WebNavigatorWidgetCreateOnMaterial : Set a texture web navigator on a material.

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

Parameters

SO3_SCENE	: current scene
SO3_MATERIAL	: current material
S	: new Name
I	: width
I	: height
I	: given technique
I	: given pass
I	: index of the texture

Returns: SO3_WIDGET : The web navigator widget if success , NIL otherwise

Definition at line 264 of file SCOLWebNavigatorWidget.cpp.

◆ SO3WebNavigatorWidgetFind()

int SO3WebNavigatorWidgetFind ( mmachine m )

SO3WebNavigatorWidgetFind : Search for text in the current page.

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

Parameters

SO3_WIDGET	: the web navigator object
I	The search identifier, to allow multiple search simultaneously
S	The searched text
I	1 to search forward or 0 to search backward, within the page.
I	1 to indicate that the search should be case-sensitive.
I	1 to indicate that this is the first request or 0 to indicate that it's a follow-up.

Returns: I : 1 if success, NIL if an error occurs.

Definition at line 1411 of file SCOLWebNavigatorWidget.cpp.

◆ SO3WebNavigatorWidgetGetSource()

int SO3WebNavigatorWidgetGetSource ( mmachine m )

SO3WebNavigatorWidgetGetSource : Returns a frame's HTML source as a string.

Prototype: fun [SO3_WIDGET S] S

Parameters

SO3_WIDGET	: the web navigator object
S	: The target frame name. If NIL, the target is the web navigator main frame.

Returns: S : the html source as string, NIL otherwise

Definition at line 931 of file SCOLWebNavigatorWidget.cpp.

◆ SO3WebNavigatorWidgetGetText()

int SO3WebNavigatorWidgetGetText ( mmachine m )

SO3WebNavigatorWidgetGetText : Returns a frame's display text as a string.

Prototype: fun [SO3_WIDGET S] S

Parameters

SO3_WIDGET	: the web navigator object
S	: The target frame name. If NIL, the target is the web navigator main frame.

Returns: S : the frame text content as string, NIL otherwise

Definition at line 983 of file SCOLWebNavigatorWidget.cpp.

◆ SO3WebNavigatorWidgetGetURL()

int SO3WebNavigatorWidgetGetURL ( mmachine m )

SO3WebNavigatorWidgetGetURL : Returns the URL currently loaded in a frame.

Prototype: fun [SO3_WIDGET S] S

Parameters

SO3_WIDGET	: the web navigator object
S	: The target frame name. If NIL, the target is the web navigator main frame.

Returns: S : the frame text content as string, NIL otherwise

Definition at line 1036 of file SCOLWebNavigatorWidget.cpp.

◆ SO3WebNavigatorWidgetGetZoomLevel()

int SO3WebNavigatorWidgetGetZoomLevel ( mmachine m )

SO3WebNavigatorWidgetGetZoomLevel : Get the zoom level.

Prototype: fun [SO3_WIDGET] F

Parameters

SO3_WIDGET : the web navigator object

Returns: F : The actual zoom level, NIL if an error occurs.

Definition at line 1538 of file SCOLWebNavigatorWidget.cpp.

◆ SO3WebNavigatorWidgetGoBack()

int SO3WebNavigatorWidgetGoBack ( mmachine m )

SO3WebNavigatorWidgetGoBack : Navigate backward.

Prototype: fun [SO3_WIDGET] I

Parameters

SO3_WIDGET : the web navigator object

Returns: I : 1 if success, NIL if an error occurs.

Definition at line 1134 of file SCOLWebNavigatorWidget.cpp.

◆ SO3WebNavigatorWidgetGoForward()

int SO3WebNavigatorWidgetGoForward ( mmachine m )

SO3WebNavigatorWidgetGoForward : Navigate forward.

Prototype: fun [SO3_WIDGET] I

Parameters

SO3_WIDGET : the web navigator object

Returns: I : 1 if success, NIL if an error occurs.

Definition at line 1226 of file SCOLWebNavigatorWidget.cpp.

◆ SO3WebNavigatorWidgetLoadHTML()

int SO3WebNavigatorWidgetLoadHTML ( mmachine m )

SO3WebNavigatorWidgetLoadHTML : Load a html content in a web navigator widget.

Prototype: fun [SO3_WIDGET S] I

Parameters

SO3_WIDGET	: targeted widget
S	: Html text

Returns: I : 1 if success , NIL otherwise

Definition at line 391 of file SCOLWebNavigatorWidget.cpp.

◆ SO3WebNavigatorWidgetPrint()

int SO3WebNavigatorWidgetPrint ( mmachine m )

SO3WebNavigatorWidgetPrint : Execute printing on a frame. The user will be prompted with the print dialog appropriate to the operating system.

Prototype: fun [SO3_WIDGET S] I

Parameters

SO3_WIDGET	: the web navigator object
S	: The target frame name. If NIL, the target is the web navigator main frame.

Returns: I : 1 if success, NIL otherwise

Definition at line 827 of file SCOLWebNavigatorWidget.cpp.

◆ SO3WebNavigatorWidgetReload()

int SO3WebNavigatorWidgetReload ( mmachine m )

SO3WebNavigatorWidgetReload : Reload the current page.

Prototype: fun [SO3_WIDGET] I

Parameters

SO3_WIDGET : the web navigator object

Returns: I : 1 if success, NIL if an error occurs.

Definition at line 1271 of file SCOLWebNavigatorWidget.cpp.

◆ SO3WebNavigatorWidgetReloadIgnoreCache()

int SO3WebNavigatorWidgetReloadIgnoreCache ( mmachine m )

SO3WebNavigatorWidgetReloadIgnoreCache : Reload the current page ignoring any cached data.

Prototype: fun [SO3_WIDGET] I

Parameters

SO3_WIDGET : the web navigator object

Returns: I : 1 if success, NIL if an error occurs.

Definition at line 1316 of file SCOLWebNavigatorWidget.cpp.

◆ SO3WebNavigatorWidgetSetZoomLevel()

int SO3WebNavigatorWidgetSetZoomLevel ( mmachine m )

SO3WebNavigatorWidgetSetZoomLevel : Change the zoom level.

Prototype: fun [SO3_WIDGET F] I

Parameters

SO3_WIDGET	: the web navigator object
F	: the new zoom level

Returns: I : 1 if success, NIL if an error occurs.

Definition at line 1584 of file SCOLWebNavigatorWidget.cpp.

◆ SO3WebNavigatorWidgetShowDevTools()

int SO3WebNavigatorWidgetShowDevTools ( mmachine m )

SO3WebNavigatorWidgetShowDevTools : Open developer tools window.

Prototype: fun [SO3_WIDGET] I

Parameters

SO3_WIDGET : the web navigator object

Returns: I : 1 if success, NIL if an error occurs.

Definition at line 1676 of file SCOLWebNavigatorWidget.cpp.

◆ SO3WebNavigatorWidgetStopFinding()

int SO3WebNavigatorWidgetStopFinding ( mmachine m )

SO3WebNavigatorWidgetStopFinding : Cancel all searches that are currently going on.

Prototype: fun [SO3_WIDGET I] I

Parameters

SO3_WIDGET	: the web navigator object
I	: 1 to clear the selection, 0 to keep it.

Returns: I : 1 if success, NIL if an error occurs.

Definition at line 1487 of file SCOLWebNavigatorWidget.cpp.

◆ SO3WebNavigatorWidgetStopLoad()

int SO3WebNavigatorWidgetStopLoad ( mmachine m )

SO3WebNavigatorWidgetStopLoad : Stop loading the page.

Prototype: fun [SO3_WIDGET] I

Parameters

SO3_WIDGET : the web navigator object

Returns: I : 1 if success, NIL if an error occurs.

Definition at line 1361 of file SCOLWebNavigatorWidget.cpp.

◆ SO3WebNavigatorWidgetViewSource()

int SO3WebNavigatorWidgetViewSource ( mmachine m )

SO3WebNavigatorWidgetViewSource : Save a frame's HTML source to a temporary file and open it in the default text viewing application.

Prototype: fun [SO3_WIDGET S] I

Parameters

SO3_WIDGET	: the web navigator object
S	: The target frame name. If NIL, the target is the web navigator main frame.

Returns: I : 1 if success, NIL otherwise

Definition at line 879 of file SCOLWebNavigatorWidget.cpp.

Project

General

Profile

Scol » SO3Engine

Functions

Detailed Description

Function Documentation

◆ SO3WebNavigatorWidgetActionCopy()

◆ SO3WebNavigatorWidgetActionCut()

◆ SO3WebNavigatorWidgetActionDelete()

◆ SO3WebNavigatorWidgetActionPaste()

◆ SO3WebNavigatorWidgetActionRedo()

◆ SO3WebNavigatorWidgetActionSelectAll()

◆ SO3WebNavigatorWidgetActionUndo()

◆ SO3WebNavigatorWidgetCanGoBack()

◆ SO3WebNavigatorWidgetCanGoForward()

◆ SO3WebNavigatorWidgetClearHistory()

◆ SO3WebNavigatorWidgetCloseDevTools()

◆ SO3WebNavigatorWidgetCreate()

◆ SO3WebNavigatorWidgetCreateBackground()

◆ SO3WebNavigatorWidgetCreateOnMaterial()

◆ SO3WebNavigatorWidgetFind()

◆ SO3WebNavigatorWidgetGetSource()

◆ SO3WebNavigatorWidgetGetText()

◆ SO3WebNavigatorWidgetGetURL()

◆ SO3WebNavigatorWidgetGetZoomLevel()

◆ SO3WebNavigatorWidgetGoBack()

◆ SO3WebNavigatorWidgetGoForward()

◆ SO3WebNavigatorWidgetLoadHTML()

◆ SO3WebNavigatorWidgetPrint()

◆ SO3WebNavigatorWidgetReload()

◆ SO3WebNavigatorWidgetReloadIgnoreCache()

◆ SO3WebNavigatorWidgetSetZoomLevel()

◆ SO3WebNavigatorWidgetShowDevTools()

◆ SO3WebNavigatorWidgetStopFinding()

◆ SO3WebNavigatorWidgetStopLoad()

◆ SO3WebNavigatorWidgetViewSource()