Coherent UI for .NET  2.5.3
A modern user interface library for games
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Pages
Coherent.UI.Windows.Forms.BrowserViewControl Class Reference

Interface that allows clients to listen to Coherent::UI::ViewListener More...

Inherits PictureBox.

Public Member Functions

 BrowserViewControl ()
 Creates a new BrowserViewControl More...
 
 BrowserViewControl (IContainer container)
 Creates a new BrowserViewControl within a container More...
 
void CreateBrowserView ()
 Create the browser view for this control. More...
 
new void Resize (int w, int h)
 Resize the view More...
 
void ProcessKeyDown (KeyEventArgs e)
 Called on key down event More...
 
void ProcessKeyUp (KeyEventArgs e)
 Called on key up event More...
 
void ProcessKeyPress (KeyPressEventArgs e)
 Called on key press event More...
 
void ProcessMouseWheel (MouseEventArgs e)
 Called on mouse wheel event More...
 
void ProcessMouseDown (MouseEventArgs e)
 Called on mouse down event More...
 
void ProcessMouseUp (MouseEventArgs e)
 Called on mouse up event More...
 
void ProcessMouseMove (MouseEventArgs e)
 Called on mouse move event More...
 

Protected Member Functions

override void OnPaint (PaintEventArgs e)
 Paints the control More...
 
override void OnCreateControl ()
 Called when the control is created More...
 
override void OnMouseDown (MouseEventArgs e)
 Called on mouse down event More...
 
override void OnMouseUp (MouseEventArgs e)
 Called on mouse up event More...
 
override void OnMouseMove (MouseEventArgs e)
 Called on mouse move event More...
 
override void OnKeyDown (KeyEventArgs e)
 Called on key down event More...
 
override void OnKeyUp (KeyEventArgs e)
 Called on key up event More...
 
override void OnKeyPress (KeyPressEventArgs e)
 Called on key press event More...
 
override void OnMouseWheel (MouseEventArgs e)
 Called on mouse wheel event More...
 

Properties

BrowserViewContext Context [get, set]
 Which view context should be used by the view control. If null, a default view context will be used More...
 
int ViewWidth [get, set]
 Width of the view More...
 
int ViewHeight [get, set]
 Height of the view More...
 
string InitialUrl [get, set]
 Iniatial URL to load More...
 
string InitialScript [get, set]
 The script to execute when the view JavaScript engine is created More...
 
DisplayModes DisplayMode [get, set]
 Display mode for the view More...
 
int MaxFramerate [get, set]
 Maximum framerate for the view. More...
 
bool IsTransparent [get, set]
 Determines whether the image produced by Coherent UI supports transparency. When enabled, Coherent UI requires a little more processing time to fill in the alpha values. More...
 
Coherent.UI.BrowserView BrowserView [get]
 Get the wrapped Coherent UI view More...
 

Events

Coherent.UI.ViewListener.CoherentUI_OnViewCreated ViewCreated
 Fired when the requested More...
 
Coherent.UI.ViewListener.CoherentUI_OnFinishLoad FinishLoad
 Fired when a frame has been successfully loaded. More...
 
Coherent.UI.ViewListener.CoherentUI_OnFailLoad FailLoad
 Fired when a frame has been failed loading. More...
 
Coherent.UI.ViewListener.CoherentUI_OnURLRequest URLRequest
 Fired before an URL request is made. The default implementation allows all requests. More...
 
Coherent.UI.ViewListener.CoherentUI_OnReadyForBindings ReadyForBindings
 Fired when a frame is ready for bindings. More...
 
Coherent.UI.ViewListener.CoherentUI_OnBindingsReleased BindingsReleased
 Fired when the bindings for frame are released. More...
 
Coherent.UI.ViewListener.CoherentUI_OnStartLoading StartLoading
 Fired when a new path has started loading. More...
 
Coherent.UI.ViewListener.CoherentUI_OnStopLoading StopLoading
 Fired when all load operations have completed. More...
 
Coherent.UI.ViewListener.CoherentUI_OnNavigateTo NavigateTo
 Fired when the view starts navigation to a new path. More...
 
Coherent.UI.ViewListener.CoherentUI_OnError Error
 Fired when an error occurs for this specific More...
 
Coherent.UI.ViewListener.CoherentUI_OnScriptMessage ScriptMessage
 Fired when a message is sent from a script running in this specific More...
 
Coherent.UI.ViewListener.CoherentUI_OnCallback Callback
 Fired by the UI when there is no registered handler for this event. More...
 
