Public Member Functions | Public Attributes

nsIEditingSession Interface Reference

import "nsIEditingSession.idl";

List of all members.

Public Member Functions

void makeWindowEditable (in nsIDOMWindow window, in string aEditorType, in boolean doAfterUriLoad, in boolean aMakeWholeDocumentEditable, in boolean aInteractive)
 Make this window editable.
boolean windowIsEditable (in nsIDOMWindow window)
 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.
nsIEditor getEditorForWindow (in nsIDOMWindow window)
 Get the editor for this window.
void setupEditorOnWindow (in nsIDOMWindow window)
 Setup editor and related support objects.
void tearDownEditorOnWindow (in nsIDOMWindow window)
 Destroy editor and related support objects.
void setEditorOnControllers (in nsIDOMWindow aWindow, in nsIEditor aEditor)
void disableJSAndPlugins (in nsIDOMWindow aWindow)
 Disable scripts and plugins in aWindow.
void restoreJSAndPlugins (in nsIDOMWindow aWindow)
 Restore JS and plugins (enable/disable them) according to the state they were before the last call to disableJSAndPlugins.
void detachFromWindow (in nsIDOMWindow aWindow)
 Removes all the editor's controllers/listeners etc and makes the window uneditable.
void reattachToWindow (in nsIDOMWindow aWindow)
 Undos detachFromWindow(), reattaches this editing session/editor to the window.

Public Attributes

const long eEditorOK = 0
 Error codes when we fail to create an editor is placed in attribute editorStatus.
const long eEditorCreationInProgress = 1
const long eEditorErrorCantEditMimeType = 2
const long eEditorErrorFileNotFound = 3
const long eEditorErrorCantEditFramesets = 8
const long eEditorErrorUnknown = 9
readonly attribute unsigned long editorStatus
 Status after editor creation and document loading Value is one of the above error codes.

Member Function Documentation

void nsIEditingSession::detachFromWindow ( in nsIDOMWindow  aWindow  ) 

Removes all the editor's controllers/listeners etc and makes the window uneditable.

void nsIEditingSession::disableJSAndPlugins ( in nsIDOMWindow  aWindow  ) 

Disable scripts and plugins in aWindow.

nsIEditor nsIEditingSession::getEditorForWindow ( in nsIDOMWindow  window  ) 

Get the editor for this window.

May return null

void nsIEditingSession::makeWindowEditable ( in nsIDOMWindow  window,
in string  aEditorType,
in boolean  doAfterUriLoad,
in boolean  aMakeWholeDocumentEditable,
in boolean  aInteractive 
)

Make this window editable.

Parameters:
aWindow nsIDOMWindow, the window the embedder needs to make editable
aEditorType string, "html" "htmlsimple" "text" "textsimple"
aMakeWholeDocumentEditable 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 if PR_FALSE turn off scripting and plugins
void nsIEditingSession::reattachToWindow ( in nsIDOMWindow  aWindow  ) 

Undos detachFromWindow(), reattaches this editing session/editor to the window.

void nsIEditingSession::restoreJSAndPlugins ( in nsIDOMWindow  aWindow  ) 

Restore JS and plugins (enable/disable them) according to the state they were before the last call to disableJSAndPlugins.

void nsIEditingSession::setEditorOnControllers ( in nsIDOMWindow  aWindow,
in nsIEditor  aEditor 
)
void nsIEditingSession::setupEditorOnWindow ( in nsIDOMWindow  window  ) 

Setup editor and related support objects.

void nsIEditingSession::tearDownEditorOnWindow ( in nsIDOMWindow  window  ) 

Destroy editor and related support objects.

boolean nsIEditingSession::windowIsEditable ( in nsIDOMWindow  window  ) 

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.


Member Data Documentation

readonly attribute unsigned long nsIEditingSession::editorStatus

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

Error codes when we fail to create an editor is placed in attribute editorStatus.


The documentation for this interface was generated from the following file: