midori-websettings

midori-websettings

Synopsis

#include <midori/midori.h>

enum                MidoriStartup;
enum                MidoriNewTabType;
enum                MidoriPreferredEncoding;
enum                MidoriNewPage;
enum                MidoriToolbarStyle;
enum                MidoriProxy;
enum                MidoriIdentity;
MidoriWebSettings * midori_web_settings_new             (void);
void                midori_web_settings_add_style       (MidoriWebSettings *settings,
                                                         const gchar *rule_id,
                                                         const gchar *style);
void                midori_web_settings_remove_style    (MidoriWebSettings *settings,
                                                         const gchar *rule_id);
const gchar *       midori_web_settings_get_system_name (gchar **architecture,
                                                         gchar **platform);
gboolean            midori_web_settings_has_plugin_support
                                                        (void);
gboolean            midori_web_settings_skip_plugin     (const gchar *path);
enum                MidoriSiteDataPolicy;
MidoriSiteDataPolicy midori_web_settings_get_site_data_policy
                                                        (MidoriWebSettings *settings,
                                                         const gchar *uri);
MidoriWebSettings * midori_settings_new_full            (gchar ***extensions);
gboolean            midori_settings_save_to_file        (MidoriWebSettings *settings,
                                                         GObject *app,
                                                         const gchar *filename,
                                                         GError **error);
                    MidoriWebSettingsClass;
                    MidoriWebSettings;

Description

Details

enum MidoriStartup

typedef enum {
    MIDORI_STARTUP_BLANK_PAGE, /* One blank tab or speed dial is opened */
    MIDORI_STARTUP_HOMEPAGE, /* One homepage tab is opened */
    MIDORI_STARTUP_LAST_OPEN_PAGES, /* The session is loaded and saved */
    MIDORI_STARTUP_DELAYED_PAGES /* The session is saved, loading pages is delayed */
} MidoriStartup;

MIDORI_STARTUP_BLANK_PAGE

MIDORI_STARTUP_HOMEPAGE

MIDORI_STARTUP_LAST_OPEN_PAGES

MIDORI_STARTUP_DELAYED_PAGES


enum MidoriNewTabType

typedef enum {
    MIDORI_NEWTAB_BLANK_PAGE,
    MIDORI_NEWTAB_HOMEPAGE,
    MIDORI_NEWTAB_SEARCH,
    MIDORI_NEWTAB_SPEED_DIAL,
    MIDORI_NEWTAB_CUSTOM,
} MidoriNewTabType;

MIDORI_NEWTAB_BLANK_PAGE

MIDORI_NEWTAB_HOMEPAGE

MIDORI_NEWTAB_SEARCH

MIDORI_NEWTAB_SPEED_DIAL

MIDORI_NEWTAB_CUSTOM


enum MidoriPreferredEncoding

typedef enum {
    MIDORI_ENCODING_CHINESE /* Traditional */,
    MIDORI_ENCODING_CHINESE_SIMPLIFIED,
    MIDORI_ENCODING_JAPANESE,
    MIDORI_ENCODING_KOREAN,
    MIDORI_ENCODING_RUSSIAN,
    MIDORI_ENCODING_UNICODE,
    MIDORI_ENCODING_WESTERN,
    MIDORI_ENCODING_CUSTOM
} MidoriPreferredEncoding;

MIDORI_ENCODING_CHINESE

MIDORI_ENCODING_CHINESE_SIMPLIFIED

MIDORI_ENCODING_JAPANESE

MIDORI_ENCODING_KOREAN

MIDORI_ENCODING_RUSSIAN

MIDORI_ENCODING_UNICODE

MIDORI_ENCODING_WESTERN

MIDORI_ENCODING_CUSTOM


enum MidoriNewPage

typedef enum {
    MIDORI_NEW_PAGE_TAB,
    MIDORI_NEW_PAGE_WINDOW,
    MIDORI_NEW_PAGE_CURRENT
} MidoriNewPage;

MIDORI_NEW_PAGE_TAB

MIDORI_NEW_PAGE_WINDOW

MIDORI_NEW_PAGE_CURRENT


enum MidoriToolbarStyle

typedef enum {
    MIDORI_TOOLBAR_DEFAULT,
    MIDORI_TOOLBAR_ICONS,
    MIDORI_TOOLBAR_SMALL_ICONS,
    MIDORI_TOOLBAR_TEXT,
    MIDORI_TOOLBAR_BOTH,
    MIDORI_TOOLBAR_BOTH_HORIZ
} MidoriToolbarStyle;

MIDORI_TOOLBAR_DEFAULT

MIDORI_TOOLBAR_ICONS

MIDORI_TOOLBAR_SMALL_ICONS

MIDORI_TOOLBAR_TEXT

MIDORI_TOOLBAR_BOTH

MIDORI_TOOLBAR_BOTH_HORIZ


enum MidoriProxy

typedef enum {
    MIDORI_PROXY_AUTOMATIC,
    MIDORI_PROXY_HTTP,
    MIDORI_PROXY_NONE
} MidoriProxy;

MIDORI_PROXY_AUTOMATIC

MIDORI_PROXY_HTTP

MIDORI_PROXY_NONE


enum MidoriIdentity

typedef enum {
    MIDORI_IDENT_MIDORI /* Automatic */,
    MIDORI_IDENT_GENUINE /* Midori */,
    MIDORI_IDENT_CHROME,
    MIDORI_IDENT_SAFARI,
    MIDORI_IDENT_IPHONE,
    MIDORI_IDENT_FIREFOX,
    MIDORI_IDENT_EXPLORER,
    MIDORI_IDENT_CUSTOM,
} MidoriIdentity;

MIDORI_IDENT_MIDORI

MIDORI_IDENT_GENUINE

MIDORI_IDENT_CHROME

MIDORI_IDENT_SAFARI

MIDORI_IDENT_IPHONE

MIDORI_IDENT_FIREFOX

MIDORI_IDENT_EXPLORER

MIDORI_IDENT_CUSTOM


midori_web_settings_new ()

MidoriWebSettings * midori_web_settings_new             (void);

Creates a new MidoriWebSettings instance with default values.

You will typically want to assign this to a MidoriWebView or MidoriBrowser.

Returns :

a new MidoriWebSettings. [transfer full]

midori_web_settings_add_style ()

void                midori_web_settings_add_style       (MidoriWebSettings *settings,
                                                         const gchar *rule_id,
                                                         const gchar *style);

Adds or replaces a custom stylesheet.

settings :

the MidoriWebSettings instance to modify

rule_id :

a static string identifier

style :

a CSS stylesheet

Since 0.4.2


midori_web_settings_remove_style ()

void                midori_web_settings_remove_style    (MidoriWebSettings *settings,
                                                         const gchar *rule_id);

Removes a stylesheet from midori settings.

settings :

the MidoriWebSettings instance to modify

rule_id :

the string identifier used previously

Since 0.4.2


midori_web_settings_get_system_name ()

const gchar *       midori_web_settings_get_system_name (gchar **architecture,
                                                         gchar **platform);

Determines the system name, architecture and platform. This function may write a NULL value to architecture.

architecture :

location of a string, or NULL. [out][allow-none]

platform :

location of a string, or NULL. [out][allow-none]

Returns :

a string

Since 0.4.2


midori_web_settings_has_plugin_support ()

gboolean            midori_web_settings_has_plugin_support
                                                        (void);

Determines if Netscape plugins are supported.

Returns :

TRUE if Netscape plugins can be used

Since 0.4.4


midori_web_settings_skip_plugin ()

gboolean            midori_web_settings_skip_plugin     (const gchar *path);

Tests if a plugin is redundant. WebKit sometimes provides duplicate listings of plugins due to library deployment miscellanea.

path :

the path to the plugin file

Returns :

TRUE if the passed plugin shouldn't be shown in UI listings.

Since 0.5.1


enum MidoriSiteDataPolicy

typedef enum {
    MIDORI_SITE_DATA_UNDETERMINED,
    MIDORI_SITE_DATA_BLOCK,
    MIDORI_SITE_DATA_ACCEPT,
    MIDORI_SITE_DATA_PRESERVE,
} MidoriSiteDataPolicy;

MIDORI_SITE_DATA_UNDETERMINED

MIDORI_SITE_DATA_BLOCK

MIDORI_SITE_DATA_ACCEPT

MIDORI_SITE_DATA_PRESERVE


midori_web_settings_get_site_data_policy ()

MidoriSiteDataPolicy midori_web_settings_get_site_data_policy
                                                        (MidoriWebSettings *settings,
                                                         const gchar *uri);

Tests if uri may store site data.

settings :

the MidoriWebSettings instance

uri :

the URI for which to make the policy decision

Returns :

a MidoriSiteDataPolicy

Since 0.4.4


midori_settings_new_full ()

MidoriWebSettings * midori_settings_new_full            (gchar ***extensions);

Creates a new MidoriWebSettings instance, loading configuration from disk according to preferences and invocation mode.

You will typically want to assign this to a MidoriWebView or MidoriBrowser.

extensions :

a pointer into which to write an array of names of extensions which preferences indicate should be activated, or NULL. [out][allow-none]

Returns :

a new MidoriWebSettings. [transfer full]

midori_settings_save_to_file ()

gboolean            midori_settings_save_to_file        (MidoriWebSettings *settings,
                                                         GObject *app,
                                                         const gchar *filename,
                                                         GError **error);

Saves a MidoriWebSettings instance to disk at the path given by filename.

Also saves the list of activated extensions from app.

settings :

a MidoriWebSettings instance to save

app :

a MidoriApplication instance. [type Midori.Application][allow-none]

filename :

the filename into which to save settings

error :

return location for a GError, or NULL. [out][allow-none]

Returns :

TRUE if no error occurred; FALSE if an error occurred, in which case error will contain detailed information

MidoriWebSettingsClass

typedef struct _MidoriWebSettingsClass MidoriWebSettingsClass;

MidoriWebSettings

typedef struct _MidoriWebSettings MidoriWebSettings;