Project

General

Profile

SO3Engine
Web navigator

Functions

 WEB_NAVIGATOR_GENERATE_SCOL_ADD_CB_FUNCTION (OnExternalCall, WEB_NAVIGATOR_JS_ON_EXTERNAL_CALL_CB) WEB_NAVIGATOR_GENERATE_SCOL_ADD_CB_FUNCTION(OnExternalCallStr
 WebNavigatorCbOnExternalCall : Called when a javascript external called is performed. More...
 
int SO3WebNavigatorCreate (mmachine m)
 WebNavigatorCreate : This function create a new Embedded Web Navigator Object. More...
 
int SO3WebNavigatorCreateOffscreen (mmachine m)
 WebNavigatorCreateOffscreen : This function create a new Embedded Web Navigator Object which render it's content "offscreen". More...
 
int SO3WebNavigatorDestroy (mmachine m)
 WebNavigatorDestroy : This function destroy a Embedded Web Navigator Object. More...
 
int SO3WebNavigatorLoadURL (mmachine m)
 WebNavigatorLoadURL : Load the given url. More...
 
int SO3WebNavigatorLoadFile (mmachine m)
 WebNavigatorLoadFile : Load the given file. More...
 
int SO3WebNavigatorLoadHTML (mmachine m)
 WebNavigatorLoadHTML : Load the given html text. More...
 
int SO3WebNavigatorActionUndo (mmachine m)
 WebNavigatorActionUndo : Execute undo on a frame. More...
 
int SO3WebNavigatorActionRedo (mmachine m)
 WebNavigatorActionRedo : Execute redo on a frame. More...
 
int SO3WebNavigatorActionCut (mmachine m)
 WebNavigatorActionCut : Execute cut on a frame. More...
 
int SO3WebNavigatorActionCopy (mmachine m)
 WebNavigatorActionCopy : Execute copy on a frame. More...
 
int SO3WebNavigatorActionPaste (mmachine m)
 WebNavigatorActionPaste : Execute paste on a frame. More...
 
int SO3WebNavigatorActionDelete (mmachine m)
 WebNavigatorActionDelete : Execute delete on a frame. More...
 
int SO3WebNavigatorActionSelectAll (mmachine m)
 WebNavigatorActionSelectAll : Execute select all on a frame. More...
 
int SO3WebNavigatorPrint (mmachine m)
 WebNavigatorPrint : Execute printing on a frame. The user will be prompted with the print dialog appropriate to the operating system. More...
 
int SO3WebNavigatorViewSource (mmachine m)
 WebNavigatorViewSource : Save a frame's HTML source to a temporary file and open it in the default text viewing application. More...
 
int SO3WebNavigatorGetSource (mmachine m)
 WebNavigatorGetSource : Returns a frame's HTML source as a string. More...
 
int SO3WebNavigatorGetText (mmachine m)
 WebNavigatorGetText : Returns a frame's display text as a string. More...
 
int SO3WebNavigatorExecuteJavaScript (mmachine m)
 WebNavigatorExecuteJavaScript : Execute a string of JavaScript code in this frame. The |script_url| parameter is the URL where the script in question can be found, if any. The renderer may request this URL to show the developer the source of the error. The |start_line| parameter is the base line number to use for error reporting. More...
 
int SO3WebNavigatorGetURL (mmachine m)
 WebNavigatorGetURL : Returns the URL currently loaded in a frame. More...
 
int SO3WebNavigatorCanGoBack (mmachine m)
 WebNavigatorCanGoBack : Does the browser can navigate backward? More...
 
int SO3WebNavigatorGoBack (mmachine m)
 WebNavigatorGoBack : Navigate backward. More...
 
int SO3WebNavigatorCanGoForward (mmachine m)
 WebNavigatorCanGoForward : Does the browser can navigate forward? More...
 
int SO3WebNavigatorGoForward (mmachine m)
 WebNavigatorGoForward : Navigate forward. More...
 
int SO3WebNavigatorReload (mmachine m)
 WebNavigatorReload : Reload the current page. More...
 
int SO3WebNavigatorReloadIgnoreCache (mmachine m)
 WebNavigatorReloadIgnoreCache : Reload the current page ignoring any cached data. More...
 
int SO3WebNavigatorStopLoad (mmachine m)
 WebNavigatorStopLoad : Stop loading the page. More...
 
int SO3WebNavigatorFind (mmachine m)
 WebNavigatorFind : Search for text in the current page. More...
 
int SO3WebNavigatorStopFinding (mmachine m)
 WebNavigatorStopFinding : Cancel all searches that are currently going on. More...
 
int SO3WebNavigatorGetZoomLevel (mmachine m)
 WebNavigatorGetZoomLevel : Get the zoom level. More...
 
int SO3WebNavigatorSetZoomLevel (mmachine m)
 WebNavigatorSetZoomLevel : Change the zoom level. More...
 
int SO3WebNavigatorClearHistory (mmachine m)
 WebNavigatorClearHistory : Clear the back/forward browsing history. More...
 
int SO3WebNavigatorShowDevTools (mmachine m)
 WebNavigatorShowDevTools : Open developer tools window. More...
 
int SO3WebNavigatorCloseDevTools (mmachine m)
 WebNavigatorCloseDevTools : Close the developer tools window if one exists for this browser instance. More...
 
int SO3WebNavigatorGetSize (mmachine m)
 WebNavigatorGetSize : Retrieve the size of a web navigator object. More...
 
int SO3WebNavigatorSetSize (mmachine m)
 WebNavigatorSetSize : Set the size of a web navigator object. More...
 
int SO3WebNavigatorGetPosition (mmachine m)
 WebNavigatorGetPosition : Retrieve the position of a web navigator object. More...
 
int SO3WebNavigatorSetPosition (mmachine m)
 WebNavigatorSetPosition : Set the position of a web navigator object in his parent window. More...
 
int SO3WebNavigatorBlitOffscreen (mmachine m)
 WebNavigatorBlitOffscreen : Copy the content of an offscreen web navigator to the destination bitmap. More...
 
int SO3WebNavigatorBlitOffscreenAlpha (mmachine m)
 WebNavigatorBlitOffscreenAlpha : Copy the content of an offscreen web navigator to the destination alpha bitmap. More...
 
int SO3WebNavigatorInjectKeyDown (mmachine m)
 WebNavigatorInjectKeyDown : Send "key down" event to the web navigator. More...
 
int SO3WebNavigatorInjectKeyUp (mmachine m)
 WebNavigatorInjectKeyUp : Send "key up" event to the web navigator. More...
 
int SO3WebNavigatorInjectKeyMessage (mmachine m)
 WebNavigatorInjectKeyMessage : Send "key message" event to the web navigator. More...
 
int SO3WebNavigatorInjectMouseClick (mmachine m)
 WebNavigatorInjectMouseClick : Send "mouse click" event to the web navigator. More...
 
int SO3WebNavigatorInjectMouseUnClick (mmachine m)
 WebNavigatorInjectMouseClick : Send "mouse unclick" event to the web navigator. More...
 
int SO3WebNavigatorInjectMouseMove (mmachine m)
 WebNavigatorInjectMouseMove : Send "mouse move" event to the web navigator. More...
 
int SO3WebNavigatorInjectMouseWheel (mmachine m)
 WebNavigatorInjectMouseWheel : Send "mouse wheel" event to the web navigator. More...
 
int SO3WebNavigatorInjectFocus (mmachine m)
 WebNavigatorSetFocus : Send "focus" event to the web navigator. More...
 
int SO3WebNavigatorSetCookie (mmachine m)
 SO3WebNavigatorSetCookie : Create a domain cookie. More...
 
int SO3WebNavigatorDeleteCookies (mmachine m)
 SO3WebNavigatorDeleteCookies : Delete one or more cookie(s) More...
 
 WEB_NAVIGATOR_GENERATE_SCOL_ADD_CB_FUNCTION (OnNavStateChange, WEB_NAVIGATOR_DISPLAY_ON_NAV_STATE_CHANGE_CB) WEB_NAVIGATOR_GENERATE_SCOL_ADD_CB_FUNCTION(OnAddressChange
 SO3WebNavigatorCbOnNavStateChange : Called when the navigation state has changed. More...
 
WEB_NAVIGATOR_DISPLAY_ON_ADDRESS_CHANGE_CB WEB_NAVIGATOR_GENERATE_SCOL_ADD_CB_FUNCTION (OnTitleChange, WEB_NAVIGATOR_DISPLAY_ON_TITLE_CHANGE_CB) WEB_NAVIGATOR_GENERATE_SCOL_ADD_CB_FUNCTION(OnTooltip
 SO3WebNavigatorCbOnTitleChange : Called when the page title changes. More...
 
WEB_NAVIGATOR_DISPLAY_ON_ADDRESS_CHANGE_CB WEB_NAVIGATOR_DISPLAY_ON_TOOLTIP_CB WEB_NAVIGATOR_GENERATE_SCOL_ADD_CB_FUNCTION (OnStatusMessage, WEB_NAVIGATOR_DISPLAY_ON_STATUS_MESSAGE_CB) WEB_NAVIGATOR_GENERATE_SCOL_ADD_CB_FUNCTION(OnConsoleMessage
 WebNavigatorCbOnStatusMessage : Called when the browser receives a status message. |text| contains the text that will be displayed in the status message and |type| indicates the status message type. More...
 
WEB_NAVIGATOR_DISPLAY_ON_ADDRESS_CHANGE_CB WEB_NAVIGATOR_DISPLAY_ON_TOOLTIP_CB WEB_NAVIGATOR_DISPLAY_ON_CONSOLE_MESSAGE_CB WEB_NAVIGATOR_GENERATE_SCOL_ADD_CB_FUNCTION (OnFindResult, WEB_NAVIGATOR_FIND_ON_RESULT_CB) WEB_NAVIGATOR_GENERATE_SCOL_ADD_CB_FUNCTION(OnPopup
 SO3WebNavigatorCbOnFindResult : Called to report find results returned by CefBrowser::Find(). |identifer| is the identifier passed to 'Find' function, |count| is the number of matches currently identified, |selectionRect| is the location of where the match was found (in window coordinates), |activeMatchOrdinal| is the current position in the search results, and |finalUpdate| is true if this is the last find notification. More...
 
WEB_NAVIGATOR_DISPLAY_ON_ADDRESS_CHANGE_CB WEB_NAVIGATOR_DISPLAY_ON_TOOLTIP_CB WEB_NAVIGATOR_DISPLAY_ON_CONSOLE_MESSAGE_CB WEB_NAVIGATOR_LIFESPAN_ON_POPUP_CB WEB_NAVIGATOR_GENERATE_SCOL_ADD_CB_FUNCTION (RunModal, WEB_NAVIGATOR_LIFESPAN_RUN_MODAL_CB) WEB_NAVIGATOR_GENERATE_SCOL_ADD_CB_FUNCTION(OnLoadStart
 SO3WebNavigatorCbRunModal : Called when a modal window is about to display and the modal loop should begin running. Return false to use the default modal loop implementation or true to use a custom implementation. More...
 
WEB_NAVIGATOR_DISPLAY_ON_ADDRESS_CHANGE_CB WEB_NAVIGATOR_DISPLAY_ON_TOOLTIP_CB WEB_NAVIGATOR_DISPLAY_ON_CONSOLE_MESSAGE_CB WEB_NAVIGATOR_LIFESPAN_ON_POPUP_CB WEB_NAVIGATOR_LOAD_ON_START_CB WEB_NAVIGATOR_GENERATE_SCOL_ADD_CB_FUNCTION (OnLoadEnd, WEB_NAVIGATOR_LOAD_ON_END_CB) WEB_NAVIGATOR_GENERATE_SCOL_ADD_CB_FUNCTION(OnLoadError
 SO3WebNavigatorCbOnLoadEnd : Called when the browser is done loading a frame. The |frame| value will never be empty – call the IsMain() method to check if this frame is the main frame. Multiple frames may be loading at the same time. Sub-frames may start or continue loading after the main frame load has ended. This method will always be called for all frames irrespective of whether the request completes successfully. More...
 

Detailed Description

Scol functions definition

Function Documentation

◆ SO3WebNavigatorActionCopy()

int SO3WebNavigatorActionCopy ( mmachine  m)

WebNavigatorActionCopy : Execute copy on a frame.

Prototype: fun [ObjWebNavigator S] I

Parameters
ObjWebNavigator: 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 923 of file SCOLWebNavigator.cpp.

◆ SO3WebNavigatorActionCut()

int SO3WebNavigatorActionCut ( mmachine  m)

WebNavigatorActionCut : Execute cut on a frame.

Prototype: fun [ObjWebNavigator S] I

Parameters
ObjWebNavigator: 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 881 of file SCOLWebNavigator.cpp.

◆ SO3WebNavigatorActionDelete()

int SO3WebNavigatorActionDelete ( mmachine  m)

WebNavigatorActionDelete : Execute delete on a frame.

Prototype: fun [ObjWebNavigator S] I

Parameters
ObjWebNavigator: 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 1007 of file SCOLWebNavigator.cpp.

◆ SO3WebNavigatorActionPaste()

int SO3WebNavigatorActionPaste ( mmachine  m)

WebNavigatorActionPaste : Execute paste on a frame.

Prototype: fun [ObjWebNavigator S] I

Parameters
ObjWebNavigator: 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 965 of file SCOLWebNavigator.cpp.

◆ SO3WebNavigatorActionRedo()

int SO3WebNavigatorActionRedo ( mmachine  m)

WebNavigatorActionRedo : Execute redo on a frame.

Prototype: fun [ObjWebNavigator S] I

Parameters
ObjWebNavigator: 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 839 of file SCOLWebNavigator.cpp.

◆ SO3WebNavigatorActionSelectAll()

int SO3WebNavigatorActionSelectAll ( mmachine  m)

WebNavigatorActionSelectAll : Execute select all on a frame.

Prototype: fun [ObjWebNavigator S] I

Parameters
ObjWebNavigator: 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 1049 of file SCOLWebNavigator.cpp.

◆ SO3WebNavigatorActionUndo()

int SO3WebNavigatorActionUndo ( mmachine  m)

WebNavigatorActionUndo : Execute undo on a frame.

Prototype: fun [ObjWebNavigator S] I

Parameters
ObjWebNavigator: 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 797 of file SCOLWebNavigator.cpp.

◆ SO3WebNavigatorBlitOffscreen()

int SO3WebNavigatorBlitOffscreen ( mmachine  m)

WebNavigatorBlitOffscreen : Copy the content of an offscreen web navigator to the destination bitmap.

Prototype: fun [ObjWebNavigator ObjBitmap] ObjBitmap

Parameters
ObjWebNavigator: the web navigator object
ObjBitmap: target bitmap
Returns
ObjBitmap : returns the same bitmap if success, NIL otherwise

Definition at line 2071 of file SCOLWebNavigator.cpp.

◆ SO3WebNavigatorBlitOffscreenAlpha()

int SO3WebNavigatorBlitOffscreenAlpha ( mmachine  m)

WebNavigatorBlitOffscreenAlpha : Copy the content of an offscreen web navigator to the destination alpha bitmap.

Prototype: fun [ObjWebNavigator AlphaBitmap] AlphaBitmap

Parameters
ObjWebNavigator: the web navigator object
AlphaBitmap: target alpha bitmap
Returns
AlphaBitmap : returns the same alpha bitmap if success, NIL otherwise

Definition at line 2129 of file SCOLWebNavigator.cpp.

◆ SO3WebNavigatorCanGoBack()

int SO3WebNavigatorCanGoBack ( mmachine  m)

WebNavigatorCanGoBack : Does the browser can navigate backward?

Prototype: fun [ObjWebNavigator] I

Parameters
ObjWebNavigator: 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 1364 of file SCOLWebNavigator.cpp.

◆ SO3WebNavigatorCanGoForward()

int SO3WebNavigatorCanGoForward ( mmachine  m)

WebNavigatorCanGoForward : Does the browser can navigate forward?

Prototype: fun [ObjWebNavigator] I

Parameters
ObjWebNavigator: 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 1436 of file SCOLWebNavigator.cpp.

◆ SO3WebNavigatorClearHistory()

int SO3WebNavigatorClearHistory ( mmachine  m)

WebNavigatorClearHistory : Clear the back/forward browsing history.

Prototype: fun [ObjWebNavigator] I

Parameters
ObjWebNavigator: the web navigator object
Returns
I : 1 if success, NIL if an error occurs.

Definition at line 1798 of file SCOLWebNavigator.cpp.

◆ SO3WebNavigatorCloseDevTools()

int SO3WebNavigatorCloseDevTools ( mmachine  m)

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

Prototype: fun [ObjWebNavigator] I

Parameters
ObjWebNavigator: the web navigator object
Returns
I : 1 if success, NIL if an error occurs.

Definition at line 1868 of file SCOLWebNavigator.cpp.

◆ SO3WebNavigatorCreate()

int SO3WebNavigatorCreate ( mmachine  m)

WebNavigatorCreate : This function create a new Embedded Web Navigator Object.

Prototype: fun [Chn ObjWin I I I I S] ObjWebNavigator

Parameters
Chn: the current channel
ObjWin: the parent window on which the web navigator will be created
I: Horizontal position from the left border of the parent window, in pixels
I: Vertical position from the top border of the parent window, in pixels
I: Width of the web navigator
I: Height of the web navigator
S: Optional start url.
Returns
ObjWebNavigator : The new Embedded Web Navigator Object

Definition at line 465 of file SCOLWebNavigator.cpp.

◆ SO3WebNavigatorCreateOffscreen()

int SO3WebNavigatorCreateOffscreen ( mmachine  m)

WebNavigatorCreateOffscreen : This function create a new Embedded Web Navigator Object which render it's content "offscreen".

Prototype: fun [Chn ObjWin I I S] ObjWebNavigator

Parameters
Chn: the current channel
ObjWin: the parent window on which the web navigator will be created. Optional (could be nil), but needed for mouse cursor update and popup windows docking.
I: Width of the web navigator
I: Height of the web navigator
I: Transparency 0 or 1 to enable
S: Optional start url.
Returns
ObjWebNavigator : The new Embedded Web Navigator Object

Definition at line 543 of file SCOLWebNavigator.cpp.

◆ SO3WebNavigatorDeleteCookies()

int SO3WebNavigatorDeleteCookies ( mmachine  m)

SO3WebNavigatorDeleteCookies : Delete one or more cookie(s)

Prototype: fun [S S] I

Parameters
S: url
S: cookie name
Returns
I : 1 if success, NIL otherwise

Definition at line 2618 of file SCOLWebNavigator.cpp.

◆ SO3WebNavigatorDestroy()

int SO3WebNavigatorDestroy ( mmachine  m)

WebNavigatorDestroy : This function destroy a Embedded Web Navigator Object.

Prototype: fun [ObjWebNavigator] I

Parameters
ObjWebNavigator: the current Embedded web navigator object
Returns
I : 0 if success

Definition at line 624 of file SCOLWebNavigator.cpp.

◆ SO3WebNavigatorExecuteJavaScript()

int SO3WebNavigatorExecuteJavaScript ( mmachine  m)

WebNavigatorExecuteJavaScript : Execute a string of JavaScript code in this frame. The |script_url| parameter is the URL where the script in question can be found, if any. The renderer may request this URL to show the developer the source of the error. The |start_line| parameter is the base line number to use for error reporting.

Prototype: fun [ObjWebNavigator S S I S] I

Parameters
ObjWebNavigator: the web navigator object
S: The javascript code to execute
S: the url where the script can be found. target frame url if NIL.
I: line number for error reporting. 0 if NIL.
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 1265 of file SCOLWebNavigator.cpp.

◆ SO3WebNavigatorFind()

int SO3WebNavigatorFind ( mmachine  m)

WebNavigatorFind : Search for text in the current page.

Prototype: fun [ObjWebNavigator I S I I I] I

Parameters
ObjWebNavigator: the web navigator object
IThe search identifier, to allow multiple search simultaneously
SThe searched text
I1 to search forward or 0 to search backward, within the page.
I1 to indicate that the search should be case-sensitive.
I1 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 1618 of file SCOLWebNavigator.cpp.

◆ SO3WebNavigatorGetPosition()

int SO3WebNavigatorGetPosition ( mmachine  m)

WebNavigatorGetPosition : Retrieve the position of a web navigator object.

Prototype: fun [ObjWebNavigator] [I I]

Parameters
ObjWebNavigator: the web navigator object
Returns
[I I] : position tuple
  • I : position from left border of the parent window, in pixels
  • I : position from top border of the parent window, in pixels

Definition at line 1988 of file SCOLWebNavigator.cpp.

◆ SO3WebNavigatorGetSize()

int SO3WebNavigatorGetSize ( mmachine  m)

WebNavigatorGetSize : Retrieve the size of a web navigator object.

Prototype: fun [ObjWebNavigator] [I I]

Parameters
ObjWebNavigator: the web navigator object
Returns
[I I] : size tuple
  • I : width of the control
  • I : height of the control

Definition at line 1904 of file SCOLWebNavigator.cpp.

◆ SO3WebNavigatorGetSource()

int SO3WebNavigatorGetSource ( mmachine  m)

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

Prototype: fun [ObjWebNavigator S] S

Parameters
ObjWebNavigator: 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 1175 of file SCOLWebNavigator.cpp.

◆ SO3WebNavigatorGetText()

int SO3WebNavigatorGetText ( mmachine  m)

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

Prototype: fun [ObjWebNavigator S] S

Parameters
ObjWebNavigator: 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 1217 of file SCOLWebNavigator.cpp.

◆ SO3WebNavigatorGetURL()

int SO3WebNavigatorGetURL ( mmachine  m)

WebNavigatorGetURL : Returns the URL currently loaded in a frame.

Prototype: fun [ObjWebNavigator S] S

Parameters
ObjWebNavigator: 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 1323 of file SCOLWebNavigator.cpp.

◆ SO3WebNavigatorGetZoomLevel()

int SO3WebNavigatorGetZoomLevel ( mmachine  m)

WebNavigatorGetZoomLevel : Get the zoom level.

Prototype: fun [ObjWebNavigator] F

Parameters
ObjWebNavigator: the web navigator object
Returns
F : The actual zoom level, NIL if an error occurs.

Definition at line 1725 of file SCOLWebNavigator.cpp.

◆ SO3WebNavigatorGoBack()

int SO3WebNavigatorGoBack ( mmachine  m)

WebNavigatorGoBack : Navigate backward.

Prototype: fun [ObjWebNavigator] I

Parameters
ObjWebNavigator: the web navigator object
Returns
I : 1 if success, NIL if an error occurs.

Definition at line 1401 of file SCOLWebNavigator.cpp.

◆ SO3WebNavigatorGoForward()

int SO3WebNavigatorGoForward ( mmachine  m)

WebNavigatorGoForward : Navigate forward.

Prototype: fun [ObjWebNavigator] I

Parameters
ObjWebNavigator: the web navigator object
Returns
I : 1 if success, NIL if an error occurs.

Definition at line 1473 of file SCOLWebNavigator.cpp.

◆ SO3WebNavigatorInjectFocus()

int SO3WebNavigatorInjectFocus ( mmachine  m)

WebNavigatorSetFocus : Send "focus" event to the web navigator.

Prototype: fun [ObjWebNavigator I] I

Parameters
ObjWebNavigator: the web navigator object
I: 1 to set focus, 0 to set unfocused
Returns
I : 1 if success, NIL otherwise

Definition at line 2513 of file SCOLWebNavigator.cpp.

◆ SO3WebNavigatorInjectKeyDown()

int SO3WebNavigatorInjectKeyDown ( mmachine  m)

WebNavigatorInjectKeyDown : Send "key down" event to the web navigator.

Prototype: fun [ObjWebNavigator I I I] I

Parameters
ObjWebNavigator: the web navigator object
I: Virtual code of the key to inject
I: ASCII code
I: Key modifiers flag (MAJ/CTRL/ALT...)
Returns
I : 1 if success, NIL otherwise

Definition at line 2232 of file SCOLWebNavigator.cpp.

◆ SO3WebNavigatorInjectKeyMessage()

int SO3WebNavigatorInjectKeyMessage ( mmachine  m)

WebNavigatorInjectKeyMessage : Send "key message" event to the web navigator.

Prototype: fun [ObjWebNavigator I I I] I

Parameters
ObjWebNavigator: the web navigator object
I: window message
I: lparam
I: wparam
Returns
I : 1 if success, NIL otherwise

Definition at line 2311 of file SCOLWebNavigator.cpp.

◆ SO3WebNavigatorInjectKeyUp()

int SO3WebNavigatorInjectKeyUp ( mmachine  m)

WebNavigatorInjectKeyUp : Send "key up" event to the web navigator.

Prototype: fun [ObjWebNavigator I I] I

Parameters
ObjWebNavigator: the web navigator object
I: Virtual code of the key to inject
I: Key modifiers flag (MAJ/CTRL/ALT...)
Returns
I : 1 if success, NIL otherwise

Definition at line 2272 of file SCOLWebNavigator.cpp.

◆ SO3WebNavigatorInjectMouseClick()

int SO3WebNavigatorInjectMouseClick ( mmachine  m)

WebNavigatorInjectMouseClick : Send "mouse click" event to the web navigator.

Prototype: fun [ObjWebNavigator I I I] I

Parameters
ObjWebNavigator: the web navigator object
I: Mouse x position
I: Mouse y position
I: Mouse button
Returns
I : 1 if success, NIL otherwise

Definition at line 2352 of file SCOLWebNavigator.cpp.

◆ SO3WebNavigatorInjectMouseMove()

int SO3WebNavigatorInjectMouseMove ( mmachine  m)

WebNavigatorInjectMouseMove : Send "mouse move" event to the web navigator.

Prototype: fun [ObjWebNavigator I I] I

Parameters
ObjWebNavigator: the web navigator object
I: Mouse x position
I: Mouse y position
Returns
I : 1 if success, NIL otherwise

Definition at line 2434 of file SCOLWebNavigator.cpp.

◆ SO3WebNavigatorInjectMouseUnClick()

int SO3WebNavigatorInjectMouseUnClick ( mmachine  m)

WebNavigatorInjectMouseClick : Send "mouse unclick" event to the web navigator.

Prototype: fun [ObjWebNavigator I I I] I

Parameters
ObjWebNavigator: the web navigator object
I: Mouse x position
I: Mouse y position
I: Mouse button
Returns
I : 1 if success, NIL otherwise

Definition at line 2394 of file SCOLWebNavigator.cpp.

◆ SO3WebNavigatorInjectMouseWheel()

int SO3WebNavigatorInjectMouseWheel ( mmachine  m)

WebNavigatorInjectMouseWheel : Send "mouse wheel" event to the web navigator.

Prototype: fun [ObjWebNavigator I I I] I

Parameters
ObjWebNavigator: the web navigator object
I: Mouse x position
I: Mouse y position
I: Mouse wheel delta
Returns
I : 1 if success, NIL otherwise

Definition at line 2474 of file SCOLWebNavigator.cpp.

◆ SO3WebNavigatorLoadFile()

int SO3WebNavigatorLoadFile ( mmachine  m)

WebNavigatorLoadFile : Load the given file.

Prototype: fun [ObjWebNavigator P S] I

Parameters
ObjWebNavigator: the web navigator object
S: The path of the file to load
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 704 of file SCOLWebNavigator.cpp.

◆ SO3WebNavigatorLoadHTML()

int SO3WebNavigatorLoadHTML ( mmachine  m)

WebNavigatorLoadHTML : Load the given html text.

Prototype: fun [ObjWebNavigator S S] I

Parameters
ObjWebNavigator: the web navigator object
S: The HTML content to load
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 751 of file SCOLWebNavigator.cpp.

◆ SO3WebNavigatorLoadURL()

int SO3WebNavigatorLoadURL ( mmachine  m)

WebNavigatorLoadURL : Load the given url.

Prototype: fun [ObjWebNavigator S S] I

Parameters
ObjWebNavigator: the web navigator object
S: The URL to load
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 657 of file SCOLWebNavigator.cpp.

◆ SO3WebNavigatorPrint()

int SO3WebNavigatorPrint ( mmachine  m)

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

Prototype: fun [ObjWebNavigator S] I

Parameters
ObjWebNavigator: 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 1091 of file SCOLWebNavigator.cpp.

◆ SO3WebNavigatorReload()

int SO3WebNavigatorReload ( mmachine  m)

WebNavigatorReload : Reload the current page.

Prototype: fun [ObjWebNavigator] I

Parameters
ObjWebNavigator: the web navigator object
Returns
I : 1 if success, NIL if an error occurs.

Definition at line 1508 of file SCOLWebNavigator.cpp.

◆ SO3WebNavigatorReloadIgnoreCache()

int SO3WebNavigatorReloadIgnoreCache ( mmachine  m)

WebNavigatorReloadIgnoreCache : Reload the current page ignoring any cached data.

Prototype: fun [ObjWebNavigator] I

Parameters
ObjWebNavigator: the web navigator object
Returns
I : 1 if success, NIL if an error occurs.

Definition at line 1543 of file SCOLWebNavigator.cpp.

◆ SO3WebNavigatorSetCookie()

int SO3WebNavigatorSetCookie ( mmachine  m)

SO3WebNavigatorSetCookie : Create a domain cookie.

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

Parameters
S: Url
S: Cookie name
S: Cookie value
S: Cookie domain
S: Path
I: Https only
I: Http only
Returns
I : 1 if success, NIL otherwise

Definition at line 2558 of file SCOLWebNavigator.cpp.

◆ SO3WebNavigatorSetPosition()

int SO3WebNavigatorSetPosition ( mmachine  m)

WebNavigatorSetPosition : Set the position of a web navigator object in his parent window.

Prototype: fun [ObjWebNavigator I I] I

Parameters
ObjWebNavigator: the web navigator object
I: position from left border of the parent window, in pixels
I: position from top border of the parent window, in pixels
Returns
I : 1 if success, NIL otherwise

Definition at line 2033 of file SCOLWebNavigator.cpp.

◆ SO3WebNavigatorSetSize()

int SO3WebNavigatorSetSize ( mmachine  m)

WebNavigatorSetSize : Set the size of a web navigator object.

Prototype: fun [ObjWebNavigator I I] I

Parameters
ObjWebNavigator: the web navigator object
I: width of the control, in pixels
I: height of the control, in pixels
Returns
I : 1 if success, NIL otherwise

Definition at line 1949 of file SCOLWebNavigator.cpp.

◆ SO3WebNavigatorSetZoomLevel()

int SO3WebNavigatorSetZoomLevel ( mmachine  m)

WebNavigatorSetZoomLevel : Change the zoom level.

Prototype: fun [ObjWebNavigator F] I

Parameters
ObjWebNavigator: the web navigator object
F: the new zoom level
Returns
I : 1 if success, NIL if an error occurs.

Definition at line 1761 of file SCOLWebNavigator.cpp.

◆ SO3WebNavigatorShowDevTools()

int SO3WebNavigatorShowDevTools ( mmachine  m)

WebNavigatorShowDevTools : Open developer tools window.

Prototype: fun [ObjWebNavigator] I

Parameters
ObjWebNavigator: the web navigator object
Returns
I : 1 if success, NIL if an error occurs.

Definition at line 1833 of file SCOLWebNavigator.cpp.

◆ SO3WebNavigatorStopFinding()

int SO3WebNavigatorStopFinding ( mmachine  m)

WebNavigatorStopFinding : Cancel all searches that are currently going on.

Prototype: fun [ObjWebNavigator I] I

Parameters
ObjWebNavigator: 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 1684 of file SCOLWebNavigator.cpp.

◆ SO3WebNavigatorStopLoad()

int SO3WebNavigatorStopLoad ( mmachine  m)

WebNavigatorStopLoad : Stop loading the page.

Prototype: fun [ObjWebNavigator] I

Parameters
ObjWebNavigator: the web navigator object
Returns
I : 1 if success, NIL if an error occurs.

Definition at line 1578 of file SCOLWebNavigator.cpp.

◆ SO3WebNavigatorViewSource()

int SO3WebNavigatorViewSource ( mmachine  m)

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

Prototype: fun [ObjWebNavigator S] I

Parameters
ObjWebNavigator: 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 1133 of file SCOLWebNavigator.cpp.

◆ WEB_NAVIGATOR_GENERATE_SCOL_ADD_CB_FUNCTION() [1/7]

WEB_NAVIGATOR_GENERATE_SCOL_ADD_CB_FUNCTION ( OnExternalCall  ,
WEB_NAVIGATOR_JS_ON_EXTERNAL_CALL_CB   
)

WebNavigatorCbOnExternalCall : Called when a javascript external called is performed.

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

Parameters
OBJWEBNAVIGATORSCOL: The object on which we want to catch the event
fun[ObjWebNavigator u0 S [S r1]] u1 : Scol function to call
u0: Optionnal user parameter
Returns
OBJWEBNAVIGATORSCOL : Web navigator object if success

WebNavigatorCbOnExternalCallStr : Called when a javascript external called is performed

Deprecated:
DEPRECATED FUNCTION: This function now acts exactly as WebNavigatorCbOnExternalCall!

Prototype: fun [ObjWebNavigator fun [ObjWebNavigator u0 S [S r1]] S u0] ObjWebNavigator

Parameters
OBJWEBNAVIGATORSCOL: The object on which we want to catch the event
fun[ObjWebNavigator u0 S [S r1]] S : Scol function to call, must return a scol string as result (deprecated, return parameter is ignored)
u0: Optionnal user parameter
Returns
OBJWEBNAVIGATORSCOL : Web navigator object if success

◆ WEB_NAVIGATOR_GENERATE_SCOL_ADD_CB_FUNCTION() [2/7]

WEB_NAVIGATOR_GENERATE_SCOL_ADD_CB_FUNCTION ( OnNavStateChange  ,
WEB_NAVIGATOR_DISPLAY_ON_NAV_STATE_CHANGE_CB   
)

SO3WebNavigatorCbOnNavStateChange : Called when the navigation state has changed.

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

Parameters
ObjWebNavigator: The object on which we want to catch the event
fun[ObjWebNavigator u0] u1 : Scol function to call
u0: Optionnal user parameter
Returns
ObjWebNavigator : Web navigator object if success

SO3WebNavigatorCbOnAddressChange : Called when a frame's address has changed.

Prototype: fun [ObjWebNavigator fun [ObjWebNavigator u0 S S] u1 u0] ObjWebNavigator

Parameters
ObjWebNavigator: The object on which we want to catch the event
fun[ObjWebNavigator u0 S S] u1 : Scol function to call
u0: Optionnal user parameter
S: The name of the frame on which the address changed
S: The new url
Returns
ObjWebNavigator : Web navigator object if success

◆ WEB_NAVIGATOR_GENERATE_SCOL_ADD_CB_FUNCTION() [3/7]

WEB_NAVIGATOR_DISPLAY_ON_ADDRESS_CHANGE_CB WEB_NAVIGATOR_GENERATE_SCOL_ADD_CB_FUNCTION ( OnTitleChange  ,
WEB_NAVIGATOR_DISPLAY_ON_TITLE_CHANGE_CB   
)

SO3WebNavigatorCbOnTitleChange : Called when the page title changes.

Prototype: fun [ObjWebNavigator fun [ObjWebNavigator u0 S] u1 u0] ObjWebNavigator

Parameters
ObjWebNavigator: The object on which we want to catch the event
fun[ObjWebNavigator u0 S] u1 : Scol function to call
u0: Optionnal user parameter
S: The new title
Returns
ObjWebNavigator : Web navigator object if success

SO3WebNavigatorCbOnTooltip : Called when the browser is about to display a tooltip. |text| contains the text that will be displayed in the tooltip. To handle the display of the tooltip yourself return true. Otherwise, you can optionally modify |text| and then return false to allow the browser to display the tooltip.

Prototype: fun [ObjWebNavigator fun [ObjWebNavigator u0 S] u1 u0] ObjWebNavigator

Parameters
ObjWebNavigator: The object on which we want to catch the event
fun[ObjWebNavigator u0 S] u1 : Scol function to call
u0: Optionnal user parameter
S: Tooltip text
Returns
ObjWebNavigator : Web navigator object if success

◆ WEB_NAVIGATOR_GENERATE_SCOL_ADD_CB_FUNCTION() [4/7]

WEB_NAVIGATOR_DISPLAY_ON_ADDRESS_CHANGE_CB WEB_NAVIGATOR_DISPLAY_ON_TOOLTIP_CB WEB_NAVIGATOR_GENERATE_SCOL_ADD_CB_FUNCTION ( OnStatusMessage  ,
WEB_NAVIGATOR_DISPLAY_ON_STATUS_MESSAGE_CB   
)

WebNavigatorCbOnStatusMessage : Called when the browser receives a status message. |text| contains the text that will be displayed in the status message and |type| indicates the status message type.

Prototype: TODO OBJWEBNAVIGATORSCOL

Parameters
ObjWebNavigator: The object on which we want to catch the event
fun[ObjWebNavigator u0] u1 : Scol function to call
u0: Optionnal user parameter
Returns
ObjWebNavigator : Web navigator object if success

SO3WebNavigatorCbOnConsoleMessage : Called to display a console message. Return true to stop the message from being output to the console.

Prototype: fun [ObjWebNavigator fun [ObjWebNavigator u0 S S I] u1 u0] ObjWebNavigator

Parameters
ObjWebNavigator: The object on which we want to catch the event
fun[ObjWebNavigator u0 S S I] u1 : Scol function to call
u0: Optionnal user parameter
S: Message
S: Source file
I: File line
Returns
ObjWebNavigator : Web navigator object if success

◆ WEB_NAVIGATOR_GENERATE_SCOL_ADD_CB_FUNCTION() [5/7]

WEB_NAVIGATOR_DISPLAY_ON_ADDRESS_CHANGE_CB WEB_NAVIGATOR_DISPLAY_ON_TOOLTIP_CB WEB_NAVIGATOR_DISPLAY_ON_CONSOLE_MESSAGE_CB WEB_NAVIGATOR_GENERATE_SCOL_ADD_CB_FUNCTION ( OnFindResult  ,
WEB_NAVIGATOR_FIND_ON_RESULT_CB   
)

SO3WebNavigatorCbOnFindResult : Called to report find results returned by CefBrowser::Find(). |identifer| is the identifier passed to 'Find' function, |count| is the number of matches currently identified, |selectionRect| is the location of where the match was found (in window coordinates), |activeMatchOrdinal| is the current position in the search results, and |finalUpdate| is true if this is the last find notification.

Prototype: TODO OBJWEBNAVIGATORSCOL

Parameters
OBJWEBNAVIGATORSCOL: The object on which we want to catch the event
fun[OBJWEBNAVIGATORSCOL u0 I I [I I I I] I I] u1 : Scol function to call
u0: Optionnal user parameter
I: the identifier passed to 'Find' function
I: the number of matches currently identified
[II I I] : the location of where the match was found
I: the current position in the search results
I: '1' if this is the last find notification, '0' if there's more responses after this position.
Returns
OBJWEBNAVIGATORSCOL : Web navigator object if success

SO3WebNavigatorCbOnPopup : Called when a request for a new popup window (a new web navigator) occurs.

Prototype: fun [ObjWebNavigator fun [ObjWebNavigator u0 I I I I S] u1 u0] ObjWebNavigator

Parameters
ObjWebNavigator: The object on which we want to catch the event
fun[ObjWebNavigator u0 I I I I S] u1 : Scol function to call
u0: Optionnal user parameter
I: X position of the popup
I: Y position of the popup
I: Width of the popup
I: Height of the popup
S: Target url of the popup
Returns
ObjWebNavigator : Web navigator object if success

◆ WEB_NAVIGATOR_GENERATE_SCOL_ADD_CB_FUNCTION() [6/7]

WEB_NAVIGATOR_DISPLAY_ON_ADDRESS_CHANGE_CB WEB_NAVIGATOR_DISPLAY_ON_TOOLTIP_CB WEB_NAVIGATOR_DISPLAY_ON_CONSOLE_MESSAGE_CB WEB_NAVIGATOR_LIFESPAN_ON_POPUP_CB WEB_NAVIGATOR_GENERATE_SCOL_ADD_CB_FUNCTION ( RunModal  ,
WEB_NAVIGATOR_LIFESPAN_RUN_MODAL_CB   
)

SO3WebNavigatorCbRunModal : Called when a modal window is about to display and the modal loop should begin running. Return false to use the default modal loop implementation or true to use a custom implementation.

Prototype: fun [ObjWebNavigator fun [ObjWebNavigator u0] u1 u0] ObjWebNavigator

Parameters
ObjWebNavigator: The object on which we want to catch the event
fun[ObjWebNavigator u0] u1 : Scol function to call
u0: Optionnal user parameter
Returns
ObjWebNavigator : Web navigator object if success

SO3WebNavigatorCbOnLoadStart : Called when the browser begins loading a frame. The |frame| value will never be empty – call the IsMain() method to check if this frame is the main frame. Multiple frames may be loading at the same time. Sub-frames may start or continue loading after the main frame load has ended. This method may not be called for a particular frame if the load request for that frame fails.

Prototype: TODO OBJWEBNAVIGATORSCOL

Parameters
OBJWEBNAVIGATORSCOL: The object on which we want to catch the event
fun[OBJWEBNAVIGATORSCOL u0 S] u1 : Scol function to call
u0: Optionnal user parameter
S: Frame name
Returns
OBJWEBNAVIGATORSCOL : Web navigator object if success

◆ WEB_NAVIGATOR_GENERATE_SCOL_ADD_CB_FUNCTION() [7/7]

WEB_NAVIGATOR_DISPLAY_ON_ADDRESS_CHANGE_CB WEB_NAVIGATOR_DISPLAY_ON_TOOLTIP_CB WEB_NAVIGATOR_DISPLAY_ON_CONSOLE_MESSAGE_CB WEB_NAVIGATOR_LIFESPAN_ON_POPUP_CB WEB_NAVIGATOR_LOAD_ON_START_CB WEB_NAVIGATOR_GENERATE_SCOL_ADD_CB_FUNCTION ( OnLoadEnd  ,
WEB_NAVIGATOR_LOAD_ON_END_CB   
)

SO3WebNavigatorCbOnLoadEnd : Called when the browser is done loading a frame. The |frame| value will never be empty – call the IsMain() method to check if this frame is the main frame. Multiple frames may be loading at the same time. Sub-frames may start or continue loading after the main frame load has ended. This method will always be called for all frames irrespective of whether the request completes successfully.

Prototype: TODO OBJWEBNAVIGATORSCOL

Parameters
OBJWEBNAVIGATORSCOL: The object on which we want to catch the event
fun[OBJWEBNAVIGATORSCOL u0 S I] u1 : Scol function to call
u0: Optionnal user parameter
S: Frame name
I: http status code
Returns
OBJWEBNAVIGATORSCOL : Web navigator object if success

SO3WebNavigatorCbOnLoadError : Called when the browser fails to load a resource. |errorCode| is the error code number and |failedUrl| is the URL that failed to load. To provide custom error text assign the text to |errorText| and return true. Otherwise, return false for the default error text. See net\base\net_error_list.h for complete descriptions of the error codes.

Prototype: TODO OBJWEBNAVIGATORSCOL

Parameters
OBJWEBNAVIGATORSCOL: The object on which we want to catch the event
fun[OBJWEBNAVIGATORSCOL u0 S S I S] u1 : Scol function to call
u0: Optionnal user parameter
S: Frame name
S: Url that failed to load
I: Cef error code
S: Error text
Returns
OBJWEBNAVIGATORSCOL : Web navigator object if success
Remarks
Cef error codes values are: ERR_FAILED = -2 ERR_ABORTED = -3 ERR_INVALID_ARGUMENT = -4 ERR_INVALID_HANDLE = -5 ERR_FILE_NOT_FOUND = -6 ERR_TIMED_OUT = -7 ERR_FILE_TOO_BIG = -8 ERR_UNEXPECTED = -9 ERR_ACCESS_DENIED = -10 ERR_NOT_IMPLEMENTED = -11 ERR_CONNECTION_CLOSED = -100 ERR_CONNECTION_RESET = -101 ERR_CONNECTION_REFUSED = -102 ERR_CONNECTION_ABORTED = -103 ERR_CONNECTION_FAILED = -104 ERR_NAME_NOT_RESOLVED = -105 ERR_INTERNET_DISCONNECTED = -106 ERR_SSL_PROTOCOL_ERROR = -107 ERR_ADDRESS_INVALID = -108 ERR_ADDRESS_UNREACHABLE = -109 ERR_SSL_CLIENT_AUTH_CERT_NEEDED = -110 ERR_TUNNEL_CONNECTION_FAILED = -111 ERR_NO_SSL_VERSIONS_ENABLED = -112 ERR_SSL_VERSION_OR_CIPHER_MISMATCH = -113 ERR_SSL_RENEGOTIATION_REQUESTED = -114 ERR_CERT_COMMON_NAME_INVALID = -200 ERR_CERT_DATE_INVALID = -201 ERR_CERT_AUTHORITY_INVALID = -202 ERR_CERT_CONTAINS_ERRORS = -203 ERR_CERT_NO_REVOCATION_MECHANISM = -204 ERR_CERT_UNABLE_TO_CHECK_REVOCATION = -205 ERR_CERT_REVOKED = -206 ERR_CERT_INVALID = -207 ERR_CERT_END = -208 ERR_INVALID_URL = -300 ERR_DISALLOWED_URL_SCHEME = -301 ERR_UNKNOWN_URL_SCHEME = -302 ERR_TOO_MANY_REDIRECTS = -310 ERR_UNSAFE_REDIRECT = -311 ERR_UNSAFE_PORT = -312 ERR_INVALID_RESPONSE = -320 ERR_INVALID_CHUNKED_ENCODING = -321 ERR_METHOD_NOT_SUPPORTED = -322 ERR_UNEXPECTED_PROXY_AUTH = -323 ERR_EMPTY_RESPONSE = -324 ERR_RESPONSE_HEADERS_TOO_BIG = -325 ERR_CACHE_MISS = -400 ERR_INSECURE_RESPONSE = -501