Interface nsIEditingSessionType

Hierarchy

Properties

editorStatus

Methods

AddRef QueryInterface Release getEditorForWindow makeWindowEditable tearDownEditorOnWindow windowIsEditable

Properties

Readonly editorStatus

editorStatus: number

Status after editor creation and document loading Value is one of the above error codes

Methods

AddRef

  • Increases the reference count for this interface. The associated instance will not be deleted unless the reference count is returned to zero.

    Returns

    The resulting reference count.

    Returns number

QueryInterface

  • Parameters

    • aIID: object
    • Optional aInstancePtr: object

    Returns any

  • A run time mechanism for interface discovery.

    Returns

    NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.

    aInstancePtr must not be null.

    Parameters

    • aIID: object

      [in] A requested interface IID

    • aInstancePtr: object

      [out] A pointer to an interface pointer to receive the result.

    Returns void

Release

  • Decreases the reference count for this interface. Generally, if the reference count returns to zero, the associated instance is deleted.

    Returns

    The resulting reference count.

    Returns number

getEditorForWindow

  • Get the editor for this window. May return null

    Parameters

    • window: mozIDOMWindowProxy

    Returns nsIEditor

makeWindowEditable

  • Make this window editable

    Parameters

    • window: mozIDOMWindowProxy
    • aEditorType: string

      string, "html" "htmlsimple" "text" "textsimple"

    • doAfterUriLoad: boolean
    • aMakeWholeDocumentEditable: boolean

      if PR_TRUE make the whole document in aWindow editable, otherwise it's the embedder who should make the document (or part of it) editable.

    • aInteractive: boolean

      if PR_FALSE turn off scripting and plugins

    Returns void

tearDownEditorOnWindow

  • Destroy editor and related support objects

    Parameters

    • window: mozIDOMWindowProxy

    Returns void

windowIsEditable

  • Test whether a specific window has had its editable flag set; it may have an editor now, or will get one after the uri load.

    Use this, passing the content root window, to test if we've set up editing for this content.

    Parameters

    • window: mozIDOMWindowProxy

    Returns boolean

Settings

Member Visibility

Theme

Generated using TypeDoc