Interface that allows to listen for various events in the View. More...

Public Member Functions
virtual bool	OnNavigateTo (const char *url)=0
	Called when a navigation is about to occur. The user is able to interrupt the navigation or let it continue normally. More...

virtual void	OnScriptContextCreated ()=0
	Called immediately after the script context has been created for the page. This happens before starting to build the DOM. Execute any scripts that will influence DOM creation here.

virtual void	OnDOMBuilt ()=0
	Called when the page's DOM is fully constructed, but the referenced resources may not finish loading.

virtual void	OnLoadFailed (const char url, const char error)=0
	Called when a navigaton change request failed. More...

virtual void	OnFinishLoad (const char *url)=0
	Called when a page, including the resources it refers to, is completely loaded and initialized. More...

virtual void	OnReadyForBindings ()=0
	Called when the view is ready to accept JavaScript bindings.

virtual void	OnBindingsReleased ()=0
	Called when the JavaScript bindings are released Use this call to release any resources hold by the JavaScript bindings for the view.

virtual ScreenInfo	OnScreenInfoRequested ()=0
	Called when javascript requested screen metrics Returns current screen metrics.

virtual EventAction::Actions	OnNodeTouched (const INodeProxy node, const TouchEventData event, void *userData, const InputEventPhase::PhaseType phase)=0
	Called before an event is passed to a DOM node for evaluation. The user is able to interrupt the handling and bubbling of events or let them continue normally. Phase is the current PhaseType of the event.

virtual EventAction::Actions	OnNodeMouseEvent (const INodeProxy node, const MouseEventData event, void *userData, const InputEventPhase::PhaseType phase)=0
	Called before an event is passed to a DOM node for evaluation. The user is able to interrupt the handling and bubbling of events or let them continue normally. Phase is the current PhaseType of the event.

virtual EventAction::Actions	OnNodeKeyEvent (const INodeProxy node, const KeyEventData event, void *userData, const InputEventPhase::PhaseType phase)=0
	Called before an event is passed to a DOM node for evaluation. The user is able to interrupt the handling and bubbling of events or let them continue normally. Phase is the current PhaseType of the event.

virtual void	OnAudioStreamCreated (int id, int bitDepth, int channels, float samplingRate)
	Called by the UI when a media element initializes an audio stream. More...

virtual void	OnAudioStreamClosed (int id)
	Called when an audio stream is destroyed. More...

virtual void	OnAudioStreamPlay (int id)
	Called by the UI when a media element starts playing an audio stream. More...

virtual void	OnAudioStreamPause (int id)
	Called by the UI when a playing media element pauses. More...

virtual void	OnAudioDataReceived (int id, int samples, float **pcm, int channels)
	Called by the UI when there is decoded PCM data available for playing. More...

virtual void	OnAudioStreamEnded (int id)
	Called when an audio stream ends and will no longer receive data. More...

virtual void	OnAudioStreamVolumeChanged (int id, float volume)
	Called when an audio stream volume has changed. More...

virtual void	OnTextInputTypeChanged (TextInputControlType::ControlType type)=0
	Called when the current text input control changes (i.e. the user click an edit-box). Use this method to decide when to allow for IME input. More...

virtual void	OnCaretRectChanged (int x, int y, unsigned width, unsigned height)=0
	Called when the caret changes during IME composition. You can use this method to correctly position a custom IME control & candidate list. More...

virtual void	OnIMEShouldCancelComposition ()=0
	Called when the user must cancel the IME composition due to an event in the View itself (i.e. the user has focused a non-editable element while a composition was on-going)

Detailed Description

Interface that allows to listen for various events in the View.

Member Function Documentation

◆ OnAudioDataReceived()

virtual void cohtml::IViewListener::OnAudioDataReceived	(	int	id,
		int	samples,
		float **	pcm,
		int	channels
	)

inlinevirtual

Called by the UI when there is decoded PCM data available for playing.

