Initial community commit

Src/nprt_plugin/gecko/1.8/win/idl/nsIWebBrowserSetup.idl

@@ -0,0 +1,133 @@
+/* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
+ *
+ * ***** BEGIN LICENSE BLOCK *****
+ * Version: MPL 1.1/GPL 2.0/LGPL 2.1
+ *
+ * The contents of this file are subject to the Mozilla Public License Version
+ * 1.1 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ * http://www.mozilla.org/MPL/
+ *
+ * Software distributed under the License is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
+ * for the specific language governing rights and limitations under the
+ * License.
+ *
+ * The Original Code is the Mozilla browser.
+ *
+ * The Initial Developer of the Original Code is
+ * Netscape Communications, Inc.
+ * Portions created by the Initial Developer are Copyright (C) 1999
+ * the Initial Developer. All Rights Reserved.
+ *
+ * Contributor(s):
+ *   Travis Bogard <travis@netscape.com>
+ *
+ * Alternatively, the contents of this file may be used under the terms of
+ * either the GNU General Public License Version 2 or later (the "GPL"), or
+ * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
+ * in which case the provisions of the GPL or the LGPL are applicable instead
+ * of those above. If you wish to allow use of your version of this file only
+ * under the terms of either the GPL or the LGPL, and not to allow others to
+ * use your version of this file under the terms of the MPL, indicate your
+ * decision by deleting the provisions above and replace them with the notice
+ * and other provisions required by the GPL or the LGPL. If you do not delete
+ * the provisions above, a recipient may use your version of this file under
+ * the terms of any one of the MPL, the GPL or the LGPL.
+ *
+ * ***** END LICENSE BLOCK ***** */
+
+#include "nsISupports.idl"
+
+/**
+ * The nsIWebBrowserSetup interface allows certain properties of a new browser
+ * object to set before the browser window is opened.
+ *
+ * @note Unless stated otherwise, settings are presumed to be enabled by
+ *       default.
+ *
+ * @status FROZEN
+ */
+[scriptable, uuid(F15398A0-8018-11d3-AF70-00A024FFC08C)]
+interface nsIWebBrowserSetup : nsISupports
+{
+    /**
+     * Boolean. Enables/disables plugin support for this browser.
+     *
+     * @see setProperty
+     */
+    const unsigned long SETUP_ALLOW_PLUGINS         = 1;
+
+    /**
+     * Boolean. Enables/disables Javascript support for this browser.
+     *
+     * @see setProperty
+     */
+    const unsigned long SETUP_ALLOW_JAVASCRIPT      = 2;
+
+    /**
+     * Boolean. Enables/disables meta redirect support for this browser.
+     * Meta redirect timers will be ignored if this option is disabled.
+     *
+     * @see setProperty
+     */
+    const unsigned long SETUP_ALLOW_META_REDIRECTS  = 3;
+
+    /**
+     * Boolean. Enables/disables subframes within the browser
+     *
+     * @see setProperty
+     */
+    const unsigned long SETUP_ALLOW_SUBFRAMES       = 4;
+
+    /**
+     * Boolean. Enables/disables image loading for this browser
+     * window. If you disable the images, load a page, then enable the images,
+     * the page will *not* automatically load the images for the previously
+     * loaded page. This flag controls the state of a webBrowser at load time 
+     * and does not automatically re-load a page when the state is toggled. 
+     * Reloading must be done by hand, or by walking through the DOM tree and 
+     * re-setting the src attributes.
+     *
+     * @see setProperty
+     */
+    const unsigned long SETUP_ALLOW_IMAGES          = 5;
+
+    /**
+     * Boolean. Enables/disables whether the document as a whole gets focus before
+     * traversing the document's content, or after traversing its content.
+     *
+     * NOTE: this property is obsolete and now has no effect
+     *
+     * @see setProperty
+     */
+    const unsigned long SETUP_FOCUS_DOC_BEFORE_CONTENT = 6;
+
+    /**
+     * Boolean. Enables/disables the use of global history in the browser. Visited
+     * URLs will not be recorded in the global history when it is disabled.
+     *
+     * @see setProperty
+     */
+    const unsigned long SETUP_USE_GLOBAL_HISTORY    = 256;
+
+    /**
+     * Boolean. A value of PR_TRUE makes the browser a chrome wrapper.
+     * Default is PR_FALSE.
+     *
+     * @since mozilla1.0
+     *
+     * @see setProperty
+     */
+    const unsigned long SETUP_IS_CHROME_WRAPPER     = 7;
+
+    /**
+     * Sets an integer or boolean property on the new web browser object.
+     * Only PR_TRUE and PR_FALSE are legal boolean values.
+     *
+     * @param aId The identifier of the property to be set.
+     * @param aValue The value of the property.
+     */
+    void setProperty(in unsigned long aId, in unsigned long aValue);
+};
+