ewk_settings.h File Reference

Describes the settings API. More...

#include <Eina.h>

Go to the source code of this file.

Typedefs
typedef struct EwkSettings	Ewk_Settings

Functions
EAPI Eina_Bool	ewk_settings_fullscreen_enabled_set (Ewk_Settings *settings, Eina_Bool enable)
EAPI Eina_Bool	ewk_settings_fullscreen_enabled_get (const Ewk_Settings *settings)
EAPI Eina_Bool	ewk_settings_javascript_enabled_set (Ewk_Settings *settings, Eina_Bool enable)
EAPI Eina_Bool	ewk_settings_javascript_enabled_get (const Ewk_Settings *settings)
EAPI Eina_Bool	ewk_settings_loads_images_automatically_set (Ewk_Settings *settings, Eina_Bool automatic)
EAPI Eina_Bool	ewk_settings_loads_images_automatically_get (const Ewk_Settings *settings)
EAPI Eina_Bool	ewk_settings_developer_extras_enabled_set (Ewk_Settings *settings, Eina_Bool enable)
EAPI Eina_Bool	ewk_settings_developer_extras_enabled_get (const Ewk_Settings *settings)
EAPI Eina_Bool	ewk_settings_file_access_from_file_urls_allowed_set (Ewk_Settings *settings, Eina_Bool enable)
EAPI Eina_Bool	ewk_settings_file_access_from_file_urls_allowed_get (const Ewk_Settings *settings)
EAPI Eina_Bool	ewk_settings_frame_flattening_enabled_set (Ewk_Settings *settings, Eina_Bool enable)
EAPI Eina_Bool	ewk_settings_frame_flattening_enabled_get (const Ewk_Settings *settings)
EAPI Eina_Bool	ewk_settings_dns_prefetching_enabled_set (Ewk_Settings *settings, Eina_Bool enable)
EAPI Eina_Bool	ewk_settings_dns_prefetching_enabled_get (const Ewk_Settings *settings)
EAPI Eina_Bool	ewk_settings_encoding_detector_enabled_set (Ewk_Settings *settings, Eina_Bool enable)
EAPI Eina_Bool	ewk_settings_encoding_detector_enabled_get (const Ewk_Settings *settings)
EAPI Eina_Bool	ewk_settings_default_text_encoding_name_set (Ewk_Settings *settings, const char *encoding)
EAPI const char *	ewk_settings_default_text_encoding_name_get (const Ewk_Settings *settings)
EAPI Eina_Bool	ewk_settings_preferred_minimum_contents_width_set (Ewk_Settings *settings, unsigned width)
EAPI unsigned	ewk_settings_preferred_minimum_contents_width_get (const Ewk_Settings *settings)
EAPI Eina_Bool	ewk_settings_offline_web_application_cache_enabled_set (Ewk_Settings *settings, Eina_Bool enable)
EAPI Eina_Bool	ewk_settings_offline_web_application_cache_enabled_get (const Ewk_Settings *settings)
EAPI Eina_Bool	ewk_settings_scripts_can_open_windows_set (Ewk_Settings *settings, Eina_Bool enable)
EAPI Eina_Bool	ewk_settings_scripts_can_open_windows_get (const Ewk_Settings *settings)
EAPI Eina_Bool	ewk_settings_local_storage_enabled_set (Ewk_Settings *settings, Eina_Bool enable)
EAPI Eina_Bool	ewk_settings_local_storage_enabled_get (const Ewk_Settings *settings)
EAPI Eina_Bool	ewk_settings_plugins_enabled_set (Ewk_Settings *settings, Eina_Bool enable)
EAPI Eina_Bool	ewk_settings_plugins_enabled_get (const Ewk_Settings *settings)
EAPI Eina_Bool	ewk_settings_default_font_size_set (Ewk_Settings *settings, int size)
EAPI int	ewk_settings_default_font_size_get (const Ewk_Settings *settings)
EAPI Eina_Bool	ewk_settings_private_browsing_enabled_set (Ewk_Settings *settings, Eina_Bool enable)
EAPI Eina_Bool	ewk_settings_private_browsing_enabled_get (const Ewk_Settings *settings)
EAPI Eina_Bool	ewk_settings_text_autosizing_enabled_set (Ewk_Settings *settings, Eina_Bool enable)
EAPI Eina_Bool	ewk_settings_text_autosizing_enabled_get (const Ewk_Settings *settings)
EAPI Eina_Bool	ewk_settings_web_security_enabled_set (Ewk_Settings *settings, Eina_Bool enable)
EAPI Eina_Bool	ewk_settings_web_security_enabled_get (const Ewk_Settings *settings)
EAPI Eina_Bool	ewk_settings_spatial_navigation_enabled_set (Ewk_Settings *settings, Eina_Bool enable)
EAPI Eina_Bool	ewk_settings_spatial_navigation_enabled_get (const Ewk_Settings *settings)

