The QWebSettings class provides an object to store the settings used by QWebPage and QWebFrame. More...

Inheritance diagram for QtWebKit.QWebSettings:

Collaboration diagram for QtWebKit.QWebSettings:

Public Types
enum	FontFamily { CursiveFont = 4, FantasyFont = 5, FixedFont = 1, SansSerifFont = 3, SerifFont = 2, StandardFont = 0 }
	More...

enum	FontSize { DefaultFixedFontSize = 3, DefaultFontSize = 2, MinimumFontSize = 0, MinimumLogicalFontSize = 1 }
	More...

enum	WebAttribute { AcceleratedCompositingEnabled = 17, AutoLoadImages = 0, DeveloperExtrasEnabled = 7, DnsPrefetchEnabled = 15, FrameFlatteningEnabled = 21, HyperlinkAuditingEnabled = 25, JavaEnabled = 2, JavascriptCanAccessClipboard = 6, JavascriptCanCloseWindows = 23, JavascriptCanOpenWindows = 5, JavascriptEnabled = 1, LinksIncludedInFocusChain = 8, LocalContentCanAccessFileUrls = 19, LocalContentCanAccessRemoteUrls = 14, LocalStorageDatabaseEnabled = 13, LocalStorageEnabled = 13, OfflineStorageDatabaseEnabled = 11, OfflineWebApplicationCacheEnabled = 12, PluginsEnabled = 3, PrintElementBackgrounds = 10, PrivateBrowsingEnabled = 4, SiteSpecificQuirksEnabled = 22, SpatialNavigationEnabled = 18, TiledBackingStoreEnabled = 20, WebGLEnabled = 24, XSSAuditingEnabled = 16, ZoomTextOnly = 9 }
	More...

enum	WebGraphic { DefaultFrameIconGraphic = 2, DeleteButtonGraphic = 4, InputSpeechButtonGraphic = 5, MissingImageGraphic = 0, MissingPluginGraphic = 1, SearchCancelButtonGraphic = 6, SearchCancelButtonPressedGraphic = 7, TextAreaSizeGripCornerGraphic = 3 }
	More...

Public Member Functions
virtual void	CreateProxy ()

new string	fontFamily (QWebSettings.FontFamily which)


new int	fontSize (QWebSettings.FontSize type)


new void	ResetAttribute (QWebSettings.WebAttribute attr)


new void	ResetFontFamily (QWebSettings.FontFamily which)


new void	ResetFontSize (QWebSettings.FontSize type)


new void	SetAttribute (QWebSettings.WebAttribute attr, bool on)


new void	SetFontFamily (QWebSettings.FontFamily which, string family)


new void	SetFontSize (QWebSettings.FontSize type, int size)


new bool	TestAttribute (QWebSettings.WebAttribute attr)

Static Public Member Functions
static void	ClearIconDatabase ()


static void	ClearMemoryCaches ()


static void	EnablePersistentStorage (string path="")


static QWebSettings	GlobalSettings ()


static QIcon	IconForUrl (QUrl url)


static void	SetObjectCacheCapacities (int cacheMinDeadCapacity, int cacheMaxDead, int totalCapacity)


static void	SetWebGraphic (QWebSettings.WebGraphic type, QPixmap graphic)


static QPixmap	webGraphic (QWebSettings.WebGraphic type)

Protected Member Functions
	QWebSettings (System.Type dummy)

Protected Attributes
SmokeInvocation	interceptor

Properties
new string	DefaultTextEncoding `[get, set]`


static string	IconDatabasePath `[get, set]`


new string	LocalStoragePath `[get, set]`


static int	MaximumPagesInCache `[get, set]`


static long	OfflineStorageDefaultQuota `[get, set]`


static string	OfflineStoragePath `[get, set]`


static string	OfflineWebApplicationCachePath `[get, set]`


static long	OfflineWebApplicationCacheQuota `[get, set]`


new QUrl	UserStyleSheetUrl `[get, set]`


virtual System.IntPtr	SmokeObject `[get, set]`

Detailed Description

The QWebSettings class provides an object to store the settings used by QWebPage and QWebFrame.

Each QWebPage object has its own QWebSettings object, which configures the settings for that page. If a setting is not configured, then it is looked up in the global settings object, which can be accessed using globalSettings().

