Awesomium::WebViewListener Class Reference

#include <WebViewListener.h>

List of all members.

Public Member Functions
virtual void	onBeginNavigation (Awesomium::WebView *caller, const std::string &url, const std::wstring &frameName)=0
virtual void	onBeginLoading (Awesomium::WebView *caller, const std::string &url, const std::wstring &frameName, int statusCode, const std::wstring &mimeType)=0
virtual void	onFinishLoading (Awesomium::WebView *caller)=0
virtual void	onCallback (Awesomium::WebView *caller, const std::wstring &objectName, const std::wstring &callbackName, const Awesomium::JSArguments &args)=0
virtual void	onReceiveTitle (Awesomium::WebView *caller, const std::wstring &title, const std::wstring &frameName)=0
virtual void	onChangeTooltip (Awesomium::WebView *caller, const std::wstring &tooltip)=0
virtual void	onChangeCursor (Awesomium::WebView *caller, const HCURSOR &cursor)=0
virtual void	onChangeKeyboardFocus (Awesomium::WebView *caller, bool isFocused)=0
virtual void	onChangeTargetURL (Awesomium::WebView *caller, const std::string &url)=0
virtual void	onOpenExternalLink (Awesomium::WebView *caller, const std::string &url, const std::wstring &source)=0

---

Detailed Description

WebViewListener is a virtual interface that you can use to receive notifications from a certain WebView. Simply make a class that inherits from WebViewListener and register it via WebView::setListener.

---

Member Function Documentation

virtual void Awesomium::WebViewListener::onBeginLoading	(	Awesomium::WebView *	caller,
		const std::string &	url,
		const std::wstring &	frameName,
		int	statusCode,
		const std::wstring &	mimeType
	)			[pure virtual]

This event is fired when a WebView begins to actually receive data from a server.

Parameters:

	caller	The WebView that fired the event.
	url	The URL of the frame that is being loaded.
	frameName	The name of the frame that this event originated from.
	statusCode	The HTTP status code returned by the server.
	mimeType	The mime-type of the content that is being loaded.

virtual void Awesomium::WebViewListener::onBeginNavigation	(	Awesomium::WebView *	caller,
		const std::string &	url,
		const std::wstring &	frameName
	)			[pure virtual]

This event is fired when a WebView begins navigating to a new URL.

Parameters:

	caller	The WebView that fired the event.
	url	The URL that is being navigated to.
	frameName	The name of the frame that this event originated from.

virtual void Awesomium::WebViewListener::onCallback	(	Awesomium::WebView *	caller,
		const std::wstring &	objectName,
		const std::wstring &	callbackName,
		const Awesomium::JSArguments &	args
	)			[pure virtual]

This event is fired when a Client callback has been invoked via Javascript from a page.

Parameters:

	caller	The WebView that fired the event.
	objectName	The name of the Javascript Object that contains the invoked callback.
	callbackName	The name of the callback that was invoked (must have been previously bound via WebView::setObjectCallback).
	args	The arguments passed to the callback.

virtual void Awesomium::WebViewListener::onChangeCursor	(	Awesomium::WebView *	caller,
		const HCURSOR &	cursor
	)			[pure virtual]

This event is fired when a cursor has changed state. [Windows-only]

Parameters:

	caller	The WebView that fired the event.
	cursor	The cursor handle/type.

virtual void Awesomium::WebViewListener::onChangeKeyboardFocus	(	Awesomium::WebView *	caller,
		bool	isFocused
	)			[pure virtual]

This event is fired when keyboard focus has changed.

Parameters:

	caller	The WebView that fired the event.
	isFocused	Whether or not the keyboard is currently focused.

virtual void Awesomium::WebViewListener::onChangeTargetURL	(	Awesomium::WebView *	caller,
		const std::string &	url
	)			[pure virtual]

This event is fired when the target URL has changed. This is usually the result of hovering over a link on the page.

Parameters:

	caller	The WebView that fired the event.
	url	The updated target URL (or empty if the target URL is cleared).

virtual void Awesomium::WebViewListener::onChangeTooltip	(	Awesomium::WebView *	caller,
		const std::wstring &	tooltip
	)			[pure virtual]

This event is fired when a tooltip has changed state.

Parameters:

	caller	The WebView that fired the event.
	tooltip	The tooltip text (or, is an empty string when the tooltip should disappear).

virtual void Awesomium::WebViewListener::onFinishLoading

(

Awesomium::WebView *

caller

)

[pure virtual]

This event is fired when all loads have finished for a WebView.

Parameters:

caller

The WebView that fired the event.

virtual void Awesomium::WebViewListener::onOpenExternalLink	(	Awesomium::WebView *	caller,
		const std::string &	url,
		const std::wstring &	source
	)			[pure virtual]

This event is fired when an external link is attempted to be opened. An external link is any link that normally opens in a new window in a standard browser (for example, links with target="_blank", calls to window.open(url), and URL open events from Flash plugins). External links may or may not be automatically opened by a WebView (please see WebView::setOpensExternalLinksInCallingFrame).

Parameters:

	caller	The WebView that fired the event.
	url	The URL of the external link.
	source	If the external link originated from a call to window.open(), this value is "window.open". Else, if the link originated from a Flash plugin, this value is "flash". Otherwise, this value is the name of the frame that contains the link.

virtual void Awesomium::WebViewListener::onReceiveTitle	(	Awesomium::WebView *	caller,
		const std::wstring &	title,
		const std::wstring &	frameName
	)			[pure virtual]

This event is fired when a page title is received.

Parameters:

	caller	The WebView that fired the event.
	title	The page title.
	frameName	The name of the frame that this event originated from.

---

The documentation for this class was generated from the following file:

• include/WebViewListener.h