Coherent.UI.ViewListener.CoherentUI_OnJavaScriptMessage JavaScriptMessage
 Fired when the view triggered a javascript message box, i.e. an alert, confirmation dialog or a prompt dialog. More...
 
Coherent.UI.ViewListener.CoherentUI_OnGetAuthCredentials GetAuthCredentials
 Fired when a view requires authentication credentials. More...
 
Coherent.UI.BrowserViewListener.CoherentUI_OnCertificateError CertificateError
 Fired when there is an error with the certificate of a particular URL. the certificate and response pointers are valid only for the duration of this call More...
 
Coherent.UI.BrowserViewListener.CoherentUI_OnRequestMediaStream RequestMediaStream
 Fired when the view requests access to a media stream. Media streams are the audio capture (microphone) and video capture (camera) devices on the system. More...
 

Detailed Description

Interface that allows clients to listen to Coherent::UI::ViewListener

Encapsulates Coherent UI view as a Windows Forms control

Constructor & Destructor Documentation

Coherent.UI.Windows.Forms.BrowserViewControl.BrowserViewControl ( )
inline

Creates a new BrowserViewControl

Coherent.UI.Windows.Forms.BrowserViewControl.BrowserViewControl ( IContainer  container)
inline

Creates a new BrowserViewControl within a container

Parameters
containerthe container to hold the view

Member Function Documentation

void Coherent.UI.Windows.Forms.BrowserViewControl.CreateBrowserView ( )
inline

Create the browser view for this control.

override void Coherent.UI.Windows.Forms.BrowserViewControl.OnCreateControl ( )
inlineprotected

Called when the control is created

override void Coherent.UI.Windows.Forms.BrowserViewControl.OnKeyDown ( KeyEventArgs  e)
inlineprotected

Called on key down event

Parameters
ekey event arguments
override void Coherent.UI.Windows.Forms.BrowserViewControl.OnKeyPress ( KeyPressEventArgs  e)
inlineprotected

Called on key press event

Parameters
ekey event arguments
override void Coherent.UI.Windows.Forms.BrowserViewControl.OnKeyUp ( KeyEventArgs  e)
inlineprotected

Called on key up event

Parameters
ekey event arguments
override void Coherent.UI.Windows.Forms.BrowserViewControl.OnMouseDown ( MouseEventArgs  e)
inlineprotected

Called on mouse down event

Parameters
emouse event arguments
override void Coherent.UI.Windows.Forms.BrowserViewControl.OnMouseMove ( MouseEventArgs  e)
inlineprotected

Called on mouse move event

Parameters
emouse event arguments
override void Coherent.UI.Windows.Forms.BrowserViewControl.OnMouseUp ( MouseEventArgs  e)
inlineprotected

Called on mouse up event

Parameters
emouse event arguments
override void Coherent.UI.Windows.Forms.BrowserViewControl.OnMouseWheel ( MouseEventArgs  e)
inlineprotected

Called on mouse wheel event

Parameters
emouse event arguments
override void Coherent.UI.Windows.Forms.BrowserViewControl.OnPaint ( PaintEventArgs  e)
inlineprotected

Paints the control

Parameters
e
void Coherent.UI.Windows.Forms.BrowserViewControl.ProcessKeyDown ( KeyEventArgs  e)
inline

Called on key down event

Parameters
ekey event arguments
void Coherent.UI.Windows.Forms.BrowserViewControl.ProcessKeyPress ( KeyPressEventArgs  e)
inline

Called on key press event

Parameters
ekey event arguments
void Coherent.UI.Windows.Forms.BrowserViewControl.ProcessKeyUp ( KeyEventArgs  e)
inline

Called on key up event

Parameters
ekey event arguments
void Coherent.UI.Windows.Forms.BrowserViewControl.ProcessMouseDown ( MouseEventArgs  e)
inline

Called on mouse down event

Parameters
emouse event arguments
void Coherent.UI.Windows.Forms.BrowserViewControl.ProcessMouseMove ( MouseEventArgs  e)
inline

Called on mouse move event

Parameters
emouse event arguments
void Coherent.UI.Windows.Forms.BrowserViewControl.ProcessMouseUp ( MouseEventArgs  e)
inline

Called on mouse up event

Parameters
emouse event arguments
void Coherent.UI.Windows.Forms.BrowserViewControl.ProcessMouseWheel ( MouseEventArgs  e)
inline

Called on mouse wheel event

Parameters
emouse event arguments
new void Coherent.UI.Windows.Forms.BrowserViewControl.Resize ( int  w,
int  h 
)
inline

Resize the view

Parameters
wwidth of the view
hheight of the view