Detailed Description

Describes the settings API.

Note

The ewk_settings is for setting the preference of specific ewk_view. We can get the ewk_settings from ewk_view using ewk_view_settings_get() API.

Typedef Documentation

typedef struct EwkSettings Ewk_Settings

Creates a type name for Ewk_Settings

Function Documentation

EAPI int ewk_settings_default_font_size_get

(

const Ewk_Settings *

settings)

Returns the default font size.

Parameters

settings

settings object to get the default font size

Returns

the default font size or 0 on failure

EAPI Eina_Bool ewk_settings_default_font_size_set	(	Ewk_Settings *	settings,
		int	size
	)

Sets the default font size.

By default, the default font size is 16.

Parameters

settings	settings object to set the default font size
size	a new default font size to set

Returns

EINA_TRUE on success or EINA_FALSE on failure

EAPI const char* ewk_settings_default_text_encoding_name_get

(

const Ewk_Settings *

settings)

Gets the default text encoding name.

The returned string is guaranteed to be stringshared.

Parameters

settings

settings object to query default text encoding name

Returns

default text encoding name

EAPI Eina_Bool ewk_settings_default_text_encoding_name_set	(	Ewk_Settings *	settings,
		const char *	encoding
	)

Sets the default text encoding name.

Parameters

settings	settings object to set default text encoding name
encoding	default text encoding name

Returns

EINA_TRUE on success or EINA_FALSE on failure

EAPI Eina_Bool ewk_settings_developer_extras_enabled_get

(

const Ewk_Settings *

settings)

Queries if developer extensions are enabled.

By default, the developer extensions are disabled.

Parameters

settings

settings object to set developer extensions

Returns

EINA_TRUE if developer extensions are enabled EINA_FALSE if not or on failure

EAPI Eina_Bool ewk_settings_developer_extras_enabled_set	(	Ewk_Settings *	settings,
		Eina_Bool	enable
	)

Enables/disables developer extensions.

By default, the developer extensions are disabled.

Parameters

settings	settings object to set developer extensions
enable	EINA_TRUE to enable developer extensions EINA_FALSE to disable

Returns

EINA_TRUE on success or EINA_FALSE on failure

EAPI Eina_Bool ewk_settings_dns_prefetching_enabled_get

(

const Ewk_Settings *

settings)

Returns whether DNS prefetching is enabled or not.

DNS prefetching is an attempt to resolve domain names before a user tries to follow a link.

Parameters

settings

settings object to get DNS prefetching

Returns

EINA_TRUE if DNS prefetching is enabled EINA_FALSE if not or on failure

EAPI Eina_Bool ewk_settings_dns_prefetching_enabled_set	(	Ewk_Settings *	settings,
		Eina_Bool	enable
	)

Enables/disables DNS prefetching.

By default, DNS prefetching is disabled.

Parameters

settings	settings object to set DNS prefetching
enable	EINA_TRUE to enable DNS prefetching or EINA_FALSE to disable

Returns

EINA_TRUE on success or EINA_FALSE on failure

See Also

ewk_settings_DNS_prefetching_enabled_get()

EAPI Eina_Bool ewk_settings_encoding_detector_enabled_get

(

const Ewk_Settings *

settings)