Parameters

id	the unique ID of the stream
samples	the number of available samples
pcm	the decoded PCM data. Represented as a 2D array with \|channels\| x \|samples\| floating point elements in the range [-1, 1].
channels	the number of channels

◆ OnAudioStreamClosed()

virtual void cohtml::IViewListener::OnAudioStreamClosed ( int id )

inlinevirtual

Called when an audio stream is destroyed.

Parameters

id	the unique id of audio stream that was closed

◆ OnAudioStreamCreated()

virtual void cohtml::IViewListener::OnAudioStreamCreated	(	int	id,
		int	bitDepth,
		int	channels,
		float	samplingRate
	)

inlinevirtual

Called by the UI when a media element initializes an audio stream.

Parameters

id	the unique ID of the stream
bitDepth	the number of bits per audio sample
channels	the number of channels in the stream
samplingRate	the sampling rate of the stream in Hz

◆ OnAudioStreamEnded()

virtual void cohtml::IViewListener::OnAudioStreamEnded ( int id )

inlinevirtual

Called when an audio stream ends and will no longer receive data.

Parameters

id	the unique ID of the stream

◆ OnAudioStreamPause()

virtual void cohtml::IViewListener::OnAudioStreamPause ( int id )

inlinevirtual

Called by the UI when a playing media element pauses.

Parameters

id	the unique ID of the stream

◆ OnAudioStreamPlay()

virtual void cohtml::IViewListener::OnAudioStreamPlay ( int id )

inlinevirtual

Called by the UI when a media element starts playing an audio stream.

Parameters

id	the unique ID of the stream

◆ OnAudioStreamVolumeChanged()

virtual void cohtml::IViewListener::OnAudioStreamVolumeChanged	(	int	id,
		float	volume
	)

inlinevirtual

Called when an audio stream volume has changed.

Parameters

id	the unique ID of the stream
volume	the new value of the volume

◆ OnCaretRectChanged()

virtual void cohtml::IViewListener::OnCaretRectChanged	(	int	x,
		int	y,
		unsigned	width,
		unsigned	height
	)

pure virtual

Called when the caret changes during IME composition. You can use this method to correctly position a custom IME control & candidate list.

Parameters

x	the x position of the selection caret
y	the y position of the selection caret
width	the width of the selection caret
height	the height of the selection caret

◆ OnFinishLoad()

virtual void cohtml::IViewListener::OnFinishLoad ( const char * url )

pure virtual

Called when a page, including the resources it refers to, is completely loaded and initialized.

Parameters

url	The URL which loaded successfully

◆ OnLoadFailed()

virtual void cohtml::IViewListener::OnLoadFailed	(	const char *	url,
		const char *	error
	)

pure virtual

Called when a navigaton change request failed.

Parameters

url	The URL which failed to load
error	The error message

◆ OnNavigateTo()

virtual bool cohtml::IViewListener::OnNavigateTo ( const char * url )

pure virtual

Called when a navigation is about to occur. The user is able to interrupt the navigation or let it continue normally.

Parameters

url	The URL which the view will load

◆ OnTextInputTypeChanged()

virtual void cohtml::IViewListener::OnTextInputTypeChanged ( TextInputControlType::ControlType type )

pure virtual

Called when the current text input control changes (i.e. the user click an edit-box). Use this method to decide when to allow for IME input.

Parameters

type	the type of the currently focused text input control by the user

Public Member Functions

Detailed Description

Member Function Documentation

◆ OnAudioDataReceived()

◆ OnAudioStreamClosed()

◆ OnAudioStreamCreated()

◆ OnAudioStreamEnded()

◆ OnAudioStreamPause()

◆ OnAudioStreamPlay()

◆ OnAudioStreamVolumeChanged()

◆ OnCaretRectChanged()

◆ OnFinishLoad()

◆ OnLoadFailed()

◆ OnNavigateTo()

◆ OnTextInputTypeChanged()