docshell/base/nsIEditorDocShell.idl
author Gina Yeh <gyeh@mozilla.com>
Wed, 31 Oct 2012 17:33:50 +0800
changeset 112016 de25c9c57c5385b0c23f226aaa3c6a88bf5b2ff3
parent 95919 f4157e8c410708d76703f19e4dfb61859bfe32d8
permissions -rw-r--r--
Bug 806296 - Patch 1(v1): Cannot create an encrypted socket, r=echou

/* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#include "nsISupports.idl"

interface nsIEditor;

/**
 * nsIEditorDocShell provides a way to get an editor from
 * a specific frame in a docShell hierarchy. It is intended
 * to be only used internally. Use nsIEditingShell.getEditorForFrame
 * from out side.
 */

[scriptable, uuid(3BDB8F01-F141-11D4-A73C-FBA4ABA8A3FC)]
interface nsIEditorDocShell : nsISupports
{
             attribute  nsIEditor editor;
    readonly attribute  boolean   editable;             /* this docShell is editable */
    readonly attribute  boolean   hasEditingSession;    /* this docShell has an editing session */
    
    /**
     * Make this docShell editable, setting a flag that causes
     * an editor to get created, either immediately, or after
     * a url has been loaded.
     *      @param  inWaitForUriLoad    true to wait for a URI before
     *                                  creating the editor.
     */     
    void makeEditable(in boolean inWaitForUriLoad);
};