Returns whether the encoding detector is enabled or not.

Parameters

settings

settings object to query whether encoding detector is enabled

Returns

EINA_TRUE if the encoding detector is enabled EINA_FALSE if not or on failure

EAPI Eina_Bool ewk_settings_encoding_detector_enabled_set	(	Ewk_Settings *	settings,
		Eina_Bool	enable
	)

Enables/disables the encoding detector.

By default, the encoding detector is disabled.

Parameters

settings	settings object to set the encoding detector
enable	EINA_TRUE to enable the encoding detector, EINA_FALSE to disable

Returns

EINA_TRUE on success or EINA_FALSE on failure

EAPI Eina_Bool ewk_settings_file_access_from_file_urls_allowed_get

(

const Ewk_Settings *

settings)

Queries if file access from file:// URLs is allowed.

By default, file access from file:// URLs is not allowed.

Parameters

settings

settings object to query file access permission

Returns

EINA_TRUE if file access from file:// URLs is allowed EINA_FALSE if not or on failure

EAPI Eina_Bool ewk_settings_file_access_from_file_urls_allowed_set	(	Ewk_Settings *	settings,
		Eina_Bool	enable
	)

Allow / Disallow file access from file:// URLs.

By default, file access from file:// URLs is not allowed.

Parameters

settings	settings object to set file access permission
enable	EINA_TRUE to enable file access permission EINA_FALSE to disable

Returns

EINA_TRUE on success or EINA_FALSE on failure

EAPI Eina_Bool ewk_settings_frame_flattening_enabled_get

(

const Ewk_Settings *

settings)

Returns whether the frame flattening is enabled.

The frame flattening is a feature which expands sub frames until all the frames become one scrollable page.

Parameters

settings

settings object to get the frame flattening.

Returns

EINA_TRUE if the frame flattening is enabled EINA_FALSE if not or on failure

EAPI Eina_Bool ewk_settings_frame_flattening_enabled_set	(	Ewk_Settings *	settings,
		Eina_Bool	enable
	)

Enables/disables frame flattening.

By default, the frame flattening is disabled.

Parameters

settings	settings object to set the frame flattening
enable	EINA_TRUE to enable the frame flattening EINA_FALSE to disable

Returns

EINA_TRUE on success or EINA_FALSE on failure

See Also

ewk_settings_enable_frame_flattening_get()

EAPI Eina_Bool ewk_settings_fullscreen_enabled_get

(

const Ewk_Settings *

settings)

Returns whether the Javascript Fullscreen API is enabled or not.

Parameters

settings

settings object to query whether Javascript Fullscreen API is enabled

Returns

EINA_TRUE if the Javascript Fullscreen API is enabled EINA_FALSE if not or on failure

EAPI Eina_Bool ewk_settings_fullscreen_enabled_set	(	Ewk_Settings *	settings,
		Eina_Bool	enable
	)

Enables/disables the Javascript Fullscreen API. The Javascript API allows to request full screen mode, for more information see: http://dvcs.w3.org/hg/fullscreen/raw-file/tip/Overview.html

Default value for Javascript Fullscreen API setting is EINA_TRUE .

Parameters

settings	settings object to enable Javascript Fullscreen API
enable	EINA_TRUE to enable Javascript Fullscreen API or EINA_FALSE to disable

Returns

EINA_TRUE on success or EINA_FALSE on failure

EAPI Eina_Bool ewk_settings_javascript_enabled_get

(

const Ewk_Settings *

settings)

Returns whether JavaScript execution is enabled.

Parameters

settings

settings object to query if the javascript can be executed

Returns

EINA_TRUE if the javascript can be executed EINA_FALSE if not or on failure

EAPI Eina_Bool ewk_settings_javascript_enabled_set	(	Ewk_Settings *	settings,
		Eina_Bool	enable
	)

Enables/disables the javascript executing.

By default, JavaScript execution is enabled.

Parameters

settings	settings object to set javascript executing
enable	EINA_TRUE to enable javascript executing EINA_FALSE to disable

Returns

EINA_TRUE on success or EINA_FALSE on failure

