void indent ( AString indent )

Document me!

Arguments:

indent

void insertElementAtSelection ( nsIDOMElement element , PRBool deleteSelection )

Insert an element, which may have child nodes, at the selection Used primarily to insert a new element for various insert element dialogs, but it enforces the HTML 4.0 DTD "CanContain" rules, so it should be useful for other elements.

Arguments:

element: The element to insert

deleteSelection: Delete the selection before inserting If deleteSelection is PR_FALSE, then the element is inserted after the end of the selection for all element except Named Anchors, which insert before the selection

void insertFromDrop ( nsIDOMEvent event )

InsertFromDrop looks for a dragsession and inserts the relevant data in response to a drop.

Arguments:

event

void insertHTML ( AString inputString )

Insert some HTML source at the current location

Arguments:

inputString: the string to be inserted

void insertHTMLWithContext ( AString inputString , AString contextStr , AString infoStr , AString flavor , nsIDOMDocument sourceDoc , nsIDOMNode destinationNode , PRInt32 destinationOffset , PRBool deleteSelection )

Insert some HTML source, interpreting the string argument according to the given context.

Arguments:

inputString: the string to be inserted

contextStr: Context of insertion

infoStr: Related info to inputString

flavor: Transferable flavor, can be ""

sourceDoc: document where input was dragged from (may be null)

destinationNode: location for insertion (such as when dropped)

destinationOffset: used with destNode to determine insert location

deleteSelection: used with destNode during drag&drop

void insertLinkAroundSelection ( nsIDOMElement anchorElement )

Insert an link element as the parent of the current selection

Arguments:

anchorElement

PRBool isAnonymousElement ( nsIDOMElement element )

Arguments:

element

void makeOrChangeList ( AString listType , PRBool entireList , AString bulletType )

Document me!

Arguments:

listType

entireList

bulletType

PRBool nodeIsBlock ( nsIDOMNode node )

Tests if a node is a BLOCK element according the the HTML 4.0 DTD. This does NOT consider CSS effect on display type

Arguments:

node: the node to test

void pasteNoFormatting ( PRInt32 selectionType )

Paste the text in the OS clipboard at the cursor position, replacing the selected text (if any), but strip out any HTML styles and formatting

Arguments:

selectionType

void rebuildDocumentFromSource ( AString sourceString )

Rebuild the entire document from source HTML Needed to be able to edit HEAD and other outside-of-BODY content

Arguments:

sourceString: HTML source string of the entire new document

void removeAllDefaultProperties ( )

RemoveAllDefaultProperties() unregisters all default style properties with the editor

void removeAllInlineProperties ( )

RemoveAllInlineProperties() deletes all the inline properties from all text in the current selection.

void removeDefaultProperty ( nsIAtom property , AString attribute , AString value )

RemoveDefaultProperty() unregisters a default style property with the editor

Arguments:

property: the property to remove from defaults

attribute: the attribute of the property, if applicable. May be null. Example: property="font", attribute="color"

value: if attribute is not null, the value of the attribute. Example: property="font", attribute="color", value="0x00FFFF"

void removeInlineProperty ( nsIAtom property , AString attribute )

RemoveInlineProperty() deletes the properties from all text in the current selection. If property is not set on the selection, nothing is done.

Arguments:

property: the property to remove from the selection All atoms are for normal HTML tags (e.g.: nsIEditorProperty::font) except when you want to remove just links and not named anchors. For that, use nsIEditorProperty::href

attribute: the attribute of the property, if applicable. May be null. Example: property=nsIEditorProptery::font, attribute="color" nsIEditProperty::allAttributes is special. It indicates that all content-based text properties are to be removed from the selection.

void removeInsertionListener ( nsIContentFilter inFilter )

Remove listener for insertion override

Arguments:

inFilter: function which callers do not want called during insertion

void removeList ( AString listType )

Document me!

Arguments:

listType

void replaceHeadContentsWithHTML ( AString sourceToInsert )

Replace all children of with string of HTML source

Arguments:

sourceToInsert

void selectElement ( nsIDOMElement element )

Set the selection at the suppled element

Arguments:

element: An element in the document

void setBackgroundColor ( AString color )

Set the value of the "bgcolor" attribute on the document's element

Arguments:

color: The HTML color string, such as "#ffccff" or "yellow"

void setBodyAttribute ( AString attr , AString value )

Set an attribute on the document's element such as text, link, background colors

8/31/00 THIS ISN'T BEING USED? SHOULD WE DROP IT?

Arguments:

attr: The attribute to be set

value: The value of the attribute

void setCaretAfterElement ( nsIDOMElement element )

Create a collapsed selection just after element

XXX could we parameterize SelectElement(before/select/after>?

The selection is set to parent-of-aElement with an offset 1 greater than element's offset but it enforces the HTML 4.0 DTD "CanContain" rules, so it should be useful for other elements.

Arguments:

element: An element in the document

void setCSSInlineProperty ( nsIAtom property , AString attribute , AString value )

SetInlineProperty() sets the aggregate properties on the current selection

Arguments:

property: the property to set on the selection

attribute: the attribute of the property, if applicable. May be null. Example: property="font", attribute="color"

value: if attribute is not null, the value of the attribute. May be null. Example: property="font", attribute="color", value="0x00FFFF"

void setDocumentTitle ( AString title )

Set the documents title.

Arguments:

title

void setInlineProperty ( nsIAtom property , AString attribute , AString value )

Arguments:

property

attribute

value

void setParagraphFormat ( AString paragraphFormat )

SetParagraphFormat Insert a block paragraph tag around selection

Arguments:

paragraphFormat: "p", "h1" to "h6", "address", "pre", or "blockquote"

void updateBaseURL ( )

Set the BaseURL for the document to the current URL but only if the page doesn't have a tag This should be done after the document URL has changed, such as after saving a file This is used as base for relativizing link and image urls