QWebSettings allows configuration of browser properties, such as font sizes and families, the location of a custom style sheet, and generic attributes like JavaScript and plugins. Individual attributes are set using the setAttribute() function. The WebAttribute enum further describes each attribute.

QWebSettings also configures global properties such as the web page memory cache, icon database, local database storage and offline applications storage.

Enabling Plugins

Support for browser plugins can enabled by setting the PluginsEnabled attribute. For many applications, this attribute is enabled for all pages by setting it on the global settings object. QtWebKit will always ignore this setting when processing Qt plugins. The decision to allow a Qt plugin is made by the client in its reimplementation of QWebPage::createPlugin().

Web Application Support

WebKit provides support for features specified in HTML 5 that improve the performance and capabilities of Web applications. These include client-side (offline) storage and the use of a Web application cache.

Client-side (offline) storage is an improvement over the use of cookies to store persistent data in Web applications. Applications can configure and enable the use of an offline storage database by calling the setOfflineStoragePath() with an appropriate file path, and can limit the quota for each application by calling setOfflineStorageDefaultQuota().

See also QWebPage::settings(), QWebView::settings(), and Web Browser.

Member Enumeration Documentation

enum QtWebKit.QWebSettings.FontFamily

This enum describes the generic font families defined by CSS 2. For more information see the CSS standard.

Enumerator:

CursiveFont
FantasyFont
FixedFont
SansSerifFont
SerifFont
StandardFont

enum QtWebKit.QWebSettings.FontSize

This enum describes the font sizes configurable through QWebSettings.

Enumerator:

DefaultFixedFontSize	The default font size for fixed-pitch text.
DefaultFontSize	The default font size for regular text.
MinimumFontSize	The hard minimum font size.
MinimumLogicalFontSize	The minimum logical font size that is applied when zooming out with QWebFrame::setTextSizeMultiplier().

enum QtWebKit.QWebSettings.WebAttribute

This enum describes various attributes that are configurable through QWebSettings.

Enumerator:

AcceleratedCompositingEnabled	This feature, when used in conjunction with QGraphicsWebView, accelerates animations of web content. CSS animations of the transform and opacity properties will be rendered by composing the cached content of the animated elements. This is enabled by default.
AutoLoadImages	Specifies whether images are automatically loaded in web pages. This is enabled by default.
DeveloperExtrasEnabled	Enables extra tools for Web developers. Currently this enables the "Inspect" element in the context menu as well as the use of QWebInspector which controls the web inspector for web site debugging. This is disabled by default.
DnsPrefetchEnabled	Specifies whether QtWebkit will try to pre-fetch DNS entries to speed up browsing. This only works as a global attribute. Only for Qt 4.6 and later. This is disabled by default.
FrameFlatteningEnabled	With this setting each subframe is expanded to its contents. On touch devices, it is desired to not have any scrollable sub parts of the page as it results in a confusing user experience, with scrolling sometimes scrolling sub parts and at other times scrolling the page itself. For this reason iframes and framesets are barely usable on touch devices. This will flatten all the frames to become one scrollable page. This is disabled by default.
HyperlinkAuditingEnabled
JavaEnabled	Enables or disables Java applets. Currently Java applets are not supported.
JavascriptCanAccessClipboard	Specifies whether JavaScript programs can read or write to the clipboard. This is disabled by default.
JavascriptCanCloseWindows	Specifies whether JavaScript programs can close windows. This is disabled by default.
JavascriptCanOpenWindows	Specifies whether JavaScript programs can open new windows. This is disabled by default.
JavascriptEnabled	Enables or disables the running of JavaScript programs. This is enabled by default
LinksIncludedInFocusChain	Specifies whether hyperlinks should be included in the keyboard focus chain. This is enabled by default.
LocalContentCanAccessFileUrls	Specifies whether locally loaded documents are allowed to access other local urls. This is enabled by default. For more information about security origins and local vs. remote content see QWebSecurityOrigin.
LocalContentCanAccessRemoteUrls	Specifies whether locally loaded documents are allowed to access remote urls. This is disabled by default. For more information about security origins and local vs. remote content see QWebSecurityOrigin. (This value was introduced in 4.6.)
LocalStorageDatabaseEnabled	This enum value is deprecated. Use QWebSettings::LocalStorageEnabled instead.
LocalStorageEnabled	Specifies whether support for the HTML 5 local storage feature is enabled or not. This is disabled by default. (This value was introduced in 4.6.)
OfflineStorageDatabaseEnabled	Specifies whether support for the HTML 5 offline storage feature is enabled or not. This is disabled by default.
OfflineWebApplicationCacheEnabled	Specifies whether support for the HTML 5 web application cache feature is enabled or not. This is disabled by default.
PluginsEnabled	Enables or disables plugins in Web pages (e.g. using NPAPI). Qt plugins with a mimetype such as "application/x-qt-plugin" are not affected by this setting. This is disabled by default.
PrintElementBackgrounds	Specifies whether the background color and images are also drawn when the page is printed. This is enabled by default.
PrivateBrowsingEnabled	Private browsing prevents WebKit from recording visited pages in the history and storing web page icons. This is disabled by default.
SiteSpecificQuirksEnabled	This setting enables WebKit's workaround for broken sites. It is enabled by default.
SpatialNavigationEnabled	Enables or disables the Spatial Navigation feature, which consists in the ability to navigate between focusable elements in a Web page, such as hyperlinks and form controls, by using Left, Right, Up and Down arrow keys. For example, if a user presses the Right key, heuristics determine whether there is an element he might be trying to reach towards the right and which element he probably wants. This is disabled by default.
TiledBackingStoreEnabled	This setting enables the tiled backing store feature for a QGraphicsWebView. With the tiled backing store enabled, the web page contents in and around the current visible area is speculatively cached to bitmap tiles. The tiles are automatically kept in sync with the web page as it changes. Enabling tiling can significantly speed up painting heavy operations like scrolling. Enabling the feature increases memory consumption. It does not work well with contents using CSS fixed positioning (see also resizesToContents property). tiledBackingStoreFrozen property allows application to temporarily freeze the contents of the backing store. This is disabled by default.
WebGLEnabled
XSSAuditingEnabled	Specifies whether load requests should be monitored for cross-site scripting attempts. Suspicious scripts will be blocked and reported in the inspector's JavaScript console. Enabling this feature might have an impact on performance and it is disabled by default.
ZoomTextOnly	Specifies whether the zoom factor on a frame applies only to the text or to all content. This is disabled by default.

enum QtWebKit.QWebSettings.WebGraphic

This enums describes the standard graphical elements used in webpages.

Enumerator:

DefaultFrameIconGraphic	The default icon for QWebFrame::icon().
DeleteButtonGraphic	The graphic shown for the WebKit-Editing-Delete-Button in Deletion UI.
InputSpeechButtonGraphic	The graphic shown in input fields that support speech recognition.
MissingImageGraphic	The replacement graphic shown when an image could not be loaded.
MissingPluginGraphic	The replacement graphic shown when a plugin could not be loaded.
SearchCancelButtonGraphic	The graphic shown for clearing the text in a search field.
SearchCancelButtonPressedGraphic	The graphic shown when SearchCancelButtonGraphic is pressed.
TextAreaSizeGripCornerGraphic	The graphic shown for the size grip of text areas.

Constructor & Destructor Documentation

QtWebKit.QWebSettings.QWebSettings ( System.Type dummy )

protected

Member Function Documentation

static void QtWebKit.QWebSettings.ClearIconDatabase ( )

static

Clears the icon database.

static void QtWebKit.QWebSettings.ClearMemoryCaches ( )

static

Frees up as much memory as possible by cleaning all memory caches such as page, object and font cache.

This function was introduced in Qt 4.6.

virtual void QtWebKit.QWebSettings.CreateProxy ( )

virtual

static void QtWebKit.QWebSettings.EnablePersistentStorage ( string path = "" )

static

Enables WebKit data persistence and sets the path to path. If path is empty, the user-specific data location specified by DataLocation will be used instead.

This method will simultaneously set and enable the iconDatabasePath(), localStoragePath(), offlineStoragePath() and offlineWebApplicationCachePath().

This function was introduced in Qt 4.6.

Member Data Documentation

SmokeInvocation QtWebKit.QWebSettings.interceptor

protected