Property Documentation

Coherent.UI.BrowserView Coherent.UI.Windows.Forms.BrowserViewControl.BrowserView
get

Get the wrapped Coherent UI view

BrowserViewContext Coherent.UI.Windows.Forms.BrowserViewControl.Context
getset

Which view context should be used by the view control. If null, a default view context will be used

DisplayModes Coherent.UI.Windows.Forms.BrowserViewControl.DisplayMode
getset

Display mode for the view

string Coherent.UI.Windows.Forms.BrowserViewControl.InitialScript
getset

The script to execute when the view JavaScript engine is created

string Coherent.UI.Windows.Forms.BrowserViewControl.InitialUrl
getset

Iniatial URL to load

bool Coherent.UI.Windows.Forms.BrowserViewControl.IsTransparent
getset

Determines whether the image produced by Coherent UI supports transparency. When enabled, Coherent UI requires a little more processing time to fill in the alpha values.

int Coherent.UI.Windows.Forms.BrowserViewControl.MaxFramerate
getset

Maximum framerate for the view.

int Coherent.UI.Windows.Forms.BrowserViewControl.ViewHeight
getset

Height of the view

int Coherent.UI.Windows.Forms.BrowserViewControl.ViewWidth
getset

Width of the view

Event Documentation

Coherent.UI.ViewListener.CoherentUI_OnBindingsReleased Coherent.UI.Windows.Forms.BrowserViewControl.BindingsReleased

Fired when the bindings for frame are released.

Coherent.UI.ViewListener.CoherentUI_OnCallback Coherent.UI.Windows.Forms.BrowserViewControl.Callback

Fired by the UI when there is no registered handler for this event.

Coherent.UI.BrowserViewListener.CoherentUI_OnCertificateError Coherent.UI.Windows.Forms.BrowserViewControl.CertificateError

Fired when there is an error with the certificate of a particular URL. the certificate and response pointers are valid only for the duration of this call

Coherent.UI.ViewListener.CoherentUI_OnError Coherent.UI.Windows.Forms.BrowserViewControl.Error

Fired when an error occurs for this specific

Coherent.UI.ViewListener.CoherentUI_OnFailLoad Coherent.UI.Windows.Forms.BrowserViewControl.FailLoad

Fired when a frame has been failed loading.

Coherent.UI.ViewListener.CoherentUI_OnFinishLoad Coherent.UI.Windows.Forms.BrowserViewControl.FinishLoad

Fired when a frame has been successfully loaded.

Coherent.UI.ViewListener.CoherentUI_OnGetAuthCredentials Coherent.UI.Windows.Forms.BrowserViewControl.GetAuthCredentials

Fired when a view requires authentication credentials.

Coherent.UI.ViewListener.CoherentUI_OnJavaScriptMessage Coherent.UI.Windows.Forms.BrowserViewControl.JavaScriptMessage

Fired when the view triggered a javascript message box, i.e. an alert, confirmation dialog or a prompt dialog.

Coherent.UI.ViewListener.CoherentUI_OnNavigateTo Coherent.UI.Windows.Forms.BrowserViewControl.NavigateTo

Fired when the view starts navigation to a new path.

Coherent.UI.ViewListener.CoherentUI_OnReadyForBindings Coherent.UI.Windows.Forms.BrowserViewControl.ReadyForBindings

Fired when a frame is ready for bindings.

Coherent.UI.BrowserViewListener.CoherentUI_OnRequestMediaStream Coherent.UI.Windows.Forms.BrowserViewControl.RequestMediaStream

Fired when the view requests access to a media stream. Media streams are the audio capture (microphone) and video capture (camera) devices on the system.

Coherent.UI.ViewListener.CoherentUI_OnScriptMessage Coherent.UI.Windows.Forms.BrowserViewControl.ScriptMessage

Fired when a message is sent from a script running in this specific

Coherent.UI.ViewListener.CoherentUI_OnStartLoading Coherent.UI.Windows.Forms.BrowserViewControl.StartLoading

Fired when a new path has started loading.

Coherent.UI.ViewListener.CoherentUI_OnStopLoading Coherent.UI.Windows.Forms.BrowserViewControl.StopLoading

Fired when all load operations have completed.

Coherent.UI.ViewListener.CoherentUI_OnURLRequest Coherent.UI.Windows.Forms.BrowserViewControl.URLRequest

Fired before an URL request is made. The default implementation allows all requests.

Coherent.UI.ViewListener.CoherentUI_OnViewCreated Coherent.UI.Windows.Forms.BrowserViewControl.ViewCreated

Fired when the requested