Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIEditingSession Interface Reference

import "nsIEditingSession.idl";

Inheritance diagram for nsIEditingSession:
Inheritance graph
[legend]
Collaboration diagram for nsIEditingSession:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void makeWindowEditable (in nsIDOMWindow window, in string aEditorType, in boolean doAfterUriLoad)
 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)

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.

Detailed Description

Definition at line 49 of file nsIEditingSession.idl.


Member Function Documentation

Get the editor for this window.

May return null

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

Make this window editable.

Parameters:
aWindownsIDOMWindow, the window the embedder needs to make editable
aEditorTypestring, "html" "htmlsimple" "text" "textsimple"

Setup editor and related support objects.

Destroy editor and related support objects.

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

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

Definition at line 66 of file nsIEditingSession.idl.

Definition at line 56 of file nsIEditingSession.idl.

Definition at line 59 of file nsIEditingSession.idl.

Definition at line 57 of file nsIEditingSession.idl.

Definition at line 58 of file nsIEditingSession.idl.

Definition at line 60 of file nsIEditingSession.idl.

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

Definition at line 55 of file nsIEditingSession.idl.


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