Property Documentation

new string QtWebKit.QWebSettings.DefaultTextEncoding

getset

Returns the default text encoding.

This function was introduced in Qt 4.6.

Specifies the default text encoding system.

The encoding, must be a string describing an encoding such as "utf-8", "iso-8859-1", etc. If left empty a default value will be used. For a more extensive list of encoding names see QTextCodec

This function was introduced in Qt 4.6.

string QtWebKit.QWebSettings.IconDatabasePath

staticgetset

Returns the path of the icon database or an empty string if the icon database is disabled.

Sets the path of the icon database to path. The icon database is used to store "favicons" associated with web sites.

path must point to an existing directory.

Setting an empty path disables the icon database.

new string QtWebKit.QWebSettings.LocalStoragePath

getset

Returns the path for HTML5 local storage.

This function was introduced in Qt 4.6.

Sets the path for HTML5 local storage to path.

For more information on HTML5 local storage see the Web Storage standard.

Support for local storage can enabled by setting the LocalStorageEnabled attribute.

This function was introduced in Qt 4.6.

int QtWebKit.QWebSettings.MaximumPagesInCache

staticgetset

Returns the maximum number of web pages that are kept in the memory cache.

Sets the maximum number of pages to hold in the memory page cache to pages.

The Page Cache allows for a nicer user experience when navigating forth or back to pages in the forward/back history, by pausing and resuming up to pages.

For more information about the feature, please refer to:

http://webkit.org/blog/427/webkit-page-cache-i-the-basics/

long QtWebKit.QWebSettings.OfflineStorageDefaultQuota

staticgetset

Returns the value of the default quota for new offline storage databases.

This function was introduced in Qt 4.5.

Sets the value of the default quota for new offline storage databases to maximumSize.

This function was introduced in Qt 4.5.

string QtWebKit.QWebSettings.OfflineStoragePath

staticgetset

Returns the path of the HTML5 client-side database storage or an empty string if the feature is disabled.

This function was introduced in Qt 4.5.

Sets path as the save location for HTML5 client-side database storage data.

path must point to an existing directory.

Setting an empty path disables the feature.

Support for client-side databases can enabled by setting the OfflineStorageDatabaseEnabled attribute.

This function was introduced in Qt 4.5.

string QtWebKit.QWebSettings.OfflineWebApplicationCachePath

staticgetset

Returns the path of the HTML5 offline web application cache storage or an empty string if the feature is disabled.

This function was introduced in Qt 4.6.

Sets the path for HTML5 offline web application cache storage to path.

An application cache acts like an HTTP cache in some sense. For documents that use the application cache via JavaScript, the loader engine will first ask the application cache for the contents, before hitting the network.

The feature is described in details at: http://dev.w3.org/html5/spec/Overview.html#appcache

path must point to an existing directory.

Setting an empty path disables the feature.

Support for offline web application cache storage can enabled by setting the OfflineWebApplicationCacheEnabled attribute.

This function was introduced in Qt 4.6.

long QtWebKit.QWebSettings.OfflineWebApplicationCacheQuota

staticgetset

Returns the value of the quota for the offline web application cache.

This function was introduced in Qt 4.6.

Sets the value of the quota for the offline web application cache to maximumSize.

This function was introduced in Qt 4.6.

virtual System.IntPtr QtWebKit.QWebSettings.SmokeObject

getset

new QUrl QtWebKit.QWebSettings.UserStyleSheetUrl

getset

Returns the location of the user stylesheet.

Specifies the location of a user stylesheet to load with every web page.

The location must be either a path on the local filesystem, or a data URL with UTF-8 and Base64 encoded data, such as:

"data:text/css;charset=utf-8;base64,cCB7IGJhY2tncm91bmQtY29sb3I6IHJlZCB9Ow=="

Note: If the base64 data is not valid, the style will not be applied.

new void QtWebKit.QWebSettings.SetFontFamily	(	QWebSettings.FontFamily	which,
		string	family
	)

new void QtWebKit.QWebSettings.SetFontSize	(	QWebSettings.FontSize	type,
		int	size
	)

new void QtWebKit.QWebSettings.SetAttribute	(	QWebSettings.WebAttribute	attr,
		bool	on
	)

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Properties

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation