/*
    Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
    Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies)

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/

// The documentation in this file was imported from QtWebKit and is thus constrained
// by its LGPL license. Documentation written from scratch for new methods should be
// placed inline in the code as usual.

/*!
    \fn static QWebEngineSettings *QWebEngineSettings::globalSettings()
    Returns the global settings object.

    Any setting changed on the default object is automatically applied to all
    QWebEnginePage instances where the particular setting is not overridden already.
*/

/*!
    \class QWebEngineSettings
    \since QtWebEngine 1.0
    \brief The QWebEngineSettings class provides an object to store the settings used
    by QWebEnginePage

    \inmodule QtWebEngineWidgets

    Each QWebEnginePage object has its own QWebEngineSettings 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().

    QWebEngineSettings 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 \l{QWebEngineSettings::WebAttribute}{WebAttribute} enum further describes
    each attribute.

    \sa QWebEnginePage::settings(), QWebEngineView::settings()
*/

/*!
    \enum QWebEngineSettings::FontFamily

    This enum describes the generic font families defined by CSS 2.
    For more information see the
    \l{http://www.w3.org/TR/REC-CSS2/fonts.html#generic-font-families}{CSS standard}.

    \value StandardFont
    \value FixedFont
    \value SerifFont
    \value SansSerifFont
    \value CursiveFont
    \value FantasyFont
*/

/*!
    \enum QWebEngineSettings::FontSize

    This enum describes the font sizes configurable through QWebEngineSettings.

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

/*!
    \enum QWebEngineSettings::WebAttribute

    This enum describes various attributes that are configurable through QWebEngineSettings.

    \value AutoLoadImages Specifies whether images are automatically loaded in
        web pages. This is enabled by default.
    \value JavascriptEnabled Enables or disables the running of JavaScript
        programs. This is enabled by default
    \value JavascriptCanOpenWindows Specifies whether JavaScript programs
        can open new windows. This is enabled by default.
    \value JavascriptCanAccessClipboard Specifies whether JavaScript programs
        can read or write to the clipboard. This is disabled by default.
    \value LinksIncludedInFocusChain Specifies whether hyperlinks should be
        included in the keyboard focus chain. This is enabled by default.
    \value LocalStorageEnabled Specifies whether support for the HTML 5
        local storage feature is enabled or not. This is enabled by default.
    \value 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 QWebEngineSecurityOrigin.
    \value 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.
    \value 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.
    \value 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 QWebEngineSecurityOrigin.
    \value HyperlinkAuditingEnabled This setting enables support for the ping attribute for hyperlinks. It is disabled by default.
    \value ScrollAnimatorEnabled This setting enables animated scrolling. It is disabled by default.
    \value ErrorPageEnabled This setting enables built-in error pages of Chromium. It is enabled by default.
*/

/*!
    \fn void QWebEngineSettings::setFontSize(FontSize type, int size)
    Sets the font size for \a type to \a size.
*/

/*!
    \fn int QWebEngineSettings::fontSize(FontSize type) const
    Returns the default font size for \a type.
*/

/*!
    \fn void QWebEngineSettings::resetFontSize(FontSize type)
    Resets the font size for \a type to the size specified in the global
    settings object.

    This function has no effect on the global QWebEngineSettings instance.
*/

/*!
    \fn void QWebEngineSettings::setDefaultTextEncoding(const QString& encoding)
    Specifies the default text encoding system.

    The \a 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 \l{QTextCodec}

    \sa defaultTextEncoding()
*/

/*!
    \fn QString QWebEngineSettings::defaultTextEncoding() const
    Returns the default text encoding.

    \sa setDefaultTextEncoding()
*/

/*!
    \fn void QWebEngineSettings::setFontFamily(FontFamily which, const QString& family)
    Sets the actual font family to \a family for the specified generic family,
    \a which.
*/

/*!
    \fn QString QWebEngineSettings::fontFamily(FontFamily which) const
    Returns the actual font family for the specified generic font family,
    \a which.
*/

/*!
    \fn void QWebEngineSettings::resetFontFamily(FontFamily which)
    Resets the actual font family specified by \a which to the one set
    in the global QWebEngineSettings instance.

    This function has no effect on the global QWebEngineSettings instance.
*/

/*!
    \fn void QWebEngineSettings::setAttribute(WebAttribute attribute, bool on)

    Enables or disables the specified \a attribute feature depending on the
    value of \a on.
*/

/*!
    \fn bool QWebEngineSettings::testAttribute(WebAttribute attribute) const

    Returns true if \a attribute is enabled; otherwise returns false.
*/

/*!
    \fn void QWebEngineSettings::resetAttribute(WebAttribute attribute)

    Resets the setting of \a attribute to the value specified in the
    global QWebEngineSettings instance.

    This function has no effect on the global QWebEngineSettings instance.

    \sa globalSettings()
*/