Linux Mac OSX Windows

Implemented by


  
[scriptable, uuid(d39fd2b4-3978-45d2-a4be-ba448171b61b)]
interface nsIEditingSession : nsISupports

Constants

  Error codes when we fail to create an editor
  is placed in attribute editorStatus
const long eEditorOK = 0

        
const long eEditorCreationInProgress = 1

        
const long eEditorErrorCantEditMimeType = 2

        
const long eEditorErrorFileNotFound = 3

        
const long eEditorErrorCantEditFramesets = 8

        
const long eEditorErrorUnknown = 9

Attributes

  Status after editor creation and document loading
  Value is one of the above error codes
readonly attribute unsigned long editorStatus

Methods

  Get the editor for this window. May return null
nsIEditor getEditorForWindow(in nsIDOMWindow window)
  Make this window editable
  @param aWindow nsIDOMWindow, the window the embedder needs to make editable
  @param aEditorType string, "html" "htmlsimple" "text" "textsimple"
void makeWindowEditable(in nsIDOMWindow window, in string aEditorType, in boolean doAfterUriLoad)

        
void setEditorOnControllers(in nsIDOMWindow aWindow, in nsIEditor aEditor)
 
  Setup editor and related support objects
void setupEditorOnWindow(in nsIDOMWindow window)
 
   Destroy editor and related support objects
void tearDownEditorOnWindow(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.
boolean windowIsEditable(in nsIDOMWindow window)