Interface that allows clients to listen to Coherent::UI::ViewListener More...
Public Member Functions | |
override void | Release () |
Called when the listener is no longer needed by the UI context. More... | |
override void | OnViewCreated (View view) |
Called when the requested More... | |
override void | OnDraw (CoherentHandle handle, bool usesSharedMemory, int width, int height) |
Called when a new surface has been drawn and is ready to use by the client. More... | |
override void | OnFinishLoad (int frameId, string validatedPath, bool isMainFrame, int statusCode, HTTPHeader[] headers) |
Called when a frame has been successfully loaded. More... | |
override void | OnFailLoad (int frameId, string validatedPath, bool isMainFrame, string error) |
Called when a frame has been failed loading. More... | |
override void | OnURLRequest (URLRequest request) |
Called before an URL request is made. The default implementation allows all requests. More... | |
override void | OnReadyForBindings (int frameId, string path, bool isMainFrame) |
Called when a frame is ready for bindings. More... | |
override void | OnBindingsReleased (int frameId, string path, bool isMainFrame) |
Called when the bindings for frame are released. More... | |
override void | OnStartLoading () |
Called when a new path has started loading. More... | |
override void | OnStopLoading () |
Called when all load operations have completed. More... | |
override void | OnNavigateTo (string path) |
Called when the view starts navigation to a new path. More... | |
override void | OnError (ViewError error) |
Called when an error occurs for this specific More... | |
override void | OnScriptMessage (ViewListenerBase.MessageLevel level, string message, string sourceId, int line) |
Called when a message is sent from a script running in this specific More... | |
override void | OnCursorChanged (CursorTypes cursor) |
Called when the cursor has changed internally in the More... | |
override void | OnCallback (string eventName, Binding.CallbackArguments arguments) |
Called by the UI when there is no registered handler for this event. More... | |
override void | OnJavaScriptMessage (string message, string defaultPrompt, string frameUrl, int messageType) |
Called when the view triggered a javascript message box, i.e. an alert, confirmation dialog or a prompt dialog. More... | |
override void | OnGetAuthCredentials (bool isProxy, string host, uint port, string realm, string scheme) |
Called when a view requires authentication credentials. More... | |
override void | CreateSurface (bool sharedMemory, uint width, uint height, SurfaceResponse response) |
Called when the The format for DirectX9 must be D3DFMT_A8R8G8B8 The format for DirectX10 and DirectX11 must be B8G8R8A8_UNORM More... | |
override void | DestroySurface (CoherentHandle surface, bool usesSharedMemory) |
Called when a surface is unneeded anymore and should be destroyed This function can be called from a thread different than the main UI context thread in order to support client applications with multi-threaded rendering. More... | |
override void | OnCertificateError (string url, CertificateStatus status, Certificate certificate, CertificateErrorResponse response) |
Called 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... | |
override void | OnRequestMediaStream (MediaStreamRequest request) |
Called 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... | |
override void | OnTextInputTypeChanged (TextInputControlType type, bool canComposeInline) |
Called when the current text input control changes (i.e. the user click an edit-box). Use this methof to decide when to allow for IME input. the method will be called ONLY if IME is activated on this View. View::IMEActivate More... | |
override void | OnCaretRectChanged (uint x, uint y, uint width, uint height) |
Called when the caret changes during IME composition. You can use this method to correctly position a custom IME control & candidate list. More... | |
override void | OnIMEShouldCancelComposition () |
Called when the user must cancel the IME composition due to an event in the More... | |
override void | OnFileSelectRequest (FileSelectRequest request) |
Called when the view requests file selection. It could be either single file, directory or multiple files. More... | |
override bool | OnCanCreateChildWindow (string openerUrl, string targetUrl, ChildViewInfo childViewInfo) |
Called when the view wants to open a new window. More... | |
override void | OnAudioStreamCreated (int streamId, int channels, int bitDepth, int frequency) |
Called when a new WebAudio stream is created. This is usually when the page is loading (for <audio> HTML tags). More... | |
override void | OnAudioStreamPlay (int streamId) |
Called when a WebAudio stream is played. More... | |
override void | OnAudioStreamPause (int streamId) |
Called when a WebAudio stream is stopped. More... | |
override void | OnAudioStreamClose (int streamId) |
Called when a WebAudio stream is closed. This is usually called when the page is unloading. More... | |
Events | |
CoherentUI_OnViewCreated | ViewCreated |
Fired when the requested More... | |
CoherentUI_OnDraw | Draw |
Fired when a new surface has been drawn and is ready to use by the client. More... | |
CoherentUI_OnFinishLoad | FinishLoad |
Fired when a frame has been successfully loaded. More... | |
CoherentUI_OnFailLoad | FailLoad |
Fired when a frame has been failed loading. More... | |
CoherentUI_OnURLRequest | URLRequest |
Fired before an URL request is made. The default implementation allows all requests. More... | |
CoherentUI_OnReadyForBindings | ReadyForBindings |
Fired when a frame is ready for bindings. More... | |
CoherentUI_OnBindingsReleased | BindingsReleased |
Fired when the bindings for frame are released. More... | |
CoherentUI_OnStartLoading | StartLoading |
Fired when a new path has started loading. More... | |
CoherentUI_OnStopLoading | StopLoading |
Fired when all load operations have completed. More... | |
CoherentUI_OnNavigateTo | NavigateTo |
Fired when the view starts navigation to a new path. More... | |
CoherentUI_OnError | Error |
Fired when an error occurs for this specific More... | |
CoherentUI_OnScriptMessage | ScriptMessage |
Fired when a message is sent from a script running in this specific More... | |
CoherentUI_OnCursorChanged | CursorChanged |
Fired when the cursor has changed internally in the More... | |
CoherentUI_OnCallback | Callback |
Fired by the UI when there is no registered handler for this event. More... | |
CoherentUI_OnJavaScriptMessage | JavaScriptMessage |
Fired when the view triggered a javascript message box, i.e. an alert, confirmation dialog or a prompt dialog. More... | |
CoherentUI_OnGetAuthCredentials | GetAuthCredentials |
Fired when a view requires authentication credentials. More... | |
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... | |
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... | |
CoherentUI_OnTextInputTypeChanged | TextInputTypeChanged |
Fired when the current text input control changes (i.e. the user click an edit-box). Use this methof to decide when to allow for IME input. the method will be called ONLY if IME is activated on this View. View::IMEActivate More... | |
CoherentUI_OnCaretRectChanged | CaretRectChanged |
Fired when the caret changes during IME composition. You can use this method to correctly position a custom IME control & candidate list. More... | |
CoherentUI_OnIMEShouldCancelComposition | IMEShouldCancelComposition |
Fired when the user must cancel the IME composition due to an event in the More... | |
CoherentUI_OnFileSelectRequest | FileSelectRequest |
Fired when the view requests file selection. It could be either single file, directory or multiple files. More... | |
CoherentUI_OnAudioStreamCreated | AudioStreamCreated |
Fired when a new WebAudio stream is created. This is usually when the page is loading (for <audio> HTML tags). More... | |
CoherentUI_OnAudioStreamPlay | AudioStreamPlay |
Fired when a WebAudio stream is played. More... | |
CoherentUI_OnAudioStreamPause | AudioStreamPause |
Fired when a WebAudio stream is stopped. More... | |
CoherentUI_OnAudioStreamClose | AudioStreamClose |
Fired when a WebAudio stream is closed. This is usually called when the page is unloading. More... | |
Additional Inherited Members | |
Public Types inherited from Coherent.UI.ViewListenerBase | |
enum | MessageLevel |
Levels of script messages. More... | |
Interface that allows clients to listen to Coherent::UI::ViewListener
|
inlinevirtual |
Called when the The format for DirectX9 must be D3DFMT_A8R8G8B8 The format for DirectX10 and DirectX11 must be B8G8R8A8_UNORM
sharedMemory | true if the surface should be created in shared memory (4 * width * height bytes); false if a shared texture must be created. |
width | the width of the surface in pixels |
height | the height of the surface in pixels |
response |
|
Reimplemented from Coherent.UI.ViewListenerBase.
|
inlinevirtual |
Called when a surface is unneeded anymore and should be destroyed This function can be called from a thread different than the main UI context thread in order to support client applications with multi-threaded rendering.
surface | handle to the surface |
usesSharedMemory | determines whether the surface parameter is a handle to shared memory or shared texture |
Reimplemented from Coherent.UI.ViewListenerBase.
|
inlinevirtual |
Called when a WebAudio stream is closed. This is usually called when the page is unloading.
streamId | the ID of the stream that is closed |
Reimplemented from Coherent.UI.ViewListenerBase.
|
inlinevirtual |
Called when a new WebAudio stream is created. This is usually when the page is loading (for <audio> HTML tags).
streamId | the generated ID for the new stream |
channels | the number of channels in the stream |
bitDepth | bits per sample in the stream |
frequency | the audio stream frequency, in Hz |
Reimplemented from Coherent.UI.ViewListenerBase.
|
inlinevirtual |
Called when a WebAudio stream is stopped.
streamId | the ID of the stream that is stopped |
Reimplemented from Coherent.UI.ViewListenerBase.
|
inlinevirtual |
Called when a WebAudio stream is played.
streamId | the ID of the stream that is played |
Reimplemented from Coherent.UI.ViewListenerBase.
|
inlinevirtual |
Called when the bindings for frame are released.
frameId | the id of the frame |
path | the path in the frame |
isMainFrame | true if this is the main frame of the view |
Reimplemented from Coherent.UI.ViewListenerBase.
|
inlinevirtual |
Called by the UI when there is no registered handler for this event.
eventName | name of the event |
arguments | arguments of the event invocation |
Reimplemented from Coherent.UI.ViewListenerBase.
|
inlinevirtual |
Called when the view wants to open a new window.
openerUrl | the URL that wants to open the new window |
targetUrl | the target URL of the new window |
childViewInfo | structure that the user should fill in if she's about to allow new view creation |
Reimplemented from Coherent.UI.ViewListenerBase.
|
inlinevirtual |
Called when the caret changes during IME composition. You can use this method to correctly position a custom IME control & candidate list.
the | x position of the selection caret |
the | y position of the selection caret |
the | width of the selection caret |
the | height of the selection caret |
Reimplemented from Coherent.UI.ViewListenerBase.
|
inlinevirtual |
Called 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
url | the url of the request |
status | the error status of the certificate |
certificate | the certificate details. This pointer will be valid only for this call |
response | object to signal whether to continue loading the URL. This pointer will be valid only for this call |
Reimplemented from Coherent.UI.ViewListenerBase.
|
inlinevirtual |
Called when the cursor has changed internally in the
cursor | the new cursor |
Reimplemented from Coherent.UI.ViewListenerBase.
|
inlinevirtual |
Called when a new surface has been drawn and is ready to use by the client.
handle | a handle to one of the buffers created by CreateSurface. May be a shared memory buffer or a shared texture depending on the way the View was created. The handle is valid only during this call |
usesSharedMemory | determines whether the handle parameter is a handle to shared memory or shared texture |
width | the width of the surface |
height | the height of the surface |
Reimplemented from Coherent.UI.ViewListenerBase.
|
inlinevirtual |
Called when an error occurs for this specific
error | error description |
Reimplemented from Coherent.UI.ViewListenerBase.
|
inlinevirtual |
Called when a frame has been failed loading.
frameId | the id of the frame |
validatedPath | the path in the frame |
isMainFrame | true if this is the main frame of the View |
error | error message for the failure |
Reimplemented from Coherent.UI.ViewListenerBase.
|
inlinevirtual |
Called when the view requests file selection. It could be either single file, directory or multiple files.
request | contains the file selection params for the request |
Reimplemented from Coherent.UI.ViewListenerBase.
|
inlinevirtual |
Called when a frame has been successfully loaded.
frameId | the id of the loaded frame |
validatedPath | the path loaded in the frame |
isMainFrame | true if this is the main frame of the View |
statusCode | the status code of the response |
headers | an array of header fields |
headersCount | the count of items in the headers array |
Reimplemented from Coherent.UI.ViewListenerBase.
|
inlinevirtual |
Called when a view requires authentication credentials.
isProxy | whether the request came from a server or a proxy |
host | the host which triggered the request |
port | the port at which the request was triggered |
realm | realm of the authentication challenge. Encoded in UTF-8 |
scheme | the authentication scheme used, e.g. "basic" or "digest". Encoded in ASCII |
Reimplemented from Coherent.UI.ViewListenerBase.
|
inlinevirtual |
Called when the user must cancel the IME composition due to an event in the
Reimplemented from Coherent.UI.ViewListenerBase.
|
inlinevirtual |
Called when the view triggered a javascript message box, i.e. an alert, confirmation dialog or a prompt dialog.
message | the JavaScript message |
defaultPrompt | the default value of the prompt text box, in case the message type is prompt |
frameUrl | the URL which created the message |
messageType | the type of the message (alert/confirm/prompt) |
Reimplemented from Coherent.UI.ViewListenerBase.
|
inlinevirtual |
Called when the view starts navigation to a new path.
path | URL that the view is navigating to |
Reimplemented from Coherent.UI.ViewListenerBase.
|
inlinevirtual |
Called when a frame is ready for bindings.
frameId | the id of the frame |
path | the path in the frame |
isMainFrame | true if this is the main frame of the view |
Reimplemented from Coherent.UI.ViewListenerBase.
|
inlinevirtual |
Called when the view requests access to a media stream. Media streams are the audio capture (microphone) and video capture (camera) devices on the system.
request | contains the available media streams for the request |
Reimplemented from Coherent.UI.ViewListenerBase.
|
inlinevirtual |
Called when a message is sent from a script running in this specific
level | message level |
message | the text of the message |
sourceId | id of the script (usually file name) |
line | the number of the line in which the message was sent |
Reimplemented from Coherent.UI.ViewListenerBase.
|
inlinevirtual |
Called when a new path has started loading.
Reimplemented from Coherent.UI.ViewListenerBase.
|
inlinevirtual |
Called when all load operations have completed.
Reimplemented from Coherent.UI.ViewListenerBase.
|
inlinevirtual |
Called when the current text input control changes (i.e. the user click an edit-box). Use this methof to decide when to allow for IME input. the method will be called ONLY if IME is activated on this View. View::IMEActivate
type | the type of the currently focused text input control by the user |
canComposeInline | if the IME composition could be performed in-line in the control |
Reimplemented from Coherent.UI.ViewListenerBase.
|
inlinevirtual |
Called before an URL request is made. The default implementation allows all requests.
request | the URLRequest object that can be used to modify the request. This pointer will be valid only for this call |
Reimplemented from Coherent.UI.ViewListenerBase.
|
inlinevirtual |
Called when the requested
view | the instance of the view containing all manipulation methods |
Reimplemented from Coherent.UI.ViewListenerBase.
|
inlinevirtual |
Called when the listener is no longer needed by the UI context.
Reimplemented from Coherent.UI.ViewListenerBase.
CoherentUI_OnAudioStreamClose Coherent.UI.BrowserViewListener.AudioStreamClose |
Fired when a WebAudio stream is closed. This is usually called when the page is unloading.
CoherentUI_OnAudioStreamCreated Coherent.UI.BrowserViewListener.AudioStreamCreated |
Fired when a new WebAudio stream is created. This is usually when the page is loading (for <audio> HTML tags).
CoherentUI_OnAudioStreamPause Coherent.UI.BrowserViewListener.AudioStreamPause |
Fired when a WebAudio stream is stopped.
CoherentUI_OnAudioStreamPlay Coherent.UI.BrowserViewListener.AudioStreamPlay |
Fired when a WebAudio stream is played.
CoherentUI_OnBindingsReleased Coherent.UI.BrowserViewListener.BindingsReleased |
Fired when the bindings for frame are released.
CoherentUI_OnCallback Coherent.UI.BrowserViewListener.Callback |
Fired by the UI when there is no registered handler for this event.
CoherentUI_OnCaretRectChanged Coherent.UI.BrowserViewListener.CaretRectChanged |
Fired when the caret changes during IME composition. You can use this method to correctly position a custom IME control & candidate list.
CoherentUI_OnCertificateError Coherent.UI.BrowserViewListener.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
CoherentUI_OnCursorChanged Coherent.UI.BrowserViewListener.CursorChanged |
Fired when the cursor has changed internally in the
CoherentUI_OnDraw Coherent.UI.BrowserViewListener.Draw |
Fired when a new surface has been drawn and is ready to use by the client.
CoherentUI_OnError Coherent.UI.BrowserViewListener.Error |
Fired when an error occurs for this specific
CoherentUI_OnFailLoad Coherent.UI.BrowserViewListener.FailLoad |
Fired when a frame has been failed loading.
CoherentUI_OnFileSelectRequest Coherent.UI.BrowserViewListener.FileSelectRequest |
Fired when the view requests file selection. It could be either single file, directory or multiple files.
CoherentUI_OnFinishLoad Coherent.UI.BrowserViewListener.FinishLoad |
Fired when a frame has been successfully loaded.
CoherentUI_OnGetAuthCredentials Coherent.UI.BrowserViewListener.GetAuthCredentials |
Fired when a view requires authentication credentials.
CoherentUI_OnIMEShouldCancelComposition Coherent.UI.BrowserViewListener.IMEShouldCancelComposition |
Fired when the user must cancel the IME composition due to an event in the
CoherentUI_OnJavaScriptMessage Coherent.UI.BrowserViewListener.JavaScriptMessage |
Fired when the view triggered a javascript message box, i.e. an alert, confirmation dialog or a prompt dialog.
CoherentUI_OnNavigateTo Coherent.UI.BrowserViewListener.NavigateTo |
Fired when the view starts navigation to a new path.
CoherentUI_OnReadyForBindings Coherent.UI.BrowserViewListener.ReadyForBindings |
Fired when a frame is ready for bindings.
CoherentUI_OnRequestMediaStream Coherent.UI.BrowserViewListener.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.
CoherentUI_OnScriptMessage Coherent.UI.BrowserViewListener.ScriptMessage |
Fired when a message is sent from a script running in this specific
CoherentUI_OnStartLoading Coherent.UI.BrowserViewListener.StartLoading |
Fired when a new path has started loading.
CoherentUI_OnStopLoading Coherent.UI.BrowserViewListener.StopLoading |
Fired when all load operations have completed.
CoherentUI_OnTextInputTypeChanged Coherent.UI.BrowserViewListener.TextInputTypeChanged |
Fired when the current text input control changes (i.e. the user click an edit-box). Use this methof to decide when to allow for IME input. the method will be called ONLY if IME is activated on this View. View::IMEActivate
CoherentUI_OnURLRequest Coherent.UI.BrowserViewListener.URLRequest |
Fired before an URL request is made. The default implementation allows all requests.
CoherentUI_OnViewCreated Coherent.UI.BrowserViewListener.ViewCreated |
Fired when the requested