Interface nsIEditorType

Add a DocumentStateListener to the editors list of doc state listeners.

------------ Various listeners methods -------------- nsIEditor holds strong references to the editor observers, action listeners and document state listeners.

add an EditActionListener to the editors list of listeners.

beginTransaction is a signal from the caller to the editor that the caller will execute multiple updates to the content tree that should be treated as a single logical operation, in the most efficient way possible.
All transactions executed between a call to beginTransaction and endTransaction will be undoable as an atomic action.
endTransaction must be called after beginTransaction.
Calls to beginTransaction can be nested, as long as endTransaction is called once per beginUpdate.

Collapses selection at start of the document. If it's an HTML editor, collapses selection at start of current editing host ( element if it's in designMode) instead. If there is a non-editable node before any editable text nodes or inline elements which can have text nodes as their children, collapses selection at start of the editing host. If there is an editable text node which is not collapsed, collapses selection at start of the text node. If there is an editable inline element which cannot have text nodes as its child, collapses selection at before the element node. Otherwise, collapses selection at start of the editing host.

canCopy() returns true if selected content is allowed to be copied to the clipboard. Note that this always returns true if the editor is in a non-chrome HTML/XHTML document. FYI: Current user in script is only BlueGriffon.

canCut() returns true if selected content is allowed to be copied to the clipboard and to be removed. Note that this always returns true if the editor is in a non-chrome HTML/XHTML document. FYI: Current user in script is only BlueGriffon.

Can we paste? True if the doc is modifiable, and we have pasteable data in the clipboard.

Clears the transactions both for undo and redo. This may fail if you call this while editor is handling something, i.e., don't call this from a legacy mutation event listeners, then, you won't see any exceptions.

cloneAttributes() is similar to Node::cloneNode(), it assures the attribute nodes of the destination are identical with the source node by copying all existing attributes from the source and deleting those not in the source. This is used when the destination element already exists

copy the currently selected text, putting it into the OS clipboard What if no text is selected? What about mixed selections? What are the clipboard formats?

------------ Clipboard methods --------------

cut the currently selected text, putting it into the OS clipboard What if no text is selected? What about mixed selections? What are the clipboard formats?

deleteNode removes aChild from aParent.

------------ Selected content removal --------------

DeleteSelection removes all nodes in the current selection.

------------ Transaction methods --------------

turn the undo system on or off

Returns

if aEnable is PR_TRUE, returns NS_OK if the undo system could be initialized properly if aEnable is PR_FALSE, returns NS_OK.

Sets the selection to the end of the last leaf child/descendant or the root element.

endTransaction is a signal to the editor that the caller is finished updating the content model.
beginUpdate must be called before endTransaction is called.
Calls to beginTransaction can be nested, as long as endTransaction is called once per beginTransaction.

forceCompositionEnd() force the composition end

------------ Inline Spell Checking methods --------------

Returns the inline spell checker associated with this object. The spell checker is lazily created, so this function may create the object for you during this call.

Gets the modification count of the document we are editing.

Returns

the modification count of the document being edited. Zero means unchanged.

called each time we modify the document. Increments the modification count of the document.

Insert a line break into the content model. The interpretation of a break is up to the implementation: it may enter a character, split a node in the tree, etc. This may be more efficient than calling InsertText with a newline.

insertNode inserts aNode into aParent at aPosition. No checking is done to verify the legality of the insertion. That is the responsibility of the caller.

Inserts a string at the current location, given by the selection. If the selection is not collapsed, the selection is deleted and the insertion takes place at the resulting collapsed selection.

mask() is available only when the editor is a password field. This masks all unmasked characters immediately.

------------ Output methods --------------

Output methods: aFormatType is a mime type, like text/plain.

paste the text in the OS clipboard at the cursor position, replacing the selected text (if any)

Paste the text in |aTransferable| at the cursor position, replacing the selected text (if any).

Redo the topmost transaction in the redo stack. This may throw exception when this is called while editor is handling transactions.

removeAttribute() deletes aAttribute from the attribute list of aElement. If aAttribute is not an attribute of aElement, nothing is done.

Remove a DocumentStateListener to the editors list of doc state listeners.

Remove an EditActionListener from the editor's list of listeners.

to be used ONLY when we need to override the doc's modification state (such as when it's saved).

------------ Selection methods --------------

sets the document selection to the entire contents of the document

------------ Node manipulation methods --------------

setAttribute() sets the attribute of aElement. No checking is done to see if aAttribute is a legal attribute of the node, or if aValue is a legal value of aAttribute.

While setting the flag with this method to false, DeleteRangeTransaction, DeleteTextTransaction, InsertNodeTransaction, InsertTextTransaction and SplitNodeTransaction won't change Selection after modifying the DOM tree. Note that calling this with false does not guarantee that Selection won't be changed because other transaction may ignore this flag, editor itself may change selection, and current selection may become invalid after changing the DOM tree, etc. After calling this method with true, the caller should guarantee that Selection should be positioned where user expects.

Called when the user manually overrides the spellchecking state for this editor.

Undo the topmost transaction in the undo stack. This may throw exception when this is called while editor is handling transactions.

Undo all transactions in the undo stack. This may throw exception when this is called while editor is handling transactions.

unmask() is available only when the editor is a passwrod field. This unmasks characters in specified by aStart and aEnd. If there have already unmasked characters, they are masked when this is called. Note that if you calls this without non-zero aTimeout, you bear responsibility for masking password with calling mask(). I.e., user inputting password won't be masked automacitally. If user types a new character and echo is enabled, unmasked range is expanded to including it.