EAPI Eina_Bool ewk_settings_loads_images_automatically_get

(

const Ewk_Settings *

settings)

Returns whether the images can be loaded automatically or not.

Parameters

settings

settings object to get auto loading of the images

Returns

EINA_TRUE if the images are loaded automatically EINA_FALSE if not or on failure

EAPI Eina_Bool ewk_settings_loads_images_automatically_set	(	Ewk_Settings *	settings,
		Eina_Bool	automatic
	)

Enables/disables auto loading of the images.

By default, auto loading of the images is enabled.

Parameters

settings	settings object to set auto loading of the images
automatic	EINA_TRUE to enable auto loading of the images EINA_FALSE to disable

Returns

EINA_TRUE on success or EINA_FALSE on failure

EAPI Eina_Bool ewk_settings_local_storage_enabled_get

(

const Ewk_Settings *

settings)

Returns whether the HTML5 local storage functionality is enabled or not.

Local storage provides simple synchronous storage access. HTML5 local storage specification is available at http://dev.w3.org/html5/webstorage/.

By default, the HTML5 local storage is enabled.

Parameters

settings

settings object to query whether HTML5 local storage is enabled

Returns

EINA_TRUE if the HTML5 local storage is enabled EINA_FALSE if disabled or on failure

EAPI Eina_Bool ewk_settings_local_storage_enabled_set	(	Ewk_Settings *	settings,
		Eina_Bool	enable
	)

Enables/disables the HTML5 local storage functionality.

Local storage provides simple synchronous storage access. HTML5 local storage specification is available at http://dev.w3.org/html5/webstorage/.

By default, the HTML5 local storage is enabled.

Parameters

settings	settings object to set the HTML5 local storage state
enable	EINA_TRUE to enable HTML5 local storage, EINA_FALSE to disable

Returns

EINA_TRUE on success or EINA_FALSE on failure

EAPI Eina_Bool ewk_settings_offline_web_application_cache_enabled_get

(

const Ewk_Settings *

settings)

Returns whether the offline application cache is enabled or not.

Parameters

settings

settings object to query whether offline application cache is enabled

Returns

EINA_TRUE if the offline application cache is enabled EINA_FALSE if disabled or on failure

EAPI Eina_Bool ewk_settings_offline_web_application_cache_enabled_set	(	Ewk_Settings *	settings,
		Eina_Bool	enable
	)

Enables/disables the offline application cache.

By default, the offline application cache is enabled.

Parameters

settings	settings object to set the offline application cache state
enable	EINA_TRUE to enable the offline application cache, EINA_FALSE to disable

Returns

EINA_TRUE on success or EINA_FALSE on failure

EAPI Eina_Bool ewk_settings_plugins_enabled_get

(

const Ewk_Settings *

settings)

Returns whether plug-ins support is enabled or not.

Parameters

settings

settings object to query whether plug-ins support is enabled

Returns

EINA_TRUE if plug-ins support is enabled EINA_FALSE if not or on failure

EAPI Eina_Bool ewk_settings_plugins_enabled_set	(	Ewk_Settings *	settings,
		Eina_Bool	enable
	)

Toggles plug-ins support.

By default, plug-ins support is enabled.

Parameters

settings	settings object to set plug-ins support
enable	EINA_TRUE to enable plug-ins support EINA_FALSE to disable

Returns

EINA_TRUE on success or EINA_FALSE on failure

EAPI unsigned ewk_settings_preferred_minimum_contents_width_get

(

const Ewk_Settings *

settings)

Returns preferred minimum contents width or 0 on failure.

Parameters

settings

settings object to query preferred minimum contents width

Returns

preferred minimum contents width 0 on failure

EAPI Eina_Bool ewk_settings_preferred_minimum_contents_width_set	(	Ewk_Settings *	settings,
		unsigned	width
	)

Sets preferred minimum contents width which is used as default minimum contents width for non viewport meta element sites.

By default, preferred minimum contents width is equal to 980.

Parameters

settings	settings object to set the encoding detector
width	the preferred minimum contents width

Returns

