Web navigator general functions

Functions
int	WebNavigatorCreate (mmachine m)
	WebNavigatorCreate : This function create a new Embedded Web Navigator Object.
int	WebNavigatorCreateOffscreen (mmachine m)
	WebNavigatorCreate : This function create a new Embedded Web Navigator Object which render it's content "offscreen".
int	WebNavigatorDestroy (mmachine m)
	WebNavigatorDestroy : This function destroy a Embedded Web Navigator Object.
int	WebNavigatorLoadURL (mmachine m)
	WebNavigatorLoadURL : Load the given url.
int	WebNavigatorLoadFile (mmachine m)
	WebNavigatorLoadFile : Load the given file.
int	WebNavigatorLoadHTML (mmachine m)
	WebNavigatorLoadHTML : Load the given html text.
int	WebNavigatorActionUndo (mmachine m)
	WebNavigatorActionUndo : Execute undo on a frame.
int	WebNavigatorActionRedo (mmachine m)
	WebNavigatorActionRedo : Execute redo on a frame.
int	WebNavigatorActionCut (mmachine m)
	WebNavigatorActionCut : Execute cut on a frame.
int	WebNavigatorActionCopy (mmachine m)
	WebNavigatorActionCopy : Execute copy on a frame.
int	WebNavigatorActionPaste (mmachine m)
	WebNavigatorActionPaste : Execute paste on a frame.
int	WebNavigatorActionDelete (mmachine m)
	WebNavigatorActionDelete : Execute delete on a frame.
int	WebNavigatorActionSelectAll (mmachine m)
	WebNavigatorActionSelectAll : Execute select all on a frame.
int	WebNavigatorPrint (mmachine m)
	WebNavigatorPrint : Execute printing on a frame. The user will be prompted with the print dialog appropriate to the operating system.
int	WebNavigatorViewSource (mmachine m)
	WebNavigatorViewSource : Save a frame's HTML source to a temporary file and open it in the default text viewing application.
int	WebNavigatorGetSource (mmachine m)
	WebNavigatorGetSource : Returns a frame's HTML source as a string.
int	WebNavigatorGetText (mmachine m)
	WebNavigatorGetText : Returns a frame's display text as a string.
int	WebNavigatorExecuteJavaScript (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.
int	WebNavigatorGetURL (mmachine m)
	WebNavigatorGetURL : Returns the URL currently loaded in a frame.
int	WebNavigatorCanGoBack (mmachine m)
	WebNavigatorCanGoBack : Does the browser can navigate backward?
int	WebNavigatorGoBack (mmachine m)
	WebNavigatorGoBack : Navigate backward.
int	WebNavigatorCanGoForward (mmachine m)
	WebNavigatorCanGoForward : Does the browser can navigate forward?
int	WebNavigatorGoForward (mmachine m)
	WebNavigatorGoForward : Navigate forward.
int	WebNavigatorReload (mmachine m)
	WebNavigatorReload : Reload the current page.
int	WebNavigatorReloadIgnoreCache (mmachine m)
	WebNavigatorReloadIgnoreCache : Reload the current page ignoring any cached data.
int	WebNavigatorStopLoad (mmachine m)
	WebNavigatorStopLoad : Stop loading the page.
int	WebNavigatorFind (mmachine m)
	WebNavigatorFind : Search for text in the current page.
int	WebNavigatorStopFinding (mmachine m)
	WebNavigatorStopFinding : Cancel all searches that are currently going on.
int	WebNavigatorGetZoomLevel (mmachine m)
	WebNavigatorGetZoomLevel : Get the zoom level.
int	WebNavigatorSetZoomLevel (mmachine m)
	WebNavigatorSetZoomLevel : Change the zoom level.
int	WebNavigatorClearHistory (mmachine m)
	WebNavigatorClearHistory : Clear the back/forward browsing history.
int	WebNavigatorShowDevTools (mmachine m)
	WebNavigatorShowDevTools : Open developer tools window.
int	WebNavigatorCloseDevTools (mmachine m)
	WebNavigatorCloseDevTools : Close the developer tools window if one exists for this browser instance.
int	WebNavigatorGetSize (mmachine m)
	WebNavigatorGetSize : Retrieve the size of a web navigator object.
int	WebNavigatorSetSize (mmachine m)
	WebNavigatorSetSize : Set the size of a web navigator object.
int	WebNavigatorGetPosition (mmachine m)
	WebNavigatorGetPosition : Retrieve the position of a web navigator object.
int	WebNavigatorSetPosition (mmachine m)
	WebNavigatorSetPosition : Set the position of a web navigator object in his parent window.
int	WebNavigatorBlitOffscreen (mmachine m)
	WebNavigatorBlitOffscreen : Copy the content of an offscreen web navigator to the destination bitmap.
int	WebNavigatorBlitOffscreenAlpha (mmachine m)
	WebNavigatorBlitOffscreenAlpha : Copy the content of an offscreen web navigator to the destination alpha bitmap.
int	WebNavigatorInjectKeyDown (mmachine m)
	WebNavigatorInjectKeyDown : Send "key down" event to the web navigator.
int	WebNavigatorInjectKeyUp (mmachine m)
	WebNavigatorInjectKeyUp : Send "key up" event to the web navigator.
int	WebNavigatorInjectKeyMessage (mmachine m)
	WebNavigatorInjectKeyMessage : Send "key message" event to the web navigator.
int	WebNavigatorInjectMouseClick (mmachine m)
	WebNavigatorInjectMouseClick : Send "mouse click" event to the web navigator.
int	WebNavigatorInjectMouseMove (mmachine m)
	WebNavigatorInjectMouseMove : Send "mouse move" event to the web navigator.
int	WebNavigatorInjectMouseWheel (mmachine m)
	WebNavigatorInjectMouseWheel : Send "mouse wheel" event to the web navigator.
int	WebNavigatorSetFocus (mmachine m)
	WebNavigatorSetFocus : Send "focus" event to the web navigator.

---

Detailed Description

Creation / deletion functions and generic usage of the web navigator component.

---

Function Documentation

int WebNavigatorActionCopy

(

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

int WebNavigatorActionCut

(

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

int WebNavigatorActionDelete

(

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

int WebNavigatorActionPaste

(

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

int WebNavigatorActionRedo

(

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

int WebNavigatorActionSelectAll

(

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

int WebNavigatorActionUndo

(

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

int WebNavigatorBlitOffscreen

(

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

int WebNavigatorBlitOffscreenAlpha

(

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

int WebNavigatorCanGoBack

(

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.

int WebNavigatorCanGoForward

(

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.

int WebNavigatorClearHistory

(

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.

int WebNavigatorCloseDevTools

(

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.

int WebNavigatorCreate

(

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

int WebNavigatorCreateOffscreen

(

mmachine

m

)

WebNavigatorCreate : 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

int WebNavigatorDestroy

(

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

int WebNavigatorExecuteJavaScript

(

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

int WebNavigatorFind

(

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
	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.

int WebNavigatorGetPosition

(

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

int WebNavigatorGetSize

(

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

int WebNavigatorGetSource

(

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

int WebNavigatorGetText

(

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

int WebNavigatorGetURL

(

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

int WebNavigatorGetZoomLevel

(

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.

int WebNavigatorGoBack

(

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.

int WebNavigatorGoForward

(

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.

int WebNavigatorInjectKeyDown

(

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

int WebNavigatorInjectKeyMessage

(

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

int WebNavigatorInjectKeyUp

(

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

int WebNavigatorInjectMouseClick

(

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

int WebNavigatorInjectMouseMove

(

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

int WebNavigatorInjectMouseWheel

(

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

int WebNavigatorLoadFile

(

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

int WebNavigatorLoadHTML

(

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

int WebNavigatorLoadURL

(

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

int WebNavigatorPrint

(

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

int WebNavigatorReload

(

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.

int WebNavigatorReloadIgnoreCache

(

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.

int WebNavigatorSetFocus

(

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

int WebNavigatorSetPosition

(

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

int WebNavigatorSetSize

(

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

int WebNavigatorSetZoomLevel

(

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.

int WebNavigatorShowDevTools

(

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.

int WebNavigatorStopFinding

(

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.

int WebNavigatorStopLoad

(

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.

int WebNavigatorViewSource

(

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