EINA_TRUE on success or EINA_FALSE on failure

EAPI Eina_Bool ewk_settings_private_browsing_enabled_get

(

const Ewk_Settings *

settings)

Returns whether private browsing is enabled or not.

Private Browsing allows a user to browse the Internet without saving any information about which sites and pages a user has visited.

Parameters

settings

settings object to query whether private browsing is enabled

Returns

EINA_TRUE if private browsing is enabled EINA_FALSE if not or on failure

EAPI Eina_Bool ewk_settings_private_browsing_enabled_set	(	Ewk_Settings *	settings,
		Eina_Bool	enable
	)

Enables/disables private browsing.

By default, private browsing is disabled.

Parameters

settings	settings object to set private browsing
enable	EINA_TRUE to enable private browsing EINA_FALSE to disable

Returns

EINA_TRUE on success or EINA_FALSE on failure

EAPI Eina_Bool ewk_settings_scripts_can_open_windows_get

(

const Ewk_Settings *

settings)

Returns whether the scripts can open new windows.

Parameters

settings

settings object to query whether the scripts can open new windows

Returns

EINA_TRUE if the scripts can open new windows EINA_FALSE if not or on failure (scripts are disabled)

EAPI Eina_Bool ewk_settings_scripts_can_open_windows_set	(	Ewk_Settings *	settings,
		Eina_Bool	enable
	)

Enables/disables if the scripts can open new windows.

By default, the scripts can open new windows.

Parameters

settings	settings object to set if the scripts can open new windows
enable	EINA_TRUE if the scripts can open new windows EINA_FALSE if not

Returns

EINA_TRUE on success or EINA_FALSE on failure (scripts are disabled)

EAPI Eina_Bool ewk_settings_spatial_navigation_enabled_get

(

const Ewk_Settings *

settings)

Returns current state of spatial navigation.

Parameters

settings

settings object to get whether spatial navigation is enabled

Returns

EINA_TRUE if spatial navigation is enabled EINA_FALSE if spatial navigation is disabled

EAPI Eina_Bool ewk_settings_spatial_navigation_enabled_set	(	Ewk_Settings *	settings,
		Eina_Bool	enable
	)

Changes spatial navigation state.

Parameters

settings	settings object to enable/disable spatial navigation
enable	EINA_TRUE to enable spatial navigation EINA_FALSE to disable spatial navigation

Returns

EINA_TRUE on success or EINA_FALSE on failure

EAPI Eina_Bool ewk_settings_text_autosizing_enabled_get

(

const Ewk_Settings *

settings)

Returns whether the text autosizing is enabled.

The text autosizing is a feature which adjusts the font size of text in wide columns, and makes text more legible.

Parameters

settings

settings object to query whether text autosizing is enabled

Returns

EINA_TRUE if the text autosizing is enabled EINA_FALSE if not or on failure

EAPI Eina_Bool ewk_settings_text_autosizing_enabled_set	(	Ewk_Settings *	settings,
		Eina_Bool	enable
	)

Enables/disables text autosizing.

By default, the text autosizing is disabled.

Parameters

settings	settings object to set the text autosizing
enable	EINA_TRUE to enable the text autosizing EINA_FALSE to disable

Returns

EINA_TRUE on success or EINA_FALSE on failure

See Also

ewk_settings_text_autosizing_enabled_get()

EAPI Eina_Bool ewk_settings_web_security_enabled_get

(

const Ewk_Settings *

settings)

Returns whether the web security is enabled.

Parameters

settings

settings object to query whether web security is enabled

Returns

EINA_TRUE if the web security is enabled EINA_FALSE if not or on failure

EAPI Eina_Bool ewk_settings_web_security_enabled_set	(	Ewk_Settings *	settings,
		Eina_Bool	enable
	)

Enables/disables web security.

By default, the web security is enabled.

Parameters

settings	settings object to set the web security
enable	EINA_TRUE to enable the web security EINA_FALSE to disable

Returns

EINA_TRUE on success or EINA_FALSE on failure

See Also

ewk_settings_web_security_enabled_get()